freemusicarchive 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+.rake_tasks~
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freemusicarchive.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Liane Nakamura
+
+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,52 @@
+# The Free Music Archive Ruby Gem
+
+A Ruby wrapper for the Free Music Archive API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'freemusicarchive'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freemusicarchive
+
+## Usage Examples
+
+See the [API Docs](http://freemusicarchive.org/api/docs/) for more information
+
+    require "rubygems"
+    require "freemusicarchive"
+    
+    # All methods require authentication by api key.
+    FreeMusicArchive.configure do |config|
+      config.api_key = YOUR_API_KEY
+    end
+    
+    # Get a list of all curators
+    puts FreeMusicArchive.curators
+    
+    # Get a list of all genres sorted by genre_id
+    puts FreeMusicArchive.genres(:sort_by => "genre_id")
+    
+    # Get a list of 10 artists
+    puts FreeMusicArchive.artists(:limit => 10)
+    
+    # Get a list albums by Arcade Fire
+    puts FreeMusicArchive.albums(:artist_handle => "Arcade_Fire")
+    
+    # Get a list of tracks that are permitted for commercial and remix purposes
+    puts FreeMusicArchive.tracks(:commercial => true, :remix => true)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/freemusicarchive.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/freemusicarchive/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Liane Nakamura"]
+  gem.email         = ["idiofox555+github@gmail.com"]
+  gem.description   = %q{A ruby wrapper for the Free Music Archive API}
+  gem.summary       = %q{The freemusicarchive gem is a wrapper for the Free Music Archive API. It provides simple methods to execute HTTP calls.}
+  gem.homepage      = ""
+
+  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.name          = "freemusicarchive"
+  gem.require_paths = ["lib"]
+  gem.version       = FreeMusicArchive::VERSION
+  
+  gem.add_dependency 'faraday', '~> 0.7'
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.8')
+  gem.add_runtime_dependency('hashie',  '>= 0.4.0')
+  gem.add_runtime_dependency('multi_xml', '~> 0.4.4')
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency('webmock', '~> 1.6')
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise FreeMusicArchive::BadRequest, error_message_400(response)
+        when 404
+          raise FreeMusicArchive::NotFound, error_message_400(response)
+        when 500
+          raise FreeMusicArchive::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 503
+          raise FreeMusicArchive::ServiceUnavailable, error_message_500(response, "Free Music Archive is rate limiting your requests.")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['meta'] and body['meta']['error_message'] and not body['meta']['error_message'].empty?
+        ": #{body['meta']['error_message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

data/lib/freemusicarchive.rb

@@ -0,0 +1,30 @@
+# Core modules
+require File.expand_path('../freemusicarchive/client', __FILE__)
+require File.expand_path('../freemusicarchive/configuration', __FILE__)
+
+module FreeMusicArchive
+  extend Configuration
+  
+  class << self
+  
+    # Alias for FreeMusicArchive::Client.new
+    #
+    # @return [FreeMusicArchive::Client]
+    def client (options={})
+      FreeMusicArchive::Client.new(options)
+    end
+  
+    # Delegate to FreeMusicArchive::Client
+    def method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
+
+    # Delegate to FreeMusicArchive::Client
+    def respond_to?(method)
+      return client.respond_to?(method) || super
+    end
+  
+  end
+  
+end

data/lib/freemusicarchive/client.rb

@@ -0,0 +1,31 @@
+require 'freemusicarchive/configuration'
+require 'freemusicarchive/request'
+
+module FreeMusicArchive
+  class Client
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+    
+    include FreeMusicArchive::Request
+    
+    include FreeMusicArchive::Client::Albums
+    include FreeMusicArchive::Client::Artists
+    include FreeMusicArchive::Client::Curators
+    include FreeMusicArchive::Client::Genres
+    include FreeMusicArchive::Client::Tracks
+    
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    
+    # Initializes a new API object
+    #
+    # @param attrs [Hash]
+    # @return [FreeMusicArchive::Client]
+    def initialize(attrs={})
+      attrs = FreeMusicArchive.options.merge(attrs)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+    
+  end
+
+end

data/lib/freemusicarchive/client/albums.rb

@@ -0,0 +1,11 @@
+module FreeMusicArchive
+  class Client
+    module Albums
+      
+      def albums(options={})
+        get("/api/get/albums", options)
+      end
+      
+    end
+  end
+end

data/lib/freemusicarchive/client/artists.rb

@@ -0,0 +1,11 @@
+module FreeMusicArchive
+  class Client
+    module Artists
+      
+      def artists(options={})
+        get("/api/get/artists", options)
+      end
+      
+    end
+  end
+end

data/lib/freemusicarchive/client/curators.rb

@@ -0,0 +1,11 @@
+module FreeMusicArchive
+  class Client
+    module Curators
+      
+      def curators(options={})
+        get("/api/get/curators", options)
+      end
+      
+    end
+  end
+end

data/lib/freemusicarchive/client/genres.rb

@@ -0,0 +1,11 @@
+module FreeMusicArchive
+  class Client
+    module Genres
+      
+      def genres(options={})
+        get("/api/get/genres", options)
+      end
+      
+    end
+  end
+end

data/lib/freemusicarchive/client/tracks.rb

@@ -0,0 +1,11 @@
+module FreeMusicArchive
+  class Client
+    module Tracks
+      
+      def tracks(options={})
+        get("/api/get/tracks", options)
+      end
+      
+    end
+  end
+end

data/lib/freemusicarchive/configuration.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module FreeMusicArchive
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {FreeMusicArchive::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_key,
+      :endpoint,
+      :format,
+      :user_agent,
+      :proxy
+    ].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_API_KEY = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'http://freemusicarchive.org'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    DEFAULT_FORMAT = :xml
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Free Music Archive Ruby Gem #{FreeMusicArchive::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter        = DEFAULT_ADAPTER
+      self.api_key        = DEFAULT_API_KEY
+      self.endpoint       = DEFAULT_ENDPOINT
+      self.format         = DEFAULT_FORMAT
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.proxy          = DEFAULT_PROXY
+    end
+  end
+end

data/lib/freemusicarchive/error.rb

@@ -0,0 +1,19 @@
+module FreeMusicArchive
+  # Custom error class for rescuing from all Free Music Archive errors
+  class Error < StandardError; end
+
+  # Raised when Free Music Archive returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Free Music Archive returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Free Music Archive returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Free Music Archive returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+end

data/lib/freemusicarchive/request.rb

@@ -0,0 +1,43 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module FreeMusicArchive
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, unformatted=false)
+      response = connection.get do |req|
+        req.url(formatted_path(path), options)
+        if api_key != nil
+          req.params['api_key'] = api_key
+        end
+      end
+      response.body.data
+    end
+
+    private
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  
+    def connection()
+      options = {
+        :headers => {:accept => "application/#{format}; charset=utf-8", :user_agent => user_agent},
+        :proxy => proxy,
+        :ssl => { :verify => false },
+        :url => endpoint,
+      }
+      
+      Faraday.new(options) do |builder|
+        #builder.use Faraday::Response::Logger
+        builder.use Faraday::Request::UrlEncoded
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseXml
+        builder.adapter(adapter)
+        builder.use FaradayMiddleware::RaiseHttpException
+      end
+    end
+    
+  end
+end

data/lib/freemusicarchive/version.rb

@@ -0,0 +1,3 @@
+module FreeMusicArchive  
+  VERSION = '0.0.1'
+end