gingerhendrix-echonest 0.2.0 → 0.3.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 2
+: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/lib/echonest.rb

@@ -1,6 +1,8 @@
 
 require 'happymapper'
 require 'open-uri'
+require 'activesupport'
+require 'delegate'
 
 module EchoNest
    def self.api_key=(api_key)
@@ -14,33 +16,41 @@ module EchoNest
 end
 
 require "echonest/api_request.rb"
+require "echonest/paged_result.rb"
+
 require "echonest/artist.rb"
-require "echonest/artist_search.rb"
-require "echonest/audio_doc.rb"
-require "echonest/audio_results.rb"
-require "echonest/audio_result.rb"
-require "echonest/blog_doc.rb"
-require "echonest/blog_results.rb"
-require "echonest/blog_result.rb"
-require "echonest/familiarity_result.rb"
-require "echonest/hotttnesss_result.rb"
-
-require "echonest/news_doc.rb"
-require "echonest/news_results.rb"
-require "echonest/news_result.rb"
-
-require "echonest/profile_result.rb"
-
-require "echonest/reviews_doc.rb"
-require "echonest/reviews_results.rb"
-require "echonest/reviews_result.rb"
-
-require "echonest/similar_doc.rb"
-require "echonest/similar_results.rb"
-require "echonest/similar_result.rb"
-
-require "echonest/urls_result.rb"
-
-require "echonest/video_doc.rb"
-require "echonest/video_results.rb"
-require "echonest/video_result.rb"
+require "echonest/xml/artist_doc.rb"
+
+require "echonest/xml/artist_search_results.rb"
+
+require "echonest/xml/audio_doc.rb"
+require "echonest/xml/audio_results.rb"
+require "echonest/xml/audio_result.rb"
+
+require "echonest/xml/blogs_doc.rb"
+require "echonest/xml/blogs_results.rb"
+require "echonest/xml/blogs_result.rb"
+
+require "echonest/xml/familiarity_result.rb"
+
+require "echonest/xml/hotttnesss_result.rb"
+
+require "echonest/xml/news_doc.rb"
+require "echonest/xml/news_results.rb"
+require "echonest/xml/news_result.rb"
+
+require "echonest/xml/profile_result.rb"
+
+require "echonest/xml/reviews_doc.rb"
+require "echonest/xml/reviews_results.rb"
+require "echonest/xml/reviews_result.rb"
+
+require "echonest/xml/similar_doc.rb"
+require "echonest/xml/similar_results.rb"
+require "echonest/xml/similar_result.rb"
+
+require "echonest/xml/urls_result.rb"
+
+require "echonest/xml/video_doc.rb"
+require "echonest/xml/video_results.rb"
+require "echonest/xml/video_result.rb"

data/lib/echonest/artist.rb

@@ -1,70 +1,74 @@
 
 module EchoNest
   class Artist
-    include HappyMapper
+    attr_accessor :id
     
     def initialize(id=nil)
       @id = id if id
     end
     
-    element :name, String
-    element :id, String
-    element :familiarity, Float
-    element :hotttnesss, Float
-    element :foreign_id, String
+    def self.service(name, options = {})
     
-    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})
-      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
+      define_method "get_#{name.to_s}" do |*args|
+        options = args[0] if args.length == 1
+        options = {:id => id}.merge(options)
+        request = ApiRequest.new("get_#{name.to_s}", options)
+        "Xml::#{name.to_s.titleize}Result".constantize.parse request.fetch
+      end
 
-    def get_profile
-      request = ApiRequest.new("get_profile", {:id => id})
-      ProfileResult.parse request.fetch
-    end
+      if !options[:singular]
+        define_method name do
+          return instance_variable_get("@#{name.to_s}") if instance_variable_get("@#{name.to_s}")
+          result = self.send("get_#{name.to_s}")
+          pager = Proc.new { |start, rows| 
+            self.send("get_#{name.to_s}", :start => start, :rows => rows).results
+          }
+          page = PagedResult.new result.results, pager 
+          instance_variable_set("@#{name.to_s}",  page)
+        end
+      else
+        if !options[:provides]
+          define_method name do
+            return instance_variable_get("@#{name.to_s}") if instance_variable_get("@#{name.to_s}")
+            result = self.send("get_#{name.to_s}")
+            instance_variable_set("@#{name.to_s}", result.artist.send(name))
+          end
+        else
+
+          define_method name do
+            return instance_variable_get("@#{name.to_s}") if instance_variable_get("@#{name.to_s}")
+            result = self.send("get_#{name.to_s}")
+            instance_variable_set("@#{name.to_s}", result.artist)
+          end
 
-    def get_similar
-      request = ApiRequest.new("get_similar", {:id => id})
-      SimilarResult.parse request.fetch
+          options[:provides].each do |prop|
+            define_method prop do
+              return instance_variable_get("@#{prop.to_s}") if instance_variable_get("@#{prop.to_s}")
+              instance_variable_set("@#{prop.to_s}",  self.send(name).send(prop))
+            end
+          end
+        end
+      end    
     end
     
-    def get_urls
-      request = ApiRequest.new("get_urls", {:id => id})
-      UrlsResult.parse request.fetch
+    def self.find(query, options={})
+      options = {:query => query}.merge(options)
+      request = ApiRequest.new("search_artists", options)
+      results = Xml::ArtistSearchResults.parse(request.fetch)
+      results.artists
     end
     
-    def get_video
-      request = ApiRequest.new("get_video", {:id => id})
-      VideoResult.parse request.fetch
-    end
-
+    service :audio
+    service :blogs
+    service :familiarity, :singular => true
+    service :hotttnesss, :singular => true
+    service :news
+    service :profile, :singular => true, :provides => [:id, :name, :foreign_id]
+    service :reviews
+    service :similar
+    service :urls, :singular => true, :provides => [:mb_url, :official_url, :myspace_url, :wikipedia_url,  :amazon_url, :itunes_url]
+    service :video
+    
+ 
   end
 end

data/lib/echonest/paged_result.rb

@@ -0,0 +1,33 @@
+
+
+
+module EchoNest
+  class PagedResult < DelegateClass(Array)
+
+    def initialize(results, block, options={})
+      @results = results
+      @update = block
+      @page_name = options[:page] || :docs 
+      @available = @results.send(@page_name)
+      super(@available)
+    end
+
+    def found
+      @results.found
+    end
+
+    def next_page
+      results = @update.call @available.length, 15
+      @available += results.send(@page_name)
+      self.__setobj__(@available)
+    end
+
+    def [](i)
+      return @available[i] if @available[i]
+      next_page
+      @available[i]
+    end    
+        
+    
+  end
+end

data/lib/echonest/xml/artist_doc.rb

@@ -0,0 +1,23 @@
+
+module EchoNest
+  module Xml
+    class ArtistDoc
+      include HappyMapper
+       
+      tag :artist
+       
+      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 
+    end
+  end
+end

data/lib/echonest/xml/artist_search_results.rb

@@ -0,0 +1,14 @@
+
+module EchoNest
+  module Xml
+    class ArtistSearchResults
+      include HappyMapper
+    
+      tag :response
+      
+  #    has_one :status, RequestStatus
+  #    has_one :query, RequestQuery
+      has_many :artists, ArtistDoc
+    end  
+  end
+end

data/lib/echonest/xml/audio_doc.rb

@@ -0,0 +1,20 @@
+
+module EchoNest
+  module Xml
+    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
+end

data/lib/echonest/xml/audio_result.rb

@@ -0,0 +1,13 @@
+
+module EchoNest
+  module Xml
+    class AudioResult
+      include HappyMapper
+      
+      tag :response
+      
+      has_one :artist, ArtistDoc
+      has_one :results, AudioResults
+    end    
+  end
+end

data/lib/echonest/xml/audio_results.rb

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

data/lib/echonest/xml/blogs_doc.rb

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

data/lib/echonest/xml/blogs_result.rb

@@ -0,0 +1,14 @@
+
+module EchoNest
+  module Xml
+    class BlogsResult
+      include HappyMapper
+      
+      tag :response
+      
+      has_one :artist, ArtistDoc
+      has_one :results, BlogsResults
+      
+    end
+   end
+end

data/lib/echonest/xml/blogs_results.rb

@@ -0,0 +1,18 @@
+
+module EchoNest
+  module Xml
+    class BlogsResults
+      include HappyMapper
+     
+      tag :results
+     
+      attribute :found, String
+      attribute :shown, String    
+      attribute :start, String
+      
+      has_many :docs, BlogsDoc    
+      
+    end
+  end
+end
+

data/lib/echonest/xml/familiarity_result.rb

@@ -0,0 +1,12 @@
+
+module EchoNest
+  module Xml
+    class FamiliarityResult
+        include HappyMapper
+        
+        tag :response
+        
+        has_one :artist, ArtistDoc
+    end
+  end
+end