scrobbler-ng 2.0.0 → 2.0.1

data/lib/scrobbler/library.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+
+require File.expand_path('base.rb', File.dirname(__FILE__))
+
 module Scrobbler
   # Class for invocation of library.* API functions.
   class Library < Base
@@ -9,13 +13,13 @@ module Scrobbler
     #   is requested.
     # @raise ArgumentError If a not supported type is given as user.
     def initialize(user)
-      case user.class
-        when user.class == Scrobbler::User
-          @user = user
-        when [String, Symbol].contains?(user.class)
-          @user = Scrobbler::User.new(user.to_s)
-        else
-          raise ArgumentError("Invalid argument for user.")
+      super()
+      if user.kind_of?(Scrobbler::User)
+        @user = user
+      elsif user.kind_of?(String)
+        @user = Scrobbler::User.new(:name => user.to_s)
+      else
+        raise ArgumentError, "Invalid argument for user: #{user.class}"
       end
     end
     
@@ -37,85 +41,55 @@ module Scrobbler
     # A list of all the albums in a user's library, with play counts and tag 
     # counts. 
     def albums(options={})
-        options = {:force => false, :all => true}.merge options
-        options[:user] = @user.name
-        albums = []
-        if options[:all]
-            doc = Base.request('library.getalbums', options)
-            root = nil
-            doc.root.children.each do |child|
-                next unless child.name == 'albums'
-                root = child
-            end
-            total_pages = root['totalPages'].to_i
-            root.children.each do |child|
-                next unless child.name == 'album'
-                albums << Scrobbler::Album.new_from_libxml(child)
-            end
-            for i in 2..total_pages do
-                options[:page] = i
-                albums.concat get_response('library.getalbums', :none, 'albums', 'album', options, true)
-            end
-        else
-            albums = get_response('library.getalbums', :get_albums, 'albums', 'album', options, true)
-        end
-        albums
+      request_library('library.getalbums', :albums, Album, options)
     end
 
     # A list of all the artists in a user's library, with play counts and tag
     # counts. 
+    #
+    # @param [Hash<Symbol>] options The options to configure this API call.
+    # @return [Array<Scrobbler::Artist>] The artists included in this library.
     def artists(options={})
-        options = {:force => false, :all => true}.merge options
-        options[:user] = @user.name
-        artists = []
-        if options[:all]
-            doc = Base.request('library.getartists', options)
-            root = nil
-            doc.root.children.each do |child|
-                next unless child.name == 'artists'
-                root = child
-            end
-            total_pages = root['totalPages'].to_i
-            root.children.each do |child|
-                next unless child.name == 'artist'
-                artists << Scrobbler::Artist.new_from_libxml(child)
-            end
-            for i in 2..total_pages do
-                options[:page] = i
-                artists.concat get_response('library.getartists', :none, 'artists', 'artist', options, true)
-            end
-        else
-            artists = get_response('library.getartists', :get_albums, 'artists', 'artist', options, true)
-        end
-        artists
+      request_library('library.getartists', :artists, Artist, options)
     end
     
     # A list of all the tracks in a user's library, with play counts and tag
     # counts. 
     def tracks(options={})
-        options = {:force => false, :all => true}.merge options
-        options[:user] = @user.name
-        tracks = []
-        if options[:all]
-            doc = Base.request('library.gettracks', options)
-            root = nil
-            doc.root.children.each do |child|
-                next unless child.name == 'tracks'
-                root = child
-            end
-            total_pages = root['totalPages'].to_i
-            root.children.each do |child|
-                next unless child.name == 'track'
-                tracks << Scrobbler::Track.new_from_libxml(child)
-            end
-            for i in 2..total_pages do
-                options[:page] = i
-                tracks.concat get_response('library.gettracks', :none, 'tracks', 'track', options, true)
-            end
-        else
-            tracks = get_response('library.gettracks', :get_albums, 'tracks', 'track', options, true)
+        request_library('library.gettracks', :tracks, Track, options)
+    end
+    
+    # Generic request method for the most Library funtions
+    #
+    # @param [String,Symbol] api_method The method which shall be called.
+    # @param [Hash] options The parameters passed as URL params.
+    # @param [String,Symbol] parent the parent XML node to look for.
+    # @param [Class] element The xml node name which shall be converted
+    #   into an object.
+    # @return [Array]
+    def request_library(method, parent, element, options={})
+      options = {:all => true, :user => @user.name}.merge options
+      result = []
+      if options.delete(:all)
+        doc = Base.request(method, options)
+        root = nil
+        doc.root.children.each do |child|
+          next unless child.name == parent.to_s
+          root = child
+        end
+        total_pages = root['totalPages'].to_i
+        root.children.each do |child|
+          next unless child.name == element.to_s.sub("Scrobbler::","").downcase
+          result << element.new_from_libxml(child)
         end
-        tracks
+        (2..total_pages).each do |i|
+          options[:page] = i
+          result.concat call(method, parent, element, options)
+        end
+      else
+        result = call(method, parent, element, options)
+      end
+      result
     end
     
   end

data/lib/scrobbler/playlist.rb

@@ -1,45 +1,87 @@
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 module Scrobbler
-  # @todo everything
-  class Playlist < Base
+  class Playlist < BaseXml
     # Load Helper modules
     include ImageObjectFuncs
-    extend  ImageClassFuncs
+    include Scrobbler::StreamableObjectFuncs
     
     attr_reader :url, :id, :title, :date, :creator
     attr_reader :description, :size, :duration, :streamable
-    class << self
-      def new_from_libxml(xml)
-        data = {}
-
-        xml.children.each do |child|
-          data[:id] = child.content.to_i if child.name == 'id'
-          data[:title] = child.content if child.name == 'title'
-
-          maybe_image_node(data, child)
-          data[:date] = Time.parse(child.content) if child.name == 'date'
+    
+    # Alias for Playlist.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      Playlist.new(:xml => xml)
+    end
 
-          data[:size] = child.content.to_i if child.name == 'size'
-          data[:description] = child.content if child.name == 'description'
-          data[:duration] = child.content.to_i if child.name == 'duration'
+    def self.create
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
 
-          if child.name == 'streamable'
-            if ['1', 'true'].include?(child.content)
-              data[:streamable] = true
-            else
-              data[:streamable] = false
-            end
-          end
-          data[:creator]        = child.content if child.name == 'creator'
-          data[:url]        = child.content if child.name == 'url'
-        end
-        Playlist.new(data[:url],data)
-      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, "Url is required" if @url.empty?
     end
-  
-    def initialize(url,data={})
-      @url = url
-      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 'id'
+            @id = child.content.to_i
+          when 'title'
+            @title = child.content
+          when 'image'
+            check_image_node(child)
+          when 'date'
+            @date = Time.parse(child.content)
+          when 'streamable'
+            check_streamable_node(child)
+          when 'size'
+            @size = child.content.to_i
+          when 'description'
+            @description = child.content
+          when 'duration'
+            @duration = child.content.to_i
+          when 'creator'
+            @creator = child.content
+          when 'url'
+            @url = child.content
+          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 add_track
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
     end
+
+    def fetch
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
   end
 end
 

data/lib/scrobbler/radio.rb

@@ -6,6 +6,17 @@ module Scrobbler
     def initialize(station)
       @station = station
     end
+
+    def tune
+        # This function require authentication, but SimpleAuth is not yet 2.0
+        raise NotImplementedError
+    end
+    
+    def playlist
+        # This function require authentication, but SimpleAuth is not yet 2.0
+        raise NotImplementedError
+    end
+    
     
   end
 end

data/lib/scrobbler/shout.rb

@@ -1,21 +1,47 @@
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 module Scrobbler
-  class Shout < Base
+  class Shout < BaseXml
     attr_reader :author, :date, :body
-    
-    class << self
-      def new_from_libxml(xml)
-        data={}
-        xml.children.each do |child|
-          data[:body] = child.content if child.name == 'body'
-          data[:author] = Scrobbler::User.new(child.content) if child.name == 'author'
-          data[:date] = Time.parse(child.content) if child.name == 'date'
-        end
-        Shout.new(data)
-      end
+
+    # Alias for Shout.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      Shout.new(:xml => xml)
     end
 
-    def initialize(input={})
-      populate_data(input)
+    def initialize(data={})
+      raise ArgumentError unless data.kind_of?(Hash)
+      super(data)
+      # Load data given as method-parameter
+      populate_data(data)
     end
+    
+    # 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
+          when 'body'
+            @body = child.content
+          when 'author' 
+            @author = Scrobbler::User.new(:name => child.content)
+          when 'date'
+            @date = Time.parse(child.content)
+          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 #^ load_from_xml
   end
 end

data/lib/scrobbler/tag.rb

@@ -99,15 +99,32 @@ module Scrobbler
       get_response('tag.gettoptracks', :top_tracks, 'toptracks', 'track', {'tag'=>@name}, force)
     end
 
-    def Tag.top_tags
-        self.get('tag.gettoptags', :toptags, :tag)
+    def self.top_tags
+        Base.get('tag.gettoptags', :toptags, :tag)
     end
     
+    def self.search
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    
     # Search for tags similar to this one. Returns tags ranked by similarity, 
     # based on listening data.
     def similar(force=false)
         params = {:tag => @name}
         get_response('tag.getsimilar', :similar, 'similartags', 'tag', params, force)
     end
+
+    def weekly_artist_chart
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def weekly_chart_list
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
   end
 end

data/lib/scrobbler/track.rb

@@ -1,78 +1,43 @@
-# 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
+# encoding: utf-8
+
 module Scrobbler
   class Track < Base
     # Load Helper modules
     include ImageObjectFuncs
     extend  ImageClassFuncs
     
-    attr_accessor :artist, :name, :mbid, :playcount, :rank, :url, :id, :count
-    attr_accessor :streamable, :album, :date, :now_playing, :tagcount
-    attr_accessor :duration, :listeners
+    attr_reader :artist, :name, :mbid, :playcount, :rank, :url, :id, :count
+    attr_reader :streamable, :album, :date, :now_playing, :tagcount
+    attr_reader :duration, :listeners
     
-    class << self
-      def new_from_libxml(xml)
-        data = {}
-        xml.children.each do |child|
-          data[:name] = child.content if child.name == 'name'
-          data[:mbid] = child.content if child.name == 'mbid'
-          data[:url] = child.content if child.name == 'url'
-          data[:date] = Time.parse(child.content) if child.name == 'date'
-          data[:artist] = Artist.new_from_libxml(child) if child.name == 'artist'
-          data[:album] = Album.new_from_libxml(child) if child.name == 'album'
-          data[:playcount] = child.content.to_i if child.name == 'playcount'
-          data[:tagcount] = child.content.to_i if child.name == 'tagcount'
-          maybe_image_node(data, child)
-          if child.name == 'streamable'
-            if ['1', 'true'].include?(child.content)
-              data[:streamable] = true
-            else
-              data[:streamable] = false
-            end
+    def self.new_from_libxml(xml)
+      data = {}
+      xml.children.each do |child|
+        data[:name] = child.content if child.name == 'name'
+        data[:mbid] = child.content if child.name == 'mbid'
+        data[:url] = child.content if child.name == 'url'
+        data[:date] = Time.parse(child.content) if child.name == 'date'
+        data[:artist] = Artist.new(:xml => child) if child.name == 'artist'
+        data[:album] = Album.new(:xml => child) if child.name == 'album'
+        data[:playcount] = child.content.to_i if child.name == 'playcount'
+        data[:tagcount] = child.content.to_i if child.name == 'tagcount'
+        maybe_image_node(data, child)
+        if child.name == 'streamable'
+          if ['1', 'true'].include?(child.content)
+            data[:streamable] = true
+          else
+            data[:streamable] = false
           end
         end
-        
-        
-        data[:rank] = xml['rank'].to_i if xml['rank']
-        data[:now_playing] = true if xml['nowplaying'] && xml['nowplaying'] == 'true'
-        
-        data[:now_playing] = false if data[:now_playing].nil?
-        
-        Track.new(data[:artist], data[:name], data)
       end
+      
+      
+      data[:rank] = xml['rank'].to_i if xml['rank']
+      data[:now_playing] = true if xml['nowplaying'] && xml['nowplaying'] == 'true'
+      
+      data[:now_playing] = false if data[:now_playing].nil?
+      
+      Track.new(data[:artist], data[:name], data)
     end
     
     def initialize(artist, name, data={})
@@ -121,13 +86,43 @@ module Scrobbler
     end
 
     def top_fans(force=false)
-      get_response('track.gettopfans', :fans, 'topfans', 'user', {:artist=>@artist.name, :track=>@name}, force)
+      call('track.gettopfans', :topfans, User, {:artist => @artist.name, :track => @name})
     end
     
     def top_tags(force=false)
-      get_response('track.gettoptags', :top_tags, 'toptags', 'tag', {:artist=>@artist.name.to_s, :track=>@name}, force)
+      call('track.gettoptags', :toptags, Tag, {:artist => @artist.name, :track => @name})
+    end
+    
+    def similar
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def tags
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def love
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
     end
     
+    def remove_tag
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def search
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def share
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
     def ==(otherTrack)
       if otherTrack.is_a?(Scrobbler::Track)
         return ((@name == otherTrack.name) && (@artist == otherTrack.artist))