nestling 0.0.1 → 0.1.0

data/LICENSE

@@ -17,3 +17,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+

data/README.md

@@ -75,9 +75,14 @@ Additional information passed by EchoNest for collections (such as `results`,
 too:
 
     blogs.each do |blog|
-      # Some smart code
+      puts blog.name
     end
 
+Nestling will also convert timestamps to Ruby DateTime objects for you:
+
+    nestling.artist("Radiohead").blogs[0].date_found
+    # => #<DateTime: 2011-09-09T20:49:16+00:00 (53045590339/21600,0/1,2299161)>
+
 ## WHAT'S MISSING AT THE MOMENT?
 
 - Catalog API Methods

data/Rakefile

@@ -6,3 +6,4 @@ Rake::TestTask.new do |t|
 end
 
 task :default => :test
+

data/lib/nestling/artist.rb

@@ -5,7 +5,6 @@ module Nestling
     METHOD_PREFIX = "artist/"
 
     METHODS = {
-      :audio       => { :collection => true },
       :biographies => { :collection => true },
       :blogs       => { :collection => true },
       :familiarity => { :collection => false, :key => "artist" },
@@ -27,6 +26,8 @@ module Nestling
       :video       => { :collection => true }
     }
 
+    define_api_methods METHODS
+
     def initialize(name, client)
       name.kind_of?(::Hash) ? @id = name[:id] : @name = name
       super(client)

data/lib/nestling/base.rb

@@ -5,43 +5,60 @@ module Nestling
     METHOD_PREFIX = ""
     METHODS       = {}
 
-    def initialize(client)
-      @client = client
-    end
-
-    def method_missing(meth, *args, &block)
-      unless method = self.class::METHODS[meth]
-        return super(meth, *args, &block)
+    class << self
+      def define_api_methods(methods)
+        methods.each do |key, definition|
+          if definition[:collection]
+            define_api_method_returning_collection(key, definition)
+          else
+            define_api_method(key, definition)
+          end
+        end
       end
 
-      opts  = args[0] || {}
-      key   = meth.to_s
-      query = self.class::METHOD_PREFIX + key
+      private
 
-      resp    = get(query, options(opts))["response"]
-      payload = resp[method[:key] || key]
+      def define_api_method_returning_collection(key, definition)
+        define_method key do |*args|
+          resp = get_request(key, args[0])
+          hashes = convert_hashes(resp[definition[:key] || key.to_s])
+          Collection.new(resp).push(hashes).flatten!
+        end
+      end
 
-      if method[:collection]
-        Collection.new(resp["total"], resp["start"],
-                       resp["session_id"]).tap do |c|
-          payload.each { |h| c << convert(h) }
+      def define_api_method(key, definition)
+        define_method key do |*args|
+          resp = get_request(key, args[0])
+          convert_hash(resp[definition[:key] || key.to_s])
         end
-      else
-        convert(payload)
       end
     end
 
+    def initialize(client)
+      @client = client
+    end
+
     private
 
-    def convert(hash)
-      hash = Hash.new(hash)
+    def get_request(key, opts)
+      opts ||= {}
+      query = self.class::METHOD_PREFIX + key.to_s
+      get(query, options(opts))["response"]
+    end
+
+    def convert_hashes(hashes)
+      hashes.map { |hash| convert_hash(hash) }
+    end
+
+    def convert_hash(hash)
+      hash = Nestling::Hash.new(hash).symbolize_keys!
 
       hash.each do |key, value|
         if value.kind_of?(String) &&
           value.match(/\d{4}(-\d\d){2}T\d{2}(:\d\d){2}/)
           hash[key] = DateTime.parse(value)
         elsif value.kind_of?(::Hash)
-          hash[key] = convert(value)
+          hash[key] = convert_hash(value)
         end
       end
     end

data/lib/nestling/client.rb

@@ -38,7 +38,7 @@ module Nestling
       hash = JSON.parse(data)
 
       if (code = hash["response"]["status"]["code"].to_i) != 0
-        raise Nestling::ERRNO[code], hash["response"]["status"]["message"]
+        raise ERRNO[code], hash["response"]["status"]["message"]
       end
 
       hash

data/lib/nestling/collection.rb

@@ -1,11 +1,13 @@
 module Nestling
   class Collection < Array
-    attr_accessor :results, :start, :session_id
+    attr_accessor :results, :start, :session_id, :type
 
-    def initialize(results = nil, start = nil, session_id = nil, *args)
-      @results    = results
-      @start      = start
-      @session_id = session_id
+    def initialize(options = {}, *args)
+      options = Nestling::Hash.new(options).symbolize_keys!
+      @results    = options[:results] || options[:total]
+      @start      = options[:start]
+      @session_id = options[:session_id]
+      @type       = options[:type]
       super *args
     end
   end

data/lib/nestling/hash.rb

@@ -1,7 +1,7 @@
 module Nestling
   class Hash < ::Hash
     def initialize(hash = nil, *args)
-      self.merge!(hash).symbolize_keys! if hash
+      self.merge!(hash) if hash
       super *args
     end
 
@@ -9,8 +9,6 @@ module Nestling
       (val = self[meth]) ? val : super(meth, *args, &block)
     end
 
-    undef length # Property used by EchoNest API
-
     # Adapted from ActiveSupport (part of Ruby on Rails)
     # Released under the MIT license
     def symbolize_keys

data/lib/nestling/playlist.rb

@@ -7,6 +7,8 @@ module Nestling
       :dynamic      => { :collection => true,  :key => "songs" },
       :session_info => { :collection => false, :key => "terms" }
     }
+
+    define_api_methods METHODS
   end
 end
 

data/lib/nestling/song.rb

@@ -7,6 +7,8 @@ module Nestling
       :profile  => { :collection => true, :key => "songs" },
       :identify => { :collection => true, :key => "songs" }
     }
+
+    define_api_methods METHODS
   end
 end
 

data/lib/nestling/track.rb

@@ -5,6 +5,8 @@ module Nestling
     METHODS = {
       :profile  => { :collection => false, :key => "track" },
     }
+
+    define_api_methods METHODS
   end
 end
 

data/lib/nestling/version.rb

@@ -1,8 +1,8 @@
 module Nestling
   module Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 1
+    MINOR = 1
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/nestling.gemspec

@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "json", "~> 1.5.3"
-  s.add_development_dependency("mocha", "~> 0.9.12")
+  s.add_dependency "json", "~> 1.5.4"
+  s.add_development_dependency "mocha", "~> 0.9.12"
 end
 

data/test/test_artist.rb

@@ -16,12 +16,13 @@ class TestArtist < MiniTest::Unit::TestCase
         "start": 11,
         "total": 1393,
         "session_id": 123,
-        "audio": [{
+        "blogs": [{
           "title": "foo",
           "date": "2011-08-16T01:15:01"
         }]
       }}
     EOS
+    @artist = Client.new('foo').artist('bar')
   end
 
   def test_superclass
@@ -33,7 +34,7 @@ class TestArtist < MiniTest::Unit::TestCase
   end
 
   def test_number_of_methods
-    assert_equal 20, METHODS.length
+    assert_equal 19, METHODS.length
   end
 
   def test_artist_with_id
@@ -49,113 +50,127 @@ class TestArtist < MiniTest::Unit::TestCase
   end
 
   def test_passes_name
-    expect_request @collection_response, 'artist/audio', { :name => 'bar' }
-    Client.new('foo').artist('bar').audio
+    expect_request @collection_response, 'artist/blogs', { :name => 'bar' }
+    Client.new('foo').artist('bar').blogs
   end
 
   def test_passes_id
-    expect_request @collection_response, 'artist/audio', { :id => 'baz' }
-    Client.new('foo').artist(:id => 'baz').audio
-  end
-
-  def test_audio
-    assert METHODS[:audio][:collection]
-    assert_nil METHODS[:audio][:key]
+    expect_request @collection_response, 'artist/blogs', { :id => 'baz' }
+    Client.new('foo').artist(:id => 'baz').blogs
   end
 
   def test_biographies
     assert METHODS[:biographies][:collection]
     assert_nil METHODS[:biographies][:key]
+    assert @artist.respond_to?(:biographies)
   end
 
   def test_blogs
     assert METHODS[:blogs][:collection]
     assert_nil METHODS[:blogs][:key]
+    assert @artist.respond_to?(:blogs)
   end
 
   def test_familiarity
     refute METHODS[:familiarity][:collection]
     assert_equal "artist", METHODS[:familiarity][:key]
+    assert @artist.respond_to?(:familiarity)
   end
 
   def test_hotttnesss
     refute METHODS[:hotttnesss][:collection]
     assert_equal "artist", METHODS[:hotttnesss][:key]
+    assert @artist.respond_to?(:hotttnesss)
   end
 
   def test_images
     assert METHODS[:images][:collection]
     assert_nil METHODS[:images][:key]
+    assert @artist.respond_to?(:images)
   end
 
   def test_list_terms
     assert METHODS[:list_terms][:collection]
     assert_nil METHODS[:list_terms][:key]
+    assert @artist.respond_to?(:list_terms)
   end
 
   def test_news
     assert METHODS[:news][:collection]
     assert_nil METHODS[:news][:key]
+    assert @artist.respond_to?(:news)
   end
 
   def test_profile
     refute METHODS[:profile][:collection]
     assert_equal "artist", METHODS[:profile][:key]
+    assert @artist.respond_to?(:profile)
   end
 
   def test_reviews
     assert METHODS[:reviews][:collection]
     assert_nil METHODS[:reviews][:key]
+    assert @artist.respond_to?(:reviews)
   end
 
   def test_search
     assert METHODS[:search][:collection]
     assert_equal "artists", METHODS[:search][:key]
+    assert @artist.respond_to?(:search)
   end
 
   def test_extract
     assert METHODS[:extract][:collection]
     assert_equal "artist", METHODS[:extract][:key]
+    assert @artist.respond_to?(:extract)
   end
 
   def test_songs
     assert METHODS[:songs][:collection]
     assert_nil METHODS[:songs][:key]
+    assert @artist.respond_to?(:songs)
   end
 
   def test_similar
     assert METHODS[:similar][:collection]
     assert_equal "artists", METHODS[:similar][:key]
+    assert @artist.respond_to?(:similar)
   end
 
   def test_suggest
     assert METHODS[:suggest][:collection]
     assert_equal "artists", METHODS[:suggest][:key]
+    assert @artist.respond_to?(:suggest)
   end
 
   def test_terms
     assert METHODS[:terms][:collection]
     assert_nil METHODS[:terms][:key]
+    assert @artist.respond_to?(:terms)
   end
 
   def test_top_hottt
     assert METHODS[:top_hottt][:collection]
     assert_equal "artists", METHODS[:top_hottt][:key]
+    assert @artist.respond_to?(:top_hottt)
   end
 
   def test_top_terms
     assert METHODS[:top_terms][:collection]
     assert_equal "terms", METHODS[:top_terms][:key]
+    assert @artist.respond_to?(:top_terms)
   end
 
   def test_urls
     refute METHODS[:urls][:collection]
     assert_nil METHODS[:urls][:key]
+    assert @artist.respond_to?(:urls)
   end
 
   def test_video
     assert METHODS[:video][:collection]
     assert_nil METHODS[:video][:key]
+    assert @artist.respond_to?(:video)
   end
 end
 

data/test/test_base.rb

@@ -2,11 +2,14 @@ require File.join(File.dirname(__FILE__), 'helper')
 
 class BaseTest < Nestling::Base
   METHOD_PREFIX = 'test/'
+
   METHODS = {
     :omg =>  { :collection => true,  :key => "foo" },
     :bar =>  { :collection => false, :key => "baz" },
     :zomg => { :collection => false }
   }
+
+  define_api_methods METHODS
 end
 
 class TestBase < MiniTest::Unit::TestCase
@@ -73,6 +76,16 @@ class TestBase < MiniTest::Unit::TestCase
     BaseTest.new(@client).omg :foo => 'bar'
   end
 
+  def test_define_api_methods
+    assert Base.respond_to?(:define_api_methods)
+  end
+
+  def test_define_api_methods_defines_instance_methods
+    BaseTest::METHODS.each do |method|
+      assert BaseTest.method_defined?(:method)
+    end
+  end
+
   def test_converts_hash
     stub_http_get @hash_response
     hash = BaseTest.new(@client).bar

data/test/test_collection.rb

@@ -3,6 +3,30 @@ require File.join(File.dirname(__FILE__), 'helper')
 class TestErrors < MiniTest::Unit::TestCase
   include Nestling
 
+  def setup
+    @sym_options = {
+      :results    => 10,
+      :start      => 2,
+      :session_id => 123,
+      :type       => "mood"
+    }
+
+    @str_options = {
+      "results"    => 10,
+      "start"      => 2,
+      "session_id" => 123,
+      "type"       => "mood"
+    }
+
+    @str_options_with_total = {
+      "total" => 23
+    }
+
+    @sym_options_with_total = {
+      :total => 23
+    }
+  end
+
   def test_superclass
     assert_equal Collection.superclass, Array
   end
@@ -15,15 +39,25 @@ class TestErrors < MiniTest::Unit::TestCase
   end
 
   def test_collection_assigns_results
-    assert_equal 10, Collection.new(10).results
+    assert_equal 10, Collection.new(@str_options).results
+    assert_equal 10, Collection.new(@sym_options).results
+    assert_equal 23, Collection.new(@str_options_with_total).results
+    assert_equal 23, Collection.new(@sym_options_with_total).results
   end
 
-  def test_collection_assigns_results
-    assert_equal 2, Collection.new(10, 2).start
+  def test_collection_assigns_start
+    assert_equal 2, Collection.new(@str_options).start
+    assert_equal 2, Collection.new(@sym_options).start
   end
 
   def test_collection_assigns_session_id
-    assert_equal 123, Collection.new(10, 2, 123).session_id
+    assert_equal 123, Collection.new(@str_options).session_id
+    assert_equal 123, Collection.new(@sym_options).session_id
+  end
+
+  def test_collection_assigns_type
+    assert_equal "mood", Collection.new(@str_options).type
+    assert_equal "mood", Collection.new(@sym_options).type
   end
 end
 

data/test/test_hash.rb

@@ -17,13 +17,12 @@ class TestHash < MiniTest::Unit::TestCase
     h = Nestling::Hash.new
     assert_respond_to h, :symbolize_keys
     assert_respond_to h, :symbolize_keys!
-    refute_respond_to Nestling::Hash.new, :length
   end
 
   def test_initialize
     h = Nestling::Hash.new({ :foo => "bar", "bar" => :baz})
     assert_equal "bar", h[:foo]
-    assert_equal :baz, h[:bar]
+    assert_equal :baz, h["bar"]
   end
 
   def test_symbolize_keys

data/test/test_playlist.rb

@@ -5,6 +5,10 @@ class TestPlaylist < MiniTest::Unit::TestCase
 
   METHODS = Playlist::METHODS
 
+  def setup
+    @playlist = Nestling.new('foo').playlist
+  end
+
   def test_superclass
     assert_equal Base, Playlist.superclass
   end
@@ -20,17 +24,19 @@ class TestPlaylist < MiniTest::Unit::TestCase
   def test_static
     assert METHODS[:static][:collection]
     assert_equal "songs", METHODS[:static][:key]
+    assert @playlist.respond_to?(:static)
   end
 
   def test_dynamic
     assert METHODS[:dynamic][:collection]
     assert_equal "songs", METHODS[:dynamic][:key]
+    assert @playlist.respond_to?(:dynamic)
   end
 
   def test_session_info
     refute METHODS[:session_info][:collection]
     assert_equal "terms", METHODS[:session_info][:key]
+    assert @playlist.respond_to?(:session_info)
   end
 end
 
-

data/test/test_song.rb

@@ -5,6 +5,10 @@ class TestSong < MiniTest::Unit::TestCase
 
   METHODS = Song::METHODS
 
+  def setup
+    @song = Nestling.new('foo').song
+  end
+
   def test_superclass
     assert_equal Base, Song.superclass
   end
@@ -20,16 +24,19 @@ class TestSong < MiniTest::Unit::TestCase
   def test_search
     assert METHODS[:search][:collection]
     assert_equal "songs", METHODS[:search][:key]
+    assert @song.respond_to?(:search)
   end
 
   def test_profile
     assert METHODS[:profile][:collection]
     assert_equal "songs", METHODS[:profile][:key]
+    assert @song.respond_to?(:profile)
   end
 
   def test_identify
     assert METHODS[:identify][:collection]
     assert_equal "songs", METHODS[:identify][:key]
+    assert @song.respond_to?(:identify)
   end
 end
 

data/test/test_track.rb

@@ -5,6 +5,10 @@ class TestTrack < MiniTest::Unit::TestCase
 
   METHODS = Track::METHODS
 
+  def setup
+    @track = Nestling.new('foo').track
+  end
+
   def test_superclass
     assert_equal Base, Track.superclass
   end
@@ -20,7 +24,7 @@ class TestTrack < MiniTest::Unit::TestCase
   def test_profile
     refute METHODS[:profile][:collection]
     assert_equal "track", METHODS[:profile][:key]
+    assert @track.respond_to?(:profile)
   end
 end
 
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nestling
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date: 2011-09-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70312819046000 !ruby/object:Gem::Requirement
+  requirement: &70365143049080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.5.4
   type: :runtime
   prerelease: false
-  version_requirements: *70312819046000
+  version_requirements: *70365143049080
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70312819045500 !ruby/object:Gem::Requirement
+  requirement: &70365143048260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *70312819045500
+  version_requirements: *70365143048260
 description: Ruby wrapper for the EchoNest API
 email:
 - tob@tobiassvensson.co.uk
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the EchoNest API