echonest-ruby-api 0.1.2 → 0.1.5

data/lib/echonest-ruby-api.rb

@@ -2,6 +2,7 @@ require "echonest-ruby-api/version"
 require 'echonest-ruby-api/artist'
 require 'echonest-ruby-api/song'
 require 'echonest-ruby-api/error'
+require 'echonest-ruby-api/playlist'
 
 module Echonest
 

data/lib/echonest-ruby-api/artist.rb

@@ -3,18 +3,18 @@ require "bundler/setup"
 require_relative 'base'
 require_relative 'blog'
 require_relative 'biography'
+require_relative 'foreign_id'
 
 module Echonest
 
   class Artist < Echonest::Base
 
-    def initialize(api_key, name = nil)
+    attr_accessor :id, :name, :foreign_ids
+
+    def initialize(api_key, name = nil, foreign_ids = nil)
       @name = name
       @api_key = api_key
-    end
-
-    def name
-      @name
+      @foreign_ids = ForeignId.parse_array(foreign_ids) if foreign_ids
     end
 
     def biographies(options = { results: 1 })
@@ -58,6 +58,15 @@ module Echonest
       get_response[:genres]
     end
 
+    def search(options = {})
+      options = {name: @name}.merge(options)
+      artists = []
+      get_response(options)[:artists].each do |a|
+        artists << Artist.new(@api_key, a[:name], a[:foreign_ids])
+      end
+      artists
+    end
+
     def songs
       songs = []
       get_response(name: @name)[:songs].each do |s|

data/lib/echonest-ruby-api/foreign_id.rb

@@ -0,0 +1,18 @@
+class ForeignId
+
+  attr_accessor :catalog, :foreign_id, :catalog_id
+
+  def initialize(options = {})
+    @catalog = options[:catalog]
+    @foreign_id = options[:foreign_id]
+    @catalog_id = foreign_id.split(":").last
+  end
+
+  def self.parse_array(array = [])
+    foreign_ids = []
+    array.each do |fid|
+      foreign_ids << ForeignId.new(fid)
+    end
+    foreign_ids
+  end
+end

data/lib/echonest-ruby-api/playlist.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+require "bundler/setup"
+require_relative 'base'
+
+module Echonest
+  
+  class Playlist < Echonest::Base
+
+    def initialize(api_key, artist) 
+      @api_key = api_key
+      @artist = artist
+      @type = 'artist-radio'
+      response = get('playlist/dynamic/create', 
+        { artist: @artist, type: @type })
+      @session_id = response[:session_id]
+    end
+
+    def next
+      response = get('playlist/dynamic/next', { session_id: session_id })
+      artist = Echonest::Artist.new(@api_key, response[:songs].first[:artist_name])
+      { :artist => artist, :track => response[:songs].first[:title] }
+    end
+
+    def session_id
+      @session_id
+    end
+
+  end
+  
+end

data/lib/echonest-ruby-api/version.rb

@@ -1,3 +1,3 @@
 module Echonest
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/spec/artist_spec.rb

@@ -15,8 +15,10 @@ describe Echonest::Artist do
   describe '#entity_name' do
 
     it 'should always return artist' do
-      a = Echonest::Artist.new('Weezer', '12345')
-      a.entity_name.should eql 'artist'
+      VCR.use_cassette('entity_name') do
+        a = Echonest::Artist.new('Weezer', '12345')
+        a.entity_name.should eql 'artist'
+      end
     end
 
   end
@@ -24,18 +26,24 @@ describe Echonest::Artist do
   describe '#biographies' do
 
     it 'should download a specified number of biographies' do
-      create_valid_artist
-      @a.biographies(results: 10).count.should be 10
+      VCR.use_cassette('biographies') do
+        create_valid_artist
+        @a.biographies(results: 10).count.should be 10
+      end
     end
 
     it 'should return one biography by default' do
-      create_valid_artist
-      @a.biographies.count.should be 1
+      VCR.use_cassette('single_biography') do
+        create_valid_artist
+        @a.biographies.count.should be 1
+      end
     end
 
     it 'should deal gracefully with an invalid API key' do
-      a = Echonest::Artist.new('Weezer', 'THISISNOTAKEY')
-      expect { a.biographies }.to raise_error(Echonest::Error)
+      VCR.use_cassette('invalid_api_key_error') do
+        a = Echonest::Artist.new('Weezer', 'THISISNOTAKEY')
+        expect { a.biographies }.to raise_error(Echonest::Error)
+      end
     end
 
   end
@@ -43,13 +51,17 @@ describe Echonest::Artist do
   describe '#blogs' do
 
     it 'should download a specified number of blogs' do
-      create_valid_artist
-      @a.blogs(results: 10).count.should be 10
+      VCR.use_cassette('ten_blogs') do
+        create_valid_artist
+        @a.blogs(results: 10).count.should be 10
+      end
     end
 
     it 'should return one blog by default' do
-      create_valid_artist
-      @a.blogs.count.should be 1
+      VCR.use_cassette('blogs') do
+        create_valid_artist
+        @a.blogs.count.should be 1
+      end
     end
 
   end
@@ -57,8 +69,10 @@ describe Echonest::Artist do
   describe '#familiarity' do
 
     it 'should allow us to find out how familiar an artist is' do
-      create_valid_artist
-      @a.familiarity.should be_a Float
+      VCR.use_cassette('familiarity') do
+        create_valid_artist
+        @a.familiarity.should be_a Float
+      end
     end
 
   end
@@ -66,8 +80,10 @@ describe Echonest::Artist do
   describe '#hotttnesss' do
 
     it 'should allow us to find out how hotttt an artist is' do
-      create_valid_artist
-      @a.hotttnesss.should be_a Float
+      VCR.use_cassette('hotttnesss') do
+        create_valid_artist
+        @a.hotttnesss.should be_a Float
+      end
     end
 
   end
@@ -75,14 +91,18 @@ describe Echonest::Artist do
   describe '#images' do
 
     it 'should allow us to get an array of urls' do
-      create_valid_artist
-      @a.images.should be_a Array
+      VCR.use_cassette('images') do
+        create_valid_artist
+        @a.images.should be_a Array
+      end
     end
 
     it 'should only return urls in the array' do
-      create_valid_artist
-      @a.images.each do |i|
-        i.should match(/^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/)
+      VCR.use_cassette('images') do
+        create_valid_artist
+        @a.images.each do |i|
+          i.should match(/^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/)
+        end
       end
     end
 
@@ -91,30 +111,65 @@ describe Echonest::Artist do
   describe '#list_genres' do
 
     it 'should return an array of acceptable genres' do
-      create_valid_artist
-      @a.list_genres.should be_a Array
+      VCR.use_cassette('list_genres') do
+        create_valid_artist
+        @a.list_genres.should be_a Array
+      end
     end
 
     it 'should return an array in the correct format' do
-      create_valid_artist
-      @a.list_genres.each do |g|
-        g[:name].should be_a String
+      VCR.use_cassette('list_genres') do
+        create_valid_artist
+        @a.list_genres.each do |g|
+          g[:name].should be_a String
+        end
       end
     end
 
   end
 
+  describe '#search' do
+    it 'should return an Array of artists' do
+      VCR.use_cassette('search') do
+        create_valid_artist
+        @a.search.should be_a Array
+      end
+    end
+
+    it 'should return an Artist object for each result' do
+      VCR.use_cassette('search') do
+        create_valid_artist
+        @a.search.each do |k|
+          k.class.should be Echonest::Artist
+        end
+      end
+    end
+
+    it 'should search the specified bucket' do
+      VCR.use_cassette('search_2') do
+        create_valid_artist
+        results = @a.search(bucket: "id:musicbrainz")
+        foreign_id = results.first.foreign_ids.first
+        foreign_id.catalog.should eq("musicbrainz")
+      end
+    end
+  end
+
   describe '#songs' do
 
     it 'should return an Array of a Hash of songs' do
-      create_valid_artist
-      @a.songs.should be_a Array
+      VCR.use_cassette('songs') do
+        create_valid_artist
+        @a.songs.should be_a Array
+      end
     end
 
     it 'should return a valid hash for each song' do
-      create_valid_artist
-      @a.songs.each do |k|
-        k.should be_a Hash
+      VCR.use_cassette('songs') do
+        create_valid_artist
+        @a.songs.each do |k|
+          k.should be_a Hash
+        end
       end
     end
 

data/spec/foreign_id_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ForeignId do
+
+    it 'should parse the catalog id' do
+      foreign_id = ForeignId.new(catalog: "musicbrainz", foreign_id: "musicbrainz:artist:6fe07aa5-fec0-4eca-a456-f29bff451b04")
+      foreign_id.catalog_id.should eq("6fe07aa5-fec0-4eca-a456-f29bff451b04")
+    end
+
+    it 'should parse an array of results' do
+      results = [{catalog: "musicbrainz", foreign_id: "123"},{catalog: "musicbrainz", foreign_id: "456"}]
+      ForeignId.parse_array(results).count.should be 2
+    end
+
+end

data/spec/playlist_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Echonest::Playlist do
+
+  describe '#initialize' do
+
+    it 'should iniaitlize with an API key and an artist ' do
+      VCR.use_cassette('playlist') do
+        seed = Echonest::Playlist.new('BNOAEBT3IZYZI6WXI', 'Weezer')
+        seed.should be
+      end
+    end
+
+  end
+
+  describe '#session_id' do
+
+    it 'should set a playlist session ID' do
+      VCR.use_cassette('playlist') do
+        seed = Echonest::Playlist.new('BNOAEBT3IZYZI6WXI', 'Weezer')
+        seed.session_id.should be_a String
+      end
+    end
+
+  end
+
+  describe '#next' do
+
+    it 'should return a Hash object' do
+      VCR.use_cassette('playlist_next') do
+        seed = Echonest::Playlist.new('BNOAEBT3IZYZI6WXI', 'Weezer')
+        seed.next.should be_a Hash
+      end
+    end
+
+    it 'should include the next Song' do
+      VCR.use_cassette('playlist_next_2') do
+        seed = Echonest::Playlist.new('BNOAEBT3IZYZI6WXI', 'Weezer')
+        seed.next[:artist].should be_a Echonest::Artist
+        seed.next[:track].should be_a String
+      end
+    end
+
+  end
+
+end
+

data/spec/song_spec.rb

@@ -11,40 +11,44 @@ describe Echonest::Song do
   describe '#search' do
 
     it 'should return an array of tracks' do
-      a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
-      options = { title: 'Hello' }
-      a.search(options).should be_a Array
+      VCR.use_cassette('song_search') do
+        a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+        options = { title: 'Hello' }
+        a.search(options).should be_a Array
+      end
     end
 
     it 'should have the expected parameters' do
-      a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
-      options = { title: 'Hello' }
-      a.search(options).each do |song|
-        song.keys.should include :id, :artist_id, :artist_name, :title
+      VCR.use_cassette('song_search') do
+        a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+        options = { title: 'Hello' }
+        a.search(options).each do |song|
+          song.keys.should include :id, :artist_id, :artist_name, :title
+        end
       end
     end
 
     it 'should happily find slow songs' do
-      a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
-      options = { max_tempo: 60 }
-      a.search(options).each do |song|
-        song.keys.should include :id, :artist_id, :artist_name, :title
+      VCR.use_cassette('song_search_slow') do
+        a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+        options = { max_tempo: 60 }
+        a.search(options).each do |song|
+          song.keys.should include :id, :artist_id, :artist_name, :title
+        end
       end
     end
-    
-    # TODO: Write some comprehensive tests to make sure this breaks
-    # if the API ever changes.
-    # http://developer.echonest.com/docs/v4/song.html#search
 
   end
 
   describe '#identify' do
 
     it 'should identify billie jean with ease' do
-      a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
-      result = a.identify('eJxVlIuNwzAMQ1fxCDL133-xo1rnGqNAEcWy_ERa2aKeZmW9ustWVYrXrl5bthn_laFkzguNWpklEmoTB74JKYZSPlbJ0sy9fQrsrbEaO9W3bsbaWOoK7IhkHFaf_ag2d75oOQSZczbz5CKA7XgTIBIXASvFi0A3W8pMUZ7FZTWTVbujCcADlQ_f_WbdRNJ2vDUwSF0EZmFvAku_CVy440fgiIvArWZZWoJ7GWd-CVTYC5FCFI8GQdECdROE20UQfLoIUmhLC7IiByF1gzbAs3tsSKctyC76MPJlHRsZ5qhSQhu_CJFcKtW4EMrHSIrpTGLFqsdItj1H9JYHQYN7W2nkC6GDPjZTAzL9dx0fS4M1FoROHh9YhLHWdRchQSd_CLTpOHkQQP3xQsA2-sLOUD7CzxU0GmHVdIxh46Oide0NrNEmjghG44Ax_k2AoDHsiV6WsiD6OFm8y-0Lyt8haDBBzeMlAnTuuGYIB4WA2lEPAWbdeOabgFN6TQMs6ctLA5fHyKMBB0veGrjPfP00IAlWNm9n7hEh5PiYYBGKQDP-x4F0CL8HkhoQnRWN997JyEpnHFR7EhLPQMZmgXS68hsHktEVErranvSSR2VwfJhQCnkuwhBUcINNY-xu1pmw3PmBqU9-8xu0kiF1ngOa8vwBSSzzNw==')
-      result.should be_a Array
-      result.first[:artist_name].should eql 'Michael Jackson'
+      VCR.use_cassette('song_identify') do
+        a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+        result = a.identify('eJxVlIuNwzAMQ1fxCDL133-xo1rnGqNAEcWy_ERa2aKeZmW9ustWVYrXrl5bthn_laFkzguNWpklEmoTB74JKYZSPlbJ0sy9fQrsrbEaO9W3bsbaWOoK7IhkHFaf_ag2d75oOQSZczbz5CKA7XgTIBIXASvFi0A3W8pMUZ7FZTWTVbujCcADlQ_f_WbdRNJ2vDUwSF0EZmFvAku_CVy440fgiIvArWZZWoJ7GWd-CVTYC5FCFI8GQdECdROE20UQfLoIUmhLC7IiByF1gzbAs3tsSKctyC76MPJlHRsZ5qhSQhu_CJFcKtW4EMrHSIrpTGLFqsdItj1H9JYHQYN7W2nkC6GDPjZTAzL9dx0fS4M1FoROHh9YhLHWdRchQSd_CLTpOHkQQP3xQsA2-sLOUD7CzxU0GmHVdIxh46Oide0NrNEmjghG44Ax_k2AoDHsiV6WsiD6OFm8y-0Lyt8haDBBzeMlAnTuuGYIB4WA2lEPAWbdeOabgFN6TQMs6ctLA5fHyKMBB0veGrjPfP00IAlWNm9n7hEh5PiYYBGKQDP-x4F0CL8HkhoQnRWN997JyEpnHFR7EhLPQMZmgXS68hsHktEVErranvSSR2VwfJhQCnkuwhBUcINNY-xu1pmw3PmBqU9-8xu0kiF1ngOa8vwBSSzzNw==')
+        result.should be_a Array
+        result.first[:artist_name].should eql 'Michael Jackson'
+      end
     end
 
     it 'should raise ArgumentError if the code is blank' do

data/spec/spec_helper.rb

@@ -2,7 +2,16 @@ require 'rubygems'
 require 'bundler/setup'
 require_relative '../lib/echonest-ruby-api/base.rb'
 require 'echonest-ruby-api'
+require 'vcr'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
 
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  # TODO: Get rid of this when possible!
+  c.allow_http_connections_when_no_cassette = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echonest-ruby-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -107,6 +107,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple ruby wrapper around the Echonest API
 email:
 - max.woolf@boxuk.com
@@ -115,23 +147,46 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - echonest-ruby-api.gemspec
+- fixtures/vcr_cassettes/biographies.yml
+- fixtures/vcr_cassettes/blogs.yml
+- fixtures/vcr_cassettes/familiarity.yml
+- fixtures/vcr_cassettes/hotttnesss.yml
+- fixtures/vcr_cassettes/images.yml
+- fixtures/vcr_cassettes/invalid_api_key_error.yml
+- fixtures/vcr_cassettes/list_genres.yml
+- fixtures/vcr_cassettes/playlist.yml
+- fixtures/vcr_cassettes/playlist_next.yml
+- fixtures/vcr_cassettes/playlist_next_2.yml
+- fixtures/vcr_cassettes/search.yml
+- fixtures/vcr_cassettes/search_2.yml
+- fixtures/vcr_cassettes/single_biography.yml
+- fixtures/vcr_cassettes/song_identify.yml
+- fixtures/vcr_cassettes/song_search.yml
+- fixtures/vcr_cassettes/song_search_slow.yml
+- fixtures/vcr_cassettes/songs.yml
+- fixtures/vcr_cassettes/ten_blogs.yml
 - lib/echonest-ruby-api.rb
 - lib/echonest-ruby-api/artist.rb
 - lib/echonest-ruby-api/base.rb
 - lib/echonest-ruby-api/biography.rb
 - lib/echonest-ruby-api/blog.rb
 - lib/echonest-ruby-api/error.rb
+- lib/echonest-ruby-api/foreign_id.rb
+- lib/echonest-ruby-api/playlist.rb
 - lib/echonest-ruby-api/song.rb
 - lib/echonest-ruby-api/version.rb
 - spec/artist_spec.rb
 - spec/base_spec.rb
 - spec/error_spec.rb
+- spec/foreign_id_spec.rb
+- spec/playlist_spec.rb
 - spec/song_spec.rb
 - spec/spec_helper.rb
 - tmp/rspec_guard_result
@@ -163,6 +218,8 @@ test_files:
 - spec/artist_spec.rb
 - spec/base_spec.rb
 - spec/error_spec.rb
+- spec/foreign_id_spec.rb
+- spec/playlist_spec.rb
 - spec/song_spec.rb
 - spec/spec_helper.rb
 has_rdoc: