shuffler_fm 0.0.1

data/lib/shuffler_fm/middleware/error_handler.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+
+module ShufflerFM
+  # @private
+  module Middleware
+    class ErrorHandler < Faraday::Response::Middleware
+      def on_complete(response)
+        case response[:status].to_i
+        when 400
+          raise ShufflerFM::BadRequest, error_message(response)
+        when 401
+          raise ShufflerFM::Unauthorized, error_message(response)
+        when 403
+          raise ShufflerFM::Forbidden, error_message(response)
+        when 404
+          raise ShufflerFM::NotFound, error_message(response)
+        when 406
+          raise ShufflerFM::NotAcceptable, error_message(response)
+        when 422
+          raise ShufflerFM::UnprocessableEntity, error_message(response)
+        when 429
+          raise ShufflerFM::TooManyRequests, error_message(response)
+        when 500
+          raise ShufflerFM::InternalServerError, error_message(response)
+        when 501
+          raise ShufflerFM::NotImplemented, error_message(response)
+        when 502
+          raise ShufflerFM::BadGateway, error_message(response)
+        when 503
+          raise ShufflerFM::ServiceUnavailable, error_message(response)
+        end
+      end
+
+      private
+      def error_message(response)
+        msg = case response[:status].to_i
+        when 400
+          "The requested URL was not found on the server."
+        when 429
+          "Hourly rate-limit exceded."
+        else
+          response[:body].nil? ? "" : response[:body]
+        end
+
+        "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} #{msg}"
+      end
+    end
+  end
+end

data/lib/shuffler_fm/request.rb

@@ -0,0 +1,25 @@
+module ShufflerFM
+  # @private
+  module Request
+    # Performs an HTTP GET request
+    #
+    # == Parameters:
+    # @param [String] path The request path
+    # @param [Hash] options The operation options
+    #
+    # @return The HTTP response
+    #
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    private
+    def request(method, path, options = {})
+      response = http_connection.send(method) do |request|
+        request.url("#{API.version}/#{path}", options)
+      end
+
+      response.body
+    end
+  end
+end

data/lib/shuffler_fm/version.rb

@@ -0,0 +1,3 @@
+module ShufflerFM
+  VERSION = "0.0.1"
+end

data/lib/shuffler_fm.rb

@@ -0,0 +1,67 @@
+require 'shuffler_fm/version'
+require 'shuffler_fm/configuration'
+require 'shuffler_fm/api'
+
+#
+# shuffler_fm is a thin ruby API wrapper for http://shuffler.fm REST API
+#
+module ShufflerFM
+  class << self
+    # Provides an API for a given API key
+    #
+    # @overload api(key)
+    #   @param [String] key An api key provided by http://shuffler.fm
+    #
+    #   @return [ShufflerFM::API]
+    #
+    #   @example get an API instance
+    #     api = ShufflerFM.api("your-api-key")
+    #     api.tracks # gets 1st page of the track list
+    #
+    # @overload api(key, configuration)
+    #   @param [String] key An api key provided by http://shuffler.fm
+    #   @param [Hash] configuration The configuration descriptor
+    #
+    #   @option configuration [Integer] :connection_timeout The connection timeout in seconds. Defaults to 2.
+    #   @option configuration [Integer] :read_timeout The open/read timeout in seconds. Defaults to 5.
+    #   @option configuration [String]  :proxy The proxy. Is unset by default. (e.g. 'http://192.168.1.1:8080')
+    #
+    #   @return [ShufflerFM::API]
+    #
+    #   @example
+    #     api = ShufflerFM.api("your-api-key", connection_timeout: 2, read_timeout: 3, proxy: 'http://192.168.1.1:8080')
+    #     api.tracks # gets 1st page of the track list
+    #
+    # @see ShufflerFM.configure
+    # @see ShufflerFM::Configuration
+    #
+    def api(key, configuration = {})
+      self.configuration = Configuration.new(configuration)
+      ShufflerFM::API.new(key)
+    end
+
+    # @!attribute [rw] configuration
+    #   Access to the configuration descriptor
+    attr_accessor :configuration
+
+    # API wide configrations
+    #
+    # @yield [config] the configuration descriptor
+    #
+    # @see ShufflerFM.api
+    # @see ShufflerFM::Configuration
+    #
+    # @example
+    #   ShufflerFM.configure do |config|
+    #     config.connection_timeout = 1 #seconds
+    #     config.read_timeout       = 5 #seconds
+    #     config.proxy              = { uri: 'http://192.168.1.1:8080', user: 'user1', password: 'passwd'}
+    #   end
+    #
+    def configure
+      yield(self.configuration)
+    end
+  end
+
+  self.configuration = Configuration.new
+end

data/shuffler_fm.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shuffler_fm/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "shuffler_fm"
+  gem.version       = ShufflerFM::VERSION
+  gem.authors       = ["Miguel Guinada"]
+  gem.email         = ["mguinada@gmail.com"]
+  gem.description   = %q{ shuffler_fm wraps shuffler.fm's REST api on a thin layer of ruby. }
+  gem.summary       = %q{ Ruby API wrapper for http://shuffler.fm }
+  gem.homepage      = "https://github.com/mguinada/shuffler_fm"
+  gem.date          = Time.now.utc.strftime("%Y-%m-%d")
+
+  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"]
+
+  #package
+  gem.add_dependency 'faraday',            '~> 0.8'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
+  gem.add_dependency 'rash',               '~> 0.3'
+  gem.add_dependency 'multi_json',         '~> 1.3'
+
+  #development
+  gem.add_development_dependency 'json'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'maruku'
+end

data/spec/config.yml.sample

@@ -0,0 +1,3 @@
+#Copy this file naming it as: config.yml
+#Set to your api key from shuffle.fm and run: rspec (or rake)
+key: 'A KEY'

data/spec/fixtures/vcr_cassettes/api.yml

@@ -0,0 +1,26 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: http://api.shuffler.fm/v1/tracks?api-key=NO-SUCH-KEY&page=1
+    body: 
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+  response: 
+    status: 
+      code: 403
+      message: FORBIDDEN
+    headers: 
+      Content-Type: 
+      - text/html; charset=utf-8
+      Content-Length: 
+      - "39"
+      Server: 
+      - TornadoServer/2.4
+    body: 
+      string: That API-key is invalid my dear friend.
+    http_version: 
+  recorded_at: Tue, 25 Sep 2012 20:54:36 GMT
+recorded_with: VCR 2.2.5