echonest-ruby-api 0.0.5 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    echonest-ruby-api (0.0.4)
+    echonest-ruby-api (0.0.5)
       httparty
       multi_json
 

data/Guardfile

@@ -5,5 +5,4 @@ guard 'rspec', :cli => "--color --format documentation" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
-end
-
+end

data/README.md

@@ -1,7 +1,7 @@
-# echonest-ruby-api [![Code Climate](https://codeclimate.com/github/maxehmookau/echonest-ruby-api.png)](https://codeclimate.com/github/maxehmookau/echonest-ruby-api)
+# echonest-ruby-api
+[![Code Climate](https://codeclimate.com/github/maxehmookau/echonest-ruby-api.png)](https://codeclimate.com/github/maxehmookau/echonest-ruby-api)
 [![Build Status](https://travis-ci.org/maxehmookau/echonest-ruby-api.png)](https://travis-ci.org/maxehmookau/echonest-ruby-api)
 [![Dependency Status](https://gemnasium.com/maxehmookau/echonest-ruby-api.png)](https://gemnasium.com/maxehmookau/echonest-ruby-api)
-TODO: Everything. (also, come up with a cool name)
 
 ## Installation
 
@@ -17,7 +17,6 @@ Or install it yourself as:
 
     $ gem install echonest-ruby-api
 
-*That said, probably don't do any of that, since nothing works yet...*
 
 ## Usage
 
@@ -25,18 +24,46 @@ Require the gem in your file:
 
     require 'echonest-ruby-api'
 
+### Artist
+
+
 Create an instance of an object
 
-    a = Echonest::Artist.new('Weezer', 'YOUR-API-KEY')
+    artist = Echonest::Artist.new('Weezer', 'YOUR-API-KEY')
+
+Then you have access to a bunch of methods:
+
+    artist.name
+    artist.biographies
+    artist.blogs
+    artist.familiarity
+    artist.hotttnesss
+    artist.images
+    artist.songs
+
+### Song
+
+Create an instance of the Song module.
+
+    song = Echonest::Song.new('YOUR-API-KEY')
+
+Then you have access to the song/search endpoint:
+*(this is where it gets clever)*
+
+    params = { mood: "sad^.5", results: 10, min_tempo: 130, max_tempo: 150 }
+    song.search(params)
+
+See the full list of params [here](http://developer.echonest.com/docs/v4/song.html#search)
+
+You can even **identify** a song simply from its fingerprint!
 
-Find out some stuff!
+Firstly generate an [Echoprint](http://echoprint.me/) code. You'll need to run and compile this for whatever platform you're using. [echonest/echoprint-codegen](https://github.com/echonest/echoprint-codegen) Then just pass the generated code to the `song.identify` method. 
 
-    a.blogs(results: 20)
-    a.biographies
+    song.idenfity(YOUR_ECHOPRINT_CODE)
 
-Calls will return the first result unless setting the `results` option.
+Checkout `spec/song_spec.rb` for an example code. 
 
-*Any valid option for echonest API calls will work as normal*
+Note that this calls the song/identify API endpoint and does *not* support other Echoprint servers.
 
 ## Contributing
 

data/lib/echonest-ruby-api.rb

@@ -1,5 +1,6 @@
 require "echonest-ruby-api/version"
-require_relative 'artist'
+require 'echonest-ruby-api/artist'
+require 'echonest-ruby-api/song'
 
 module Echonest
 

data/lib/{artist.rb → echonest-ruby-api/artist.rb}

@@ -1,8 +1,8 @@
 require "rubygems"
 require "bundler/setup"
-require 'httparty'
-require 'multi_json'
 require_relative 'base'
+require_relative 'blog'
+require_relative 'biography'
 
 module Echonest
 
@@ -17,19 +17,6 @@ module Echonest
       @name
     end
 
-    def entity_name
-      self.class.to_s.split('::').last.downcase
-    end
-
-    def get_response(options = {})
-      get(endpoint, options)
-    end
-
-    def endpoint
-      calling_method = caller[1].split('`').last[0..-2]
-      "#{ entity_name }/#{ calling_method }"
-    end
-
     def biographies(options = { results: 1 })
       response = get_response(results: options[:results], name: @name)
       biographies = []

data/lib/{base.rb → echonest-ruby-api/base.rb}

@@ -1,6 +1,5 @@
-require 'artist'
-require 'biography'
-require 'blog'
+require 'httparty'
+require 'multi_json'
 
 module Echonest
   class Base
@@ -11,6 +10,19 @@ module Echonest
       @base_uri = "http://developer.echonest.com/api/v4/"
     end
 
+    def get_response(options = {})
+      get(endpoint, options)
+    end
+
+    def entity_name
+      self.class.to_s.split('::').last.downcase
+    end
+
+    def endpoint
+      calling_method = caller[1].split('`').last[0..-2]
+      "#{ entity_name }/#{ calling_method }"
+    end
+
     # Gets the base URI for all API calls
     #
     # Returns a String
@@ -43,6 +55,7 @@ module Echonest
       options.each do |key, value|
         query_string << "#{ key }=#{ value }&"
       end
+      #puts "#{ Base.base_uri }#{ endpoint }?api_key=#{ @api_key }&format=json&#{ query_string }"
       response = HTTParty.get("#{ Base.base_uri }#{ endpoint }?api_key=#{ @api_key }&format=json&#{ query_string }")
       json = MultiJson.load(response.body, symbolize_keys: true)
       response_code = json[:response][:status][:code]

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

@@ -0,0 +1,34 @@
+require "rubygems"
+require "bundler/setup"
+require 'httparty'
+require 'multi_json'
+require_relative 'base'
+
+module Echonest
+  class Song < Echonest::Base
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def search(options = {})
+      defaults = { api_key: @api_key }
+      response = get_response(options)
+      songs = []
+      response[:songs].each do |song|
+        songs << song
+      end
+    end
+
+    def identify(code)
+      raise ArgumentError, 'Not a valid Echoprint or ENFMP fingerprint' if code.empty?
+      response = get_response(code: code)
+      results = []
+      response[:songs].each do |song|
+        results << { score: song[:score], title: song[:title], artist_name: song[:artist_name] }
+      end
+      results
+    end
+
+  end
+end

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

@@ -1,3 +1,3 @@
 module Echonest
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/artist_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'base'
 
 describe Echonest::Artist do
 

data/spec/song_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Echonest::Song do
+
+  it 'should initialize correct' do
+    a = Echonest::Song.new('abc234')
+    a.should be_a Echonest::Song
+  end
+
+  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
+    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
+      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
+      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'
+    end
+
+    it 'should raise ArgumentError if the code is blank' do
+      a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+      expect { a.identify() }.to raise_error(ArgumentError)
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'bundler/setup'
-
+require_relative '../lib/echonest-ruby-api/base.rb'
 require 'echonest-ruby-api'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echonest-ruby-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -125,18 +125,22 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
+- echonest-ruby-api-0.0.5.gem
 - echonest-ruby-api.gemspec
-- lib/artist.rb
-- lib/base.rb
-- lib/biography.rb
-- lib/blog.rb
 - 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/song.rb
 - lib/echonest-ruby-api/version.rb
 - pkg/echonest-ruby-api-0.0.1.gem
 - pkg/echonest-ruby-api-0.0.3.gem
 - pkg/echonest-ruby-api-0.0.4.gem
+- pkg/echonest-ruby-api-0.0.5.gem
 - spec/artist_spec.rb
 - spec/base_spec.rb
+- spec/song_spec.rb
 - spec/spec_helper.rb
 - tmp/rspec_guard_result
 homepage: https://github.com/maxehmookau/echonest-ruby-api
@@ -166,5 +170,6 @@ summary: A gem to get hold of some echonest stuff!
 test_files:
 - spec/artist_spec.rb
 - spec/base_spec.rb
+- spec/song_spec.rb
 - spec/spec_helper.rb
 has_rdoc: