echonest_resource 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in echonest_resource.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Echonest gem
+
+## Installation
+
+Add the gem to your Gemfile
+
+``` ruby
+	gem "echonest_resource"
+```
+
+Obtain an API key from echonest and create a file called 'echonest.yml' in your /config directory
+
+``` ruby
+	api_key = "YOUR_API_KEY"
+```
+
+## Usage
+
+Right now the gem supports two Echonest resources: Artist and Song
+
+### Artist
+
+``` ruby
+class Artist < ActiveResource::Base
+	include EchonestResource::Base
+	echonest_resource :artist
+end
+```
+
+``` ruby
+class Artist < ActiveResource::Base
+	include EchonestResource::Base
+	echonest_resource :song
+end
+```
+
+Now you can search for an artist:
+
+``` ruby
+artists = Artist.search("Macklemore")
+```
+
+The search method also accepts an options hash where you can specify things like: results, bucket, sort
+
+
+``` ruby
+artists = Artist.search("Macklemore", {:results => 20, :sort => "hotttnesss-desc"})
+```
+
+### Song
+
+You can search for songs for an artist name
+
+``` ruby
+songs = Song.find_by_artist_name("Macklemore")
+```
+
+The find_by_artist_name method also accepts an options hash 
+
+``` ruby
+songs = Song.find_by_artist_name("Macklemore", :sort => "song_hotttnesss")
+```
+
+You can retrieve additional information by specifying a bucket like so:
+
+``` ruby
+songs = Song.find_by_artist_name("Macklemore", :sort => "duration-desc", :bucket => "audio_summary")
+```
+
+
+All the attributes on the songs use the same name as the Echonest API (http://developer.echonest.com/docs/v4)
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/echonest_resource.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "echonest_resource/version"
+
+Gem::Specification.new do |s|
+  s.name        = "echonest_resource"
+  s.version     = EchonestResource::VERSION
+  s.authors     = ["tzumby"]
+  s.email       = ["tzumby@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Echonest API Wrapper}
+  s.description = %q{Use this gem to search the Echonest API for Artists and Songs}
+
+  s.rubyforge_project = "echonest_resource"
+
+  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.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "hashie"
+end

data/lib/echonest_resource/base.rb

@@ -0,0 +1,75 @@
+module EchonestResource
+  module Base
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      
+      def request_params
+        {
+          :api_key  => EchonestResource.api_key,
+          :results  => 1
+        }
+      end
+      
+      def echonest_resource(resource)
+        raise StandardError if resource.blank?
+
+        include HTTParty
+        base_uri 'http://developer.echonest.com/api/v4'
+        format :json 
+        
+        case resource
+        when :artist
+          instance_eval <<-EOV
+            def search(name, options={})
+              raise StandardError if name.blank?
+
+              results = Hashie::Mash.new(self.get('/artist/search', :query => 
+                request_params.merge({:name => name}).merge(options)
+              ))
+              if results.response && results.response.artists; results.response.artists; end;
+            end
+          EOV
+        when :song
+          instance_eval <<-EOV
+          
+            def find_by_artist_id(id, options={})
+              raise StandardError if id.blank?
+          
+              results = Hashie::Mash.new(self.get('/song/search', :query =>
+                request_params.merge(options).merge({
+                  :artist_id => id
+                })
+              ))
+              if results.response && results.response.songs; results.response.songs; end;
+            end
+            
+            def find_by_artist_name(name, options={})
+              raise StandardError if name.blank?
+              
+              if artist = Artist.search(:name => name)
+                Song.find_by_id(artist.first.id, options)
+              end
+            end
+            
+            def search(title, options={})
+              raise StandardError if title.blank?
+              
+              results = Hashie::Mash.new(self.get('/song/search', :query => 
+                request_params.merge({:title => title}).merge(options)
+              ))
+              results
+            end
+            
+            
+          EOV
+        end
+              
+      end  
+    end
+    
+  end
+end

data/lib/echonest_resource/version.rb

@@ -0,0 +1,3 @@
+module EchonestResource
+  VERSION = "0.0.1"
+end

data/lib/echonest_resource.rb

@@ -0,0 +1,19 @@
+require "echonest_resource/version"
+require 'active_support'
+require 'httparty'
+require 'hashie'
+
+class APIKeyMissing     < StandardError; end
+class MissingConfigFile < StandardError; end
+
+module EchonestResource
+  def self.api_key
+    echonest_config = YAML.load_file("#{Rails.root}/config/echonest.yml")
+    raise MissingConfigFile if echonest_config.blank?
+    echonest_config["api_key"]
+  end
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+require File.join(directory, 'echonest_resource', 'base')

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: echonest_resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tzumby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70308245661760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70308245661760
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70308245660520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70308245660520
+description: Use this gem to search the Echonest API for Artists and Songs
+email:
+- tzumby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- echonest_resource.gemspec
+- lib/echonest_resource.rb
+- lib/echonest_resource/base.rb
+- lib/echonest_resource/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: echonest_resource
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Echonest API Wrapper
+test_files: []