echonest-ruby-api 0.7.0 → 0.8.0

data/fixtures/vcr_cassettes/genre_profile.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://developer.echonest.com/api/v4/genre/profile?api_key=BNOAEBT3IZYZI6WXI&format=json&name=folk%20rock
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Dec 2014 02:52:19 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Request-Id:
+      - PBbxhmaBRS6OugGjjBOgAQ
+      X-Worker-Node:
+      - 0c0ba:19427
+      X-Ratelimit-Remaining:
+      - '18'
+      Server:
+      - TornadoServer/3.1
+      X-Ratelimit-Limit:
+      - '20'
+      X-Api-Key:
+      - BNOAEBT3IZYZI6WXI
+      Cache-Control:
+      - max-age=86400
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Ratelimit-Used:
+      - '2'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0000627501223746 uproxy-3
+    body:
+      encoding: UTF-8
+      string: '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"},
+        "genres": [{"name": "folk rock"}]}}'
+    http_version: 
+  recorded_at: Thu, 18 Dec 2014 02:52:19 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/genre_search.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://developer.echonest.com/api/v4/genre/search?api_key=BNOAEBT3IZYZI6WXI&format=json&name=folk%20rock
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Dec 2014 02:58:41 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Request-Id:
+      - doVHTVmmRLWutqL39Ibnbg
+      X-Worker-Node:
+      - 962d4:23274
+      X-Ratelimit-Remaining:
+      - '17'
+      Server:
+      - TornadoServer/3.1
+      X-Ratelimit-Limit:
+      - '20'
+      X-Api-Key:
+      - BNOAEBT3IZYZI6WXI
+      Cache-Control:
+      - max-age=86400
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Ratelimit-Used:
+      - '3'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0000627501223746 uproxy-2
+    body:
+      encoding: UTF-8
+      string: '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"},
+        "start": 0, "genres": [{"name": "folk rock"}], "total": 1}}'
+    http_version: 
+  recorded_at: Thu, 18 Dec 2014 02:58:41 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/genre_similar.yml

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://developer.echonest.com/api/v4/genre/similar?api_key=BNOAEBT3IZYZI6WXI&format=json&name=folk%20rock
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Dec 2014 02:58:41 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Request-Id:
+      - EqhJ+djOS3yrOsfpCYjnng
+      X-Worker-Node:
+      - 0c0ba:19426
+      X-Ratelimit-Remaining:
+      - '19'
+      Server:
+      - TornadoServer/3.1
+      X-Ratelimit-Limit:
+      - '20'
+      X-Api-Key:
+      - BNOAEBT3IZYZI6WXI
+      Cache-Control:
+      - max-age=86400
+      Access-Control-Allow-Origin:
+      - '*'
+      X-Ratelimit-Used:
+      - '1'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0000627501223746 uproxy-2
+    body:
+      encoding: UTF-8
+      string: '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"},
+        "start": 0, "genres": [{"name": "singer-songwriter", "similarity": 0.70833299999999999},
+        {"name": "mellow gold", "similarity": 0.60763900000000004}, {"name": "traditional
+        folk", "similarity": 0.5}, {"name": "roots rock", "similarity": 0.45833299999999999},
+        {"name": "folk", "similarity": 0.42708299999999999}, {"name": "soft rock",
+        "similarity": 0.42013899999999998}, {"name": "country rock", "similarity":
+        0.38888899999999998}, {"name": "british folk", "similarity": 0.36805599999999999},
+        {"name": "folk-pop", "similarity": 0.36111100000000002}, {"name": "folk christmas",
+        "similarity": 0.23958299999999999}, {"name": "classic rock", "similarity":
+        0.190972}, {"name": "rock", "similarity": 0.17361099999999999}, {"name": "album
+        rock", "similarity": 0.17013900000000001}, {"name": "psychedelic rock", "similarity":
+        0.16319400000000001}, {"name": "british blues", "similarity": 0.125}], "total":
+        17}}'
+    http_version: 
+  recorded_at: Thu, 18 Dec 2014 02:58:41 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/similar_artists.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://developer.echonest.com/api/v4/artist/similar?api_key=BNOAEBT3IZYZI6WXI&format=json&name=Weezer&results=10
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 11 Nov 2014 02:35:10 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Request-Id:
+      - DO3eFGEYQpyngza8OtSZ4w
+      X-Worker-Node:
+      - 322a7:4365
+      X-Ratelimit-Remaining:
+      - '19'
+      Server:
+      - TornadoServer/3.1
+      X-Ratelimit-Limit:
+      - '20'
+      X-Api-Key:
+      - BNOAEBT3IZYZI6WXI
+      Cache-Control:
+      - max-age=86400
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Ratelimit-Used:
+      - '1'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0000627501223746 uproxy-3
+    body:
+      encoding: UTF-8
+      string: '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"},
+        "artists": [{"id": "ARQOST01187B9AC91A", "name": "Rivers Cuomo"}, {"id": "ARBMR171187B989A5E",
+        "name": "The Rentals"}, {"id": "ARP7ILI1187B9AE9F7", "name": "Phantom Planet"},
+        {"id": "AR6OJYP1187B9AE997", "name": "Jimmy Eat World"}, {"id": "ARDBSFT1187B9AC9C1",
+        "name": "Fountains of Wayne"}, {"id": "ARMR7TU1187FB37128", "name": "that
+        dog."}, {"id": "ARBAN8S1187FB4D22F", "name": "Ben Folds Five"}, {"id": "ARM454O1187B9B72B0",
+        "name": "Superdrag"}, {"id": "ARH9ZEH1187B98E01F", "name": "Harvey Danger"},
+        {"id": "ARXDFN01187B9AE80E", "name": "The Presidents of the United States
+        of America"}]}}'
+    http_version: 
+  recorded_at: Tue, 11 Nov 2014 02:35:09 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/suggest.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://developer.echonest.com/api/v4/artist/suggest?api_key=BNOAEBT3IZYZI6WXI&format=json&name=Weezer
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 01 Dec 2014 11:18:28 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Request-Id:
+      - BPbKUDVjTxqqVNFViXHnNw
+      X-Worker-Node:
+      - 89619:11853
+      X-Ratelimit-Remaining:
+      - '19'
+      Server:
+      - TornadoServer/3.1
+      X-Ratelimit-Limit:
+      - '20'
+      X-Api-Key:
+      - BNOAEBT3IZYZI6WXI
+      Cache-Control:
+      - max-age=86400
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Ratelimit-Used:
+      - '1'
+      Connection:
+      - Keep-alive
+      Keep-Alive:
+      - timeout=15, max=100
+      Via:
+      - 1.1 ID-0000627501223746 uproxy-2
+    body:
+      encoding: UTF-8
+      string: '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"},
+        "artists": [{"id": "AR633SY1187B9AC3B9", "name": "Weezer"}, {"id": "ARRLJLF13221695F30",
+        "name": "Weezer, Hayley Williams"}, {"id": "ARHVIPZ122CC3B2537", "name": "Weezer
+        Tribute"}, {"id": "ARGGYKM13365906CDC", "name": "Weezer/Hayley Williams"},
+        {"id": "ARFLKGR13C1C2A6C75", "name": "Weezer Rasca"}, {"id": "AROXBRK148E394961D",
+        "name": "Jane Weezer"}, {"id": "ARTHPBI13A23CD07FD", "name": "Weezer / Hayley
+        Williams"}, {"id": "ARWHDKF12AF7D9BEBF", "name": "Grease Weezer"}, {"id":
+        "ARIVGRW134198DDE27", "name": "Matt Sharp (of Weezer"}, {"id": "ARIAWPS13C1C298E1A",
+        "name": "Weezer Rascal"}]}}'
+    http_version: 
+  recorded_at: Mon, 01 Dec 2014 11:18:28 GMT
+recorded_with: VCR 2.9.3

data/lib/echonest-ruby-api.rb

@@ -3,6 +3,7 @@ require 'echonest-ruby-api/artist'
 require 'echonest-ruby-api/song'
 require 'echonest-ruby-api/error'
 require 'echonest-ruby-api/playlist'
+require 'echonest-ruby-api/genre'
 
 module Echonest
 

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

@@ -52,11 +52,11 @@ module Echonest
         Video.new(title: v[:title], site: v[:site], url: v[:url], date_found: v[:date_found], image_url: v[:image_url])
       end
     end
-    
+
     def urls
       get_response(name: @name)[:urls]
     end
-    
+
     def familiarity
       response = get_response(name: @name)
       response[entity_name.to_sym][__method__.to_sym]
@@ -95,6 +95,24 @@ module Echonest
       artists
     end
 
+    def similar(options = { results: 20 })
+      artists = []
+      response = get('artist/similar', {name: @name, results: options[:results]})
+      response[:artists].each do |a|
+        artists << a
+      end
+      return artists
+    end
+
+    def suggest(options = {})
+      options = {name: @name}.merge(options)
+      artists = []
+      get_response(options)[:artists].each do |a|
+        artists << Artist.new(@api_key, a[:name], a[:foreign_ids], a[:id])
+      end
+      artists
+    end
+
     def top_hottt(options = {})
       artists = []
       get_response(options)[:artists].each do |a|

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

@@ -23,20 +23,6 @@ module Echonest
       "#{ entity_name }/#{ calling_method }"
     end
 
-    # Gets the base URI for all API calls
-    #
-    # Returns a String
-    def self.base_uri
-      "http://developer.echonest.com/api/v#{ Base.version }/"
-    end
-
-    # The current version of the Echonest API to be supported.
-    #
-    # Returns a Fixnum
-    def self.version
-      4
-    end
-
     # Performs a simple HTTP get on an API endpoint.
     #
     # Examples:
@@ -51,21 +37,7 @@ module Echonest
     #
     # Returns a response as a Hash
     def get(endpoint, options = {})
-      options.merge!(api_key: @api_key,
-                           format: "json")
-
-      httparty_options = { query_string_normalizer: HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER,
-                           query: options }
-
-      response = HTTParty.get("#{ Base.base_uri }#{ endpoint }", httparty_options)
-      json = MultiJson.load(response.body, symbolize_keys: true)
-      response_code = json[:response][:status][:code]
-
-      if response_code.eql?(0)
-        json[:response]
-      else
-        raise Echonest::Error.new(response_code, response), "Error code #{ response_code }"
-      end
+      Base.get_api_endpoint(@api_key, endpoint, options)
     end
 
     # Cross-platform way of finding an executable in the $PATH.
@@ -82,5 +54,37 @@ module Echonest
       return nil
     end
 
+    # Gets the base URI for all API calls
+    #
+    # Returns a String
+    def self.base_uri
+      "http://developer.echonest.com/api/v#{version}/"
+    end
+
+    # Gets an arbitrary Echonest endpoint
+    def self.get_api_endpoint(api_key, endpoint, options = {})
+      options.merge!(api_key: api_key,
+                           format: "json")
+      httparty_options = { query_string_normalizer: HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER,
+                           query: options }
+
+      response = HTTParty.get("#{ base_uri }#{ endpoint }", httparty_options)
+      json = MultiJson.load(response.body, symbolize_keys: true)
+      response_code = json[:response][:status][:code]
+
+      if response_code.eql?(0)
+        json[:response]
+      else
+        error = Echonest::Error.new(response_code, response)
+        raise error, "Error code #{response_code}: #{error.description}"
+      end
+    end
+
+    # The current version of the Echonest API to be supported.
+    #
+    # Returns a Fixnum
+    def self.version
+      4
+    end
   end
 end