xhochy-scrobbler 0.2.14

data/History.txt

@@ -0,0 +1,5 @@
+* v 0.2.13: Nearly all API calls are now done via version 2.0 of the API
+* v 0.2.10: Upgraded to using the 2.0 API for parts of the code and added in the ability to search
+* 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-2009 John Nunemaker, Kurt Schrader, Uwe L. Korn
+
+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,65 @@
+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

data/README.rdoc

@@ -0,0 +1,114 @@
+=Scrobbler
+
+Scrobbler is a wrapper for the audioscrobbler web services (http://www.audioscrobbler.net/data/webservices/). 
+
+Currently updating to use the 2.0 API. It is very much a work in progress.
+
+Below is just a sampling of how easy this lib is to use, full documentation of
+all functions is available at http://rdoc.info/projects/xhochy/scrobbler
+
+== Initialization
+
+    Scrobbler::Base.api_key = 'foo123'
+
+== Users
+
+	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}" }
+	
+== Albums
+	
+	album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+
+	puts "Album: #{album.name}"
+	puts "Artist: #{album.artist}"
+	puts "Reach: #{album.reach}"
+	puts "URL: #{album.url}"
+	puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+
+	puts
+	puts
+
+	puts "Tracks"
+	longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
+	puts "=" * longest_track_name
+	album.tracks.each { |t| puts t.name }
+	
+==Artists
+	
+	artist = Scrobbler::Artist.new('Carrie Underwood')
+
+	puts 'Top Tracks'
+	puts "=" * 10
+	artist.top_tracks.each { |t| puts "(#{t.reach}) #{t.name}" }
+
+	puts
+
+	puts 'Similar Artists'
+	puts "=" * 15
+	artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }
+	
+==Tags	
+	
+	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}" }
+	
+==Tracks
+	
+	track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+	puts 'Fans'
+	puts "=" * 4
+	track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+	
+== Simple Authentication (for Scrobbling)
+
+    auth = Scrobbler::SimpleAuth.new(:user => 'chunky', :password => 'bacon')
+    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}"
+
+== Scrobbling
+
+    scrobble = Scrobbler::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 "Scrobbler Submission Status: #{scrobble.status}"
+
+== Now Playing Submission
+
+    playing = Scrobbler::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}"

data/Rakefile

@@ -0,0 +1,36 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'lib/scrobbler/version'
+
+WEBSITE_PATH = 'jnunemaker@rubyforge.org:/var/www/gforge-projects/scrobbler'
+
+Echoe.new('scrobbler', Scrobbler::Version) do |p|
+  p.description     = "wrapper for audioscrobbler (last.fm) web services"
+  p.url             = "http://scrobbler.rubyforge.org"
+  p.author          = ['John Nunemaker', 'Jonathan Rudenberg', 'Uwe L. Korn']
+  p.email           = "nunemaker@gmail.com"
+  p.extra_deps      = [['hpricot', '>=0.4.86'], ['activesupport', '>=1.4.2'], ['htmlentities', '>=4.0.0']]
+  p.need_tar_gz     = false
+  p.docs_host       = WEBSITE_PATH
+  p.ignore_pattern  = /website/
+end
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ #{WEBSITE_PATH}}
+  Rake::Task['website_docs'].invoke
+end
+
+task :website_docs do
+  Rake::Task['redocs'].invoke
+  sh %{rsync -av doc/ #{WEBSITE_PATH}/docs}
+end
+
+desc 'Preps the gem for a new release'
+task :prepare do
+  %w[manifest build_gemspec].each do |task|
+    Rake::Task[task].invoke
+  end
+end

data/examples/album.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+
+puts "Album: #{album.name}"
+puts "Artist: #{album.artist}"
+puts "Reach: #{album.reach}"
+puts "URL: #{album.url}"
+puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+
+puts
+puts
+
+puts "Tracks"
+longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
+puts "=" * longest_track_name
+album.tracks.each { |t| puts t.name }

data/examples/artist.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+artist = Scrobbler::Artist.new('Carrie Underwood')
+
+puts 'Top Tracks'
+puts "=" * 10
+artist.top_tracks.each { |t| puts "(#{t.reach}) #{t.name}" }
+
+puts
+
+puts 'Similar Artists'
+puts "=" * 15
+artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }

data/examples/scrobble.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+auth = Scrobbler::SimpleAuth.new(:user => 'chunky', :password => 'bacon')
+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 = Scrobbler::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 "Scrobbler Submission Status: #{scrobble.status}"
+
+playing = Scrobbler::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,11 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+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}" }

data/examples/track.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+puts 'Fans'
+puts "=" * 4
+track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }

data/examples/user.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+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}" }

data/lib/scrobbler.rb

@@ -0,0 +1,22 @@
+%w{cgi rubygems hpricot active_support}.each { |x| require x }
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'scrobbler/base'
+require 'scrobbler/version'
+
+
+require 'scrobbler/album'
+require 'scrobbler/artist'
+require 'scrobbler/chart'
+require 'scrobbler/user'
+require 'scrobbler/tag'
+require 'scrobbler/track'
+
+require 'scrobbler/simpleauth'
+require 'scrobbler/scrobble'
+require 'scrobbler/playing'
+
+require 'scrobbler/rest'
+
+require 'scrobbler/search'

data/lib/scrobbler/album.rb

@@ -0,0 +1,140 @@
+# Getting information about an album such as release date and the tracks on it is very easy.
+# 
+#   album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+# 
+#   puts "Album: #{album.name}"
+#   puts "Artist: #{album.artist}"
+#   puts "Reach: #{album.reach}"
+#   puts "URL: #{album.url}"
+#   puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+# 
+#   puts
+#   puts
+# 
+#   puts "Tracks"
+#   longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
+#   puts "=" * longest_track_name
+#   album.tracks.each { |t| puts t.name }
+#
+# Would output:
+#
+#   Album: Some Hearts
+#   Artist: Carrie Underwood
+#   Reach: 18729
+#   URL: http://www.last.fm/music/Carrie+Underwood/Some+Hearts
+#   Release Date: 11/15/2005
+# 
+# 
+#   Tracks
+#   ===============================
+#   Wasted
+#   Don't Forget to Remember Me
+#   Some Hearts
+#   Jesus, Take the Wheel
+#   The Night Before (Life Goes On)
+#   Lessons Learned
+#   Before He Cheats
+#   Starts With Goodbye
+#   I Just Can't Live a Lie
+#   We're Young and Beautiful
+#   That's Where It Is
+#   Whenever You Remember
+#   I Ain't in Checotah Anymore
+#   Inside Your Heaven
+#
+module Scrobbler
+  # @todo Add missing functions that require authentication
+  # @todo Integrate search functionality into this class which is already implemented in Scrobbler::Search
+  class Album < Base
+    attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url
+    attr_accessor :reach, :release_date, :listeners, :playcount, :top_tags
+    attr_accessor :image_large, :image_medium, :image_small
+    attr_writer :tracks
+    
+    # needed on top albums for tag
+    attr_accessor :count, :streamable
+    
+    # needed for weekly album charts
+    attr_accessor :chartposition
+    
+    class << self
+      def find(artist, name, o={})
+        new(artist, name, o)
+      end
+      
+      def new_from_xml(xml, doc=nil)
+        name = Base::sanitize(xml.at(:name).inner_html) if xml.at(:name)
+        name = Base::sanitize(xml['name'])              if name.nil? && xml['name']
+        artist = Base::sanitize(xml.at('/artist/name').inner_html) if xml.at('/artist/name')
+        a = Album.new(artist, name)
+        a.artist_mbid = xml.at(:artist).at(:mbid).inner_html if xml.at(:artist) && xml.at(:artist).at(:mbid)
+        a.mbid          = xml.at(:mbid).inner_html           if xml.at(:mbid)
+        a.playcount     = xml.at(:playcount).inner_html      if xml.at(:playcount)
+        a.chartposition = xml.at(:chartposition).inner_html  if xml.at(:chartposition)
+        a.rank          = xml['rank']                        if xml['rank']
+        a.url           = xml.at('/url').inner_html          if xml.at('/url')
+        a.image_large   = xml.at("/image[@size='large']").inner_html  if xml.at("/image[@size='large']")
+        a.image_medium  = xml.at("/image[@size='medium']").inner_html if xml.at("/image[@size='medium']")
+        a.image_small   = xml.at("/image[@size='small']").inner_html  if xml.at("/image[@size='small']")
+                
+        # needed on top albums for tag
+        a.count          = xml['count'] if xml['count']
+        a.streamable     = xml['streamable'] if xml['streamable']
+        a
+      end
+    end
+    
+    # If the additional parameter :include_info is set to true, additional 
+    # information is loaded
+    #
+    # @todo Albums should be able to be created via a MusicBrainz id too
+    def initialize(artist, name, o={})
+      raise ArgumentError, "Artist is required" if artist.blank?
+      raise ArgumentError, "Name is required" if name.blank?
+      @artist = artist
+      @name   = name
+      options = {:include_info => false}.merge(o)
+      load_info() if options[:include_info]
+    end
+    
+    @info_loaded = false # Indicates if the info was already loaded
+    
+    # Load additional information about this album
+    #
+    # Calls "album.getinfo" REST method
+    #
+    # @todo Parse wiki content
+    # @todo Add language code for wiki translation
+    def load_info
+      xml = request('album.getinfo', {'artist' => @artist, 'name' => @name})
+      unless xml.at(:lfm)['status'] == 'failed' || @info_loaded
+        xml = xml.at(:album)
+        @url          = xml.at(:url).inner_html
+        @release_date = Time.parse(xml.at(:releasedate).inner_html.strip)
+        @image_extralarge = xml.at("/image[@size='extralarge']").inner_html
+        @image_large  = xml.at("/image[@size='large']").inner_html
+        @image_medium = xml.at("/image[@size='medium']").inner_html
+        @image_small  = xml.at("/image[@size='small']").inner_html
+        @mbid         = xml.at(:mbid).inner_html
+        @listeners    = xml.at(:listeners).inner_html.to_i
+        @playcount    = xml.at(:playcount).inner_html.to_i
+        @info_loaded  = true
+        @top_tags = []
+        xml.at(:toptags).search(:tag).each do |elem|
+            @top_tags << Tag.new_from_xml(elem)
+        end
+      end
+    end
+    
+    def image(which=:small)
+      which = which.to_s
+      raise ArgumentError unless ['small', 'medium', 'large', 'extralarge'].include?(which)      
+      img_url = instance_variable_get("@image_#{which}")
+      if img_url.nil?
+        load_info
+        img_url = instance_variable_get("@image_#{which}")
+      end
+      img_url
+    end
+  end
+end