echonest-ruby-api 0.1.0 → 0.1.2

data/.gitignore

@@ -1,2 +1,11 @@
-.DS_Store
-.yardoc
+_Store
+.bundle
+.rvmrc
+.yardoc
+.rake_tasks~
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*
+.DS_STORE

data/README.md

@@ -1,21 +1,26 @@
-# 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)
+# 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)
 
-## Installation
 
-Add this line to your application's Gemfile:
+![Echonest] (http://the.echonest.com/static/img/logos/250x80_lt.gif)
 
-    gem 'echonest-ruby-api'
+**echonesst-ruby-api** is a pure Ruby wrapper around the Echonest APIs. 
+
+## Requirements
+* An API Key (available free)
+* Ruby 1.9.3+
+* [echonest/echoprint-codegen](https://github.com/echonest/echoprint-codegen) binary in your `$PATH` if you want to identify audio files. (yeah, *identify!*)
 
-And then execute:
+## Installation
+
+In your Gemfile:
 
-    $ bundle
+    gem 'echonest-ruby-api'
+    
+and then `bundle install`
 
-Or install it yourself as:
+Or install locally:
 
-    $ gem install echonest-ruby-api
+    $ (sudo) gem install echonest-ruby-api
 
 
 ## Usage
@@ -24,8 +29,7 @@ Require the gem in your file:
 
     require 'echonest-ruby-api'
 
-### Artist
-
+## Artist
 
 Create an instance of an object
 
@@ -40,8 +44,10 @@ Then you have access to a bunch of methods:
     artist.hotttnesss
     artist.images
     artist.songs
+    
+*Exact response are specified in the RDoc  but the method names try to be as self-explanatory as possible.*
 
-### Song
+## Song
 
 Create an instance of the Song module.
 
@@ -55,13 +61,62 @@ Then you have access to the song/search endpoint:
 
 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!
+## Identification
+
+> **Note:** This stuff is flakey as hell. Seems to work pretty well on OSX, but it doesn't work out of the box. You'll need to follow these instructions to get it working.
+
+You can even **identify** a song simply from its fingerprint! Support for this is flaky so far and only tested on OS X.
 
-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. 
+Firstly, make sure that the `echoprint-codegen` binary is available on your local `$PATH`. 
+    
+Just run: `echoprint-codegen` on the terminal and see if it returns anything other than an error.
+    
+If it's not installed, you'll need to compile it from source. **It's not as scary as it sounds.**
 
-    song.idenfity(YOUR_ECHOPRINT_CODE)
 
-Checkout `spec/song_spec.rb` for an example code. 
+    brew install ffmpeg boost taglib # Install dependencies
+    
+    cd ~/Desktop/ # or somewhere else sensible, you can delete it later anyway
+    
+    git clone https://github.com/echonest/echoprint-codegen.git
+    
+    cd echoprint-codegen
+    
+    make
+    
+    make install
+    
+This should then allow you to use the `echoprint-codegen` command at the command line. If not, try following the instructions here: [echonest/echoprint-codegen](https://github.com/echonest/echoprint-codegen)
+
+Then just use this method call:
+
+    song = Echonest::Song.new('YOUR-API-KEY')
+    code = song.echoprint_code('path/to/audio/file')
+    puts code.identify(code)
+
+If there's a positive match, it'll return something like this:
+
+    {
+      "response": {
+            "status": {
+            "code": 0,
+            "message": "Success",
+            "version": "4.2"
+          },
+          "songs": [
+          {
+            "title": "Billie Jean",
+            "artist_name": "Michael Jackson",
+            "artist_id": "ARXPPEY1187FB51DF4",
+            "score": 49,
+            "message": "OK (match type 5)",
+            "id": "SOKHYNL12A8C142FC7"
+          }
+        ]
+      }
+    }
+
+Checkout `spec/song_spec.rb` for an example code to test it out. 
 
 Note that this calls the song/identify API endpoint and does *not* support other Echoprint servers.
 

data/echonest-ruby-api.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", "~> 2.6"
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+  gem.add_development_dependency 'mocha'
 end

data/lib/echonest-ruby-api.rb

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

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

@@ -67,4 +67,4 @@ module Echonest
     end
 
   end
-end
+end

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

@@ -60,8 +60,21 @@ module Echonest
       json = MultiJson.load(response.body, symbolize_keys: true)
       response_code = json[:response][:status][:code]
 
-      response_code.eql?(0) ? json[:response] : raise(ArgumentError, "Error code #{ response_code }")
+      response_code.eql?(0) ? json[:response] : raise(Echonest::Error.new(response_code), "Error code #{ response_code }")
+    end
 
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    #   which('ruby') #=> /usr/bin/ruby
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{ cmd }#{ ext }")
+          return exe if File.executable? exe
+        }
+      end
+      return nil
     end
 
   end

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

@@ -0,0 +1,27 @@
+module Echonest
+
+  class Error < Exception
+    ERRORS = { '-1' => 'Unknown Error', 
+               '0' => 'Success',
+               '1' => 'Invalid/Missing API Key',
+               '2' => 'This API key is not allowed to call that method',
+               '3' => 'Rate limit exceeded',
+               '4' => 'Missing parameter',
+               '5' => 'Invalid parameter',
+               '6' => 'Missing echoprint-codegen binary on $PATH'
+             }
+
+
+    # Create a new Echonest::Error object
+    def initialize(error_code)
+      @error_code = error_code
+    end
+
+    
+    def description
+      ERRORS[@error_code.to_s]
+    end
+
+  end
+
+end

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

@@ -30,5 +30,28 @@ module Echonest
       results
     end
 
+    # Generates an acoustic fingerprint using the echoprint-codegen
+    # binary.
+    #
+    # Examples:
+    #     echoprint_code('path/to/song.mp3')
+    #     #=> Echoprint code as String 
+    #
+    # Raises an +Echoprint::Error+ if the echoprint-codegen binary
+    # is not accessible to Ruby on $PATH
+    #
+    # * +filepath+ - Path (absolute or relative) to an audio file atleast 21 seconds in length
+    # 
+    # Returns a String
+    def echoprint_code(filepath)
+      if which('echoprint-codegen').nil?
+        error = Error.new(6)
+        raise Error.new(6), error.description
+      else
+        response = `echoprint-codegen #{ filepath } 1 20`
+        JSON.parse(response)[0]['code']
+      end
+    end
+
   end
-end
+end

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

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

data/spec/artist_spec.rb

@@ -35,7 +35,7 @@ describe Echonest::Artist do
 
     it 'should deal gracefully with an invalid API key' do
       a = Echonest::Artist.new('Weezer', 'THISISNOTAKEY')
-      expect { a.biographies }.to raise_error(ArgumentError)
+      expect { a.biographies }.to raise_error(Echonest::Error)
     end
 
   end

data/spec/error_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Echonest::Error do
+
+  describe '#initialize' do
+
+    it 'should accept an error code as the only parameter' do
+      err = Echonest::Error.new(3)
+    end
+
+  end
+
+  describe '#description' do
+
+    it 'should return the errors description' do
+      err = Echonest::Error.new(5)
+      err.description.should eql 'Invalid parameter'
+    end
+
+  end
+
+end

data/spec/song_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'mocha/setup'
 
 describe Echonest::Song do
 
@@ -52,5 +53,35 @@ describe Echonest::Song do
     end
 
   end
+
+  describe '#echoprint_code' do
+    # This is all very hard to test in a sensible way since it relies on
+    # a binary existing on the users machine.
+
+    # it 'should raise Exception if echoprint-codegen binary is not present' do
+    #   a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+    #   a.stubs(:which).returns(nil)
+    #   expect { a.echoprint_code('path-to-mp3') }.to raise_error(Echonest::Error)
+    # end
+
+    # it 'should call the echoprint-binary if it exists' do
+    #   a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+    #   a.echoprint_code('/Users/maxwoolf/Desktop/example.mp3')
+    # end
+
+    # it 'should return a massive string if it was successful' do
+    #   a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+    #   a.echoprint_code('/Users/maxwoolf/Desktop/example.mp3').should be_a String
+    #   a.echoprint_code('/Users/maxwoolf/Desktop/example.mp3').length.should be > 400
+    # end
+
+    # it 'should identify a song using a generated code' do
+    #   a = Echonest::Song.new('BNOAEBT3IZYZI6WXI')
+    #   code = a.echoprint_code('/Users/maxwoolf/Desktop/example.mp3')
+    #   puts code
+    #   puts
+    # end
+  end
+
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echonest-ruby-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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
@@ -100,46 +116,22 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/Biography.html
-- doc/Blog.html
-- doc/Echonest.html
-- doc/Echonest/Artist.html
-- doc/Echonest/Base.html
-- doc/Echonest/Base/EchonestConnectionError.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- 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/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/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/error_spec.rb
 - spec/song_spec.rb
 - spec/spec_helper.rb
 - tmp/rspec_guard_result
@@ -170,6 +162,7 @@ summary: A gem to get hold of some echonest stuff!
 test_files:
 - spec/artist_spec.rb
 - spec/base_spec.rb
+- spec/error_spec.rb
 - spec/song_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/Gemfile.lock

@@ -1,56 +0,0 @@
-PATH
-  remote: .
-  specs:
-    echonest-ruby-api (0.0.5)
-      httparty
-      multi_json
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
-    guard (1.6.2)
-      listen (>= 0.6.0)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      terminal-table (>= 1.4.3)
-      thor (>= 0.14.6)
-    guard-rspec (2.4.0)
-      guard (>= 1.1)
-      rspec (~> 2.11)
-    httparty (0.10.2)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    listen (0.7.2)
-    lumberjack (1.0.2)
-    method_source (0.8.1)
-    multi_json (1.5.0)
-    multi_xml (0.5.2)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-    rake (10.0.3)
-    rb-fsevent (0.9.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.0)
-    rspec-expectations (2.12.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    slop (3.3.3)
-    terminal-table (1.4.5)
-    thor (0.16.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  echonest-ruby-api!
-  guard-rspec
-  rake
-  rb-fsevent (~> 0.9.1)
-  rspec (~> 2.6)