active_lastfm 1.0.0 → 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/lib/active_lastfm.rb

@@ -2,12 +2,14 @@ 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/'
-  # This abstract base-class extends ActiveResource::Base to make requests to last.fm
-  # Based largely on the ActiveYouTube examples found at:
-  # - http://www.quarkruby.com/2008/1/15/activeresource-and-youtube
-  # - http://www.quarkruby.com/2008/3/11/consume-non-rails-style-rest-apis
 
   class << self
     ## Remove format from the url.

data/test/active_lastfm_test.rb

@@ -1,3 +1,4 @@
+$:.unshift "#{File.dirname(__FILE__)}/../test"
 require 'abstract_unit'
 require 'active_lastfm'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: active_lastfm
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Ben Smith
-autorequire: activeresource
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-02-03 00:00:00 +00:00
+date: 2008-10-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,21 +23,23 @@ dependencies:
         version: 2.0.2
     version: 
 description: Last.fm client for Ruby (and Rails) based on ActiveResource
-email: ben@thesmith.co.uk
+email: ben [at] thesmith [dot] co [dot] uk
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - lib/active_lastfm.rb
 - lib/patch.rb
-has_rdoc: false
-homepage: http://thesmith.co.uk/
+- README
+has_rdoc: true
+homepage: http://github.com/thesmith/active_lastfm
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -60,6 +62,4 @@ signing_key:
 specification_version: 2
 summary: Last.fm client for Ruby (and Rails) based on ActiveResource
 test_files: 
-- test/abstract_unit.rb
 - test/active_lastfm_test.rb
-- test/setter_trap.rb

data/test/abstract_unit.rb

@@ -1,26 +0,0 @@
-require 'test/unit'
-require 'rubygems'
-
-$:.unshift "#{File.dirname(__FILE__)}/../lib"
-require 'active_resource'
-require 'active_resource/http_mock'
-
-$:.unshift "#{File.dirname(__FILE__)}/../test"
-require 'setter_trap'
-
-ActiveResource::Base.logger = Logger.new("#{File.dirname(__FILE__)}/debug.log")
-
-def uses_gem(gem_name, test_name, version = '> 0')
-  gem gem_name.to_s, version
-  require gem_name.to_s
-  yield
-rescue LoadError
-  $stderr.puts "Skipping #{test_name} tests. `gem install #{gem_name}` and try again."
-end
-
-# Wrap tests that use Mocha and skip if unavailable.
-unless defined? uses_mocha
-  def uses_mocha(test_name, &block)
-    uses_gem('mocha', test_name, '>= 0.5.5', &block)
-  end
-end

data/test/setter_trap.rb

@@ -1,27 +0,0 @@
-class SetterTrap < ActiveSupport::BasicObject
-  class << self
-    def rollback_sets(obj)
-      returning yield(setter_trap = new(obj)) do
-        setter_trap.rollback_sets
-      end
-    end
-  end
-
-  def initialize(obj)
-    @cache = {}
-    @obj = obj
-  end
-
-  def respond_to?(method)
-    @obj.respond_to?(method)
-  end
-
-  def method_missing(method, *args, &proc)
-    @cache[method] ||= @obj.send($`) if method.to_s =~ /=$/
-    @obj.send method, *args, &proc
-  end
-
-  def rollback_sets
-    @cache.each { |k, v| @obj.send k, v }
-  end
-end