youpy / ruby-lastfm Goto Github PK

View Code? Open in Web Editor NEW

248.0 15.0 107.0 346 KB

A Ruby interface for Last.fm Web Services

License: MIT License

Ruby 100.00%

ruby-lastfm's Introduction

ruby-lastfm

A Ruby interface for Last.fm Web Services v2.0

Synopsis

require 'lastfm'

lastfm = Lastfm.new(api_key, api_secret)
token = lastfm.auth.get_token

# open 'http://www.last.fm/api/auth/?api_key=xxxxxxxxxxx&token=xxxxxxxx' and grant the application

lastfm.session = lastfm.auth.get_session(token: token)['key']

lastfm.track.love(artist: 'Hujiko Pro', track: 'acid acid 7riddim')
lastfm.track.scrobble(artist: 'Hujiko Pro', track: 'acid acid 7riddim')
lastfm.track.update_now_playing(artist: 'Hujiko Pro', track: 'acid acid 7riddim')

Supported Rubies

1.9.3
2.0.0
2.1.0
2.2.0

Supported API Methods

It supports methods which require authentication.

Album

Artist

Auth

Track

User

Geo

~~geo.getEvents~~ deleted

Group

group.getMembers

Library

Chart

Installation

Archive Installation

rake install

Gem Installation

gem update --system
gem install gemcutter
gem tumble
gem install lastfm

Features/Problems

Comitters

see https://github.com/youpy/ruby-lastfm/contributors

Note on Patches/Pull Requests

Fork the project.
Make your feature addition or bug fix.
Add tests for it. This is important so I don't break it in a future version unintentionally.
Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
Send me a pull request. Bonus points for topic branches.

Copyright

ruby-lastfm's People

Contributors

Stargazers

Watchers

Forkers

dodeja cps mattfawcett ramblurr tze pipedreambomb kl-7 brinkar epictetus mikepack masterkain bdotdub guniorobot kabturek joshuaknox workingben brenes dannyhertz noecker mask8 travisvalentine zerox-tj mllocs spariev ckdake andyleclair erickreutz morion4000 polomasta 8tracks viandant urbanvention lisongx norbert talsafran alessiorocco greggroth w00lf ryland rahilsondhi teenst iamjoshbinder hivan benuuu wsifuentes oprbguitar jmahoney cepera63 mihaiionescu ghiculescu tianhonghui nstokoe rootpd sebweaver vbsteven qblake songyiyang alow moonpeople lgmkr missionsf dropofwill mattv135 klinskyc tallkeith tony007digital jabrad0 illtellyoulater cytomich travisbrace maryhuynh volontarian icoretech alexis779 shanalmoore bopster 1v tmothymartel aidarbek mitzimagination nofrazie worthe danrempel gbrethen jessicaec ozgeergen aumdove tripproberts baktybekdoskul gfauredumont dalboz merongivian aastronautss villskog plexinc toy dyet92k taher-ghaleb eashman softwarehistorysociety

ruby-lastfm's Issues

Wrong scrobble date is sent when date parameter left blank

I have no idea how to fix it myself, setting scrobble date manually solves the problem.

The optional parameter artist of track.search makes no difference

According to #30 you should be able to use the optional artist parameter of track.search. However, when I try it it makes no difference. For example

p lastfm.track.search(artist: 'Spacemen 3', track: 'Revolution')['results']['trackmatches']['track'].length

gives the same result as

p lastfm.track.search(track: 'Revolution')['results']['trackmatches']['track'].length

getGeo.events and artist.getEvents not working, but maybe because LastFM API changed or broken?

Examples

lastfm = Lastfm.new(ENV['LAST_FM_KEY'],ENV['LAST_FM_SECRET'])

lastfm.geo.get_events(location: "New York")
>Lastfm::ApiError: Invalid Method - No method with that name in this package

lastfm.artist.get_events(artist: "Morrissey")
>Lastfm::ApiError: Invalid Method - No method with that name in this package

Relevant links as to API status

https://plus.google.com/+TimothyMalseed/posts/Sn6qcQuPDrX

Their status doesn't reflect deletion or changes in these methods.
http://status.last.fm/

Anyone else having these problems? Or know what the issue is? I reached out to LastFM but haven't heard back yet.

Rexml parsing escaping problem

Problem with artist.
I thinks this placeformed=>"Montreal & Ottawa, Canada" don't escaped

lastfm.artist.get_info(artist: "Obey The Brave")

/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/parsers/treeparser.rb:95:in `rescue in parse': #<RuntimeError: Illegal character '&' in raw string "Montreal & Ottawa, Canada"> (REXML::ParseException)
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/text.rb:155:in `block in check'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/text.rb:153:in `scan'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/text.rb:153:in `check'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/text.rb:120:in `initialize'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/parsers/treeparser.rb:46:in `new'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/parsers/treeparser.rb:46:in `parse'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/document.rb:283:in `build'
/Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/document.rb:43:in `initialize'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:965:in `new'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:965:in `parse'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:164:in `xml_in'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:203:in `xml_in'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/response.rb:11:in `rescue in initialize'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/response.rb:9:in `initialize'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm.rb:114:in `new'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm.rb:114:in `request'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/method_category/base.rb:84:in `request'
/Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/method_category/base.rb:46:in `block in __define_method'
lastfm.rb:11:in `<main>'
...
Illegal character '&' in raw string "Montreal & Ottawa, Canada"
Line: 112
Position: 6708
Last 80 unconsumed characters:
</placeformed>
    from /Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/parsers/treeparser.rb:20:in `parse'
    from /Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/document.rb:283:in `build'
    from /Users/onemanstartup/.rvm/rubies/ruby-2.0.0-p195/lib/ruby/2.0.0/rexml/document.rb:43:in `initialize'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:965:in `new'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:965:in `parse'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:164:in `xml_in'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/xml-simple-1.1.2/lib/xmlsimple.rb:203:in `xml_in'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/response.rb:11:in `rescue in initialize'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/response.rb:9:in `initialize'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm.rb:114:in `new'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm.rb:114:in `request'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/method_category/base.rb:84:in `request'
    from /Users/onemanstartup/.rvm/gems/ruby-2.0.0-p195/gems/lastfm-1.19.0/lib/lastfm/method_category/base.rb:46:in `block in __define_method'
    from lastfm.rb:11:in `<main>'

track.getCorrection returns exceptions or nil

69946f0

Lastfm.new(Settings.services.lastfm.api_key, Settings.services.lastfm.secret).track.get_correction('White Stripes', 'One More Cup of Coffee', 'wainekerr')

This uses the same data as in the spec, however it returns nil for me.

If instead we use a mispelt artist or track title, it raises:

Lastfm::ApiError: Supplied artist does not exist
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-2242de096b1e/lib/lastfm.rb:96:in `request'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-2242de096b1e/lib/lastfm/method_category/base.rb:54:in `request'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-2242de096b1e/lib/lastfm/method_category/base.rb:29:in `block in __define_method'

There's no way to know last.fm username after calling auth.getSession

It returns session key only, api has no methods that would return user's name by its session key.
To get name it is needed to modify existing method auth.getSession to return not only session key, but entire session info. But this likely would cause problems to existing gem users.

*#search raises REXML::UndefinedNamespaceException

last.fm returns invalid XML, missing namespace declaration.

<?xml version="1.0" encoding="UTF-8" ?>
  <lfm status="ok">
    <results for="Believe">
      <opensearch:Query role="request" searchTerms="Believe" startPage="1"></opensearch:Query>
...

valid XML is:

<?xml version="1.0" encoding="UTF-8" ?>
  <lfm status="ok">
    <results for="Believe" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
      <opensearch:Query role="request" searchTerms="Believe" startPage="1"></opensearch:Query>
...

track.scrobble rerurn True, but timestamp is not valid and scrobbling was not done

If the timestamp is older than 14+ days, then Last.fm doesn't accept scrobble, but track.scrobble returns True.
There is no such thing in the Last.fm API documentation, but its so.
The API response for such a track contains ignoredMessage Code 1

I get an album with no tracks; any idea why ?

Hi, when I try to get this album using your gem,

document = lastfm.album.get_info('artist':'Pepe Deluxé','album':'Queen of the Wave')

I get a result for the album but the tracks attribute is an empty array; while the album exists (with tracks) on Last.fm.

Any idea of why it does this ?
Could it be related to the accents ?

Thanks for the awesome work !

releasedate apparently gone

https://github.com/youpy/ruby-lastfm/blob/master/lib/lastfm/method_category/album.rb#L33

I'm debugging an issue for which album.getInfo raises an error, apparently the lastfm api removed the releasedate key: http://ws.audioscrobbler.com/2.0/?method=album.getinfo&api_key=19e067c215c61839b6a907e90d1d8d6e&artist=Cher&album=Believe&format=json

I'm not sure if it's intended and I'm going to contact them.

getSession - Invalid method signature supplied

I have a problem when I try to set the session attribute.

@lastfm.session = @lastfm.auth.get_session(token: @token)['api_key']

I don't know exactly what to put inside [ ]. I've tried api_key, but I get the following error

 Invalid method signature supplied

How can I solve this?

Thanks

XML inconsistency

I noticed that the Last.fm API's endpoints in the Tag group don't return the same XML as written in their documentation.As an example of the problem, here are screenshots of the data, that is actually returned by their API and data written in official documentation.

API links broken in the documentation

a lot of API links are broken on your documentation page...
Thanks for your code !

Why the project uses XML API?

Last.FM has JSON API with format=json

http://www.last.fm/api/rest

Mandatory and optional parameters

The problem comes when the required params are dependent, such as:

album.getInfo:

artist (Required (unless mbid) : The artist name
album (Required (unless mbid) : The album name
mbid (Optional) : The musicbrainz id for the album
...

Here you can provide whether mbid or both artist and album.

The gem only implements the artist and album case, not if you provide only the mbid.

The way regular_method is implemented doesn't allow an easy way to solve these cases (or at least I don't see it :( )

def regular_method(id, mandatory, optional = [], &block)
  __define_method(:request, id, mandatory, optional, &block)
end

Any idea of how we could handle the mbid case? It's not only a problem of this method (album.getInfo) but also in many other...

Cannot install lastfm gem

When trying to install lastfm gem i get this error message.

ERROR: Error installing lastfm:
lastfm requires lastfm (>= 0)

OSX Lion
ruby 1.9.3p125

nil errors during auth

Here is what I get when I try both get_token and get_session:

http://pastie.org/private/owdevg8mx7lcfw1vzbtw

Optional user parameter in user#get_info

First of thanks for a awesome gem!

According to the official Last.fm API docs the user.getInfo method doesn't require a user parameter being passed along the call. If it's omitted it will default to the authenticated user. Therefor it would be great if the method would mimic this behaviour aswell.

ArgumentError: File does not exist: .

Hello,
I upgraded to 1.8.0 and I'm getting this exception on now_playing:

xml-simple (1.1.1) lib/xmlsimple.rb:990:in `find_xml_file'
xml-simple (1.1.1) lib/xmlsimple.rb:168:in `xml_in'
xml-simple (1.1.1) lib/xmlsimple.rb:203:in `xml_in'
lastfm (1.8.0) lib/lastfm/response.rb:9:in `initialize'
lastfm (1.8.0) lib/lastfm.rb:94:in `new'
lastfm (1.8.0) lib/lastfm.rb:94:in `request'
lastfm (1.8.0) lib/lastfm/method_category/base.rb:54:in `request'
lastfm (1.8.0) lib/lastfm/method_category/base.rb:39:in `write_request'
lastfm (1.8.0) lib/lastfm/method_category/base.rb:29:in `block in __define_method'

client.track.update_now_playing(artist, title, album, position)
# or
client.track.update_now_playing(artist: artist, track: title, album: album, trackNumber: position)

Is the Last.fm service being funky?

Version upgrade

Hi Youpy,

Thank you for having pulled my recent upgrade! When do you plan to release it on rubygems? Indeed, the gem I'm developing now requires yours and I'd like to release it soon with the right dependency. No pressure, of course. ;-)

Thanks in advance.

Bye

License missing from gemspec

Some companies will only use gems with a certain license.
The canonical and easy way to check is via the gemspec
via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

There is even a License Finder to help companies ensure all gems they use
meet their licensing needs. This tool depends on license information being available in the gemspec.
Including a license in your gemspec is a good practice, in any case.

How did I find you?

I'm using a script to collect stats on gems, originally looking for download data, but decided to collect licenses too,
and make issues for missing ones as a public service :)
https://gist.github.com/bf4/5952053#file-license_issue-rb-L13 So far it's going pretty well

.

This is an issue to recover rubygems.org account

Rakefile depends on old version of rspec

I'd like to contribute, but the Rakefile seems to depend on rspec 1.3. As I have 2.1.0 installed I can't install the library. I've attempted a few different fixes, but my rake foo isn't good enough. Any chance you could upgrade the Rakefile to support 2.1.0?

Structure of return from track.search is different if there is one match only

If there is only one match

@lastfm.track.search(track: song.to_search_term)['results']['trackmatches']['track']

returns a hash but otherwise it returns an array. Is this intended?

Currently I hack around this fact by putting the resulting hash in an array if there only one match.

user.get_loved_tracks does not always return an array

It is possible to get three different return types from user.get_loved_tracks:

When a user has more than one loved track it returns an array.
When a user has only one loved track it returns a hash.
When a user has not got any loved tracks it returns nil.

This leads to ugly code. For example if one wants to use each on the result from user.get_loved_tracks one has to check before whether it is nil or a hash. This is similar to #46.

track#get_tags requires authentication

Lastfm::MethodCategory::Track#get_tags uses method_with_authentication, but the getTags end point on Last.fm doesn't require authentication, which is causing some confusion. I'll try and submit a pull request to adjust this.

Nice gem by the way, very elegant.

NoMethodError: undefined method `lstrip!' for {}:Hash on album.getinfo

Please have a look at this:

Lastfm.new(yourkey, yoursecret).album.get_info('Vemoth', 'The Upcoming End')

NoMethodError: undefined method `lstrip!' for {}:Hash
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-33f2415100e3/lib/lastfm/method_category/album.rb:6:in `block in <class:Album>'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-33f2415100e3/lib/lastfm/method_category/base.rb:29:in `call'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/bundler/gems/ruby-lastfm-33f2415100e3/lib/lastfm/method_category/base.rb:29:in `block in __define_method'
  from (irb):2
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/gems/railties-3.2.3/lib/rails/commands/console.rb:47:in `start'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/gems/railties-3.2.3/lib/rails/commands/console.rb:8:in `start'
  from /Users/kain/.rvm/gems/ruby-1.9.3-p125/gems/railties-3.2.3/lib/rails/commands.rb:41:in `<top (required)>'
  from script/rails:6:in `require'
  from script/rails:6:in `<main>'

This happens because the releasedate is {}:

lastfm.request('album.getInfo', { artist: 'Vemoth', album: 'The Upcoming End'})

 => #<Lastfm::Response:0x007fd5d1862460 @xml={"status"=>"ok", "album"=>{"name"=>"The Upcoming End", "artist"=>"Vemoth", "id"=>"75620491", "mbid"=>{}, "url"=>"http://www.last.fm/music/Vemoth/The+Upcoming+End", "releasedate"=>{}, "image"=>[{"size"=>"small", "content"=>"http://userserve-ak.last.fm/serve/34s/35151317.jpg"}, {"size"=>"medium", "content"=>"http://userserve-ak.last.fm/serve/64s/35151317.jpg"}, {"size"=>"large", "content"=>"http://userserve-ak.last.fm/serve/174s/35151317.jpg"}, {"size"=>"extralarge", "content"=>"http://userserve-ak.last.fm/serve/300x300/35151317.jpg"}, {"size"=>"mega", "content"=>"http://userserve-ak.last.fm/serve/_/35151317/The+Upcoming+End.jpg"}], "listeners"=>"242", "playcount"=>"4003", "tracks"=>{}, "toptags"=>{}}}>

REXML::ParseException

When calling get_recent_tracks for my last.fm data, some nasty data from Last.fm causes the gem to blow up with:

REXML::ParseException: #<RuntimeError: Illegal character "\uFFFE" in raw string "�䬀愀瀀匀氀愀瀀">

This probably should get eaten by the gem because as it is, the only way I could effectively catch this is to loop through get_recent_tracks once per song which is a Bad Thing.

Question regarding using the gem for authenticating a web app.

I have the gem accepting a token and getting a session key for a given user. I'm storing this session key for later use in my User table. My question is, how do I sign my requests like, lastfm.track.scrobble and lastfm.track.update_now_playing, with this saved session key so I do not have get the user to give me a new token and retrieve a new session key every time.

cc: @youpy

Thanks!