luchadeer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77d28c953c62036e898630d204bd3e630ecc90e5
+  data.tar.gz: 675625e43a2d925c7e1697d37ff5563a91536eb0
+SHA512:
+  metadata.gz: 53d5e8f133ffabf11316572708618b7a937c374647b30d09ed0fd6ea142f8a99b8a2862cb4f9d8b1e27707f4f731c9ae8ad10a80ad7c76b86b72c4d28814990d
+  data.tar.gz: dc98a568a7fb9af7c92ddcac6b99e7744f0ceae2f9c34466484c4e5d91762f893a6c1d6632a728c044ac4bc978dab654d92bc4b881d9262945d07166a918031a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+
+script: bundle exec rspec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    luchadeer (0.1.0)
+      faraday (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    mime-types (2.1)
+    multi_json (1.8.4)
+    multipart-post (2.0.0)
+    rake (10.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    safe_yaml (1.0.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.18.1)
+    tins (1.0.0)
+    webmock (1.17.2)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  coveralls
+  luchadeer!
+  rake
+  rspec
+  webmock

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Paul Friedman
+
+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,58 @@
+# Luchadeer
+
+[![Build Status](https://travis-ci.org/paulfri/luchadeer.png?branch=master)][build]
+[![Coverage Status](https://coveralls.io/repos/paulfri/luchadeer/badge.png?branch=master)][coverage]
+[![Code Climate](https://codeclimate.com/github/paulfri/luchadeer.png)][grade]
+
+[build]: (https://travis-ci.org/paulfri/luchadeer)
+[coverage]: https://coveralls.io/r/paulfri/luchadeer?branch=master
+[grade]: https://codeclimate.com/github/paulfri/luchadeer
+
+The bombingest Giant Bomb API client library for Ruby.
+
+## Features
+1. Fully unit-tested.
+2. Caches API responses.
+3. fully.recursive.dot.syntax, no random hash[:syntax] cutoff point
+4. Fetch full details for partial objects (e.g. embedded results) with object.detail.
+5. Thread-ready (thready?): no global or class state. Use convenience methods to use a default client per-thread, or use an alternate syntax for full control.
+
+## Configuration
+Get your API key [here](http://www.giantbomb.com/api).
+
+```ruby
+Luchadeer.configure(api_key: 'my_api_key') # default client for this thread
+Luchadeer::Client.new(api_key: 'my_api_key')
+```
+
+You can also pass a block to either method, and it will yield the client object to configure to your liking.
+
+```ruby
+Luchadeer.configure do |client|
+  client.api_key = 'my_api_key'
+end
+```
+
+## Supported resources
+* game
+* franchise
+* character
+* concept
+* object
+* location
+* person
+* company
+* video
+
+## Usage
+
+```ruby
+Luchadeer::Game.find(21373) # or...
+my_client.game(21373) # => #<Luchadeer::Game name="Shin Megami Tensei: Persona 4" ...>
+```
+
+## TODO
+1. Add filtering to search.
+2. Add per-resource searching class methods on each resource object.
+3. Refactor the test suite with shared example groups.
+4. Make the caching layer more flexible - more options besides in-memory store. Add a null store, too.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/luchadeer.rb

@@ -0,0 +1,32 @@
+require 'luchadeer/version'
+
+require 'luchadeer/api'
+require 'luchadeer/client'
+require 'luchadeer/error'
+require 'luchadeer/search'
+
+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 << self
+    def configure(opts = {}, &blk)
+      Luchadeer.client = Luchadeer::Client.new(opts, &blk)
+    end
+
+    def client
+      Thread.current[:luchadeer_client]
+    end
+
+    def client=(new_client)
+      Thread.current[:luchadeer_client] = new_client
+    end
+  end
+end

data/lib/luchadeer/api.rb

@@ -0,0 +1,51 @@
+require 'luchadeer/api/characters'
+require 'luchadeer/api/companies'
+require 'luchadeer/api/concepts'
+require 'luchadeer/api/franchises'
+require 'luchadeer/api/games'
+require 'luchadeer/api/locations'
+require 'luchadeer/api/objects'
+require 'luchadeer/api/people'
+require 'luchadeer/api/videos'
+
+module Luchadeer
+  module API
+    API_MODULES = [
+      Luchadeer::API::Characters,
+      Luchadeer::API::Companies,
+      Luchadeer::API::Concepts,
+      Luchadeer::API::Franchises,
+      Luchadeer::API::Games,
+      Luchadeer::API::Locations,
+      Luchadeer::API::Objects,
+      Luchadeer::API::People,
+      Luchadeer::API::Videos
+    ]
+
+    API_MODULES.each do |mod|
+      include mod
+    end
+
+    attr_writer :cache
+
+    def cache(key, refresh = false, &blk)
+      @cache ||= {}
+      @cache.delete(key) if refresh
+
+      if block_given?
+        @cache[key] || (@cache[key] = yield)
+      else
+        @cache.fetch(key)
+      end
+    end
+
+    def fetch(path, refresh = false, klass = Luchadeer::Resource)
+      return unless results = cache(path, refresh) do
+        get(path).body[:results]
+      end
+
+      results.is_a?(Array) ? results.map { |r| klass.new(r) } : klass.new(results)
+    end
+
+  end
+end

data/lib/luchadeer/api/characters.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Characters
+
+      def character(id, refresh = false)
+        fetch("character/3005-#{id}", refresh, Luchadeer::Character)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/companies.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Companies
+
+      def company(id, refresh = false)
+        fetch("company/3010-#{id}", refresh, Luchadeer::Company)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/concepts.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Concepts
+
+      def concept(id, refresh = false)
+        fetch("concept/3015-#{id}", refresh, Luchadeer::Concept)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/franchises.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Franchises
+
+      def franchise(id, refresh = false)
+        fetch("franchise/3025-#{id}", refresh, Luchadeer::Franchise)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/games.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Games
+
+      def game(id, refresh = false)
+        fetch("game/3030-#{id}", refresh, Luchadeer::Game)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/locations.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Locations
+
+      def location(id, refresh = false)
+        fetch("location/3035-#{id}", refresh, Luchadeer::Location)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/objects.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Objects
+
+      def object(id, refresh = false)
+        fetch("object/3055-#{id}", refresh, Luchadeer::Object)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/people.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module People
+
+      def person(id, refresh = false)
+        fetch("person/3040-#{id}", refresh, Luchadeer::Person)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/api/videos.rb

@@ -0,0 +1,11 @@
+module Luchadeer
+  module API
+    module Videos
+
+      def video(id, refresh = false)
+        fetch("video/2300-#{id}", refresh, Luchadeer::Video)
+      end
+
+    end
+  end
+end

data/lib/luchadeer/character.rb

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

data/lib/luchadeer/client.rb

@@ -0,0 +1,73 @@
+require 'faraday'
+require 'luchadeer/middleware/follow_redirects'
+require 'luchadeer/middleware/parse_json'
+require 'luchadeer/middleware/parse_http_error'
+require 'luchadeer/middleware/parse_api_error'
+
+module Luchadeer
+  class Client
+    include Luchadeer::API
+
+    attr_accessor :api_key
+    GIANT_BOMB = 'http://www.giantbomb.com/api'
+
+    def initialize(opts = {})
+      opts.each do |key, value|
+        send(:"#{key}=", value)
+      end
+
+      yield self if block_given?
+    end
+
+    def user_agent
+      "Luchadeer #{Luchadeer::VERSION}"
+    end
+
+    def api_key?
+      not (api_key.nil? || api_key == '')
+    end
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+  private
+
+    def connection
+      @_connection ||= Faraday.new(GIANT_BOMB, connection_options)
+    end
+
+    def connection_options
+      {
+        builder: middleware,
+        headers: {
+          accept: 'application/json',
+          user_agent: user_agent,
+        }
+      }
+    end
+
+    def middleware
+      Faraday::RackBuilder.new do |builder|
+        # order is important
+        builder.response :parse_api_error
+        builder.response :parse_json
+        builder.response :parse_http_error
+        builder.response :follow_redirects
+
+        builder.adapter  :net_http
+      end
+    end
+
+    def request(method, path, params = {})
+      connection.send(method.to_sym, path, params.merge(default_params))
+    # rescue => e
+    #   raise Luchadeer::Error.new(e)
+    end
+
+    def default_params
+      { format: 'json', api_key: api_key }
+    end
+
+  end
+end