scrobbler 0.1.0

data/History.txt

@@ -0,0 +1 @@
+* v 0.1.0: initial release

data/Manifest.txt

@@ -0,0 +1,58 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+setup.rb
+examples/album.rb
+examples/artist.rb
+examples/tag.rb
+examples/track.rb
+examples/user.rb
+lib/scrobbler.rb
+lib/scrobbler/album.rb
+lib/scrobbler/artist.rb
+lib/scrobbler/base.rb
+lib/scrobbler/chart.rb
+lib/scrobbler/rest.rb
+lib/scrobbler/tag.rb
+lib/scrobbler/track.rb
+lib/scrobbler/user.rb
+lib/scrobbler/version.rb
+test/test_helper.rb
+test/fixtures/xml/album/info.xml
+test/fixtures/xml/artist/fans.xml
+test/fixtures/xml/artist/similar.xml
+test/fixtures/xml/artist/topalbums.xml
+test/fixtures/xml/artist/toptags.xml
+test/fixtures/xml/artist/toptracks.xml
+test/fixtures/xml/tag/topalbums.xml
+test/fixtures/xml/tag/topartists.xml
+test/fixtures/xml/tag/toptags.xml
+test/fixtures/xml/tag/toptracks.xml
+test/fixtures/xml/track/fans.xml
+test/fixtures/xml/track/toptags.xml
+test/fixtures/xml/user/friends.xml
+test/fixtures/xml/user/neighbours.xml
+test/fixtures/xml/user/profile.xml
+test/fixtures/xml/user/recentbannedtracks.xml
+test/fixtures/xml/user/recentlovedtracks.xml
+test/fixtures/xml/user/recenttracks.xml
+test/fixtures/xml/user/systemrecs.xml
+test/fixtures/xml/user/topalbums.xml
+test/fixtures/xml/user/topartists.xml
+test/fixtures/xml/user/toptags.xml
+test/fixtures/xml/user/toptracks.xml
+test/fixtures/xml/user/weeklyalbumchart.xml
+test/fixtures/xml/user/weeklyalbumchart_from_1138536002_to_1139140802.xml
+test/fixtures/xml/user/weeklyartistchart.xml
+test/fixtures/xml/user/weeklyartistchart_from_1138536002_to_1139140802.xml
+test/fixtures/xml/user/weeklychartlist.xml
+test/fixtures/xml/user/weeklytrackchart.xml
+test/fixtures/xml/user/weeklytrackchart_from_1138536002_to_1139140802.xml
+test/mocks/rest.rb
+test/unit/album_test.rb
+test/unit/artist_test.rb
+test/unit/chart_test.rb
+test/unit/tag_test.rb
+test/unit/track_test.rb
+test/unit/user_test.rb

data/README.txt

@@ -0,0 +1,71 @@
+=Scrobbler
+
+Scrobbler is a wrapper for the audioscrobbler web services (http://www.audioscrobbler.net/data/webservices/). 
+
+Below is just a sampling of how easy this lib is to use.
+
+== 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}" }

data/Rakefile

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'scrobbler', 'version')
+
+AUTHOR = 'nunemaker'  # can also be an array of Authors
+EMAIL = "nunemaker@gmail.com"
+DESCRIPTION = "wrapper for audioscrobbler (last.fm) web services"
+GEM_NAME = 'scrobbler' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'scrobbler' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "scrobbler"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = Scrobbler::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'scrobbler documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [['hpricot', '>=0.4.86'], ['activesupport', '>=1.4.2']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end

data/examples/album.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require '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,14 @@
+require 'rubygems'
+require '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/tag.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require '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,7 @@
+require 'rubygems'
+require '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,15 @@
+require 'rubygems'
+require '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,13 @@
+%w{cgi rubygems hpricot active_support}.each { |x| require x }
+
+require 'scrobbler/base'
+
+require 'scrobbler/album'
+require 'scrobbler/artist'
+require 'scrobbler/chart'
+require 'scrobbler/user'
+require 'scrobbler/tag'
+require 'scrobbler/track'
+
+require 'scrobbler/rest'
+require 'scrobbler/version'

data/lib/scrobbler/album.rb

@@ -0,0 +1,143 @@
+# 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
+  class Album < Base
+    attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url, :reach, :release_date
+    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             = (xml).at(:name).inner_html                   if (xml).at(:name)
+        name             = xml['name']                                  if name.nil? && xml['name']
+        artist           = (xml).at(:artist)['name']                    if (xml).at(:artist) && (xml).at(:artist)['name']
+        artist           = (xml).at(:artist).inner_html                 if artist.nil? && (xml).at(:artist)
+        artist           = doc.root['artist']                           if artist.nil? && doc.root['artist']
+        a                = Album.new(artist, name)
+        a.artist_mbid    = (xml).at(:artist)['mbid']                    if (xml).at(:artist) && (xml).at(:artist)['mbid']
+        a.artist_mbid    = (xml).at(:artist).at(:mbid).inner_html       if a.artist_mbid.nil? && (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).at(:rank).inner_html                   if (xml).at(:rank)
+        a.url            = (xml/:url).last.inner_html                   if (xml/:url).size > 1
+        a.url            = (xml).at(:url).inner_html                    if a.url.nil? && (xml).at(:url)
+        a.reach          = (xml).at(:reach).inner_html                  if (xml).at(:reach)
+        a.image_large    = (xml).at(:image).at(:large).inner_html       if (xml).at(:image) && (xml).at(:image).at(:large)
+        a.image_medium   = (xml).at(:image).at(:medium).inner_html      if (xml).at(:image) && (xml).at(:image).at(:medium)
+        a.image_small    = (xml).at(:image).at(:small).inner_html       if (xml).at(:image) && (xml).at(:image).at(:small)
+        
+        # coverart element used on top albums for tag
+        a.image_large    = (xml).at(:coverart).at(:large).inner_html    if a.image_large.nil? && (xml).at(:coverart) && (xml).at(:coverart).at(:large)
+        a.image_medium   = (xml).at(:coverart).at(:medium).inner_html   if a.image_medium.nil? && (xml).at(:coverart) && (xml).at(:coverart).at(:medium)
+        a.image_small    = (xml).at(:coverart).at(:small).inner_html    if a.image_small.nil? && (xml).at(:coverart) && (xml).at(:coverart).at(:small)
+        
+        # needed on top albums for tag
+        a.count          = xml['count'] if xml['count']
+        a.streamable     = xml['streamable'] if xml['streamable']
+        a
+      end
+    end
+    
+    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
+    
+    def api_path
+      "/#{API_VERSION}/album/#{CGI::escape(artist)}/#{CGI::escape(name)}"
+    end
+    
+    def load_info
+      doc           = self.class.fetch_and_parse("#{api_path}/info.xml")
+      @reach        = (doc).at(:reach).inner_html
+      @url          = (doc).at(:url).inner_html
+      @release_date = Time.parse((doc).at(:releasedate).inner_html.strip)
+      @image_large  = (doc).at(:coverart).at(:large).inner_html
+      @image_medium = (doc).at(:coverart).at(:medium).inner_html
+      @image_small  = (doc).at(:coverart).at(:small).inner_html
+      @mbid         = (doc).at(:mbid).inner_html
+      @tracks       = (doc/:track).inject([]) do |tracks, track|
+        t             = Track.new(artist, track['title'])
+        t.artist_mbid = artist_mbid
+        t.album       = name
+        t.album_mbid  = mbid
+        t.url         = (track).at(:url).inner_html
+        t.reach       = (track).at(:reach).inner_html
+        tracks << t
+        tracks
+      end
+    end
+    
+    def tracks
+      load_info if @tracks.nil?
+      @tracks
+    end
+    
+    def image(which=:small)
+      which = which.to_s
+      raise ArgumentError unless ['small', 'medium', 'large'].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