gingerhendrix-scrobbler2 0.0.4

data/README

@@ -0,0 +1,5 @@
+Scrobbler2
+==========
+
+
+A ruby library for accessing the last.fm api v2.0.  Based on John Nunemaker's httParty gem and inspired by his scrobbler gem.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :default => 'test:unit'

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 0
+:minor: 0

data/generators/acceptance_test/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generate a scrobbler2 acceptance test
+  
+Usage:
+  ./script/generate acceptance_test resource func
+  
+  * resource is a last.fm api resource (eg. user, track etc)
+  * func is a last.fm api method (eg. info, similar, top_tags etc)
+

data/generators/acceptance_test/acceptance_test_generator.rb

@@ -0,0 +1,57 @@
+class AcceptanceTestGenerator < RubiGen::Base
+
+#  default_options :author => nil
+
+  attr_reader :resource
+  attr_reader :func
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?  || args.length < 2
+    @resource = args.shift
+    @func = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "test/acceptance/#{@resource}"
+
+      # Create stubs
+      m.template  "acceptance_test.rb.erb", "test/acceptance/#{@resource}/#{@func}_test.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a scrobbler2 acceptance test
+
+USAGE: #{$0} #{spec.name} resource func
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/acceptance_test/templates/acceptance_test.rb.erb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+describe "<%=func%> for <%=resource%> ..." do
+  
+  before(:all) do #We only want to hit the webservice once.
+    @<%=resource%> = Scrobbler2::<%=resource.classify%>.new "..."
+    @<%=func%> = @<%=resource%>.<%=func%>
+  end 
+  
+  it "should be hash" do
+    @<%=func%>.should be_kind_of Hash
+  end
+  
+end

data/generators/resource/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a scrobbler2 resource
+  
+Usage:
+  ./script/generate resource resource [funcs]
+  
+  * resource is a last.fm api resource (eg. user, track etc)
+  * funcs are a list of last.fm get api method (eg. info, similar, top_tags etc)

data/generators/resource/resource_generator.rb

@@ -0,0 +1,47 @@
+class ResourceGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+  attr_reader :funcs
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    @funcs = args
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'lib/scrobbler2'
+      m.directory 'test/unit'
+      
+      # Create stubs
+      m.template "resource.rb.erb", "lib/scrobbler2/#{name}.rb"
+      m.template "spec.rb.erb", "test/unit/#{name}_spec.rb"
+      
+      # Create acceptance tests
+      funcs.each do |func|
+        m.dependency "acceptance_test", [name, func]
+      end
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a scrobbler2 resource
+
+USAGE: #{$0} #{spec.name} name funcs
+EOS
+    end
+
+    def add_options!(opts)
+    end
+
+    def extract_options
+    end
+end

data/generators/resource/templates/resource.rb.erb

@@ -0,0 +1,11 @@
+module Scrobbler2
+  class <%= name.classify %> < Base
+    
+    def initialize()
+      @query = {}#TODO eg. {:artist => artist, :track => track}
+    end
+    <% funcs.each do |func| %>
+     get_resource :<%=func%>, :root => "<%=func.camelize.downcase%>"
+   <% end %>
+  end
+end

data/generators/resource/templates/spec.rb.erb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe "<%=name.classify%>" do
+  before(:each) do
+    @<%=name%> = Scrobbler2::<%=name.classify%>.new "..."
+    @<%=name%>.class.stub!(:get).and_return Hash.new
+  end
+  
+  it "should have a default query {TODO}" do
+    @<%=name%>.instance_variable_get(:@query).should == {}  
+  end
+  
+  <% funcs.each do |func| %>
+  
+  it "<%=func%> should call get with '<%=name%>.get<%=func%>'" do
+    @<%=name%>.class.should_receive(:get).with('<%=name%>.get<%=func%>', anything(), anything()).and_return Hash.new
+    @<%=name%>.<%=func%>
+  end
+  
+  <% end %>
+
+end

data/lib/scrobbler2.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'httparty'
+require 'active_support'
+$: << File.dirname(__FILE__)
+
+module Scrobbler2
+
+end
+
+require 'scrobbler2/base.rb'
+require 'scrobbler2/auth.rb'
+require 'scrobbler2/album.rb'
+require 'scrobbler2/artist.rb'
+require 'scrobbler2/event.rb'
+require 'scrobbler2/geo.rb'
+require 'scrobbler2/group.rb'
+require 'scrobbler2/library.rb'
+require 'scrobbler2/playlist.rb'
+require 'scrobbler2/tag.rb'
+require 'scrobbler2/track.rb'
+require 'scrobbler2/user.rb'
+require 'scrobbler2/venue.rb'
+

data/lib/scrobbler2/album.rb

@@ -0,0 +1,11 @@
+module Scrobbler2
+  class Album < Base
+    
+    def initialize(artist, album)
+      @query = {:artist => artist, :album => album}
+    end
+    
+     get_resource :info, :root => 'album'
+   
+  end
+end

data/lib/scrobbler2/artist.rb

@@ -0,0 +1,29 @@
+
+module Scrobbler2
+  class Artist < Base
+    
+    def initialize(artist)
+      @query = {:artist => artist}
+    end
+
+    get_resource :events, :root => 'events'
+    get_resource :info, :root => 'artist'
+    get_resource :shouts, :root => 'shouts'
+    get_resource :similar, :root => 'similarartists'
+    get_resource :top_albums, :root => 'topalbums'
+    get_resource :top_fans, :root => 'topfans'
+    get_resource :top_tags, :root => 'toptags'
+    get_resource :top_tracks, :root => 'toptracks'
+    
+    def tags
+      return @tags if @tags
+      @tags = self.class.get_with_auth("artist.gettags", @query)["lfm"]["tags"]    
+    end
+
+    def add_tags(tags)
+      query = @query.merge :tags => tags.join(",")
+      self.class.post_with_auth("artist.addtags", query)
+    end
+    
+  end
+end

data/lib/scrobbler2/auth.rb

@@ -0,0 +1,19 @@
+module Scrobbler2
+  class Auth < Base
+ 
+    def token
+      return @token if @token
+      @token = self.class.get_with_auth("auth.gettoken")["lfm"]["token"]
+    end 
+    
+    def url
+      "http://www.last.fm/api/auth/?api_key=#{api_key}&token=#{token}"     
+    end
+    
+    def session
+      return @session if @session
+      @session = self.class.get_with_auth("auth.getsession", {:token => token})["lfm"]["session"]
+    end
+  
+  end
+end

data/lib/scrobbler2/base.rb

@@ -0,0 +1,73 @@
+
+
+module Scrobbler2
+  class Base
+    cattr_accessor :api_key
+    cattr_accessor :api_secret
+    cattr_accessor :session_key
+    
+    def self.get(method, query={}, options={})
+      query = query.merge({:api_key => api_key, :method => method, :format => 'json'})
+      options = options.merge({:query => query})
+
+      response = HTTParty.get('http://ws.audioscrobbler.com/2.0/', options)
+    end
+    
+    def self.get_resource(name, options = {})
+      define_method name do |*args|
+        query = args[1] || {}
+        local_options = args[0] || {}
+        local_value = instance_variable_get("@#{name.to_s}")
+        return local_value if local_value && !options[:force]
+
+        query = query.merge options[:query] if options[:query]
+        query = query.merge(@query) if @query && !options[:query]
+        
+        method_name = options[:resource_name] || self.class.name.split("::").last.downcase + ".get#{name.to_s.tr('_', '').downcase}" 
+        if options[:auth]
+          value = self.class.get_with_auth(method_name, query, local_options)
+        else
+          value = self.class.get(method_name, query, local_options)                
+        end
+        value = value[options[:root]] if options[:root]
+        
+        instance_variable_set("@#{name}", value)
+      end   
+    end
+    
+    #implements signed requests
+    def self.get_with_auth(method, query={}, options={})
+      http_with_auth(:get, method, query, options)
+    end
+    
+    def self.http_with_auth(http_method, method, query={}, options={})
+      query = query.merge({:api_key => api_key, :method => method})
+      query = query.merge({:sk => session_key}) if session_key
+      
+      signature = sign(query)      
+      query = query.merge({:api_sig => signature})
+
+      if(http_method == :get)
+        options = options.merge({:query => query})
+      else
+        options = options.merge({:body => query})
+      end
+      response = HTTParty.send(http_method, 'http://ws.audioscrobbler.com/2.0/', options)
+    end
+    
+    def self.post_with_auth(method, query={}, options={})
+      http_with_auth(:post, method, query, options)      
+    end
+    
+    def self.sign(query)
+      signature = query_signature(query)
+      md5 = Digest::MD5.hexdigest(signature)
+    end
+    
+    def self.query_signature(query)
+      signature = query.sort {|a,b| a[0].to_s <=> b[0].to_s }.map { |param| param.join('') }.join('')
+      signature = "#{signature}#{api_secret}"
+      signature
+    end
+  end
+end

data/lib/scrobbler2/event.rb

@@ -0,0 +1,12 @@
+module Scrobbler2
+  class Event < Base
+    
+    def initialize(event_id)
+      @query = {:event => event_id}
+    end
+    
+     get_resource :info, :root => 'event'
+     get_resource :shouts, :root => 'shouts'
+     
+  end
+end

data/lib/scrobbler2/geo.rb

@@ -0,0 +1,15 @@
+module Scrobbler2
+  class Geo < Base
+    
+    def initialize()
+      @query = {}#TODO eg. {:artist => artist, :track => track}
+    end
+    
+     get_resource :events, :root => "events"
+   
+     get_resource :top_artists, :root => "topartists"
+   
+     get_resource :top_tracks, :root => "toptracks"
+   
+  end
+end

data/lib/scrobbler2/group.rb

@@ -0,0 +1,14 @@
+module Scrobbler2
+  class Group < Base
+    
+    def initialize(group_name)
+      @query = {:group => group_name}
+    end
+    
+     get_resource :members, :root => 'members'
+     get_resource :weekly_album_chart, :root => 'weeklyalbumchart'
+     get_resource :weekly_artist_chart, :root => 'weeklyartistchart'
+     get_resource :weekly_track_chart, :root => 'weeklytrackchart'
+     get_resource :weekly_chart_list, :root => 'weeklychartlist'
+  end
+end

data/lib/scrobbler2/library.rb

@@ -0,0 +1,12 @@
+module Scrobbler2
+  class Library < Base
+    
+    def initialize(user)
+      @query = {:user => user}
+    end
+    
+     get_resource :artists, :root => 'artists'
+     get_resource :albums, :root => 'albums'
+     get_resource :tracks, :root => 'tracks'
+  end
+end

data/lib/scrobbler2/playlist.rb

@@ -0,0 +1,10 @@
+module Scrobbler2
+  class Playlist < Base
+    
+    def initialize(playlist_url)
+      @query = {:playlistURL => playlist_url}
+    end
+    
+     get_resource :fetch, :root => 'playlist', :resource_name => 'playlist.fetch'
+  end
+end

data/lib/scrobbler2/tag.rb

@@ -0,0 +1,17 @@
+
+module Scrobbler2
+  class Tag < Base
+    
+    def initialize(tag)
+      @query = {:tag => tag}
+    end
+
+    get_resource :similar, :root => 'similar'
+    get_resource :top_artists, :root => 'topartists'
+    get_resource :top_albums, :root => 'topalbums'
+    get_resource :top_tracks, :root => 'toptracks'
+    get_resource :top_tags, :root => 'toptags'
+    get_resource :weekly_artist_chart, :root => 'weeklyartistchart'
+    get_resource :weekly_chart_list, :root => 'weeklychartlist'
+  end
+end