scrobbler-ng 2.0.1 → 2.0.2

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 0
-:patch: 1
 :major: 2
+:minor: 0
+:patch: 2
 :build: 

data/lib/scrobbler.rb

@@ -1,5 +1,8 @@
+# encoding: utf-8
 
-%w{uri rubygems libxml time}.each { |x| require x }
+require 'rubygems'
+require 'uri'
+require 'time'
 
 $: << File.expand_path(File.dirname(__FILE__))
 
@@ -27,7 +30,6 @@ require 'scrobbler/playlist'
 require 'scrobbler/radio'
 
 require 'scrobbler/simpleauth'
-require 'scrobbler/scrobble'
 require 'scrobbler/playing'
 
 require 'scrobbler/rest'

data/lib/scrobbler/album.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
-require File.expand_path('basexml.rb', File.dirname(__FILE__))
+require File.expand_path('basexmlinfo.rb', File.dirname(__FILE__))
 
 module Scrobbler
   # @todo Add missing functions that require authentication
-  class Album < BaseXml
+  class Album < BaseXmlInfo
     include Scrobbler::ImageObjectFuncs
     
     attr_reader :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url
@@ -28,16 +28,10 @@ module Scrobbler
     # 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
-    #
     # @param [Hash] data The options to initialize the class
     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, "Artist or mbid is required" if @artist.nil? && @mbid.nil?
       raise ArgumentError, "Name is required" if @name.empty?

data/lib/scrobbler/artist.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 
-require File.expand_path('basexml.rb', File.dirname(__FILE__))
+require File.expand_path('basexmlinfo.rb', File.dirname(__FILE__))
 
 module Scrobbler
   # @todo Add missing functions that require authentication
   # @todo Integrate search functionality into this class which is already implemented in Scrobbler::Search
-  class Artist < BaseXml
+  class Artist < BaseXmlInfo
     include Scrobbler::ImageObjectFuncs
     include Scrobbler::StreamableObjectFuncs
     
@@ -25,14 +25,12 @@ module Scrobbler
     def initialize(data = {})
       raise ArgumentError unless data.kind_of?(Hash)
       super(data)
-      # Load data given as method-parameter
-      populate_data(data)
       raise ArgumentError, "Name is required" if @name.nil? || @name.strip.empty?
     end
     
     # Load the data for this object out of a XML-Node
     #
-    # @param [LibXML::XML::Node] node The XML node containing the information
+    # @param [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
@@ -51,7 +49,7 @@ module Scrobbler
           when 'chartposition'
             @chartposition = child.content
           when 'name'
-            @name = child.content.to_s
+            @name = child.content
           when 'image'
             check_image_node(child)
           when 'streamable'
@@ -77,7 +75,7 @@ module Scrobbler
       end #^ do |child|
 
       # Get all information from the root's attributes
-      @name = node['name'].to_s unless node['name'].nil?
+      @name = node['name'] unless node['name'].nil?
       @rank = node['rank'].to_i unless node['rank'].nil?
       maybe_streamable_attribute(node)
       @mbid = node['mbid'] unless node['mbid'].nil?

data/lib/scrobbler/base.rb

@@ -1,9 +1,8 @@
 require 'digest/md5'
+require 'nokogiri'
 
 $KCODE = 'u'
 
-include LibXML
-
 module Scrobbler
  
   API_URL     = 'http://ws.audioscrobbler.com/'
@@ -44,24 +43,6 @@ module Scrobbler
       URI.escape(param.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
     end
   
-    # Camelize and Constanize a string.
-    #
-    # @param [String,Symbol] word The word which should be camelized and
-    #   constanized.
-    # @return [Constant]
-    def Base.constanize(word)
-      names = word.to_s.gsub(/\/(.?)/) do
-        "::#{$1.upcase}"
-      end.gsub(/(?:^|_)(.)/) { $1.upcase }.split('::')
-      names.shift if names.empty? || names.first.empty?
-  
-      constant = Object
-      names.each do |name|
-        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-      end
-      constant
-    end
-
     # Initiate a API and parse it.
     #
     # @param [String,Symbol] api_method The API method to call.
@@ -70,13 +51,8 @@ module Scrobbler
     # @param [Hash<String,Symbol>] parameters The parameters for the method call.
     # @return [Array<Scrobbler::Base>]
     def Base.get(api_method, parent, element, parameters = {})
-      if (element.is_a?(Class))
-        scrobbler_class = element
-        element = element.to_s.sub("Scrobbler::","").downcase
-      else
-        element = element.to_s
-        scrobbler_class = constanize("scrobbler/#{element}")
-      end
+      scrobbler_class = element
+      element = element.to_s.sub("Scrobbler::","").downcase
       doc = request(api_method, parameters)
       elements = []
       doc.root.children.each do |child|
@@ -131,15 +107,14 @@ module Scrobbler
           paramlist << "#{sanitize(key)}=#{sanitize(value)}"
         end
       end
-      url = '/2.0/?' + paramlist.join('&')
-      XML::Document.string(self.connection.send(request_method,url))
+      url = "/2.0/?#{paramlist.join('&')}"
+      xml = self.connection.send(request_method, url)
+      doc = Nokogiri::XML(xml) do |config|
+        config.noent.noblanks.nonet
+      end
+      doc
     end
     
-    # @deprecated
-    def get_response(api_method, instance_name, parent, element, params, force=true)
-      Base.get(api_method, parent, element, params)
-    end
-  
     # Load information into instance variables.
     #
     # @param [Hash<String,Symbol>] data Each entry will be stored as a variable.

data/lib/scrobbler/basexml.rb

@@ -12,6 +12,7 @@ module Scrobbler
         load_from_xml(data[:xml])
         data.delete(:xml)
       end
+      populate_data(data)
     end
   end
 end

data/lib/scrobbler/basexmlinfo.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
+module Scrobbler
+  class BaseXmlInfo < BaseXml
+    # Load data out of a XML node, fetch addtional info if requested
+    #
+    # @param [Hash] data
+    def initialize(data = {})
+      raise ArgumentError unless data.kind_of?(Hash)
+      data = {:include_info => false}.merge(data)
+      fetch_info = data.delete(:include_info) 
+      super(data)
+      load_info() if fetch_info 
+    end
+  end
+end

data/lib/scrobbler/event.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-require File.expand_path('basexml.rb', File.dirname(__FILE__))
+require File.expand_path('basexmlinfo.rb', File.dirname(__FILE__))
 
 module Scrobbler
-  class Event < BaseXml
+  class Event < BaseXmlInfo
     # Load Helper modules
     include ImageObjectFuncs
     
@@ -24,11 +24,7 @@ module Scrobbler
     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, "ID is required" if @id.nil?
     end
     

data/lib/scrobbler/helper/image.rb

@@ -9,10 +9,9 @@ module Scrobbler
     # of, read it into that given hash of data 
     #
     # @param [Hash<Symbol, String>] data The data extracted from an API response
-    # @param [LibXML::XML::Node] node XML node, part of the API response
+    # @param [(LibXML::)XML::Node] node XML node, part of the API response
     def maybe_image_node(data, node)
       raise ArgumentError unless data.kind_of?(Hash)
-      raise ArgumentError unless node.kind_of?(LibXML::XML::Node)
       if node.name == 'image'
         case node['size'].to_s # convert to string to fix libxml-ruby bug
           when 'small'

data/lib/scrobbler/playlist.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-require File.expand_path('basexml.rb', File.dirname(__FILE__))
+require File.expand_path('basexmlinfo.rb', File.dirname(__FILE__))
 
 module Scrobbler
-  class Playlist < BaseXml
+  class Playlist < BaseXmlInfo
     # Load Helper modules
     include ImageObjectFuncs
     include Scrobbler::StreamableObjectFuncs
@@ -26,11 +26,6 @@ module Scrobbler
     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
     

data/lib/scrobbler/shout.rb

@@ -16,8 +16,6 @@ module Scrobbler
     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

data/lib/scrobbler/tag.rb

@@ -1,106 +1,69 @@
-# 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
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 module Scrobbler
-  class Tag < Base
-    attr_accessor :name, :count, :url, :streamable
+  class Tag < BaseXml
+    include Scrobbler::StreamableObjectFuncs
+
+    attr_reader :name, :count, :url, :streamable
     
-    class << self
-      def new_from_libxml(xml)
-        data = {}
-        xml.children.each do |child|
-          data[:name] = child.content if child.name == 'name'
-          data[:count] = child.content.to_i if child.name == 'count'
-          data[:url] = child.content if child.name == 'url'
-          if child.name == 'streamable'
-            if ['1', 'true'].include?(child.content)
-              data[:streamable] = true
-            else
-              data[:streamable] = false
-            end
-          end
-        end
-        
-        Tag.new(data[:name], data)
-      end
+    # Alias for Artist.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      Tag.new(:xml => xml)
     end
     
-    def initialize(name, data={})
-      raise ArgumentError, "Name is required" if name.empty?
-      @name = name
-      @url = data[:url] unless data[:url].nil?
-      @count = data[:count] unless data[:count].nil?
-      @streamable = data[:streamable] unless data[:streamable].nil?
+    # Create a new Scrobbler::Artist instance
+    #
+    # @param [Hash] data The options to initialize the class
+    def initialize(data = {})
+      raise ArgumentError unless data.kind_of?(Hash)
+      super(data)
+      raise ArgumentError, "Name is required" if @name.nil? || @name.strip.empty?
     end
     
-    def top_artists(force=false)
-      get_response('tag.gettopartists', :top_artists, 'topartists', 'artist', {'tag'=>@name}, force)
+    # Load the data for this object out of a XML-Node
+    #
+    # @param [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 'count'
+            @count = child.content.to_i
+          when 'url'
+            @url = child.content
+          when 'name'
+            @name = child.content
+          when 'streamable'
+            check_streamable_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 #^ load_from_xml
+
+    def top_artists
+      call('tag.gettopartists', :topartists, Artist, {:tag => @name})
     end
     
-    def top_albums(force=false)
-      get_response('tag.gettopalbums', :top_albums, 'topalbums', 'album', {'tag'=>@name}, force)
+    def top_albums
+      call('tag.gettopalbums', :topalbums, Album, {:tag => @name})
     end
 
-    def top_tracks(force=false)
-      get_response('tag.gettoptracks', :top_tracks, 'toptracks', 'track', {'tag'=>@name}, force)
+    def top_tracks
+      call('tag.gettoptracks', :toptracks, Track, {:tag => @name})
     end
 
     def self.top_tags
-        Base.get('tag.gettoptags', :toptags, :tag)
+        Base.get('tag.gettoptags', :toptags, Tag)
     end
     
     def self.search
@@ -111,9 +74,8 @@ module Scrobbler
     
     # 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)
+    def similar
+        call('tag.getsimilar', :similartags, Tag, {:tag => @name})
     end
 
     def weekly_artist_chart