gingerhendrix-echonest 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gareth Andrew
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= echonest
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Gareth Andrew. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "echonest"
+    gem.summary = "A ruby ribrary for accessing the echonest api"
+    gem.email = "gingerhendrix@hotmail.com"
+    gem.homepage = "http://github.com/gingerhendrix/echonest"
+    gem.authors = ["Gareth Andrew"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "echonest #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/echonest/api_request.rb

@@ -0,0 +1,26 @@
+
+module EchoNest
+  class ApiRequest
+  
+    def initialize(resource, options)
+      @options = {:version =>3, :api_key => EchoNest.api_key}.merge(options)
+      @resource = resource
+    end
+    
+    def uri
+      "http://developer.echonest.com/api/#{@resource}?#{query_string(@options)}"
+    end
+    
+    def fetch
+      open(uri).read
+    end
+    
+    private
+    
+    def query_string(options)
+      options.keys.map { |key| "#{key.to_s}=#{options[key]}" }.join('&')
+    end
+  
+  end
+
+end

data/lib/echonest/artist.rb

@@ -0,0 +1,19 @@
+
+module EchoNest
+  class Artist
+    include HappyMapper
+    
+    def initialize(id=nil)
+      @id = id if id
+    end
+    
+    element :name, String
+    element :id, String
+    
+    def get_audio
+      request = ApiRequest.new("get_audio", {:id => id})
+      Audio.parse request.fetch
+    end
+    
+  end
+end

data/lib/echonest/artist_search.rb

@@ -0,0 +1,18 @@
+
+module EchoNest
+  class ArtistSearch
+    include HappyMapper
+  
+    tag :response
+    
+#    has_one :status, RequestStatus
+#    has_one :query, RequestQuery
+    has_many :artists, Artist
+  
+    def self.search(query)
+      request = ApiRequest.new("search_artists", {:query => query})
+      parse(request.fetch)
+    end
+  
+  end
+end

data/lib/echonest/audio.rb

@@ -0,0 +1,12 @@
+
+module EchoNest
+  class Audio
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    has_one :results, AudioResults
+    
+  end
+end

data/lib/echonest/audio_doc.rb

@@ -0,0 +1,18 @@
+
+module EchoNest
+  class AudioDoc
+    include HappyMapper
+    
+    tag :doc
+    
+    element :artist_id, String
+    element :foreign_artist_id, String
+    element :artist, String
+    element :release, String
+    element :title, String
+    element :url, String
+    element :link, String
+    element :date, String
+    element :length, String
+  end
+end

data/lib/echonest/audio_results.rb

@@ -0,0 +1,15 @@
+
+module EchoNest
+  class AudioResults
+    include HappyMapper
+   
+    tag :results
+   
+    attribute :found, String
+    attribute :shown, String    
+    attribute :start, String
+    
+    has_many :docs, AudioDoc    
+    
+  end
+end

data/lib/echonest.rb

@@ -0,0 +1,22 @@
+
+require 'happymapper'
+require 'open-uri'
+
+module EchoNest
+   def self.api_key=(api_key)
+    @api_key = api_key
+   end  
+   
+   def self.api_key
+    @api_key
+   end  
+
+end
+
+require "echonest/api_request.rb"
+require "echonest/artist.rb"
+require "echonest/artist_search.rb"
+require "echonest/audio_doc.rb"
+require "echonest/audio_results.rb"
+require "echonest/audio.rb"
+

data/spec/echonest/api_request_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe "ApiRequest" do
+  before(:all) do
+    EchoNest.api_key = "API_KEY"
+  end
+
+  it { EchoNest::ApiRequest.new("artist_search", :query => "Wavves").uri.should == "http://developer.echonest.com/api/artist_search?query=Wavves&api_key=API_KEY&version=3" }
+
+end

data/spec/echonest/audio_test.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Audio" do
+
+  describe "#parse" do
+    
+    before(:each) do
+      @xml =  File.read(File.dirname(__FILE__) + "/../fixtures/audio/wavves.xml")
+    end
+    
+    it "should parse xml" do
+      EchoNest::Audio.parse(@xml)
+    end
+    
+    it "should have artist" do
+      audio = EchoNest::Audio.parse(@xml)
+      audio.artist.should be_kind_of(EchoNest::Artist)
+      audio.artist.name.should == "Wavves"
+      audio.artist.id.should == "music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB"      
+    end
+    
+    it "should have results" do
+      audio = EchoNest::Audio.parse(@xml)
+      audio.results.should be_kind_of(EchoNest::AudioResults)
+      audio.results.found.should == "51"
+      audio.results.shown.should == "15"
+      audio.results.start.should == "0"
+      audio.results.docs.should be_kind_of(Array)
+      audio.results.docs.length.should == 15
+    end
+    
+    describe "result" do
+      it "should be an AudioDoc" do
+        audio = EchoNest::Audio.parse(@xml)
+        doc = audio.results.docs[0]  
+        doc.should be_kind_of(EchoNest::AudioDoc)
+        doc.artist_id.should == "music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB"
+        doc.artist.should == "Wavves"
+        doc.release.should == "03/21/09 Austin TX"
+        doc.title.should == "So Bored (LIVE SXSW 2009)"
+        doc.url.should == "http://www.2groundcontrol.com/IMAGENS/songs/03%20So%20Bored%20%28LIVE%20SXSW%202009%29.mp3"
+        doc.link.should == "http://2groundcontrol.blogspot.com"
+        doc.length.should == "265.0"
+      end
+    end
+  end    
+
+
+end

data/spec/echonest/search_test.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "ArtistSearch" do
+
+  describe "#search" do
+     before(:each) do
+      @mock_request = mock "Request"
+      @mock_request.stub!(:fetch)
+      EchoNest::ApiRequest.stub!(:new).and_return(@mock_request)
+      EchoNest::ArtistSearch.stub!(:parse)      
+     end
+      
+    it "should create a new ApiRequest with resource 'search_artists' and :query => query" do
+      EchoNest::ApiRequest.should_receive(:new).with('search_artists', :query=> "QUERY").and_return(@mock_request)
+      EchoNest::ArtistSearch.search("QUERY")
+    end
+    
+    it "should call fetch on the api request" do
+      @mock_request.should_receive(:fetch)
+      EchoNest::ArtistSearch.search("QUERY")
+    end
+    
+    it "should call parse on the results of fetch" do
+      @mock_request.stub!(:fetch).and_return("RESULT")
+      EchoNest::ArtistSearch.should_receive(:parse).with("RESULT").and_return("search_result")
+      EchoNest::ArtistSearch.search("QUERY").should == "search_result"
+    end
+
+  end
+
+  describe "#parse" do
+    
+    before(:each) do
+      @xml =  File.read(File.dirname(__FILE__) + "/../fixtures/search_artists/wavves.xml")
+    end
+    
+    it "should parse xml" do
+      EchoNest::ArtistSearch.parse(@xml)
+    end
+    
+    it "should have list of artists" do
+      search = EchoNest::ArtistSearch.parse(@xml)
+      search.artists.should be_kind_of(Array)
+      search.artists[0].should be_kind_of(EchoNest::Artist)
+      search.artists[0].name.should == "Wavves"
+      search.artists[0].id.should == "music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB"      
+    end
+  
+  end
+
+end

data/spec/fixtures/audio/wavves.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response version="3"><status><code>0</code><message>Success</message></status><query><parameter name="api_key">CREDOYO7GFJ9OW3TV</parameter><parameter name="id">music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</parameter><parameter name="start">0</parameter><parameter name="rows">15</parameter><parameter name="format">xml</parameter></query><artist><name>Wavves</name><id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</id></artist><results found="51" shown="15" start="0"><doc id="67ae7bcb306c04dc933c158517366efc" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>So Bored (LIVE SXSW 2009)</title><url>http://www.2groundcontrol.com/IMAGENS/songs/03%20So%20Bored%20%28LIVE%20SXSW%202009%29.mp3</url><link>http://2groundcontrol.blogspot.com</link><length>265.0</length></doc><doc id="fcd91b8da229449ea4fa6931788b94e9" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavvves</release><title>So Bored</title><url>http://www.minneapolisfuckingrocks.com/mp3/wavves_sobored1.mp3</url><link>http://minneapolisfuckingrocks.blogspot.com</link><length>193.0</length></doc><doc id="d69d000d7bd6adb494dbc4fb2ef29088" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavvves</release><title>So Bored</title><url>http://www.yooglimusic.com/blog/wp-content/uploads/2009/04/06-so-bored.mp3</url><link>http://www.yooglimusic.com/blog/</link><length>193.0</length></doc><doc id="8930d130dc079588a728b1788ccad9ed" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavves</release><title>So Bored</title><url>http://www.catbirdseat.org/catbirdseat/wavves-sobored.mp3</url><link>http://stereopaste.blogspot.com/2009/02/wavves.html</link><length>193.0</length></doc><doc id="31fa8b7067b241dd055b21c59b7ac3f9" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavves</release><title>Teenage Super Party</title><url>http://livingears.com/music/Wavves/Teenage%20Super%20Party.mp3</url><link>http://livingears.blogspot.com/2009/02/wavves.html</link><length>101.0</length></doc><doc id="28348f549b4e712ead63703241293003" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavvves</release><title>Surf Goth</title><url>http://prettygoeswithpretty.typepad.com/files/09-surf-goth.mp3</url><link>http://prettygoeswithpretty.typepad.com/pgwp/</link><length>126.0</length></doc><doc id="5f991a5090c0a215b7a3ffcd26437cdd" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavvves</release><title>So Bored</title><url>http://www.thankscaptainobvious-mp3.net/06%20So%20Bored.mp3</url><link>http://www.thankscaptainobvious.net</link><length>193.0</length></doc><doc id="75ff3d8cf10786cf2a3e0ecca73b5e62" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>Wavvves</release><title>So Bored (new)</title><url>http://auralstates.com/Music/wavvessobored.mp3</url><link>http://auralstates.com/</link><length>193.0</length></doc><doc id="e9982eda02973eeccc14be3817c6d65b" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>SXSW 2009</release><title>So Bored</title><url>http://www.acertainromance.com/files/sxsw2009/Wavves_SoBored.mp3</url><link>http://www.acertainromance.com</link><length>193.0</length></doc><doc id="992030536bab5402bd3c92bf5ecc344b" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>Wavves</title><url>http://lullabyes.net/mp3/090320%20Wavves%20Austin%20TX%2005%20Wavves.mp3</url><link>http://www.lullabyes.net/blog/</link><length>198.0</length></doc><doc id="3c7e8a47725fc42abf79e6a54207c3eb" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>Satan Tried to Stop Me</title><url>http://lullabyes.net/mp3/090320%20Wavves%20Austin%20TX%2004%20Satan%20Tried%20to%20Stop%20Me.mp3</url><link>http://www.lullabyes.net/blog/</link><length>216.0</length></doc><doc id="9041a46be397081955e61b94cf67340e" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>To The Dregs</title><url>http://lullabyes.net/mp3/090320%20Wavves%20Austin%20TX%2002%20To%20The%20Dregs.mp3</url><link>http://www.lullabyes.net/blog/</link><length>220.0</length></doc><doc id="45c83c8dfd36a8de4bf70b5b3d45e507" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>So Bored</title><url>http://lullabyes.net/mp3/090320%20Wavves%20Austin%20TX%2003%20So%20Bored.mp3</url><link>http://www.lullabyes.net/blog/</link><length>265.0</length></doc><doc id="28a8ebed7733eab36bb5eaaed4433592" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>Wavves</artist><release>03/21/09 Austin TX</release><title>Intro</title><url>http://lullabyes.net/mp3/090320%20Wavves%20Austin%20TX%2001%20Intro.mp3</url><link>http://www.lullabyes.net/blog/</link><length>27.0</length></doc><doc id="bf11fe9e6c862060d41f4f41f70d06ac" type="audio"><artist_id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</artist_id><artist>WAVVES</artist><release>WAVVVES (ALBUM)</release><title>So Bored</title><url>http://fakepennycomics.com/blog/WAVV_SoBored.mp3</url><link>http://pastaprima.net</link><length>193.0</length></doc></results></response>

data/spec/fixtures/search_artists/wavves.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<response version="3"><status><code>0</code><message>Success</message></status><query><parameter name="api_key">CREDOYO7GFJ9OW3TV</parameter><parameter name="query">wavves</parameter><parameter name="sounds_like">Y</parameter><parameter name="exact">N</parameter></query><artists><artist><id>music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB</id><name>Wavves</name></artist></artists></response>

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'echonest'
+#require 'fakeweb'
+
+#FakeWeb.allow_net_connect = false
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gingerhendrix-echonest
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gareth Andrew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gingerhendrix@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/echonest.rb
+- lib/echonest/api_request.rb
+- lib/echonest/artist.rb
+- lib/echonest/artist_search.rb
+- lib/echonest/audio.rb
+- lib/echonest/audio_doc.rb
+- lib/echonest/audio_results.rb
+- spec/echonest/api_request_test.rb
+- spec/echonest/audio_test.rb
+- spec/echonest/search_test.rb
+- spec/fixtures/audio/wavves.xml
+- spec/fixtures/search_artists/wavves.xml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gingerhendrix/echonest
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A ruby ribrary for accessing the echonest api
+test_files: 
+- spec/spec_helper.rb
+- spec/echonest/search_test.rb
+- spec/echonest/api_request_test.rb
+- spec/echonest/audio_test.rb