giant_bomb_api 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fd8d486158ad9852607a5d5449d7c178231d240
+  data.tar.gz: 6db2a32b7bb1b96b9c0b2558f049f777aba75347
+SHA512:
+  metadata.gz: e4c734f8103a813df3ed478f91066c14639282e48d3229b6274c01ad594e990455bfcb14b546d30f02095c6eeb06fe417b1373a7feaaf3245e53e557347e21fc
+  data.tar.gz: 148e746b6817d37b70cd31511c2a9419169dec0d18c781198ef5015a984fd6bdb92907da0c725e9a7a1e7bcad9ef830e6f907dcdfa9fab73c0558a564d78ee26

data/.gitignore

@@ -0,0 +1,3 @@
+bin
+coverage
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+LineLength:
+  Max: 999
+Documentation:
+  Enabled: false
+StringLiterals:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+giant_bomb_api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    giant_bomb_api (0.1)
+      activesupport
+      faraday
+      faraday_middleware
+      require_all
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    codeclimate-test-reporter (0.4.5)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.0)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.0.1)
+      byebug (~> 3.4)
+      pry (~> 0.10)
+    rake (10.1.1)
+    require_all (1.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    timecop (0.7.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  giant_bomb_api!
+  pry-byebug
+  rake (~> 10.1.0)
+  rspec (~> 3.0)
+  timecop

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tim Adler
+
+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,155 @@
+# Giant Bomb API
+
+An unofficial ruby wrapper for the [Giantbomb API](http://api.giantbomb.com). An API that provides structured data about videogames. You should inform yourself about the endpoints at http://www.giantbomb.com/api/documentation .
+
+This gem aims to provide access to most endpoints on the API. You'll be able to **search**, **filter** and page throught most of them. See further below on what is supported. 
+
+**Contributors are welcome**. Please contact [@toadle](https://github.com/toadle).
+
+[![Code Climate](https://codeclimate.com/github/toadle/giant_bomb_api/badges/gpa.svg)](https://codeclimate.com/github/toadle/giant_bomb_api)
+[![Test Coverage](https://codeclimate.com/github/toadle/giant_bomb_api/badges/coverage.svg)](https://codeclimate.com/github/toadle/giant_bomb_api/coverage)
+[![Circle CI](https://circleci.com/gh/toadle/giant_bomb_api/tree/dev.svg?style=svg)](https://circleci.com/gh/toadle/giant_bomb_api/tree/dev)
+
+## Changelog
+* **2015-09-19**: Initial release as 0.5
+
+# Installation
+
+As you'd expect. Nothing special here: 
+
+```
+gem install giant_bomb_api
+```
+
+or in your `Gemfile`
+
+```
+gem giant_bomb_api
+```
+
+# How to use
+
+## Configuration
+
+Before you use GiantBombApi you need to configure it:
+```
+GiantBombApi.configure do |config|
+  config.api_key = "your api-key"
+end
+```
+
+## Usage
+
+There is several ways to query the GiantBomb-Database.
+
+### General search
+```
+GiantBombApi.search("your query")
+```
+It will return a list of games that match you query. 
+
+If you want to be more specific, you can create your own search-request: 
+
+```
+GiantBombApi::Request::Search.new("your query", resources: [array of GiantBombApi::Resource-classes], limit: 100, page: 1)
+```
+
+e.g.
+
+```
+GiantBombApi::Request::Search.new("spelunky", resources: [GiantBombApi::Resource::Game], limit: 100, page: 1)
+```
+
+or
+
+```
+GiantBombApi::Request::Search.new("mario", resources: [GiantBombApi::Resource::Game, GiantBombApi::Resource::Character], limit: 100, page: 1)
+```
+
+your can then use `GiantBombApi.client` to send the request like: 
+
+```
+GiantBombApi.client.send_request(<your request>)
+```
+
+This returns a `GiantBombApi::Response` where your can find your results in `response.results`. This might be a collection of things or just one object.
+
+
+### Getting details
+
+If you want a special object by ID you can just do something like:
+
+```
+GiantBombApi::Resource::Game.find(id)
+```
+
+Available resources are:
+
+```
+- GiantBombApi::Resource::Accessory
+- GiantBombApi::Resource::Character
+- GiantBombApi::Resource::Chat
+- GiantBombApi::Resource::Company
+- GiantBombApi::Resource::Concept
+- GiantBombApi::Resource::Franchise
+- GiantBombApi::Resource::Game
+- GiantBombApi::Resource::GameRating
+- GiantBombApi::Resource::Genre
+- GiantBombApi::Resource::Location
+- GiantBombApi::Resource::Object
+- GiantBombApi::Resource::Person
+- GiantBombApi::Resource::Platform
+- GiantBombApi::Resource::Promo
+- GiantBombApi::Resource::RatingBoard
+- GiantBombApi::Resource::Region
+- GiantBombApi::Resource::Release
+- GiantBombApi::Resource::Review
+- GiantBombApi::Resource::Theme
+- GiantBombApi::Resource::UserReview
+- GiantBombApi::Resource::Video
+- GiantBombApi::Resource::VideoType
+```
+
+### Requesting collections
+
+You can also directly query a resource that has a collection-endpoint.
+
+This is available for all resources that the [Giantbomb API](http://www.giantbomb.com/api/documentation) offers a 'collection' for. e.g. `game` and `games`or `character` and `characters`.
+
+e.g. all:
+
+```
+GiantBombApi::Resource::Game.all
+```
+
+this call supports optional sorting, e.g.:
+
+```
+GiantBombApi::Resource::Game.all(sort: { name: :desc })
+```
+
+if you want to get more detailed your can do: 
+
+```
+GiantBombApi::Resource::Game.where(name: "spelunky", aliases: "something", sort: { name: :desc }, limit: 10, offset: 0)
+```
+
+
+## Response
+
+Every API-request will always return a `GiantBombApi::Response`-object that has the following attributes: 
+
+- `limit`: The limit that applied
+- `offset`: The offset that applied
+- `number_of_page_results`: Guess!
+- `number_of_total_results`: Meeeh...
+- `results`: An array of stuff that you were looking for ;-)
+
+For everything else I urge you to look through the code.
+
+## Feedback
+Feedback and pull-request are always welcome. 
+You can find the author via http://toadle.me
+
+## License
+The giant_bomb_api-gem is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new :spec

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  environment:
+    CODECLIMATE_REPO_TOKEN: "1fdcaf004abc7657d5aeb234af9f3da6419b07aaad7b78ea5d837bc9da2b78b9"
+  timezone: "Europe/Berlin"
+  ruby:
+    version: "2.2.2"

data/giant_bomb_api.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name                      = "giant_bomb_api"
+  s.version                   = "0.5.1"
+  s.default_executable        = "giantbomb"
+
+  s.authors                   = ["Tim Adler"]
+  s.date                      = %q{2015-09-19}
+  s.description               = %q{An unofficial ruby wrapper for the Giantbomb API (http://api.giantbomb.com). An API that provides structured data about videogames.}
+  s.summary                   = s.description
+  s.email                     = %q{mail (at) toadle (dot) me}
+  s.license                   = "MIT"
+
+  s.files                     = `git ls-files`.split("\n")
+  s.test_files                = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage                  = %q{https://github.com/toadle/giant_bomb_api}
+  s.require_paths             = ["lib"]
+  s.rubygems_version          = %q{1.6.2}
+
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'require_all'
+
+  s.add_development_dependency 'rake', '~> 10.1.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'codeclimate-test-reporter'
+
+end
+

data/lib/giant_bomb_api.rb

@@ -0,0 +1,38 @@
+require 'active_support/all'
+require 'require_all'
+
+require_rel 'giant_bomb_api/**/*.rb'
+
+module GiantBombApi
+
+  class Configuration
+    attr_accessor :api_key
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.raise_error(message)
+    raise Exception.new message
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+
+    @@client = nil
+  end
+
+  def self.search(query)
+    client.send_request(Request::Search.new(query))
+  end
+
+  def self.client
+    raise_error "Configure GiantBombApi-module before using" if configuration.nil?
+    raise_error "Configure 'api_key' first" if configuration.api_key.nil?
+
+    @@client ||= GiantBombApi::Client.new(api_key: configuration.api_key)
+  end
+
+end

data/lib/giant_bomb_api/client.rb

@@ -0,0 +1,54 @@
+require 'digest'
+require 'uri'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module GiantBombApi
+  class Client
+    attr_accessor :api_key
+
+    API_URL = 'http://api.giantbomb.com'
+
+    def initialize(api_key: nil, options: {})
+      @api_key = api_key
+      @options = options
+    end
+
+    def send_request(giant_bomb_api_request)
+      connection = Faraday.new(url: API_URL) do |faraday|
+        faraday.request  :url_encoded
+        faraday.use      FaradayMiddleware::FollowRedirects
+        faraday.adapter  Faraday.default_adapter
+      end
+
+      response = connection.get do |req|
+        req.url giant_bomb_api_request.end_point
+        req.options[:timeout] = 5
+        req.options[:open_timeout] = 2
+        req.params = giant_bomb_api_request.params.merge(format: 'json', api_key: api_key)
+      end 
+
+      response_json = JSON.parse(response.body)
+
+      if(response_json["status_code"] == 1)
+        response = handle_success_response(response_json)
+        response.request = giant_bomb_api_request
+        response
+      else
+        handle_error_response(response_json)
+      end
+    end
+
+    private
+
+    def handle_success_response(response_json)
+      GiantBombApi::Response.new response_json
+    end
+
+    def handle_error_response(response_json)
+      raise Exception::ApiError.new(response_json["status_code"], response_json["error"])
+    end
+
+  end
+end

data/lib/giant_bomb_api/collection_resource.rb

@@ -0,0 +1,40 @@
+module GiantBombApi
+  module CollectionResource
+
+    def self.extended(base)
+      base.extend Resource
+    end
+
+    def collection_resource_name(collection_resource_name = nil)
+      if collection_resource_name.present?
+        self.instance_variable_set("@collection_resource_name", collection_resource_name)
+      end
+      self.instance_variable_get("@collection_resource_name") || self.resource_name.pluralize
+    end
+
+    def all(sort = {})
+      where(sort: sort)
+    end
+
+    def find(id, params = {})
+      GiantBombApi.client.send_request(Request::Detail.new(resource_name, id, params))
+    end
+
+    def where(params = {})
+      return GiantBombApi.client.send_request(Request::Collection.new(self)) unless params.present?
+
+      sort = params[:sort]
+      limit = params[:limit]
+      offset = params[:offset]
+
+      args = {}
+      args[:filter] = params.reject {|key,value| %i(sort limit offset).include?(key) }
+      args[:sort] = sort if sort.present?
+      args[:limit] = limit if limit.present?
+      args[:offset] = offset if offset.present?
+
+      GiantBombApi.client.send_request(Request::Collection.new(self, args))
+    end
+
+  end
+end