echonest 0.3.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: 3
+:patch: 0

data/examples/artist_audio.rb

@@ -0,0 +1,33 @@
+
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'echonest'
+require 'highline'
+
+include EchoNest
+
+EchoNest.api_key = "CREDOYO7GFJ9OW3TV"
+
+HighLine.track_eof = false
+highline = HighLine.new
+
+artist_name = highline.ask "Please type an artist name? "
+artist_search = Artist.find artist_name
+search_names = artist_search.map(&:name)
+highline.say "Found #{search_names.length}"
+choice = highline.choose do |menu|
+  menu.select_by = :index
+  menu.choices(*search_names)
+end 
+idx = search_names.index choice
+highline.say "Finding audio for #{artist_search[idx].name} - #{artist_search[idx].id}"
+artist = Artist.new artist_search[idx].id
+audio = artist.audio
+highline.say "Found #{audio.found}, retrieved #{audio.length}"
+highline.say highline.list( audio.map(&:title) )
+while highline.agree "Next?"
+  audio.next_page
+  highline.say highline.list( audio.map(&:title) )
+end
+

data/generators/echonest_acceptance_test/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/echonest_acceptance_test/echonest_acceptance_test_generator.rb

@@ -0,0 +1,50 @@
+class EchonestAcceptanceTestGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'features'
+
+      # Create stubs
+      m.template "feature.erb", "features/artist_#{@name}.feature"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/echonest_acceptance_test/templates/feature.erb

@@ -0,0 +1,8 @@
+Feature: Artist <%= name %>
+  In order to find <%= name %> about an an artist
+  A user should be able to retrieve <%= name %> for an artist
+
+  Scenario: Artist <%= name %>
+    When I retrieve the <%= name %> for "music://id.echonest.com/~/AR/ARVVZQP11E2835DBCB"
+    Then I should get some <%= name %> results
+

data/generators/echonest_model/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/echonest_model/echonest_model_generator.rb

@@ -0,0 +1,52 @@
+class EchonestModelGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'lib/echonest'
+
+      m.template "result.rb.erb", "lib/echonest/#{name}_result.rb"
+      m.template "results.rb.erb", "lib/echonest/#{name}_results.rb"
+      m.template "doc.rb.erb", "lib/echonest/#{name}_doc.rb"
+      
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/echonest_model/templates/doc.rb.erb

@@ -0,0 +1,12 @@
+
+module EchoNest
+  class <%=name.capitalize%>Doc
+    include HappyMapper
+    
+    tag :doc
+   
+    #TODO: Add document elements
+    # element :name, String
+    # element :url, String
+  end
+end

data/generators/echonest_model/templates/result.rb.erb

@@ -0,0 +1,12 @@
+
+module EchoNest
+  class <%=name.capitalize%>Result
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    has_one :results, <%=name.capitalize%>Results
+    
+  end
+end

data/generators/echonest_model/templates/results.rb.erb

@@ -0,0 +1,15 @@
+
+module EchoNest
+  class <%=name.capitalize%>Results
+    include HappyMapper
+   
+    tag :results
+   
+    attribute :found, String
+    attribute :shown, String    
+    attribute :start, String
+    
+    has_many :docs, <%=name.capitalize%>Doc    
+    
+  end
+end

data/generators/echonest_resource/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/echonest_resource/echonest_resource_generator.rb

@@ -0,0 +1,50 @@
+class EchonestResourceGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.dependency "echonest_acceptance_test", [name]
+      m.dependency "echonest_unit_test", [name]
+      m.dependency "echonest_model", [name]
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end
+

data/generators/echonest_unit_test/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/echonest_unit_test/echonest_unit_test_generator.rb

@@ -0,0 +1,50 @@
+class EchonestUnitTestGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'spec/echonest'
+
+      # Create stubs
+      m.template "unit_test.rb.erb", "spec/echonest/#{name}_result_spec.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/echonest_unit_test/templates/unit_test.rb.erb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "<%=name.capitalize%>Result" do
+
+  describe "#parse" do
+    
+    before(:each) do
+      @xml =  File.read(File.dirname(__FILE__) + "/../fixtures/<%=name%>/radiohead.xml")
+    end
+    
+    it "should parse xml" do
+      EchoNest::<%=name.capitalize%>Result.parse(@xml)
+    end
+    
+    it "should have artist" do
+      <%=name%> = EchoNest::<%=name.capitalize%>Result.parse(@xml)
+      <%=name%>.artist.should be_kind_of(EchoNest::Artist)
+      <%=name%>.artist.name.should == "Radiohead"
+      <%=name%>.artist.id.should == "music://id.echonest.com/~/AR/ARH6W4X1187B99274F"      
+    end
+    
+    it "should have results" do
+      <%=name%> = EchoNest::<%=name.capitalize%>Result.parse(@xml)
+      <%=name%>.results.should be_kind_of(EchoNest::<%=name.capitalize%>Results)
+      #TODO: Fill in these values as found in fixture
+      <%=name%>.results.found.should == "51"
+      <%=name%>.results.shown.should == "15"
+      <%=name%>.results.start.should == "0"
+      <%=name%>.results.docs.should be_kind_of(Array)
+      <%=name%>.results.docs.length.should == 15
+    end
+    
+    describe "result" do
+      it "should be an <%=name.capitalize%>Doc" do
+        <%=name%> = EchoNest::<%=name.capitalize%>Result.parse(@xml)
+        doc = <%=name%>.results.docs[0]  
+        doc.should be_kind_of(EchoNest::<%=name.capitalize%>Doc)
+        #TODO: Create tests based on attributes in resource
+      end
+    end
+  end    
+
+
+end