luchadeer 0.1.0

data/lib/luchadeer/company.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Company < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.company(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/concept.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Concept < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.concept(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/error.rb

@@ -0,0 +1,50 @@
+module Luchadeer
+  class Error < StandardError
+
+    # http://www.giantbomb.com/api/documentation#toc-0-0
+    module Codes
+      OK                     = 1
+      INVALID_API_KEY        = 100
+      OBJECT_NOT_FOUND       = 101
+      URL_FORMAT_ERROR       = 102
+      FILTER_ERROR           = 104
+      SUBSCRIBER_ONLY        = 105
+    end
+
+    # Used for bespoke status codes returned in the response body
+    def self.api_errors
+      {
+        Codes::INVALID_API_KEY  => Luchadeer::Error::InvalidAPIKey,
+        Codes::OBJECT_NOT_FOUND => Luchadeer::Error::NotFound,
+        Codes::URL_FORMAT_ERROR => Luchadeer::Error::URLFormatError,
+        Codes::FILTER_ERROR     => Luchadeer::Error::FilterError,
+        Codes::SUBSCRIBER_ONLY  => Luchadeer::Error::SubscriberOnly
+      }
+    end
+
+    # Used for HTTP status codes
+    def self.http_errors
+      {
+        400 => Luchadeer::Error::BadRequest,
+        404 => Luchadeer::Error::NotFound,
+        500 => Luchadeer::Error::InternalServerError,
+        502 => Luchadeer::Error::InternalServerError, # unconfirmed
+        503 => Luchadeer::Error::InternalServerError, # unconfirmed
+        504 => Luchadeer::Error::InternalServerError, # unconfirmed
+      }
+    end
+
+  private
+
+    class RedirectLimitReached < Luchadeer::Error; end
+    class RequestTimeout < Luchadeer::Error; end
+
+    class InvalidAPIKey < Luchadeer::Error; end
+    class URLFormatError < Luchadeer::Error; end
+    class FilterError < Luchadeer::Error; end
+    class SubscriberOnly < Luchadeer::Error; end
+    class BadRequest < Luchadeer::Error; end
+    class NotFound < Luchadeer::Error; end
+    class InternalServerError < Luchadeer::Error; end
+  end
+end

data/lib/luchadeer/franchise.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Franchise < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.franchise(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/game.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Game < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.game(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/location.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Location < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.location(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/middleware/follow_redirects.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+require 'set'
+require 'luchadeer/error'
+
+module Luchadeer
+  module Middleware
+    class FollowRedirects < Faraday::Response::Middleware
+      FOLLOW_LIMIT = 3
+
+      def call(env)
+        follow_redirect(env, FOLLOW_LIMIT)
+      end
+
+    private
+
+      def follow_redirect(env, follows)
+        request_body = env[:body]
+        response = @app.call(env)
+
+        response.on_complete do |env|
+          if follow_redirect?(env, response)
+            raise Luchadeer::Error::RedirectLimitReached, response if follows.zero?
+
+            env      = update_env(env, request_body, response)
+            response = follow_redirect(env, follows - 1)
+          end
+        end
+
+        response
+      end
+
+      def follow_redirect?(env, response)
+        env[:method] == :get and [301, 302, 303, 307].include? response.status
+      end
+
+      def update_env(env, request_body, response)
+        env[:url] += response['location']
+        env[:method] = :get
+
+        [:status, :response, :response_headers].each do |key|
+          env.delete key
+        end
+
+        env
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware follow_redirects: Luchadeer::Middleware::FollowRedirects

data/lib/luchadeer/middleware/parse_api_error.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'luchadeer/error'
+
+module Luchadeer
+  module Middleware
+    class ParseAPIError < Faraday::Response::Middleware
+
+      def on_complete(response)
+        klass = Luchadeer::Error.api_errors[response.body[:status_code]]
+
+        fail(klass.new(response.body[:error])) if klass
+      end
+
+    end
+  end
+end
+
+Faraday::Response.register_middleware parse_api_error: Luchadeer::Middleware::ParseAPIError

data/lib/luchadeer/middleware/parse_http_error.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'luchadeer/error'
+
+module Luchadeer
+  module Middleware
+    class ParseHTTPError < Faraday::Response::Middleware
+
+      def on_complete(response)
+        klass = Luchadeer::Error.http_errors[response.status.to_i]
+
+        fail(klass.new) if klass
+      end
+
+    end
+  end
+end
+
+Faraday::Response.register_middleware parse_http_error: Luchadeer::Middleware::ParseHTTPError

data/lib/luchadeer/middleware/parse_json.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'json'
+
+# adapted from the 'twitter' gem
+# https://github.com/sferik/twitter/blob/88d7b19e295f27e1dcf970b979585fa9d3984cd6/lib/twitter/rest/response/parse_json.rb
+module Luchadeer
+  module Middleware
+    class ParseJSON < Faraday::Response::Middleware
+      WHITESPACE_REGEX = /\A^\s*$\z/
+
+      def parse(body)
+        case body
+        when WHITESPACE_REGEX, nil
+          nil
+        else
+          JSON.parse(body, symbolize_names: true)
+        end
+      end
+
+      def on_complete(response)
+        response.body = parse(response.body)
+      end
+
+    end
+  end
+end
+
+Faraday::Response.register_middleware parse_json: Luchadeer::Middleware::ParseJSON

data/lib/luchadeer/object.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Object < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.object(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/person.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Person < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.person(id, refresh)
+      end
+    end
+
+  end
+end

data/lib/luchadeer/resource.rb

@@ -0,0 +1,37 @@
+module Luchadeer
+  class Resource < OpenStruct
+
+    # http://andreapavoni.com/blog/2013/4/create-recursive-openstruct-from-a-ruby-hash
+    def initialize(hash = nil)
+      @table = {}
+      @hash_table = {}
+
+      return unless hash
+
+      hash.each do |k, v|
+        @hash_table[k.to_sym] = v
+        @table[k.to_sym] = deep_structify(k, v)
+        new_ostruct_member(k)
+      end
+    end
+
+    def to_h
+      @hash_table
+    end
+
+    def detail
+      api_detail_url ? Luchadeer.client.fetch(api_detail_url, false, self.class) : self
+    end
+
+  private
+
+    def deep_structify(k, v)
+      case v
+      when Hash then Luchadeer::Resource.new(v)
+      when Array then v.map { |n| Luchadeer::Resource.new(n) }
+      else v
+      end
+    end
+
+  end
+end

data/lib/luchadeer/search.rb

@@ -0,0 +1,45 @@
+require 'luchadeer/character'
+require 'luchadeer/company'
+require 'luchadeer/concept'
+require 'luchadeer/franchise'
+require 'luchadeer/game'
+require 'luchadeer/location'
+require 'luchadeer/object'
+require 'luchadeer/person'
+require 'luchadeer/video'
+
+module Luchadeer
+  class Search
+    attr_accessor :query
+
+    RESOURCE_TYPES = {
+      'character' => Luchadeer::Character,
+      'company'   => Luchadeer::Company,
+      'concept'   => Luchadeer::Concept,
+      'franchise' => Luchadeer::Franchise,
+      'game'      => Luchadeer::Game,
+      'location'  => Luchadeer::Location,
+      'object'    => Luchadeer::Object,
+      'person'    => Luchadeer::Person,
+      'video'     => Luchadeer::Video
+    }
+
+    def initialize(query)
+      @query = query
+    end
+
+    def fetch
+      Luchadeer.client.get('search', search_params).body[:results].map do |r|
+        type = r.delete(:resource_type)
+        RESOURCE_TYPES[type] && RESOURCE_TYPES[type].new(r)
+      end.compact
+    end
+
+  private
+
+    def search_params
+      { query: @query }
+    end
+
+  end
+end

data/lib/luchadeer/version.rb

@@ -0,0 +1,3 @@
+module Luchadeer
+  VERSION = '0.1.0'
+end

data/lib/luchadeer/video.rb

@@ -0,0 +1,13 @@
+require 'luchadeer/resource'
+
+module Luchadeer
+  class Video < Resource
+
+    class << self
+      def find(id, refresh = false)
+        Luchadeer.client.video(id, refresh)
+      end
+    end
+
+  end
+end

data/luchadeer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'luchadeer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'luchadeer'
+  spec.version       = Luchadeer::VERSION
+  spec.authors       = ['Paul Friedman']
+  spec.email         = ['paulrfri@gmail.com']
+  spec.summary       = %q{The bombingest Giant Bomb API client library for Ruby.}
+  spec.homepage      = 'https://github.com/paulfri/luchadeer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'coveralls'
+end

data/spec/luchadeer/api/characters_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Luchadeer::API::Characters do
+  let(:client) { Luchadeer::Client.new }
+
+  describe '#characters' do
+    let(:character_id) { 1 }
+    let(:character_path) { %r(#{Luchadeer::Client::GIANT_BOMB}/character/3005-#{character_id}) }
+
+    it 'requests the right url' do
+      stub = stub_request(:get, character_path).to_return(body: '{ }')
+      client.character("#{character_id}")
+      expect(stub).to have_been_requested
+    end
+
+    it 'returns a Luchadeer::Character' do
+      stub_request(:get, character_path).to_return(body: '{ "results": { "key": "value"}}')
+      expect(client.character("#{character_id}")).to be_instance_of Luchadeer::Character
+    end
+
+    it 'caches responses' do
+      stub_request(:get, character_path).to_return(body: '{ }')
+      expect(client).to receive :cache
+      client.character("#{character_id}")
+    end
+
+  end
+end

data/spec/luchadeer/api/companies_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Luchadeer::API::Characters do
+  let(:client) { Luchadeer::Client.new }
+
+  describe '#companies' do
+    let(:company_id) { 1 }
+    let(:company_path) { %r(#{Luchadeer::Client::GIANT_BOMB}/company/3010-#{company_id}) }
+
+    it 'requests the right url' do
+      stub = stub_request(:get, company_path).to_return(body: '{ }')
+      client.company("#{company_id}")
+      expect(stub).to have_been_requested
+    end
+
+    it 'returns a Luchadeer::Company' do
+      stub_request(:get, company_path).to_return(body: '{ "results": { "key": "value"}}')
+      expect(client.company("#{company_id}")).to be_instance_of Luchadeer::Company
+    end
+
+    it 'caches responses' do
+      stub_request(:get, company_path).to_return(body: '{ }')
+      expect(client).to receive :cache
+      client.company("#{company_id}")
+    end
+
+  end
+end