scrobbler-ng 2.0.4 → 2.0.5

data/README.rdoc

@@ -10,95 +10,18 @@ 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('Some Hearts', :artist => 'Carrie Underwood', :include_info => true)
-
-  puts "Album: #{album.name}"
-  puts "Artist: #{album.artist}"
-  puts "Playcount: #{album.playcount}"
-  puts "URL: #{album.url}"
-  puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
-	
-==Artists
-	
-  artist = Scrobbler::Artist.new('Carrie Underwood')  
   
-  puts 'Top Tracks'
-  puts "=" * 10
-  artist.top_tracks.each { |t| puts "(#{t.playcount}) #{t.name}" }
-
-  puts
-
-  puts 'Similar Artists'
-  puts "=" * 15
-  artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }
-
-==Geo
-
-  geo = Scrobbler::Geo.new()
-
-  puts 'Events'
-  puts "=" * 10
-  geo.events(:location => 'Manchester').each { |e| puts "(#{e.id}) #{e.title}" }
-
-  puts
+== Usage
 
-  puts 'Top Artists'
-  puts "=" * 10
-  geo.top_artists(:location => 'Manchester').each { |a| puts "(#{a.name}) #{a.playcount}" }
-
-  puts
-
-  puts 'Top Tracks'
-  puts "=" * 10
-  geo.top_tracks(:location => 'Manchester').each { |t| puts "(#{a.name}) #{a.playcount}" }
-
-	
-==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.top_fans.each { |u| puts "(#{u.weight}) #{u.username}" }
-	
-== Simple Authentication (for Scrobbling)
-
-  work in progress...
-    
-== Scrobbling
-
-  work in progress...
-
-== Now Playing Submission
-
-  work in progress...
+  coming soon ...
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
 

data/VERSION.yml

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

data/lib/scrobbler/base.rb

@@ -1,19 +1,28 @@
 # encoding: utf-8
 
 require 'digest/md5'
+require 'net/https'
 require 'nokogiri'
+require 'uri'
 
 # Only set KCODE in Ruby 1.8.X, not in 1.9.X as it is deprecated
 if RUBY_VERSION =~ /1\.8\.[0-9]/ then
   $KCODE = 'u' 
 end
 
-
 module Scrobbler
  
-  API_URL     = 'http://ws.audioscrobbler.com/'
+  API_URL  = 'http://ws.audioscrobbler.com/' unless defined? API_URL
   
   class Base
+    
+    # By default, there is no cache
+    @@cache = []
+    
+    def Base.add_cache(cache)
+      @@cache << cache
+    end
+    
     # Set the default API key.
     #
     # This key will be used by all Scrobbler classes and objects.
@@ -72,6 +81,53 @@ module Scrobbler
     def Base.post_request(api_method, parameters = {})
       Base.request(api_method, parameters, 'post')
     end
+    
+    # Load a request from cache if possible
+    #
+    # @param [Hash] parameters The parameters passed as URL params.
+    # @return [String,nil]
+    def Base.load_from_cache(parameters)
+      @@cache.each do |cache|
+        if cache.has?(parameters)
+          return cache.get(parameters)
+        end
+      end
+      nil
+    end
+    
+    # Save a request answer to all caches that would store it.
+    #
+    # @param [String] xml The answer from the Last.fm API
+    # @param [Hash] parameters The parameters passed as URL params.
+    # @return [nil]
+    def Base.save_to_cache(xml, parameters)
+      @@cache.each do |cache|
+        if cache.writable? then
+          cache.set(xml, parameters)
+        end
+      end 
+    end
+    
+    # Fetch a http answer for the given request
+    #
+    # @param [String] request_method The HTTP verb for the request type
+    # @param [Array<String>] paramlist The URL(-query) parameters
+    # @return [String] The plain response from the Last.fm API
+    def Base.fetch_http(request_method, paramlist)
+      url = URI.join(API_URL, "/2.0/?#{paramlist.join('&')}")
+      case request_method.downcase
+        when "get"
+          req = Net::HTTP::Get.new(url.request_uri)
+        when "post"
+          req = Net::HTTP::Post.new(url.request_uri)
+      end
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = (url.port == 443)
+      xml = http.start() do |conn| 
+        conn.request(req)
+      end
+      xml.body
+    end
   
     # Execute a request to the Audioscrobbler webservice
     #
@@ -86,6 +142,7 @@ module Scrobbler
       parameters = {:signed => false}.merge(parameters)
       parameters['api_key'] = @@api_key
       parameters['method'] = api_method.to_s
+      check_cache = false
       paramlist = []
       # Check if we want a signed call and pop :signed
       if parameters.delete :signed
@@ -102,30 +159,25 @@ module Scrobbler
           paramlist << "#{sanitize(a.at(0))}=#{sanitize(a.at(1))}"
         end
       else
+        if request_method == 'get' then
+          check_cache = true
+        end
         parameters.each do |key, value|
           paramlist << "#{sanitize(key)}=#{sanitize(value)}"
         end
       end
       
-      # TODO Caching!
-      
-      url = URI.join(API_URL, "/2.0/?#{paramlist.join('&')}")
-
-      # Fetch the http answer
-      case request_method
-        when "get"
-          req = Net::HTTP::Get.new(url.request_uri)
-        when "post"
-          req = Net::HTTP::Post.new(url.request_uri)
-      end
-      http = Net::HTTP.new(url.host, url.port)
-      http.use_ssl = (url.port == 443)
-      
+      xml = nil
+      # Check if we could read from cache
+      xml = load_from_cache(parameters) if check_cache
+      # Fetch the http answer if cache was empty
+      xml = fetch_http(request_method, paramlist) if xml.nil?
       # Process it
-      res = http.start() { |conn| conn.request(req) }
-      doc = Nokogiri::XML(res.body) do |config|
-        config.noent.noblanks.nonet
-      end
+      doc = Nokogiri::XML(xml) { |config| config.noent.noblanks.nonet }
+      # Write to cache
+      save_to_cache(xml, parameters) if check_cache
+      
+      # Return the parsed result      
       doc
     end
     

data/lib/scrobbler/user.rb

@@ -68,8 +68,31 @@ module Scrobbler
     end
 
     # Get a list of the user's friends on Last.fm.    
-    def friends(page=1, limit=50)
-      call('user.getfriends', :friends, User, {:user => @name, :page => page, :limit => limit})
+    def friends(opts={})
+      result = []
+      if opts.delete :all
+        params = {:page => 1, :limit => 50, :user => @name}.merge(opts)
+        doc = Base.request('user.getfriends', params)
+        root = nil
+        doc.root.children.each do |child|
+          next unless child.name == 'friends'
+          root = child
+        end
+        total_pages = root['totalPages'].to_i
+        root.children.each do |child|
+          next unless child.name == 'user'
+          result << Scrobbler::User.new_from_libxml(child)
+        end
+        puts total_pages
+        (2..total_pages).each do |i|
+          params[:page] = i
+          result.concat call('user.getfriends', :friends, User, params)
+        end
+      else
+        params = {:page => 1, :limit => 50, :user => @name}.merge(opts)
+        result = call('user.getfriends', :friends, User, params)
+      end
+      result
     end
     
     # Get information about a user profile.

data/scrobbler-ng.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{scrobbler-ng}
-  s.version = "2.0.4"
+  s.version = "2.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker", "Jonathan Rudenberg", "Uwe L. Korn"]
-  s.date = %q{2010-07-28}
+  s.date = %q{2010-07-30}
   s.description = %q{A ruby library for accessing the Last.fm 2.0 API. It is higly optimized so that it uses less memory and parses XML (through Nokogiri) than other implementations.}
   s.email = %q{uwelk@xhochy.org}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scrobbler-ng
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 2
   - 0
-  - 4
-  version: 2.0.4
+  - 5
+  version: 2.0.5
 platform: ruby
 authors: 
 - John Nunemaker
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 +02:00
+date: 2010-07-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency