scrobbler2 0.0.4

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,100 @@
+
+
+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.has_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]
+
+        if options[:query]
+          query.merge!(options[:query])
+        elsif @query
+          query.merge!(@query)
+        end
+
+        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
+
+    # TODO this needs to be DRYed up, wrt has_resource
+    def self.has_singleton_resource(name, options={})
+      (class << self; self; end).class_eval do
+        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.merge!(options[:query]) if options[:query]
+
+          method_name = options[:resource_name] || self.name.split("::").last.downcase + ".get#{name.to_s.tr('_', '').downcase}"
+          if options[:auth]
+            value = self.get_with_auth(method_name, query, local_options)
+          else
+            value = self.get(method_name, query, local_options)
+          end
+          value = value[options[:root]] if options[:root]
+
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+
+    #implements signed requests
+    def self.get_with_auth(method, query={}, options={})
+      http_with_auth(:get, method, query, options)["lfm"]
+    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
+    
+     has_resource :info, :root => 'event'
+     has_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
+    
+     has_resource :events, :root => "events"
+   
+     has_resource :top_artists, :root => "topartists"
+   
+     has_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
+    
+     has_resource :members, :root => 'members'
+     has_resource :weekly_album_chart, :root => 'weeklyalbumchart'
+     has_resource :weekly_artist_chart, :root => 'weeklyartistchart'
+     has_resource :weekly_track_chart, :root => 'weeklytrackchart'
+     has_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
+    
+     has_resource :artists, :root => 'artists'
+     has_resource :albums, :root => 'albums'
+     has_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
+    
+     has_resource :fetch, :root => 'playlist', :resource_name => 'playlist.fetch'
+  end
+end

data/lib/scrobbler2/tag.rb

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

data/lib/scrobbler2/track.rb

@@ -0,0 +1,13 @@
+module Scrobbler2
+  class Track < Base
+    
+    def initialize(artist, track)
+      @query = {:artist => artist, :track => track}
+    end
+    
+     has_resource :info, :root => 'track'
+     has_resource :similar, :root => 'similartracks'
+     has_resource :top_fans, :root => 'topfans'
+     has_resource :top_tags, :root => 'toptags'
+  end
+end

data/lib/scrobbler2/user.rb

@@ -0,0 +1,29 @@
+module Scrobbler2
+  class User < Base
+    
+    def initialize(username)
+      @query = {:user => username}
+    end
+    
+     has_resource :events, :root => "events"
+     has_resource :info, :root=>"user", :auth=>true, :query => {}
+     has_resource :friends, :root => "friends"
+     has_resource :loved_tracks, :root => "lovedtracks"
+     has_resource :neighbours, :root => "neighbours"
+     has_resource :past_events, :root => "events"
+     has_resource :playlists, :root => "playlists"
+     has_resource :recent_tracks, :root => "recenttracks"
+     has_resource :recommended_artists, :root => "recommendedartists", :auth => true, :query => {}
+     has_resource :recommended_events, :root => "recommendedevents", :auth => true, :query => {}
+     has_resource :shouts, :root => "shouts"
+     has_resource :top_albums, :root => "topalbums"
+     has_resource :top_artists, :root => "topartists"
+     has_resource :top_tags, :root => "toptags"
+     has_resource :top_tracks, :root => "toptracks"
+     has_resource :weekly_album_chart, :root => "weeklyalbumchart"
+     has_resource :weekly_artist_chart, :root => "weeklyartistchart"
+     has_resource :weekly_chart_list, :root => "weeklychartlist"
+     has_resource :weekly_track_chart, :root => "weeklytrackchart"
+   
+  end
+end

data/lib/scrobbler2/venue.rb

@@ -0,0 +1,12 @@
+module Scrobbler2
+  class Venue < Base
+    
+    def initialize(id)
+      @query = {:venue => id}
+    end
+    
+     has_resource :events, :root => "events"
+     has_resource :past_events, :root => "events"
+   
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scrobbler2.rb'}"
+puts "Loading scrobbler2 gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/scrobbler2.gemspec

@@ -0,0 +1,243 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scrobbler2}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gareth Andrew", "Kurt Schrader"]
+  s.date = %q{2010-01-12}
+  s.description = %q{A ruby library for accessing the last.fm v2 webservices}
+  s.email = %q{gingerhendrix@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION.yml",
+     "generators/acceptance_test/USAGE",
+     "generators/acceptance_test/acceptance_test_generator.rb",
+     "generators/acceptance_test/templates/acceptance_test.rb.erb",
+     "generators/resource/USAGE",
+     "generators/resource/resource_generator.rb",
+     "generators/resource/templates/resource.rb.erb",
+     "generators/resource/templates/spec.rb.erb",
+     "lib/scrobbler2.rb",
+     "lib/scrobbler2/album.rb",
+     "lib/scrobbler2/artist.rb",
+     "lib/scrobbler2/auth.rb",
+     "lib/scrobbler2/base.rb",
+     "lib/scrobbler2/event.rb",
+     "lib/scrobbler2/geo.rb",
+     "lib/scrobbler2/group.rb",
+     "lib/scrobbler2/library.rb",
+     "lib/scrobbler2/playlist.rb",
+     "lib/scrobbler2/tag.rb",
+     "lib/scrobbler2/track.rb",
+     "lib/scrobbler2/user.rb",
+     "lib/scrobbler2/venue.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "scrobbler2.gemspec",
+     "tasks/jeweler.rake",
+     "tasks/rcov.rake",
+     "tasks/rdoc.rake",
+     "tasks/tests.rake",
+     "test/acceptance/album/info_test.rb",
+     "test/acceptance/artist/add_tags_test.rb",
+     "test/acceptance/artist/events_test.rb",
+     "test/acceptance/artist/info_test.rb",
+     "test/acceptance/artist/shouts_test.rb",
+     "test/acceptance/artist/similar_artists_test.rb",
+     "test/acceptance/artist/tags_test.rb",
+     "test/acceptance/artist/top_albums_test.rb",
+     "test/acceptance/artist/top_fans.rb",
+     "test/acceptance/artist/top_tags.rb",
+     "test/acceptance/artist/top_tracks.rb",
+     "test/acceptance/auth/auth_test.rb",
+     "test/acceptance/event/info_test.rb",
+     "test/acceptance/event/shouts_test.rb",
+     "test/acceptance/geo/events_test.rb",
+     "test/acceptance/geo/top_artists_test.rb",
+     "test/acceptance/geo/top_tracks_test.rb",
+     "test/acceptance/group/members_test.rb",
+     "test/acceptance/group/weekly_album_chart_test.rb",
+     "test/acceptance/group/weekly_artist_chart_test.rb",
+     "test/acceptance/group/weekly_chart_list_test.rb",
+     "test/acceptance/group/weekly_track_chart_test.rb",
+     "test/acceptance/library/albums_test.rb",
+     "test/acceptance/library/artists_test.rb",
+     "test/acceptance/library/tracks_test.rb",
+     "test/acceptance/playlist/fetch_test.rb",
+     "test/acceptance/shared/album.rb",
+     "test/acceptance/shared/artist.rb",
+     "test/acceptance/shared/paged_result.rb",
+     "test/acceptance/shared/top_fans.rb",
+     "test/acceptance/shared/top_tags.rb",
+     "test/acceptance/shared/track.rb",
+     "test/acceptance/tag/similar_test.rb",
+     "test/acceptance/tag/top_albums_test.rb",
+     "test/acceptance/tag/top_artists_test.rb",
+     "test/acceptance/tag/top_tags_test.rb",
+     "test/acceptance/tag/top_tracks_test.rb",
+     "test/acceptance/tag/weekly_artist_chart.rb",
+     "test/acceptance/tag/weekly_chart_list.rb",
+     "test/acceptance/test_helper.rb",
+     "test/acceptance/track/info_test.rb",
+     "test/acceptance/track/similar_test.rb",
+     "test/acceptance/track/top_fans_test.rb",
+     "test/acceptance/track/top_tags_test.rb",
+     "test/acceptance/user/events_test.rb",
+     "test/acceptance/user/friends_test.rb",
+     "test/acceptance/user/info_test.rb",
+     "test/acceptance/user/loved_tracks_test.rb",
+     "test/acceptance/user/neighbours_test.rb",
+     "test/acceptance/user/past_events_test.rb",
+     "test/acceptance/user/playlists_test.rb",
+     "test/acceptance/user/recent_tracks_test.rb",
+     "test/acceptance/user/recommended_artists_test.rb",
+     "test/acceptance/user/recommended_events_test.rb",
+     "test/acceptance/user/shouts_test.rb",
+     "test/acceptance/user/top_albums_test.rb",
+     "test/acceptance/user/top_artists_test.rb",
+     "test/acceptance/user/top_tags_test.rb",
+     "test/acceptance/user/top_tracks_test.rb",
+     "test/acceptance/user/weekly_album_chart_test.rb",
+     "test/acceptance/user/weekly_artist_chart_test.rb",
+     "test/acceptance/user/weekly_chart_list_test.rb",
+     "test/acceptance/user/weekly_track_chart_test.rb",
+     "test/acceptance/venue/events_test.rb",
+     "test/acceptance/venue/past_events_test.rb",
+     "test/generators/test_acceptance_test_generator.rb",
+     "test/generators/test_generator_helper.rb",
+     "test/generators/test_resource_generator.rb",
+     "test/unit/album_spec.rb",
+     "test/unit/artist_spec.rb",
+     "test/unit/auth_spec.rb",
+     "test/unit/base_spec.rb",
+     "test/unit/event_spec.rb",
+     "test/unit/geo_spec.rb",
+     "test/unit/group_spec.rb",
+     "test/unit/library_spec.rb",
+     "test/unit/playlist_spec.rb",
+     "test/unit/spec_helper.rb",
+     "test/unit/tag_spec.rb",
+     "test/unit/track_spec.rb",
+     "test/unit/user_spec.rb",
+     "test/unit/venue_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/gingerhendrix/scrobbler2}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby library for accessing the last.fm v2 webservices}
+  s.test_files = [
+    "test/acceptance/album/info_test.rb",
+     "test/acceptance/artist/add_tags_test.rb",
+     "test/acceptance/artist/events_test.rb",
+     "test/acceptance/artist/info_test.rb",
+     "test/acceptance/artist/shouts_test.rb",
+     "test/acceptance/artist/similar_artists_test.rb",
+     "test/acceptance/artist/tags_test.rb",
+     "test/acceptance/artist/top_albums_test.rb",
+     "test/acceptance/artist/top_fans.rb",
+     "test/acceptance/artist/top_tags.rb",
+     "test/acceptance/artist/top_tracks.rb",
+     "test/acceptance/auth/auth_test.rb",
+     "test/acceptance/event/info_test.rb",
+     "test/acceptance/event/shouts_test.rb",
+     "test/acceptance/geo/events_test.rb",
+     "test/acceptance/geo/top_artists_test.rb",
+     "test/acceptance/geo/top_tracks_test.rb",
+     "test/acceptance/group/members_test.rb",
+     "test/acceptance/group/weekly_album_chart_test.rb",
+     "test/acceptance/group/weekly_artist_chart_test.rb",
+     "test/acceptance/group/weekly_chart_list_test.rb",
+     "test/acceptance/group/weekly_track_chart_test.rb",
+     "test/acceptance/library/albums_test.rb",
+     "test/acceptance/library/artists_test.rb",
+     "test/acceptance/library/tracks_test.rb",
+     "test/acceptance/playlist/fetch_test.rb",
+     "test/acceptance/shared/album.rb",
+     "test/acceptance/shared/artist.rb",
+     "test/acceptance/shared/paged_result.rb",
+     "test/acceptance/shared/top_fans.rb",
+     "test/acceptance/shared/top_tags.rb",
+     "test/acceptance/shared/track.rb",
+     "test/acceptance/tag/similar_test.rb",
+     "test/acceptance/tag/top_albums_test.rb",
+     "test/acceptance/tag/top_artists_test.rb",
+     "test/acceptance/tag/top_tags_test.rb",
+     "test/acceptance/tag/top_tracks_test.rb",
+     "test/acceptance/tag/weekly_artist_chart.rb",
+     "test/acceptance/tag/weekly_chart_list.rb",
+     "test/acceptance/test_helper.rb",
+     "test/acceptance/track/info_test.rb",
+     "test/acceptance/track/similar_test.rb",
+     "test/acceptance/track/top_fans_test.rb",
+     "test/acceptance/track/top_tags_test.rb",
+     "test/acceptance/user/events_test.rb",
+     "test/acceptance/user/friends_test.rb",
+     "test/acceptance/user/info_test.rb",
+     "test/acceptance/user/loved_tracks_test.rb",
+     "test/acceptance/user/neighbours_test.rb",
+     "test/acceptance/user/past_events_test.rb",
+     "test/acceptance/user/playlists_test.rb",
+     "test/acceptance/user/recent_tracks_test.rb",
+     "test/acceptance/user/recommended_artists_test.rb",
+     "test/acceptance/user/recommended_events_test.rb",
+     "test/acceptance/user/shouts_test.rb",
+     "test/acceptance/user/top_albums_test.rb",
+     "test/acceptance/user/top_artists_test.rb",
+     "test/acceptance/user/top_tags_test.rb",
+     "test/acceptance/user/top_tracks_test.rb",
+     "test/acceptance/user/weekly_album_chart_test.rb",
+     "test/acceptance/user/weekly_artist_chart_test.rb",
+     "test/acceptance/user/weekly_chart_list_test.rb",
+     "test/acceptance/user/weekly_track_chart_test.rb",
+     "test/acceptance/venue/events_test.rb",
+     "test/acceptance/venue/past_events_test.rb",
+     "test/generators/test_acceptance_test_generator.rb",
+     "test/generators/test_generator_helper.rb",
+     "test/generators/test_resource_generator.rb",
+     "test/unit/album_spec.rb",
+     "test/unit/artist_spec.rb",
+     "test/unit/auth_spec.rb",
+     "test/unit/base_spec.rb",
+     "test/unit/event_spec.rb",
+     "test/unit/geo_spec.rb",
+     "test/unit/group_spec.rb",
+     "test/unit/library_spec.rb",
+     "test/unit/playlist_spec.rb",
+     "test/unit/spec_helper.rb",
+     "test/unit/tag_spec.rb",
+     "test/unit/track_spec.rb",
+     "test/unit/user_spec.rb",
+     "test/unit/venue_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.2.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.2.2"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.2.2"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+