rockstar 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc/*
+pkg/*
+.swp

data/History.txt

@@ -0,0 +1,6 @@
+* v 0.3.0: update api to use v2.0 of the last.fm api and renamed gem to
+* "Rockstar Gem"
+* v 0.2.3: changed the way things get escaped in hopes that it would fix some problems some were having
+* v 0.2.2: a bunch of changes from titanous, mostly refactoring
+* v 0.2.0: added support for scrobbling tracks and now playing submission (Titanous)
+* v 0.1.0: initial release

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2010 John Nunemaker, Bodo Tasche
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -0,0 +1,72 @@
+History.txt
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+examples/album.rb
+examples/artist.rb
+examples/lastfm.yml_example
+examples/scrobble.rb
+examples/tag.rb
+examples/track.rb
+examples/user.rb
+lib/rockstar.rb
+lib/rockstar/album.rb
+lib/rockstar/artist.rb
+lib/rockstar/auth.rb
+lib/rockstar/base.rb
+lib/rockstar/chart.rb
+lib/rockstar/playing.rb
+lib/rockstar/rest.rb
+lib/rockstar/scrobble.rb
+lib/rockstar/session.rb
+lib/rockstar/simpleauth.rb
+lib/rockstar/tag.rb
+lib/rockstar/tokenauth.rb
+lib/rockstar/track.rb
+lib/rockstar/user.rb
+lib/rockstar/version.rb
+test/fixtures/xml/album/getinfo_album_Some_Hearts_artist_Carrie_Underwood.xml
+test/fixtures/xml/artist/getsimilar_artist_Metallica.xml
+test/fixtures/xml/artist/gettopalbums_artist_Metallica.xml
+test/fixtures/xml/artist/gettopfans_artist_Metallica.xml
+test/fixtures/xml/artist/gettoptags_artist_Metallica.xml
+test/fixtures/xml/artist/gettoptracks_artist_Metallica.xml
+test/fixtures/xml/tag/gettopalbums_tag_rock.xml
+test/fixtures/xml/tag/gettopartists_tag_rock.xml
+test/fixtures/xml/tag/gettoptags.xml
+test/fixtures/xml/tag/gettoptracks_tag_rock.xml
+test/fixtures/xml/track/gettopfans_artist_Carrie_Underwood_track_Before_He_Cheats.xml
+test/fixtures/xml/track/gettoptags_artist_Carrie_Underwood_track_Before_He_Cheats.xml
+test/fixtures/xml/track/love_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml
+test/fixtures/xml/user/getfriends_user_jnunemaker.xml
+test/fixtures/xml/user/getinfo_user_jnunemaker.xml
+test/fixtures/xml/user/getinfo_user_oaknd1.xml
+test/fixtures/xml/user/getinfo_user_wharle.xml
+test/fixtures/xml/user/getlovedtracks_user_jnunemaker.xml
+test/fixtures/xml/user/getneighbours_user_jnunemaker.xml
+test/fixtures/xml/user/getrecenttracks_user_jnunemaker.xml
+test/fixtures/xml/user/getrecommendedartists_sk_token_user_jnunemaker.xml
+test/fixtures/xml/user/gettopalbums_user_jnunemaker.xml
+test/fixtures/xml/user/gettopartists_user_jnunemaker.xml
+test/fixtures/xml/user/gettoptags_user_jnunemaker.xml
+test/fixtures/xml/user/gettoptracks_user_jnunemaker.xml
+test/fixtures/xml/user/getweeklyalbumchart_from_1138536002_to_1139140802_user_jnunemaker.xml
+test/fixtures/xml/user/getweeklyalbumchart_from__to__user_jnunemaker.xml
+test/fixtures/xml/user/getweeklyartistchart_from_1138536002_to_1139140802_user_jnunemaker.xml
+test/fixtures/xml/user/getweeklyartistchart_from__to__user_jnunemaker.xml
+test/fixtures/xml/user/getweeklychartlist_user_jnunemaker.xml
+test/fixtures/xml/user/getweeklytrackchart_from_1138536002_to_1139140802_user_jnunemaker.xml
+test/fixtures/xml/user/getweeklytrackchart_from__to__user_jnunemaker.xml
+test/mocks/rest.rb
+test/test_helper.rb
+test/unit/test_album.rb
+test/unit/test_artist.rb
+test/unit/test_chart.rb
+test/unit/test_playing.rb
+test/unit/test_scrobble.rb
+test/unit/test_simpleauth.rb
+test/unit/test_tag.rb
+test/unit/test_tokenauth.rb
+test/unit/test_track.rb
+test/unit/test_user.rb

data/README.rdoc

@@ -0,0 +1,140 @@
+=Rockstar
+
+Rockstar is a wrapper for the last.fm audioscrobbler web services (http://www.last.fm/api/). This gem is based on the scrobbler
+gem by John Nunemaker and updated to use the 2.0 version of the last.fm api
+
+Below is just a sampling of how easy this lib is to use.
+
+Please initialize your api key and secret before using the api:
+
+    Rockstar.lastfm = YAML.load_file('lastfm.yml')
+
+Here is an example lastfm.yml:
+
+    api_key: "API"
+    api_secret: "SECRET"    
+
+If you want to use the api in an rails app, you could add an initializer in config/initializers/lastm.rb and load a config/lastfm.yml file.
+
+    rails_root = ENV['RAILS_ROOT'] || File.dirname(__FILE__) + '/../..'
+    Rockstar.lastfm =  YAML.load_file(rails_root + '/config/lastfm.yml')
+
+== Users
+
+    user = Rockstar::User.new('jnunemaker')
+
+    puts "#{user.username}'s Recent Tracks"
+    puts "=" * (user.username.length + 16)
+    user.recent_tracks.each { |t| puts t.name }
+
+    puts
+    puts
+
+    puts "#{user.username}'s Top Tracks"
+    puts "=" * (user.username.length + 13)
+    user.top_tracks.each { |t| puts "(#{t.playcount}) #{t.name}" }
+    
+== Albums
+    
+    album = Rockstar::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+
+    puts "Album: #{album.name}"
+    puts "Artist: #{album.artist}"
+    puts "URL: #{album.url}"
+    puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+
+==Artists
+    
+    artist = Rockstar::Artist.new('Carrie Underwood')
+
+    puts 'Top Tracks'
+    puts "=" * 10
+    artist.top_tracks.each { |t| puts "(#{t.name}" }
+
+    puts
+
+    puts 'Similar Artists'
+    puts "=" * 15
+    artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }
+    
+==Tags    
+    
+    tag = Rockstar::Tag.new('country')
+
+    puts 'Top Albums'
+    tag.top_albums.each { |a| puts "(#{a.count}) #{a.name} by #{a.artist}" }
+
+    puts
+
+    puts 'Top Tracks'
+    tag.top_tracks.each { |t| puts "(#{t.count}) #{t.name} by #{t.artist}" }
+    
+==Tracks
+    
+    track = Rockstar::Track.new('Carrie Underwood', 'Before He Cheats')
+    puts 'Fans'
+    puts "=" * 4
+    track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+    
+    # Love a song, session_key is returned by Rockstar::Auth. See Rockstar::TokenAuth or
+    # examples/scrobble.rb for a complete example
+    track.love(session_key)
+
+== Token Authentication (for scrobbling and recommendations)
+
+    a = Rockstar::Auth.new
+    token = a.token
+    
+    puts
+    puts "Please open http://www.last.fm/api/auth/?api_key=#{Rockstar.lastfm_api_key}&token=#{token}"
+    puts
+    puts "Press enter when done."
+    
+    gets
+    
+    session = a.session(token)
+    
+    auth = Rockstar::TokenAuth.new({:username => session.username, :token => session.key})
+    auth.handshake!
+
+More details can be found in in Rockstar::TokenAuth
+
+== Scrobbling
+
+    scrobble = Rockstar::Scrobble.new(:session_id => auth.session_id,
+                                       :submission_url => auth.submission_url,
+                                       :artist => 'Coldplay',
+                                       :track => 'Viva La Vida',
+                                       :album => "Viva La Vida",
+                                       :time => Time.new,
+                                       :length => 244,
+                                       :track_number => 7)
+    scrobble.submit!
+    puts "Rockstar Submission Status: #{scrobble.status}"
+
+== Now Playing Submission
+
+    playing = Rockstar::Playing.new(:session_id => auth.session_id,
+                                     :now_playing_url => auth.now_playing_url,
+                                     :artist => 'Anberlin',
+                                     :track => 'Readyfuels',
+                                     :album => 'Blueprints For the Black Market',
+                                     :length => 218,
+                                     :track_number => 1)
+
+    playing.submit!         
+    puts "Playing Submission Status: #{playing.status}"
+
+== 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
+
+Copyright (c) 2007-2010 John Nunemaker, Bodo Tasche. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,21 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'lib/rockstar/version'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rockstar"
+    gem.summary = %Q{wrapper for audioscrobbler (last.fm) web services}
+    gem.description = %Q{This gem is an updated version of jnunemakers scrobbler gem.}
+    gem.email = "bodo@bitboxer.de"
+    gem.homepage = "http://github.com/bitboxer/rockstar"
+    gem.authors = ["Bodo Tasche"]
+    gem.add_dependency("hpricot", ">=0.4.86")
+    gem.add_dependency("activesupport", ">=1.4.2")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/examples/.gitignore

@@ -0,0 +1 @@
+lastfm.yml

data/examples/album.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+album = Rockstar::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+
+puts "Album: #{album.name}"
+puts "Artist: #{album.artist}"
+puts "URL: #{album.url}"
+puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+puts "Large cover: #{album.image_large}"
+puts
+puts
+puts "Summary: #{album.summary}"

data/examples/artist.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+artist = Rockstar::Artist.new('Madonna')
+
+puts 'Top Tracks'
+puts "=" * 10
+artist.top_tracks.each { |t| puts "#{t.name}" }
+
+puts
+
+puts 'Similar Artists'
+puts "=" * 15
+artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }

data/examples/lastfm.yml_example

@@ -0,0 +1,3 @@
+# Please enter your API-Keys. You can find them here : http://www.lastfm.de/api/account
+api_key: "API"
+api_secret: "KEY"

data/examples/scrobble.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+# This is the desktop app aproach to token auth. See Rockstar::TokenAuth for
+# details on how to get a token for a web app.
+
+a = Rockstar::Auth.new
+token = a.token
+
+puts
+puts "Please open http://www.last.fm/api/auth/?api_key=#{Rockstar.lastfm_api_key}&token=#{token}"
+puts
+puts "Press enter when done."
+
+gets
+
+session = a.session(token)
+
+auth = Rockstar::TokenAuth.new({:username => session.username, :token => session.key})
+auth.handshake!
+
+puts "Auth Status: #{auth.status}"
+puts "Session ID: #{auth.session_id}"
+puts "Now Playing URL: #{auth.now_playing_url}"
+puts "Submission URL: #{auth.submission_url}"
+
+scrobble = Rockstar::Scrobble.new(:session_id => auth.session_id,
+                                   :submission_url => auth.submission_url,
+                                   :artist => 'Coldplay',
+                                   :track => 'Viva La Vida',
+                                   :album => 'Viva La Vida',
+                                   :time => Time.new,
+                                   :length => 244,
+                                   :track_number => 7)
+scrobble.submit!
+puts "Rockstar Submission Status: #{scrobble.status}"
+
+# Love the Song :
+l_status = Rockstar::Track.new('Coldplay', 'Viva La Vida').love(session.key)
+
+puts "Love track status : #{l_status}"
+
+playing = Rockstar::Playing.new(:session_id => auth.session_id,
+                                 :now_playing_url => auth.now_playing_url,
+                                 :artist => 'Anberlin',
+                                 :track => 'A Day Late',
+                                 :album => 'Never Take Friendship Personal',
+                                 :length => 214,
+                                 :track_number => 5)
+                                 
+playing.submit!         
+puts "Playing Submission Status: #{playing.status}"      

data/examples/tag.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+tag = Rockstar::Tag.new('country')
+
+puts 'Top Tags '
+Rockstar::Tag.top_tags.each { |a| puts "(#{a.count}) #{a.name}" }
+
+puts
+
+puts 'Top Albums'
+tag.top_albums.each { |a| puts "(#{a.count}) #{a.name} by #{a.artist}" }
+
+puts
+
+puts 'Top Tracks'
+tag.top_tracks.each { |t| puts "(#{t.count}) #{t.name} by #{t.artist}" }

data/examples/track.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+require 'pp'
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+track = Rockstar::Track.new('Carrie Underwood', 'Before He Cheats')
+puts 'Fans'
+puts "=" * 4
+track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+
+track = Rockstar::Track.new('U2 & Green Day', 'The Saints Are Coming')
+pp track.tags

data/examples/user.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rockstar'))
+
+# Please enter your API-Keys into lastfm.yml first. 
+# You can find them here : http://www.lastfm.de/api/account
+Rockstar.lastfm = YAML.load_file(File.join(File.dirname(__FILE__), 'lastfm.yml'))
+
+user = Rockstar::User.new('jnunemaker')
+
+puts "#{user.username}'s Recent Tracks"
+puts "=" * (user.username.length + 16)
+user.recent_tracks.each { |t| puts t.name }
+
+puts
+puts
+
+puts "#{user.username}'s Top Tracks"
+puts "=" * (user.username.length + 13)
+user.top_tracks.each { |t| puts "(#{t.playcount}) #{t.name}" }

data/lib/rockstar.rb

@@ -0,0 +1,39 @@
+%w{cgi rubygems hpricot active_support}.each { |x| require x }
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'rockstar/base'
+require 'rockstar/version'
+
+require 'rockstar/album'
+require 'rockstar/artist'
+require 'rockstar/chart'
+require 'rockstar/user'
+require 'rockstar/tag'
+require 'rockstar/track'
+
+require 'rockstar/simpleauth'
+require 'rockstar/auth'
+require 'rockstar/session'
+require 'rockstar/tokenauth'
+require 'rockstar/scrobble'
+require 'rockstar/playing'
+
+require 'rockstar/rest'
+
+module Rockstar
+  extend self
+  
+  def lastfm=(args)
+    @api_key    = args["api_key"]
+    @api_secret = args["api_secret"]
+  end
+  
+  def lastfm_api_key
+    @api_key
+  end
+  
+  def lastfm_api_secret
+    @api_secret
+  end
+end