scrobbler-ng 2.0.0 → 2.0.1

data/lib/scrobbler/user.rb

@@ -1,98 +1,79 @@
-# 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
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 module Scrobbler  
-  class User < Base
+  class User < BaseXml
     # Load Helper modules
     include ImageObjectFuncs
-    extend  ImageClassFuncs
-    
-    attr_reader :username, :url, :weight, :match, :realname, :name
-    
-    class << self
-      def new_from_libxml(xml)
-        data = {}
-        xml.children.each do |child|
-          data[:name] = child.content if child.name == 'name'
-          data[:url] = child.content if child.name == 'url'
-          data[:weight] = child.content.to_i if child.name == 'weight'
-          data[:match] = child.content if child.name == 'match'
-          data[:realname] = child.content if child.name == 'realname'
-          maybe_image_node(data, child)
-        end
-        User.new(data[:name], data)
-      end
+    
+    attr_reader :url, :weight, :match, :realname, :name
+    
+    # Alias for User.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      User.new(:xml => xml)
+    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
+    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
     
-    def initialize(username, input={})
-      data = {:include_profile => false}.merge(input)
-      raise ArgumentError if username.empty?
-      @username = username
-      @name = @username
-      load_profile() if data[:include_profile]
-      populate_data(data)
+    # Load the data for this object out of a XML-Node
+    #
+    # @param [LibXML::XML::Node] node The XML node containing the information
+    # @return [nil]
+    def load_from_xml(node)
+      # Get all information from the root's children nodes
+      node.children.each do |child|
+        case child.name.to_s
+          when 'name'
+            @name = child.content
+          when 'url'
+            @url = child.content
+          when 'weight'
+            @weight = child.content.to_i
+          when 'match'
+            @match = child.content
+          when 'realname'
+            @realname = child.content
+          when 'image'
+            check_image_node(child)
+          when 'text'
+            # ignore, these are only blanks
+          when '#text'
+            # libxml-jruby version of blanks
+          else
+            raise NotImplementedError, "Field '#{child.name}' not known (#{child.content})"
+        end #^ case
+      end #^ do |child|
+    end
+    
+    def initialize(data={})
+      raise ArgumentError unless data.kind_of?(Hash)
+      super(data)
+      data = {:include_info => false}.merge(data)
+      # Load data given as method-parameter
+      load_info() if data.delete(:include_info)
+      populate_data(data)      
+      
+      raise ArgumentError, "Name is required" if @name.empty?
     end
     
     # Get a list of upcoming events that this user is attending. 
     #
     # Supports ical, ics or rss as its format  
-    def events(force=false)
-      get_response('user.getevents', :events, 'events', 'event', {'user'=>@username}, force)
+    def events
+      call('user.getevents', :events, :event, {:user => @name})
     end
 
     # Get a list of the user's friends on Last.fm.    
-    def friends(force=false, page=1, limit=50)
-      get_response('user.getfriends', :friends, 'friends', 'user', {'user'=>@username, 'page'=>page.to_s, 'limit'=>limit.to_s}, force)
+    def friends(page=1, limit=50)
+      call('user.getfriends', :friends, :user, {:user => @name, :page => page, :limit => limit})
     end
     
     # Get information about a user profile.
@@ -102,13 +83,13 @@ module Scrobbler
     end
     
     # Get the last 50 tracks loved by a user.
-    def loved_tracks(force=false)
-        get_response('user.getlovedtracks', :loved_tracks, 'lovedtracks', 'track', {'user'=>@username}, force)
+    def loved_tracks
+        call('user.getlovedtracks', :lovedtracks, :track, {:user => @name})
     end
 
     # Get a list of a user's neighbours on Last.fm.
-    def neighbours(force=false)
-      get_response('user.getneighbours', :neighbours, 'neighbours', 'user', {'user'=>@username}, force)
+    def neighbours
+      call('user.getneighbours', :neighbours, :user, {:user => @name})
     end
 
     # Get a paginated list of all events a user has attended in the past. 
@@ -118,9 +99,8 @@ module Scrobbler
     end
     
     # Get a list of a user's playlists on Last.fm. 
-    def playlists(force=false)
-                          #(api_method, instance_name, parent, element, parameters, force=false)
-      get_response('user.getplaylists', :playlist, 'playlists', 'playlist', {'user'=>@username}, force)
+    def playlists
+      call('user.getplaylists', :playlists, :playlist, {:user => @name})
     end
     
     # Get a list of the recent tracks listened to by this user. Indicates now 
@@ -128,9 +108,9 @@ module Scrobbler
     #
     # Possible parameters:
     #   - limit: An integer used to limit the number of tracks returned.
-    def recent_tracks(force=false, parameters={})
-      parameters.merge!({'user' => @username})
-      get_response('user.getrecenttracks', :recent_tracks, 'recenttracks', 'track', parameters, force)
+    def recent_tracks(parameters={})
+      parameters.merge!({:user => @name})
+      call('user.getrecenttracks', :recenttracks, :track, parameters)
     end
     
     # Get Last.fm artist recommendations for a user
@@ -154,45 +134,49 @@ module Scrobbler
     
     # Get the top albums listened to by a user. You can stipulate a time period. 
     # Sends the overall chart by default. 
-    def top_albums(force=false, period='overall')
-      get_response('user.gettopalbums', :top_albums, 'topalbums', 'album', {'user'=>@username, 'period'=>period}, force)
+    def top_albums(period=:overall)
+      call('user.gettopalbums', :topalbums, :album, {:user => @name, :period => period})
     end
 
     # Get the top artists listened to by a user. You can stipulate a time 
     # period. Sends the overall chart by default. 
-    def top_artists(force=false, period='overall')
-      get_response('user.gettopartists', :top_artists, 'topartists', 'artist', {'user' => @username, 'period'=>period}, force)
+    def top_artists(period=:overall)
+      call('user.gettopartists', :topartists, :artist, {:user => @name, :period => period})
     end
 
     #  Get the top tags used by this user.
-    def top_tags(force=false)
-      get_response('user.gettoptags', :top_tags, 'toptags', 'tag', {'user'=>@username}, force)
+    def top_tags
+      call('user.gettoptags', :toptags, :tag, {:user => @name})
     end
 
     # Get the top tracks listened to by a user. You can stipulate a time period. 
     # Sends the overall chart by default. 
-    def top_tracks(force=false, period='overall')
-      get_response('user.gettoptracks', :top_tracks, 'toptracks', 'track', {'user'=>@username, 'period'=>period}, force)
+    def top_tracks(period=:overall)
+      call('user.gettoptracks', :toptracks, :track, {:user => @name, :period => period})
+    end
+
+    # Setup the parameters for a *chart API call
+    def setup_chart_params(from=nil, to=nil)
+      parameters = {:user => @name}
+      parameters[:from] = from unless from.nil?
+      parameters[:to] = to unless to.nil?
+      parameters
     end
 
     # Get an album chart for a user profile, for a given date range. If no date 
     # range is supplied, it will return the most recent album chart for this 
     # user. 
     def weekly_album_chart(from=nil, to=nil)
-      parameters = {'user' => @username}
-      parameters['from'] = from unless from.nil?
-      parameters['to'] = to unless to.nil?
-      get_response('user.getweeklyalbumchart', nil, 'weeklyalbumchart', 'album', parameters, true)
+      parameters = setup_chart_params(from, to)
+      call('user.getweeklyalbumchart', :weeklyalbumchart, Album, parameters)
     end
     
     # Get an artist chart for a user profile, for a given date range. If no date
     # range is supplied, it will return the most recent artist chart for this 
     # user. 
     def weekly_artist_chart(from=nil, to=nil)
-      parameters = {'user' => @username}
-      parameters['from'] = from unless from.nil?
-      parameters['to'] = to unless to.nil?
-      get_response('user.getweeklyartistchart', nil, 'weeklyartistchart', 'artist', parameters, true)
+      parameters = setup_chart_params(from, to)
+      call('user.getweeklyartistchart', :weeklyartistchart, Artist, parameters)
     end
     
     # Get a list of available charts for this user, expressed as date ranges 
@@ -206,10 +190,8 @@ module Scrobbler
     # range is supplied, it will return the most recent track chart for this 
     # user. 
     def weekly_track_chart(from=nil, to=nil)
-      parameters = {'user' => @username}
-      parameters['from'] = from unless from.nil?
-      parameters['to'] = to unless to.nil?
-      get_response('user.getweeklytrackchart', nil, 'weeklytrackchart', 'track', parameters, true)
+      parameters = setup_chart_params(from, to)
+      call('user.getweeklytrackchart', :weeklytrackchart, Track, parameters)
     end
     
     # Shout on this user's shoutbox

data/lib/scrobbler.rb

@@ -1,11 +1,10 @@
 
 %w{uri rubygems libxml time}.each { |x| require x }
-require 'digest/md5'
 
 $: << File.expand_path(File.dirname(__FILE__))
 
 # Load base class
-require 'scrobbler/base'
+require File.expand_path('scrobbler/base.rb', File.dirname(__FILE__))
 
 # Load helper modules
 require 'scrobbler/helper/image'

data/tasks/jeweler.rake

@@ -7,12 +7,16 @@ begin
     s.homepage = "http://github.com/xhochy/scrobbler"
     s.description = "A ruby library for accessing the last.fm v2 webservices"
     s.authors = ['John Nunemaker', 'Jonathan Rudenberg', 'Uwe L. Korn']
-    if RUBY_PLATFORM =~ /\bjava\b/
-      s.add_dependency 'libxml-jruby'
-    else
-      s.add_dependency 'libxml-ruby'
-    end
+    s.add_development_dependency "rspec", ">= 1.2.9"
+    s.add_development_dependency "yard", ">= 0"
+    s.add_development_dependency "fakeweb", ">= 0"
+    #if RUBY_PLATFORM =~ /\bjava\b/
+    #  s.add_dependency 'libxml-jruby'
+    #else
+    #  s.add_dependency 'libxml-ruby'
+    #end
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/tasks/metric_fu.rake

@@ -0,0 +1,27 @@
+begin
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    # Deactivated: saikuro, stats, rcov
+    config.metrics  = [:churn, :flog, :flay, :reek, :roodi]
+    config.graphs   = [:flog, :flay, :reek, :roodi, :rcov]
+    config.flay     = { :dirs_to_flay => ['lib'],
+                        :minimum_score => 100  } 
+    config.flog     = { :dirs_to_flog => ['lib']  }
+    config.reek     = { :dirs_to_reek => ['lib']  }
+    config.roodi    = { :dirs_to_roodi => ['lib'] }
+    config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10}
+    config.rcov     = { :environment => 'test',
+                        :test_files => ['test/**/*_test.rb', 
+                                        'spec/**/*_spec.rb'],
+                        :rcov_opts => ["--sort coverage", 
+                                       "--no-html", 
+                                       "--text-coverage",
+                                       "--no-color",
+                                       "--profile",
+                                       "--rails",
+                                       "--exclude /gems/,/Library/,spec"]}
+    config.graph_engine = :bluff
+  end
+rescue LoadError
+  puts "metric_fu not available. Install it with: gem install metric_fu"
+end

data/tasks/reek.rake

@@ -0,0 +1,13 @@
+begin
+  require 'reek/rake/task'
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+

data/tasks/roodi.rake

@@ -0,0 +1,13 @@
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+

data/tasks/tests.rake

@@ -9,5 +9,13 @@ Spec::Rake::SpecTask.new('test:unit') do |t|
   end
   t.spec_opts << '--format' << 'html:spec.html'
   t.spec_opts << '--format' << 'progress'
+  t.spec_opts << '-b'
   t.spec_files = FileList['test/unit/*_spec.rb']
 end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'test/unit/*_spec.rb'
+  spec.rcov = true
+end
+

data/test/mocks/library.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+## ## library.getartists
+{
+  'api_key=foo123&user=xhochy' => 'artists-p1.xml',
+  'limit=30&api_key=foo123&user=xhochy' => 'artists-f30.xml'
+}.each do |url, file|
+  register_fw('method=library.getartists&' + url, 'library', file)
+end
+(2..7).each do |n|
+  register_fw('method=library.getartists&page=' + n.to_s +
+    '&api_key=foo123&user=xhochy', 'library', "artists-p#{n}.xml")
+end
+
+## ## library.gettracks
+{
+  'api_key=foo123&user=xhochy' => 'tracks-p1.xml',
+  'limit=30&api_key=foo123&user=xhochy' => 'tracks-f30.xml'
+}.each do |url, file|
+  register_fw('method=library.gettracks&' + url, 'library', file)
+end
+(2..34).each do |n|
+  register_fw("user=xhochy&page=#{n}&api_key=foo123&method=library.gettracks", 
+    'library', "tracks-p#{n}.xml")
+end
+
+## ## library.getalbums
+FakeWeb.register_uri(:get, WEB_BASE + 'limit=30&user=xhochy&api_key=foo123&method=library.getalbums', :body => File.join([FIXTURES_BASE, 'library', 'albums-f30.xml']))
+FakeWeb.register_uri(:get, WEB_BASE + 'user=xhochy&api_key=foo123&method=library.getalbums', :body => File.join([FIXTURES_BASE, 'library', 'albums-p1.xml']))
+(2..8).each do |n|
+  FakeWeb.register_uri(:get, WEB_BASE + 'method=library.getalbums&page=' + 
+    n.to_s + '&api_key=foo123&user=xhochy', 
+    :body => File.join([FIXTURES_BASE, 'library', 'albums-p' +
+    n.to_s + '.xml']))  
+end