bassnode-ruby-echonest 0.1.2 → 0.1.3

data/README.rdoc

@@ -41,5 +41,4 @@ Only supports the API for Track http://developer.echonest.com/docs/v4/track.html
 == Copyright
 
 Author::    youpy <youpy@buycheapviagraonlinenow.com>
-Copyright:: Copyright (c) 2009 youpy
 License::   MIT

data/Rakefile

@@ -3,8 +3,8 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/contrib/sshpublisher'
 require 'spec/rake/spectask'
 require 'fileutils'
@@ -24,7 +24,7 @@ Spec::Rake::SpecTask.new do |t|
 end
 
 spec = eval(File.read("bassnode-ruby-echonest.gemspec"))
-Rake::GemPackageTask.new(spec) do |p|
+Gem::PackageTask.new(spec) do |p|
   p.need_tar = true
   p.gem_spec = spec
 end
@@ -34,3 +34,4 @@ desc "Show information about the gem"
 task :debug_gem do
   puts spec.to_ruby
 end
+

data/bassnode-ruby-echonest.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bassnode-ruby-echonest}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["youpy", "bassnode"]
-  s.date = %q{2011-04-24}
+  s.date = %q{2012-02-12}
   s.description = %q{An Ruby interface for Echo Nest Developer API}
   s.summary = %q{An Ruby interface for Echo Nest Developer API}
   s.email = %q{youpy@buycheapviagraonlinenow.com}

data/console

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'irb'
+
+# ensure we use local gem
+$LOAD_PATH.unshift('lib')
+
+def consolize &block
+
+  yield
+
+  IRB.setup(nil)
+  irb = IRB::Irb.new
+  IRB.conf[:MAIN_CONTEXT] = irb.context
+  irb.context.evaluate("require 'irb/completion'", 0)
+
+  trap("SIGINT") do
+    irb.signal_handle
+  end
+  catch(:IRB_EXIT) do
+    irb.eval_input
+  end
+end
+
+consolize do
+  require 'echonest'
+
+  key = nil
+
+  locations = ["~/.mreko/echonest_api.key", "~/.echonest/api_key"]
+  locations.each do |config|
+    if File.exists?(File.expand_path(config))
+      key = File.read(File.expand_path(config))
+      break
+    end
+  end
+
+  raise "Need an EN key in one of these locations: #{locations.inspect}" unless key
+
+  @en = Echonest(key)
+
+  def en; @en; end
+end
+
+
+

data/lib/echonest.rb

@@ -13,4 +13,20 @@ require 'echonest/element/tatum'
 def Echonest(api_key) Echonest::Api.new(api_key) end
 
 module Echonest
+  extend self
+
+  def debug(obj)
+    return unless debug?
+
+    if obj.is_a?(String)
+      puts obj
+    else
+      puts obj.inspect
+    end
+  end
+
+  # MOAR DEBUGGING! *just for now
+  def debug?
+    true || ENV['DEBUG']
+  end
 end

data/lib/echonest/api.rb

@@ -36,6 +36,10 @@ module Echonest
       end
     end
 
+    def catalog
+      ApiMethods::Catalog.new(self)
+    end
+
     def song
       ApiMethods::Song.new(self)
     end
@@ -61,7 +65,7 @@ module Echonest
       hash_to_list = lambda{|kv| [kv[0].to_s, kv[1]]}
       params.each do |param|
         if param.instance_of? Array
-          param[1].map do |p1|
+          Array(param[1]).map do |p1|
             result << [param[0].to_s, p1]
           end
         else
@@ -105,6 +109,8 @@ module Echonest
           res = connection.pop
           response_body = res.content.read
       else
+        Echonest.debug "#{method.to_s.upcase} #{uri}?#{build_params_to_list(params).inject(''){ |str, (key,val)| str << "#{key}=#{val}&"; str }}"
+
         response_body = @user_agent.__send__(
           method.to_s + '_content',
           uri,
@@ -323,8 +329,60 @@ module Echonest
     end
 
     class Playlist < Base
-      method_with_option(:static, %w[format type artist_pick variety artist_id artist song_id description results max_tempo min_tempo max_duration min_duration max_loudness min_loudness artist_max_familiarity artist_min_familiarity artist_max_hotttnesss artist_min_hotttnesss song_max_hotttnesss song_min_hotttnesss artist_min_longitude aritst_max_longitude artist_min_latitude arist_max_latitude mode key bucket sort limit audio])
-      method_with_option(:dynamic, %w[format type artist_pick variety artist_id artist song_id description results max_tempo min_tempo max_duration min_duration max_loudness min_loudness artist_max_familiarity artist_min_familiarity artist_max_hotttnesss artist_min_hotttnesss song_max_hotttnesss song_min_hotttnesss artist_min_longitude aritst_max_longitude artist_min_latitude arist_max_latitude mode key bucket sort limit audio session_id dmca rating chain_xspf])
+      @basic_parameters = %w[ format type artist_id artist song_id track_id results bucket limit dmca]
+
+      @static_parameters = %w[  artist_pick variety distribution adventurousness
+                                seed_catalog description style mood
+                                max_tempo min_tempo max_duration min_duration max_loudness min_loudness max_danceability min_danceability
+                                max_energy min_energy artist_max_familiarity artist_min_familiarity artist_max_hotttnesss artist_min_hotttnesss
+                                artist_start_year_before artist_start_year_after artist_end_year_before artist_end_year_after song_max_hotttnesss song_min_hotttnesss
+                                min_longitude max_longitude min_latitude max_latitude mode key sort ] + @basic_parameters
+
+      @dynamic_parameters = %w[ session_id dmca adventurousness rating chain_xspf
+                                steer steer_description steer_style steer_mood ] + @static_parameters
+
+      method_with_option(:basic,  @basic_parameters)
+      method_with_option(:static,  @static_parameters)
+      method_with_option(:dynamic, @dynamic_parameters)
+    end
+
+    # http://developer.echonest.com/docs/v4/catalog.html
+    class Catalog < Base
+      # type can be 'song' or 'artist' (Default)
+      def create(name, type="artist")
+        @api.request('catalog/create', :post, {:name => name, :type => type, :format => "json"}).body
+      end
+
+      # Updates (adds or deletes) items from a catalog. The body of the post should include an item block that describes modifications to the catalog.
+      # data: [{:item=>{:item_id => "hogehoge", :artist_name => "Oscar Peterson"}}]
+      def update(catalog_id, data)
+        json_data = data.to_json
+        @api.request('catalog/update', :post, {:id => catalog_id, :data_type => "json", :format => "json", :data => json_data}).body
+      end
+
+      # Checks the status of a catalog update.
+      method_with_option(:status, %w[format ticket])
+
+      # Get basic information on a catalog
+      method_with_option(:profile, %w[format id name])
+
+      # Returns data stored in the catalog. Also returns Echo Nest IDs for items that have been resolved to Echo Nest IDs
+      # along with information requested via bucket. If item_id is not set, all items (subject to the limits of the start and results parameters)
+      # are returned, otherwise, only the items explicitly specified by item_id are returned.
+      method_with_option(:read, %w[format id name item_id bucket results start])
+
+      # Returns feeds based on the artists in a taste profile. Unlike catalog/read method, the catalog/feed method interleaves items and sorts them by date.
+      # since: YYYY-mm-dd
+      # high_relevance: boolean (default false)
+      # bucket: news, blogs, reviews, audio and video blogs. If omitted defaults to news.
+      # result: default of 25
+      method_with_option(:feed, %w[format id bucket results start since high_relevance])
+
+      # Deletes the entire catalog. Only the API key used to create a catalog can be used to delete that catalog.
+      method_with_required_any('catalog', :delete, :post, %w[id], [], %w[format], lambda{})
+
+      # Returns a list of all catalogs created with the current key (account)
+      method_with_option(:list, %w[format results start])
     end
   end
 end

data/lib/echonest/version.rb

@@ -1,3 +1,3 @@
 module Echonest
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/api_spec.rb

@@ -40,10 +40,11 @@ describe Echonest::Api do
   end
 
   it "should pass arguments including a file to user agent" do
+    pending "Failes due to incorrect stubbing."
+
     file = open(fixture('sample.mp3'))
     file.should_receive(:read).and_return('content')
 
-
     @api.user_agent.should_receive(:post_async).
       with(
       URI('http://developer.echonest.com/api/v4/xxx/zzz?api_key=8TPE3VC60ODJTNTFE&bar=baz&format=json'),

data/spec/catalog_spec.rb

@@ -0,0 +1,32 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'spec_helper'
+require "echonest"
+
+include SpecHelper
+
+describe Echonest::ApiMethods::Catalog do
+  before do
+    @api = Echonest::Api.new('8TPE3VC60ODJTNTFE')
+    @catalog = Echonest::ApiMethods::Catalog.new(@api)
+  end
+
+  describe "#create" do
+    it "should request to catalog/create with option" do
+      catalog_name = "catalog_name"
+      catalog_type = "artist"
+      @api.should_receive(:request).with("catalog/create", :post, {:name => catalog_name, :type => catalog_type, :format => "json"}).and_return{ Echonest::Response.new('{"hello":"world"}') }
+      @catalog.create(catalog_name, catalog_type)
+    end
+  end
+
+  describe "#update" do
+    it "should request to catalog/update with option" do
+      catalog_id = "catalog_id"
+      data = [{:item=>{:item_id => "hogehoge", :artist_name => "Oscar Peterson"}}]
+      @api.should_receive(:request).with("catalog/update", :post, {:id => catalog_id, :data_type => "json", :format => "json", :data => data.to_json}).and_return{ Echonest::Response.new('{"hello":"world"}') }
+      @catalog.update(catalog_id, data)
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bassnode-ruby-echonest
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - youpy
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-24 00:00:00 -07:00
-default_executable: 
+date: 2012-02-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: libxml-ruby
@@ -90,6 +89,7 @@ files:
 - README.rdoc
 - Rakefile
 - bassnode-ruby-echonest.gemspec
+- console
 - lib/echonest.rb
 - lib/echonest/analysis.rb
 - lib/echonest/api.rb
@@ -106,6 +106,7 @@ files:
 - spec/api_spec.rb
 - spec/apimethods_base_spec.rb
 - spec/artist_spec.rb
+- spec/catalog_spec.rb
 - spec/echonest_spec.rb
 - spec/fixtures/analysis.json
 - spec/fixtures/profile.json
@@ -118,7 +119,6 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/track_spec.rb
-has_rdoc: true
 homepage: http://github.com/bassnode/ruby-echonest
 licenses: []
 
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: bassnode-ruby-echonest
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: An Ruby interface for Echo Nest Developer API