gingerhendrix-echonest 0.1.1 → 0.2.0

data/VERSION.yml

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

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

data/lib/echonest/api_request.rb

@@ -18,7 +18,7 @@ module EchoNest
     private
     
     def query_string(options)
-      options.keys.map { |key| "#{key.to_s}=#{options[key]}" }.join('&')
+      options.keys.map { |key| "#{key.to_s}=#{URI.encode(options[key].to_s)}" }.join('&')
     end
   
   end

data/lib/echonest/artist.rb

@@ -9,11 +9,62 @@ module EchoNest
     
     element :name, String
     element :id, String
+    element :familiarity, Float
+    element :hotttnesss, Float
+    element :foreign_id, String
     
+    element :mb_url, String
+    element :official_url, String
+    element :myspace_url, String
+    element :wikipedia_url, String
+    element :amazon_url, String
+    element :itunes_url, String
+    
+      
     def get_audio
       request = ApiRequest.new("get_audio", {:id => id})
-      Audio.parse request.fetch
+      AudioResult.parse request.fetch
+    end
+    
+    def get_blogs
+      request = ApiRequest.new("get_audio", {:id => id})
+      BlogResult.parse request.fetch
+    end
+    
+    def get_familiarity
+      request = ApiRequest.new("get_familiarity", {:id => id})
+      FamiliarityResult.parse request.fetch
+    end
+    
+    def get_hotttnesss
+      request = ApiRequest.new("get_hotttnesss", {:id => id})
+      HotttnesssResult.parse request.fetch
+    end
+    
+    def get_news
+      request = ApiRequest.new("get_news", {:id => id})
+      NewsResult.parse request.fetch
+    end
+
+    def get_profile
+      request = ApiRequest.new("get_profile", {:id => id})
+      ProfileResult.parse request.fetch
+    end
+
+    def get_similar
+      request = ApiRequest.new("get_similar", {:id => id})
+      SimilarResult.parse request.fetch
     end
     
+    def get_urls
+      request = ApiRequest.new("get_urls", {:id => id})
+      UrlsResult.parse request.fetch
+    end
+    
+    def get_video
+      request = ApiRequest.new("get_video", {:id => id})
+      VideoResult.parse request.fetch
+    end
+
   end
 end

data/lib/echonest/{audio.rb → audio_result.rb}

@@ -1,6 +1,6 @@
 
 module EchoNest
-  class Audio
+  class AudioResult
     include HappyMapper
     
     tag :response

data/lib/echonest/blog_doc.rb

@@ -0,0 +1,13 @@
+
+module EchoNest
+  class BlogDoc
+    include HappyMapper
+    
+    tag :doc
+   
+    element :name, String
+    element :url, String
+    element :summary, String
+    element :date_found, String
+  end
+end

data/lib/echonest/blog_result.rb

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

data/lib/echonest/blog_results.rb

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

data/lib/echonest/familiarity_result.rb

@@ -0,0 +1,11 @@
+
+module EchoNest
+  class FamiliarityResult
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    
+  end
+end

data/lib/echonest/hotttnesss_result.rb

@@ -0,0 +1,11 @@
+
+module EchoNest
+  class HotttnesssResult
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    
+  end
+end

data/lib/echonest/news_doc.rb

@@ -0,0 +1,13 @@
+
+module EchoNest
+  class NewsDoc
+    include HappyMapper
+    
+    tag :doc
+   
+    element :name, String
+    element :url, String
+    element :summary, String
+    element :date_found, String
+  end
+end

data/lib/echonest/news_result.rb

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

data/lib/echonest/news_results.rb

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

data/lib/echonest/profile_result.rb

@@ -0,0 +1,11 @@
+
+module EchoNest
+  class ProfileResult
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    
+  end
+end

data/lib/echonest/reviews_doc.rb

@@ -0,0 +1,15 @@
+
+module EchoNest
+  class ReviewsDoc
+    include HappyMapper
+    
+    tag :doc
+   
+    #TODO: Add document elements
+    element :name, String
+    element :review_text, String
+    element :url, String
+    element :summary, String
+    element :date_found, String
+  end
+end

data/lib/echonest/reviews_result.rb

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

data/lib/echonest/reviews_results.rb

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

data/lib/echonest/similar_doc.rb

@@ -0,0 +1,13 @@
+
+module EchoNest
+  class SimilarDoc
+    include HappyMapper
+    
+    tag :artist
+   
+    #TODO: Add document elements
+    element :name, String
+    element :id, String
+    element :rank, Integer
+  end
+end

data/lib/echonest/similar_result.rb

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

data/lib/echonest/similar_results.rb

@@ -0,0 +1,11 @@
+
+module EchoNest
+  class SimilarResults
+    include HappyMapper
+   
+    tag :similar
+    
+    has_many :docs, SimilarDoc    
+    
+  end
+end

data/lib/echonest/urls_result.rb

@@ -0,0 +1,11 @@
+
+module EchoNest
+  class UrlsResult
+    include HappyMapper
+    
+    tag :response
+    
+    has_one :artist, Artist
+    
+  end
+end

data/lib/echonest/video_doc.rb

@@ -0,0 +1,14 @@
+
+module EchoNest
+  class VideoDoc
+    include HappyMapper
+    
+    tag :doc
+   
+    #TODO: Add document elements
+    element :site, String
+    element :title, String
+    element :url, String
+    element :date_found, String
+  end
+end

data/lib/echonest/video_result.rb

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