xhochy-scrobbler 0.2.14

data/lib/scrobbler/simpleauth.rb

@@ -0,0 +1,59 @@
+require 'digest/md5'
+
+# exception definitions
+class BadAuthError < StandardError; end
+class BannedError < StandardError; end
+class BadTimeError < StandardError; end
+module Scrobbler
+  AUTH_URL = 'http://post.audioscrobbler.com'
+  AUTH_VER = '1.2.1'
+  
+  class SimpleAuth
+    # you should read last.fm/api/submissions#handshake
+
+    attr_accessor :user, :password, :client_id, :client_ver
+    attr_reader :status, :session_id, :now_playing_url, :submission_url
+
+    def initialize(args = {})
+      @user = args[:user] # last.fm username
+      @password = args[:password] # last.fm password
+      @client_id = 'rbs' # Client ID assigned by last.fm; Don't change this!
+      @client_ver = Scrobbler::Version
+
+      raise ArgumentError, 'Missing required argument' if @user.blank? || @password.blank?
+
+      @connection = REST::Connection.new(AUTH_URL)
+    end
+
+    def handshake!
+      password_hash = Digest::MD5.hexdigest(@password)
+      timestamp = Time.now.to_i.to_s
+      token = Digest::MD5.hexdigest(password_hash + timestamp)
+
+      query = { :hs => 'true',
+                :p => AUTH_VER,
+                :c => @client_id,
+                :v => @client_ver,
+                :u => @user,
+                :t => timestamp,
+                :a => token }
+      result = @connection.get('/', query)
+
+      @status = result.split(/\n/)[0]
+      case @status
+      when /OK/
+        @session_id, @now_playing_url, @submission_url = result.split(/\n/)[1,3]
+      when /BANNED/
+        raise BannedError # something is wrong with the gem, check for an update
+      when /BADAUTH/
+        raise BadAuthError # invalid user/password
+      when /FAILED/
+        raise RequestFailedError, @status
+      when /BADTIME/
+        raise BadTimeError # system time is way off
+      else
+        raise RequestFailedError
+      end  
+    end
+  end
+end

data/lib/scrobbler/tag.rb

@@ -0,0 +1,93 @@
+# Below is code samples for how to find the top albums and tracks for a tag.
+# 
+#   tag = Scrobbler::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}" }
+#   
+# Which would output something similar to:
+# 
+#   Top Albums
+#   (29) American IV: The Man Comes Around by Johnny Cash
+#   (14) Folks Pop In at the Waterhouse by Various Artists
+#   (13) Hapless by Flowers From The Man Who Shot Your Cousin
+#   (9) Taking The Long Way by Dixie Chicks
+#   (8) Unchained by Johnny Cash
+#   (8) American III: Solitary Man by Johnny Cash
+#   (8) Wide Open Spaces by Dixie Chicks
+#   (7) It's Now or Later by Tangled Star
+#   (7) Greatest Hits by Hank Williams
+#   (7) American Recordings by Johnny Cash
+#   (6) Forgotten Landscape by theNoLifeKing
+#   (6) At Folsom Prison by Johnny Cash
+#   (6) Fox Confessor Brings the Flood by Neko Case
+#   (6) Murder by Johnny Cash
+#   (5) Gloom by theNoLifeKing
+#   (5) Set This Circus Down by Tim McGraw
+#   (5) Blacklisted by Neko Case
+#   (5) Breathe by Faith Hill
+#   (5) Unearthed (disc 4: My Mother's Hymn Book) by Johnny Cash
+#   (4) Home by Dixie Chicks
+# 
+#   Top Tracks
+#   (221) Hurt by Johnny Cash
+#   (152) I Walk the Line by Johnny Cash
+#   (147) Ring of Fire by Johnny Cash
+#   (125) Folsom Prison Blues by Johnny Cash
+#   (77) The Man Comes Around by Johnny Cash
+#   (67) Personal Jesus by Johnny Cash
+#   (65) Not Ready To Make Nice by Dixie Chicks
+#   (63) Before He Cheats by Carrie Underwood
+#   (62) Give My Love to Rose by Johnny Cash
+#   (49) Jackson by Johnny Cash
+#   (49) What Hurts The Most by Rascal Flatts
+#   (48) Big River by Johnny Cash
+#   (46) Man in Black by Johnny Cash
+#   (46) Jolene by Dolly Parton
+#   (46) Friends in Low Places by Garth Brooks
+#   (46) One by Johnny Cash
+#   (44) Cocaine Blues by Johnny Cash
+#   (41) Get Rhythm by Johnny Cash
+#   (41) I Still Miss Someone by Johnny Cash
+#   (40) The Devil Went Down to Georgia by Charlie Daniels Band
+module Scrobbler
+  class Tag < Base
+    attr_accessor :name, :count, :url
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        name    = xml.at(:name).inner_html
+        t       = Tag.new(name)
+        t.count = xml.at(:count).inner_html if xml.at(:count)
+        t.url   = xml.at(:url).inner_html
+        t
+      end
+    end
+    
+    def initialize(name)
+      raise ArgumentError, "Name is required" if name.blank?
+      @name = name
+    end
+    
+    def api_path
+      "/#{API_VERSION}/tag/#{CGI::escape(name)}"
+    end
+    
+    def top_artists(force=false)
+      get_instance2('tag.gettopartists', :top_artists, :artist, {'tag'=>@name}, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance2('tag.gettopalbums', :top_albums, :album, {'tag'=>@name}, force)
+    end
+
+    def top_tracks(force=false)
+      get_instance2('tag.gettoptracks', :top_tracks, :track, {'tag'=>@name}, force)
+    end
+  end
+end

data/lib/scrobbler/track.rb

@@ -0,0 +1,89 @@
+# Below is an example of how to get the top fans for a track.
+# 
+#   track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+#   puts 'Fans'
+#   puts "=" * 4
+#   track.fans.each { |u| puts u.username }
+#   
+# Which would output something like:
+# 
+#   track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+#   puts 'Fans'
+#   puts "=" * 4
+#   track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+# 
+#   Fans
+#   ====
+#   (69163) PimpinRose
+#   (7225) selene204
+#   (7000) CelestiaLegends
+#   (6817) muehllr
+#   (5387) Mudley
+#   (5368) ilovejohnny1984
+#   (5232) MeganIAD
+#   (5132) Veric
+#   (5097) aeVnar
+#   (3390) kristaaan
+#   (3239) kelseaowns
+#   (2780) syndication
+#   (2735) mkumm
+#   (2706) Kimmybeebee
+#   (2648) skorpcroze
+#   (2549) mistergreg
+#   (2449) mlmjcace
+#   (2302) tiNEey
+#   (2169) ajsbabiegirl
+module Scrobbler
+  class Track < Base
+    attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url, :reach
+    attr_accessor :streamable, :album, :album_mbid, :date, :date_uts, :now_playing
+    
+    # only seems to be used on top tracks for tag
+    attr_accessor :count, :thumbnail, :image
+    
+    # for weekly top tracks
+    attr_accessor :chartposition
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        artist          = xml.at('/artist/name').inner_html if xml.at('/artist/name')
+        artist          = xml.at(:artist).inner_html        if artist.nil? && xml.at(:artist)
+        name            = xml.at(:name).inner_html          if xml.at(:name)
+        t               = Track.new(artist, name)
+        t.artist_mbid   = xml.at(:artist)['mbid']           if xml.at(:artist) && xml.at(:artist)['mbid']
+        t.artist_mbid   = xml.at('/artist/mbid').inner_html if t.artist_mbid.nil? && xml.at('/artist/mbid')
+        t.mbid          = xml.at(:mbid).inner_html          if xml.at(:mbid)
+        t.playcount     = xml.at(:playcount).inner_html     if xml.at(:playcount)
+        t.chartposition = xml.at(:chartposition).inner_html if xml.at(:chartposition)
+        t.rank          = xml['rank'] if xml['rank']
+        t.url           = xml.at('/url').inner_html         if xml.at('/url')
+        t.streamable    = xml.at('/streamable').inner_html  if xml.at('/streamable')
+        t.count         = xml.at('/tagcount').inner_html    if xml.at('/tagcount')
+        t.album         = xml.at(:album).inner_html         if xml.at(:album)
+        t.album_mbid    = xml.at(:album)['mbid']            if xml.at(:album) && xml.at(:album)['mbid']
+        t.date          = Time.parse((xml).at(:date).inner_html)  if xml.at(:date)
+        t.date_uts      = xml.at(:date)['uts']              if xml.at(:date) && xml.at(:date)['uts']
+        t.thumbnail = xml.at('/image[@size="small"]').inner_html if xml.at('/image[@size="small"]')
+        t.image = xml.at('/image[@size="medium"]').inner_html   if xml.at('/image[@size="medium"]')
+        t.now_playing = true if xml['nowplaying'] && xml['nowplaying'] == 'true'
+        t.now_playing = false unless t.now_playing
+        t
+      end
+    end
+    
+    def initialize(artist, name)
+      raise ArgumentError, "Artist is required" if artist.blank?
+      raise ArgumentError, "Name is required" if name.blank?
+      @artist = artist
+      @name = name
+    end
+    
+    def fans(force=false)
+      get_instance2('track.gettopfans', :fans, :user, {'artist'=>@artist, 'track'=>@name}, force)
+    end
+    
+    def tags(force=false)
+      get_instance2('track.gettoptags', :tags, :tag, {'artist'=>@artist, 'track'=>@name}, force)
+    end
+  end
+end

data/lib/scrobbler/user.rb

@@ -0,0 +1,173 @@
+# Probably the most common use of this lib would be to get your most recent tracks or your top tracks. Below are some code samples.
+#   user = Scrobbler::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}" }
+#   
+# Which would output something like:
+#
+#   jnunemaker's Recent Tracks
+#   ==========================
+#   Everything You Want
+#   You're a God
+#   Bitter Sweet Symphony [Original Version]
+#   Lord I Guess I'll Never Know
+#   Country Song
+#   Bitter Sweet Symphony (Radio Edit)
+# 
+# 
+#   jnunemaker's Top Tracks
+#   =======================
+#   (62) Probably Wouldn't Be This Way
+#   (55) Not Ready To Make Nice
+#   (45) Easy Silence
+#   (43) Song 2
+#   (40) Everybody Knows
+#   (39) Before He Cheats
+#   (39) Something's Gotta Give
+#   (38) Hips Don't Lie (featuring Wyclef Jean)
+#   (37) Unwritten
+#   (37) Move Along
+#   (37) Dance, Dance
+#   (36) We Belong Together
+#   (36) Jesus, Take the Wheel
+#   (36) Black Horse and the Cherry Tree (radio version)
+#   (35) Photograph
+#   (35) You're Beautiful
+#   (35) Walk Away
+#   (34) Stickwitu
+module Scrobbler  
+  class User < Base
+    # attributes needed to initialize
+    attr_reader :username
+    
+    # profile attributes
+    attr_accessor :id, :cluster, :url, :realname, :mbox_sha1sum, :registered
+    attr_accessor :registered_unixtime, :age, :gender, :country, :playcount, :avatar
+    
+    # neighbor attributes
+    attr_accessor :match
+    
+    # track fans attributes
+    attr_accessor :weight
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        u        = User.new(xml.at(:name).inner_html)
+        u.url    = (xml).at(:url).inner_html    if (xml).at(:url)
+        u.avatar = (xml).at(:image).inner_html  if (xml).at(:image)
+        u.weight = (xml).at(:weight).inner_html if (xml).at(:weight)
+        u.match  = (xml).at(:match).inner_html  if (xml).at(:match)
+        u
+      end
+      
+      def find(*args)
+        options = {:include_profile => false}
+        options.merge!(args.pop) if args.last.is_a?(Hash)
+        users = args.flatten.inject([]) { |users, u| users << User.new(u, options); users }
+        users.length == 1 ? users.pop : users
+      end
+    end
+    
+    def initialize(username, o={})
+      options = {:include_profile => false}.merge(o)
+      raise ArgumentError if username.blank?
+      @username = username
+      load_profile() if options[:include_profile]
+    end
+    
+    def api_path
+      "/#{API_VERSION}/user/#{CGI::escape(username)}"
+    end
+    
+    def current_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/events.#{format}"
+    end
+    
+    def friends_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/friendevents.#{format}"
+    end
+    
+    def recommended_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/eventsysrecs.#{format}"
+    end
+    
+    def load_profile
+      doc                  = self.class.fetch_and_parse("#{api_path}/profile.xml")
+      @id                  = (doc).at(:profile)['id']
+      @cluster             = (doc).at(:profile)['cluster']
+      @url                 = (doc).at(:url).inner_html
+      @realname            = (doc).at(:realname).inner_html
+      @mbox_sha1sum        = (doc).at(:mbox_sha1sum).inner_html
+      @registered          = (doc).at(:registered).inner_html
+      @registered_unixtime = (doc).at(:registered)['unixtime']
+      @age                 = (doc).at(:age).inner_html
+      @gender              = (doc).at(:gender).inner_html
+      @country             = (doc).at(:country).inner_html
+      @playcount           = (doc).at(:playcount).inner_html
+      @avatar              = (doc).at(:avatar).inner_html
+    end
+    
+    def top_artists(force=false, period='overall')
+      get_instance2('user.gettopartists', :top_artists, :artist, {'user'=>@username, 'period'=>period}, force)
+    end
+    
+    def top_albums(force=false, period='overall')
+      get_instance2('user.gettopalbums', :top_albums, :album, {'user'=>@username, 'period'=>period}, force)
+    end
+    
+    def top_tracks(force=false, period='overall')
+      get_instance2('user.gettoptracks', :top_tracks, :track, {'user'=>@username, 'period'=>period}, force)
+    end
+    
+    def top_tags(force=false)
+      get_instance2('user.gettoptags', :top_tags, :tag, {'user'=>@username}, force)
+    end
+    
+    def friends(force=false, page=1, limit=50)
+      get_instance2('user.getfriends', :friends, :user, {'user'=>@username, 'page'=>page.to_s, 'limit'=>limit.to_s}, force)
+    end
+    
+    def neighbours(force=false)
+      get_instance2('user.getneighbours', :neighbours, :user, {'user'=>@username}, force)
+    end
+    
+    def recent_tracks(force=false)
+      get_instance2('user.getrecenttracks', :recent_tracks, :track, {'user'=>@username}, force)
+    end
+    
+    def recent_banned_tracks(force=false)
+      #warn "#{file}:#{lineno}:Warning: Scrobbler::User#recent_banned_tracks is deprecated (not supported by the Last.fm 2.0 API)"
+      get_instance(:recentbannedtracks, :recent_banned_tracks, :track, force)
+    end
+    
+    def recent_loved_tracks(force=false)
+      #warn "#{file}:#{lineno}:Warning: Scrobbler::User#recent_loved_tracks is deprecated (not supported by the Last.fm 2.0 API)"
+      get_instance(:recentlovedtracks, :recent_loved_tracks, :track, force)
+    end
+    
+    def recommendations(force=false)
+      #warn "#{file}:#{lineno}:Warning: Scrobbler::User#recommendations is deprecated (not supported by the Last.fm 2.0 API)"
+      get_instance(:systemrecs, :recommendations, :artist, force)
+    end
+    
+    def charts(force=false)
+      get_instance2('user.getweeklychartlist', :charts, :chart, {'user'=>@username}, force)
+    end
+    
+  end
+end

data/lib/scrobbler/version.rb

@@ -0,0 +1,3 @@
+module Scrobbler
+  Version = '0.2.14'
+end

data/scrobbler.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scrobbler}
+  s.version = "0.2.14"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker, Jonathan Rudenberg, Uwe L. Korn"]
+  s.date = %q{2009-05-02}
+  s.description = %q{wrapper for audioscrobbler (last.fm) web services}
+  s.email = %q{nunemaker@gmail.com}
+  s.extra_rdoc_files = ["lib/scrobbler/search.rb", "lib/scrobbler/rest.rb", "lib/scrobbler/track.rb", "lib/scrobbler/simpleauth.rb", "lib/scrobbler/base.rb", "lib/scrobbler/version.rb", "lib/scrobbler/chart.rb", "lib/scrobbler/playing.rb", "lib/scrobbler/artist.rb", "lib/scrobbler/scrobble.rb", "lib/scrobbler/user.rb", "lib/scrobbler/album.rb", "lib/scrobbler/tag.rb", "lib/scrobbler.rb", "README.rdoc"]
+  s.files = ["lib/scrobbler/search.rb", "lib/scrobbler/rest.rb", "lib/scrobbler/track.rb", "lib/scrobbler/simpleauth.rb", "lib/scrobbler/base.rb", "lib/scrobbler/version.rb", "lib/scrobbler/chart.rb", "lib/scrobbler/playing.rb", "lib/scrobbler/artist.rb", "lib/scrobbler/scrobble.rb", "lib/scrobbler/user.rb", "lib/scrobbler/album.rb", "lib/scrobbler/tag.rb", "lib/scrobbler.rb", "scrobbler.gemspec", "MIT-LICENSE", "Rakefile", "History.txt", "setup.rb", "README.rdoc", "examples/track.rb", "examples/artist.rb", "examples/scrobble.rb", "examples/user.rb", "examples/album.rb", "examples/tag.rb", "test/unit/album_test.rb", "test/unit/playing_test.rb", "test/unit/scrobble_test.rb", "test/unit/artist_test.rb", "test/unit/chart_test.rb", "test/unit/track_test.rb", "test/unit/tag_test.rb", "test/unit/search_test.rb", "test/unit/simpleauth_test.rb", "test/unit/user_test.rb", "test/test_helper.rb", "test/mocks/rest.rb", "test/fixtures/xml/album/info.xml", "test/fixtures/xml/track/toptags.xml", "test/fixtures/xml/track/fans.xml", "test/fixtures/xml/artist/toptags.xml", "test/fixtures/xml/artist/similar.xml", "test/fixtures/xml/artist/topalbums.xml", "test/fixtures/xml/artist/toptracks.xml", "test/fixtures/xml/artist/fans.xml", "test/fixtures/xml/tag/toptags.xml", "test/fixtures/xml/tag/topalbums.xml", "test/fixtures/xml/tag/toptracks.xml", "test/fixtures/xml/tag/topartists.xml", "test/fixtures/xml/search/track.xml", "test/fixtures/xml/search/artist.xml", "test/fixtures/xml/search/album.xml", "test/fixtures/xml/user/toptags.xml", "test/fixtures/xml/user/recentbannedtracks.xml", "test/fixtures/xml/user/topalbums.xml", "test/fixtures/xml/user/toptracks.xml", "test/fixtures/xml/user/recentlovedtracks.xml", "test/fixtures/xml/user/recenttracks.xml", "test/fixtures/xml/user/friends.xml", "test/fixtures/xml/user/profile.xml", "test/fixtures/xml/user/topartists.xml", "test/fixtures/xml/user/systemrecs.xml", "test/fixtures/xml/user/neighbours.xml", "Manifest"]
+  s.has_rdoc = true
+  s.homepage = %q{http://scrobbler.rubyforge.org}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Scrobbler", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{scrobbler}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{wrapper for audioscrobbler (last.fm) web services}
+  s.test_files = ["test/unit/album_test.rb", "test/unit/playing_test.rb", "test/unit/scrobble_test.rb", "test/unit/artist_test.rb", "test/unit/chart_test.rb", "test/unit/track_test.rb", "test/unit/tag_test.rb", "test/unit/search_test.rb", "test/unit/simpleauth_test.rb", "test/unit/user_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0.4.86"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 1.4.2"])
+      s.add_runtime_dependency(%q<htmlentities>, [">= 4.0.0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0.4.86"])
+      s.add_dependency(%q<activesupport>, [">= 1.4.2"])
+      s.add_dependency(%q<htmlentities>, [">= 4.0.0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0.4.86"])
+    s.add_dependency(%q<activesupport>, [">= 1.4.2"])
+    s.add_dependency(%q<htmlentities>, [">= 4.0.0"])
+  end
+end