thesmith-active_lastfm 1.0.1

data/README

@@ -0,0 +1,54 @@
+= Active Last.fm
+
+link:http://github.com/thesmith/active_lastfm/tree/master
+
+Active Last.fm is a client wrapper around the [http://last.fm last.fm] [http://www.last.fm/api/intro 2.0 web-services] based around ActiveResource.
+
+== Overview
+
+This wrapper is really simple at the moment. Last.fm 2.0's web-services provide an XML-RPC over XML/HTTP style interface to a load of interesting music and user information. ActiveResource is well tailored for purist RESTful interfaces but not for action-oriented services. This project basically overrides ActiveResource's URL creation for Last.fm's static URL so that the developer can simply wrap ActiveResource's default methods to create their own models around Last.fm action types.
+
+== References
+
+I really haven't done all that much myself here, here are a list of articles / projects that I've borrowed from:
+ * link:http://www.quarkruby.com/2008/1/15/activeresource-and-youtube
+ * link:http://www.quarkruby.com/2008/3/11/consume-non-rails-style-rest-apis
+ * link:http://www.quarkruby.com/2008/2/12/active-youtube
+ * link:http://github.com/rails/rails/tree/master/activeresource
+
+== Usage
+
+For example, if you wanted to use Last.fm's music ontology to create an Artist model then you might set it up something like this:
+
+	require 'active_lastfm'
+	class Artist < ActiveLastfm
+	  def search(artist)
+	    search_result = self.find(:first, :params => {
+	        :method => 'artist.search',
+	        :artist => artist,
+	        :api_key => 'b25b959554ed76058ac220b7b2e0a026'
+	    })
+	
+	    search_result.results.artistmatches.artist
+	  end
+	end
+
+Now, obviously, that's fairly buggy, what with the lack of result checking and coercing, but you get the idea. The API key used is the one that Last.fm have in their examples, so I'd suggest you go get your own one.
+
+== Testing
+
+The current unit tests use ActiveResource::HttpMock to have the mock service respond to requests and return cached results from Last.fm, stored in 'test/fixtures/'. The current methods tested are:
+ * track.search
+ * artist.search
+ * artist.gettoptracks
+
+These tests pass when run under Rake from a checked out copy, but they fail, horribly, when you test under gem (say with a: sudo gem install active_lastfm -t). Hopefully I'll get round to fixing that!
+
+== ToDo
+
+ * Proper documentation.
+ * Set up a proper release process from link:http://github.com/thesmith/active_lastfm/tree/master to link:http://rubyforge.org/projects/active-lastfm/.
+ * Start working out / test all the ActiveResource methods other than 'find'.
+ * Create re-usable models.
+ * Make sure I remove the ActiveResource patches that I've had to use.
+

data/active_lastfm.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = %q{active_lastfm}
+  s.version = "1.0.1"
+  s.date = %q{2008-10-12}
+  s.authors = ["Ben Smith"]
+  s.email = %q{ben [at] thesmith [dot] co [dot] uk}
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+  s.summary = %q{Last.fm client for Ruby (and Rails) based on ActiveResource}
+  s.homepage = %q{http://github.com/thesmith/active_lastfm}
+  s.description = %q{Last.fm client for Ruby (and Rails) based on ActiveResource}
+  s.files = ["README", "active_lastfm.gemspec", "lib/active_lastfm.rb", "lib/patch.rb"]
+  s.add_dependency('activeresource', '>= 2.0.2')
+  s.test_files = ('test/active_lastfm_test.rb')
+end
+

data/lib/active_lastfm.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'activeresource'
+require 'patch'
+
+# This abstract base-class extends ActiveResource::Base to make requests to last.fm
+# Based largely on the ActiveYouTube examples found at:
+# * link:http://www.quarkruby.com/2008/1/15/activeresource-and-youtube
+# * link:http://www.quarkruby.com/2008/3/11/consume-non-rails-style-rest-apis
+# * link:http://www.quarkruby.com/2008/2/12/active-youtube
+class ActiveLastfm < ActiveResource::Base
+  # The core Last.fm WS URL is the only URI used in this interface
+  self.site = 'http://ws.audioscrobbler.com/2.0/'
+
+  class << self
+    ## Remove format from the url.
+    def element_path(id, prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{query_string(query_options)}"
+    end
+  
+    ## Remove format from the url.
+    def collection_path(prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{query_string(query_options)}"
+    end
+
+    ## For a collection call, ActiveResource formatting is not 
+    ## compliant with YouTube's output.
+    def instantiate_collection(collection, prefix_options = {})
+      puts collection.inspect
+      unless collection.kind_of? Array
+        [instantiate_record(collection, prefix_options)]
+      else
+        collection.collect! { |record| instantiate_record(record, prefix_options) }
+      end
+    end
+  end
+end

data/lib/patch.rb

@@ -0,0 +1,32 @@
+## Patched ActiveResouce code
+## Will follow edge code and remove when included in a release
+module ActiveResource
+  class Base
+    def load(attributes)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @prefix_options, attributes = split_options(attributes)
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+          case value
+            when Array
+              resource = find_or_create_resource_for_collection(key)
+#<<<          value.map { |attrs| resource.new(attrs) }
+              value.map { |attrs| attrs.is_a?(String) ? attrs.dup : resource.new(attrs) }
+            when Hash
+              resource = find_or_create_resource_for(key)
+              resource.new(value)
+            else
+              value.dup rescue value
+          end
+      end
+      self
+    end
+  end
+
+  class ConnectionError < StandardError
+    def build_request_headers(headers, http_method=nil)
+#<<<    authorization_header.update(default_header).update(headers).update(http_format_header(http_method))
+        authorization_header.update(default_header).update(headers)
+    end
+  end
+end

data/test/active_lastfm_test.rb

@@ -0,0 +1,56 @@
+$:.unshift "#{File.dirname(__FILE__)}/../test"
+require 'abstract_unit'
+require 'active_lastfm'
+
+class ActiveLastfmTest < Test::Unit::TestCase
+  def feed(name)
+    path = File.dirname(__FILE__) + "/../test/fixtures/#{name}.xml"
+    return nil unless File.exists?(path)
+    File.read path
+  end
+
+  def setup
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get "/2.0/?api_key=b25b959554ed76058ac220b7b2e0a026&artist=cher&method=artist.search", {}, feed("artist.search")
+      mock.get "/2.0/?api_key=b25b959554ed76058ac220b7b2e0a026&method=track.search&track=Belive", {}, feed("track.search")
+      mock.get "/2.0/?api_key=b25b959554ed76058ac220b7b2e0a026&artist=cher&method=artist.gettoptracks", {}, feed("artist.track.search")
+    end
+  end
+
+  def test_site
+    assert_equal(URI.parse('http://ws.audioscrobbler.com/2.0/'), ActiveLastfm.site)
+  end
+
+  def test_artist_search
+    result = ActiveLastfm.find(:first, :params => {
+        :api_key => 'b25b959554ed76058ac220b7b2e0a026',
+        :artist  => 'cher',
+        :method  => 'artist.search',
+    })
+    assert_not_nil result
+    assert_not_nil result.results.artistmatches
+    assert_equal 20, result.results.artistmatches.artist.size
+  end
+
+  def test_track_search
+    result = ActiveLastfm.find(:first, :params => {
+        :api_key => 'b25b959554ed76058ac220b7b2e0a026',
+        :track  => 'Belive',
+        :method  => 'track.search',
+    })
+    assert_not_nil result
+    assert_not_nil result.results.trackmatches
+    assert_equal 20, result.results.trackmatches.track.size
+  end
+
+  def test_artist_track_search
+    result = ActiveLastfm.find(:first, :params => {
+        :api_key => 'b25b959554ed76058ac220b7b2e0a026',
+        :artist  => 'cher',
+        :method  => 'artist.gettoptracks',
+    })
+    assert_not_nil result
+    assert_not_nil result.toptracks
+    assert_equal 50, result.toptracks.track.size
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: thesmith-active_lastfm
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ben Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: Last.fm client for Ruby (and Rails) based on ActiveResource
+email: ben [at] thesmith [dot] co [dot] uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- active_lastfm.gemspec
+- lib/active_lastfm.rb
+- lib/patch.rb
+has_rdoc: true
+homepage: http://github.com/thesmith/active_lastfm
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Last.fm client for Ruby (and Rails) based on ActiveResource
+test_files: 
+- test/active_lastfm_test.rb