another_echonest_ruby_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a953da50f123e3908a36bbc5e89295e0e41649a1
-  data.tar.gz: 3fcd0f71d3e8cd02afdd903118c5ead6b7d2e655
+  metadata.gz: 61d265155ada680cd72b62e0e90835dab4ddacdf
+  data.tar.gz: 34cbbbb1d058d59789df2262cddfc37e7071a70f
 SHA512:
-  metadata.gz: 097da692d6790e2a975fae1ec5bc5ef92263a325095fd6df60efad9d36d8b26389703a58d21a58015b32f1493e90eab77eb14efe41ddb893cb61b158876d40b9
-  data.tar.gz: 47db52521f4c139be3b18105c3f5d6f0282f0d7cf00dafb3cc9d73cfad7c090a8e479b6e2090292aeafce6df76772782fe1a96561e11f1c3f9da12794124b7eb
+  metadata.gz: 85e4a788d9e80033a28ed64c408cb98c0f850463c481e483d221f3a8d1d1ceefae6f9950467afe86d24923d136ce7f96e8b32f51129870640a3e1ef1b70bcb01
+  data.tar.gz: c28e09862fcff0f731c8519f9b8caef6c0ac120d445e1ea8ced3124a1627007ce163f6dc7b5fbd41f63338f51685b69370426f5d97fa64799d1b89d6507e2388

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'rest-client'
+gem 'json'
+gem 'hashie'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem 'webmock'
+end

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "another_echonest_ruby_api"
+  gem.homepage = "http://github.com/spilliton/another_echonest_ruby_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Yet another ruby client for Echonest API}
+  gem.description = %Q{Yet another ruby client for Echonest API}
+  gem.email = "kloeppingzd@gmail.com"
+  gem.authors = ["Zachary Kloepping"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "another_echonest_ruby_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/another_echonest_ruby_api.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: another_echonest_ruby_api 0.0.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "another_echonest_ruby_api"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zachary Kloepping"]
+  s.date = "2014-01-22"
+  s.description = "Yet another ruby client for Echonest API"
+  s.email = "kloeppingzd@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "another_echonest_ruby_api.gemspec",
+    "lib/another_echonest_ruby_api.rb",
+    "lib/another_echonest_ruby_api/config.rb",
+    "lib/another_echonest_ruby_api/query.rb",
+    "lib/another_echonest_ruby_api/request.rb",
+    "lib/another_echonest_ruby_api/response.rb",
+    "test/config_test.rb",
+    "test/helper.rb",
+    "test/request_test.rb",
+    "test/response_test.rb",
+    "test/webmock/bad_credentials.json"
+  ]
+  s.homepage = "http://github.com/spilliton/another_echonest_ruby_api"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.10"
+  s.summary = "Yet another ruby client for Echonest API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/lib/another_echonest_ruby_api.rb

@@ -0,0 +1,30 @@
+module EchoNest
+  autoload :Config, 'another_echonest_ruby_api/config'
+  autoload :Request, 'another_echonest_ruby_api/request'
+  autoload :Query, 'another_echonest_ruby_api/query'
+  autoload :RequestException, 'another_echonest_ruby_api/request'
+  autoload :Response, 'another_echonest_ruby_api/response'
+
+  class ConfigException < Exception
+    EXCEPTION_TEXT = <<-eos
+    You must setup EchoNest before you can use!  Ex:
+
+    EchoNest.setup do |config|
+      config.api_key = 'xxxxxxxx'
+    end
+eos
+  end
+
+  def self.config
+    if @config
+      @config
+    else
+      raise ConfigException, ConfigException::EXCEPTION_TEXT
+    end
+  end
+
+  def self.setup(&block)
+    @config = Config.new
+    yield @config
+  end
+end

data/lib/another_echonest_ruby_api/config.rb

@@ -0,0 +1,5 @@
+module EchoNest
+  class Config
+    attr_accessor :api_key
+  end
+end

data/lib/another_echonest_ruby_api/query.rb

@@ -0,0 +1,10 @@
+module EchoNest
+  class Query
+
+    def self.search(params)
+      response = Request.get(params)
+      response.results
+    end
+
+  end
+end

data/lib/another_echonest_ruby_api/request.rb

@@ -0,0 +1,79 @@
+require 'rest_client'
+
+module EchoNest
+
+  class RequestException < Exception; end
+
+  class Request
+
+    BASE_URL = "http://developer.echonest.com/api/v4/"
+
+    attr_reader :params, :path, :bucket_params
+
+    def initialize(path, opts={})
+      @path = path
+      @params = opts
+      @bucket_params = if bucket = opts.delete(:bucket)
+        bucket.is_a?(Array) ? bucket : [bucket]
+      else
+        []
+      end
+    end
+
+    def self.get(path, opts={})
+      request = Request.new(path, opts)
+      request.get_response
+    end
+
+    def get_response
+      response = RestClient.get(build_url) do |response, request, result, &block|
+        # puts "response.code: #{response.code.inspect}"
+        # puts "response.body: #{response.body.inspect}"
+        if [200, 400].include? response.code
+          build_response(response.body)
+        else
+          raise RequestException, "Unexpected response code: #{response.code}"
+        end
+      end
+
+      if response.error?
+        raise RequestException, "The following errors were returned: #{response.message.inspect}"
+      else
+        response
+      end
+    end
+
+    def build_response(data)
+      Response.new(:raw_json => data.to_str, :request => self)
+    end
+
+    def build_params
+      {param_name => params}
+    end
+
+    def build_url
+      url = url_with_creds
+      if params.any?
+        parts = []
+        params.each_pair do |name, value|
+          parts << "#{URI.escape(name.to_s)}=#{URI.escape(value.to_s)}"
+        end
+        bucket_params.each do |value|
+          parts << "bucket=#{value}"
+        end
+        url = "#{url}&#{parts.join('&')}"
+      end
+      # puts "url: #{url.inspect}"
+      url
+    end
+
+    def api_key
+      EchoNest.config.api_key
+    end
+
+    def url_with_creds
+      "#{BASE_URL}#{path}?api_key=#{api_key}&format=json"
+    end
+
+  end
+end

data/lib/another_echonest_ruby_api/response.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'hashie'
+
+module EchoNest
+  class Response
+
+    # data attr is a Hashie::Mash you can use to get at json attributes returned
+    # ex:  response.data.artist.name, response.data.artist.name etc
+    attr_reader :request, :raw_json, :data, :status
+
+    def initialize(opts={})
+      @request = opts[:request]
+      @raw_json = opts[:raw_json]
+      h = JSON.parse(@raw_json)
+      @data = Hashie::Mash.new(h['response'])
+      @status = data.status
+    end
+
+    def error?
+      status.code != 0
+    end
+
+    def message
+      status.message
+    end
+    
+    def version
+      status.version
+    end
+
+
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class ConfigTest < Test::Unit::TestCase
+
+  should 'raise exception if not configured' do
+    assert_raise EchoNest::ConfigException do
+      EchoNest::Request.get(:artist => 'sdf')
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+
+unless ENV['NO_MOCKING']
+  require 'webmock/test_unit'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'another_echonest_ruby_api'
+
+class Test::Unit::TestCase
+
+  def setup_test_credentials
+    EchoNest.setup do |config|
+      config.api_key = 'fart'
+    end
+  end
+
+  def mock(name, path_and_query, status=200)
+    dir = File.dirname(__FILE__) + "/webmock/#{name}.json"
+    file = File.open(dir)
+    body = file.read
+    url = "#{EchoNest::Request::BASE_URL}#{path_and_query}"
+    stub_request(:get, url).to_return(:status => status, :body => body)
+  end
+
+  def teardown
+    EchoNest.instance_variable_set(:@config, nil)
+    WebMock.reset!
+  end
+
+end

data/test/request_test.rb

@@ -0,0 +1,34 @@
+$:.unshift '.';require File.dirname(__FILE__) + '/helper'
+
+module EchoNest
+  class RequestTest < Test::Unit::TestCase
+
+    context 'with credentials' do
+      setup do
+        setup_test_credentials
+      end
+
+      should 'raise if errors in response' do
+        mock(:bad_credentials, "artist/profile?api_key=fart&format=json&id=ARZGTK71187B9AC7F5", 400)
+        ex = assert_raise(RequestException) do 
+          Request.get("artist/profile", id: "ARZGTK71187B9AC7F5")
+        end
+        assert ex.message =~ /Invalid key: Unknown/i
+      end
+
+      should 'correctly build_url' do
+        request = Request.new("artist/profile", blah: 'huh', id: 'meh')
+        assert_equal 'http://developer.echonest.com/api/v4/artist/profile?api_key=fart&format=json&blah=huh&id=meh', request.build_url
+      end
+
+      should 'correctly build url with single bucket params' do 
+        request = Request.new("artist/profile", id: 'meh', bucket: 'biographies')
+        assert_equal 'http://developer.echonest.com/api/v4/artist/profile?api_key=fart&format=json&id=meh&bucket=biographies', request.build_url
+        request = Request.new("artist/profile", id: 'meh', bucket: %w(biographies songs id:spotify-WW))
+        assert_equal 'http://developer.echonest.com/api/v4/artist/profile?api_key=fart&format=json&id=meh&bucket=biographies&bucket=songs&bucket=id:spotify-WW', request.build_url
+      end
+
+    end
+
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,15 @@
+$:.unshift '.';require File.dirname(__FILE__) + '/helper'
+
+module EchoNest
+  class ResponseTest < Test::Unit::TestCase
+
+    should "create a hashie mash of data" do 
+      json = '{"response": {"status": {"version": "4.2", "code": 0, "message": "Success"}, "artist": {"id": "ARZGTK71187B9AC7F5", "name": "Eels"}}}'
+      response = Response.new(:raw_json => json)
+      artist = response.data.artist
+      assert_equal 'Eels', artist.name
+      assert_equal 'ARZGTK71187B9AC7F5', artist.id
+    end
+
+  end
+end

data/test/webmock/bad_credentials.json

@@ -0,0 +1 @@
+{"response": {"status": {"version": "4.2", "code": 1, "message": "1|Invalid key: Unknown"}}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: another_echonest_ruby_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zachary Kloepping
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-19 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -130,8 +130,23 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- README.md
+- .travis.yml
+- Gemfile
 - LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- another_echonest_ruby_api.gemspec
+- lib/another_echonest_ruby_api.rb
+- lib/another_echonest_ruby_api/config.rb
+- lib/another_echonest_ruby_api/query.rb
+- lib/another_echonest_ruby_api/request.rb
+- lib/another_echonest_ruby_api/response.rb
+- test/config_test.rb
+- test/helper.rb
+- test/request_test.rb
+- test/response_test.rb
+- test/webmock/bad_credentials.json
 homepage: http://github.com/spilliton/another_echonest_ruby_api
 licenses:
 - MIT