echonest-ruby-api 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in echonest-ruby-api.gemspec
+gemspec
+
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    echonest-ruby-api (0.0.3)
+      httparty
+      multi_json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    httparty (0.10.2)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    listen (0.7.2)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    multi_xml (0.5.2)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
+    rb-fsevent (0.9.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    slop (3.3.3)
+    terminal-table (1.4.5)
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  echonest-ruby-api!
+  guard-rspec
+  rake
+  rb-fsevent (~> 0.9.1)
+  rspec (~> 2.6)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color --format documentation" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Woolf
+
+MIT License
+
+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.md

@@ -0,0 +1,47 @@
+# echonest-ruby-api [![Code Climate](https://codeclimate.com/github/maxehmookau/echonest-ruby-api.png)](https://codeclimate.com/github/maxehmookau/echonest-ruby-api)
+[![Build Status](https://travis-ci.org/maxehmookau/echonest-ruby-api.png)](https://travis-ci.org/maxehmookau/echonest-ruby-api)
+[![Dependency Status](https://gemnasium.com/maxehmookau/echonest-ruby-api.png)](https://gemnasium.com/maxehmookau/echonest-ruby-api)
+TODO: Everything. (also, come up with a cool name)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'echonest-ruby-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install echonest-ruby-api
+
+*That said, probably don't do any of that, since nothing works yet...*
+
+## Usage
+
+Require the gem in your file:
+
+    require 'echonest-ruby-api'
+
+Create an instance of an object
+
+    a = Echonest::Artist.new('Weezer', 'YOUR-API-KEY')
+
+Find out some stuff!
+
+    a.blogs(results: 20)
+    a.biographies
+
+Calls will return the first result unless setting the `results` option.
+
+*Any valid option for echonest API calls will work as normal*
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+ 
+RSpec::Core::RakeTask.new(:spec) 
+ 
+task :default  => :spec

data/echonest-ruby-api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'echonest-ruby-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "echonest-ruby-api"
+  gem.version       = Echonest::VERSION
+  gem.authors       = ["Max Woolf"]
+  gem.email         = ["max.woolf@boxuk.com"]
+  gem.description   = "A gem to get hold of some echonest stuff!"
+  gem.summary       = "A gem to get hold of some echonest stuff!"
+  gem.homepage      = "http://maxehmookau.github.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('httparty')
+  gem.add_dependency('multi_json')
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+end

data/lib/artist.rb

@@ -0,0 +1,83 @@
+require "rubygems"
+require "bundler/setup"
+require 'httparty'
+require 'multi_json'
+require_relative 'base'
+
+module Echonest
+
+  class Artist < Echonest::Base
+
+    def initialize(api_key, name = nil)
+      @name = name
+      @api_key = api_key
+    end
+
+    def name
+      @name
+    end
+
+    def entity_name
+      self.class.to_s.split('::').last.downcase
+    end
+
+    def get_response(options = {})
+      get(endpoint, options)
+    end
+
+    def endpoint
+      calling_method = caller[1].split('`').last[0..-2]
+      "#{ entity_name }/#{ calling_method }"
+    end
+
+    def biographies(options = { results: 1 })
+      response = get_response(results: options[:results], name: @name)
+      biographies = []
+      response[:biographies].each do |b|
+        biographies << Biography.new(text: b[:text], site: b[:site], url: b[:url])
+      end
+      biographies
+    end
+
+    def blogs(options = { results: 1 })
+      response = get_response(results: options[:results], name: @name)
+      blogs = []
+      response[:blogs].each do |b|
+        blogs << Blog.new(name: b[:name], site: b[:site], url: b[:url])
+      end
+      blogs
+    end
+
+    def familiarity
+      response = get_response(name: @name)
+      response[entity_name.to_sym][__method__.to_sym]
+    end
+
+    def hotttnesss
+      response = get_response(name: @name)
+      response[entity_name.to_sym][__method__.to_sym]
+    end
+
+    def images
+      response = get_response(name: @name)
+      images = []
+      response[:images].each do |i|
+        images << i[:url]
+      end
+      images
+    end
+
+    def list_genres
+      get_response[:genres]
+    end
+
+    def songs
+      songs = []
+      get_response(name: @name)[:songs].each do |s|
+        songs << { s[:id] => s[:title] }
+      end
+      songs
+    end
+
+  end
+end

data/lib/base.rb

@@ -0,0 +1,37 @@
+require 'artist'
+require 'biography'
+require 'blog'
+require 'news'
+
+module Echonest
+  class Base
+    class EchonestConnectionError < Exception; end
+
+    def initialize(api_key)
+      @api_key = api_key
+      @base_uri = "http://developer.echonest.com/api/v4/"
+    end
+
+    def self.base_uri
+      "http://developer.echonest.com/api/v#{ Base.version }/"
+    end
+
+    def self.version
+      4
+    end
+
+    def get(endpoint, options = {})
+      query_string = ""
+      options.each do |key, value|
+        query_string << "#{ key }=#{ value }&"
+      end
+      response = HTTParty.get("#{ Base.base_uri }#{ endpoint }?api_key=#{ @api_key }&format=json&#{ query_string }")
+      json = MultiJson.load(response.body, symbolize_keys: true)
+      response_code = json[:response][:status][:code]
+
+      response_code.eql?(0) ? json[:response] : raise(ArgumentError, "Error code #{ response_code }")
+
+    end
+
+  end
+end

data/lib/biography.rb

@@ -0,0 +1,21 @@
+class Biography
+
+  def initialize(options = {})
+    @text = options[:text]
+    @site = options[:site]
+    @url = options[:url]
+  end
+
+  def text
+    @text
+  end
+
+  def site
+    @site
+  end
+
+  def url
+    @url
+  end
+
+end

data/lib/blog.rb

@@ -0,0 +1,24 @@
+class Blog
+  def initialize(options = {})
+    @name = options[:name]
+    @summary = options[:summary]
+    @url = options[:url]
+    @date_posted = options[:date_posted]
+  end
+
+  def name
+    @name
+  end
+
+  def summary
+    @summary
+  end
+
+  def url
+    @url
+  end
+
+  def date_posted
+    @date_posted
+  end
+end

data/lib/echonest-ruby-api/news.rb

@@ -0,0 +1,26 @@
+class News
+
+  def initialize(options = {})
+    @name = options[:name]
+    @url = options[:url]
+    @date_posted = options[:date_posted]
+    @summary = options[:summary]
+  end
+
+  def name
+    @name
+  end
+
+  def url
+    @url
+  end
+
+  def date_posted
+    @date_posted
+  end
+
+  def summary
+    @summary
+  end
+
+end

data/lib/echonest-ruby-api/version.rb

@@ -0,0 +1,3 @@
+module Echonest
+  VERSION = "0.0.3"
+end

data/lib/echonest-ruby-api.rb

@@ -0,0 +1,6 @@
+require "echonest-ruby-api/version"
+require_relative 'artist'
+
+module Echonest
+
+end

data/lib/news.rb

@@ -0,0 +1,4 @@
+module Echonest
+  class News
+  end
+end

data/spec/artist_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'base'
+
+describe Echonest::Artist do
+
+  def create_valid_artist
+    @a = Echonest::Artist.new('BNOAEBT3IZYZI6WXI', 'Weezer')
+  end
+
+
+  it 'should allow an Artist to have a name' do
+    a = Echonest::Artist.new('12345', 'Weezer')
+    a.name.should eql 'Weezer'
+  end
+
+  describe '#entity_name' do
+
+    it 'should always return artist' do
+      a = Echonest::Artist.new('Weezer', '12345')
+      a.entity_name.should eql 'artist'
+    end
+
+  end
+
+  describe '#biographies' do
+
+    it 'should download a specified number of biographies' do
+      create_valid_artist
+      @a.biographies(results: 10).count.should be 10
+    end
+
+    it 'should return one biography by default' do
+      create_valid_artist
+      @a.biographies.count.should be 1
+    end
+
+    it 'should deal gracefully with an invalid API key' do
+      a = Echonest::Artist.new('Weezer', 'THISISNOTAKEY')
+      expect { a.biographies }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  describe '#blogs' do
+
+    it 'should download a specified number of blogs' do
+      create_valid_artist
+      @a.blogs(results: 10).count.should be 10
+    end
+
+    it 'should return one blog by default' do
+      create_valid_artist
+      @a.blogs.count.should be 1
+    end
+
+  end
+
+  describe '#familiarity' do
+
+    it 'should allow us to find out how familiar an artist is' do
+      create_valid_artist
+      @a.familiarity.should be_a Float
+    end
+
+  end
+
+  describe '#hotttnesss' do
+
+    it 'should allow us to find out how hotttt an artist is' do
+      create_valid_artist
+      @a.hotttnesss.should be_a Float
+    end
+
+  end
+
+  describe '#images' do
+
+    it 'should allow us to get an array of urls' do
+      create_valid_artist
+      @a.images.should be_a Array
+    end
+
+    it 'should only return urls in the array' do
+      create_valid_artist
+      @a.images.each do |i|
+        i.should match(/^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/)
+      end
+    end
+
+  end
+
+  describe '#list_genres' do
+
+    it 'should return an array of acceptable genres' do
+      create_valid_artist
+      @a.list_genres.should be_a Array
+    end
+
+    it 'should return an array in the correct format' do
+      create_valid_artist
+      @a.list_genres.each do |g|
+        g[:name].should be_a String
+      end
+    end
+
+  end
+
+  describe '#songs' do
+
+    it 'should return an Array of a Hash of songs' do
+      create_valid_artist
+      @a.songs.should be_a Array
+    end
+
+    it 'should return a valid hash for each song' do
+      create_valid_artist
+      @a.songs.each do |k|
+        k.should be_a Hash
+      end
+    end
+
+  end
+
+end

data/spec/base_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Echonest::Base do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'echonest-ruby-api'
+
+RSpec.configure do |config|
+
+end

data/tmp/rspec_guard_result

@@ -0,0 +1 @@
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: echonest-ruby-api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Max Woolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: A gem to get hold of some echonest stuff!
+email:
+- max.woolf@boxuk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- echonest-ruby-api.gemspec
+- lib/artist.rb
+- lib/base.rb
+- lib/biography.rb
+- lib/blog.rb
+- lib/echonest-ruby-api.rb
+- lib/echonest-ruby-api/news.rb
+- lib/echonest-ruby-api/version.rb
+- lib/news.rb
+- pkg/echonest-ruby-api-0.0.1.gem
+- pkg/echonest-ruby-api-0.0.3.gem
+- spec/artist_spec.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- tmp/rspec_guard_result
+homepage: http://maxehmookau.github.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A gem to get hold of some echonest stuff!
+test_files:
+- spec/artist_spec.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb