igdb 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8252b97b715b1aba6f8ffdad48a9b55d09cd31af
-  data.tar.gz: 136512762d8792e5266fce4d65ca024717ddefea
+  metadata.gz: 20fabf6dcdaace6c88808c75eef38417a958de60
+  data.tar.gz: 112cd37e00140a5bb8d5fcb9934ecbc097ea1327
 SHA512:
-  metadata.gz: 6d19f1c392f3ab66556271dafb2697f4cbf10ef0df3159a5ecb9153289bc7d19adf38890456fa8cea3b38164b1e02d80602e938829027cebff4f980c5568140c
-  data.tar.gz: 7beec9138edba7bc14392cd57c4476ee33f298896164dcab9ab3899064968c6dd61312a49e395e40e19852b018d748539a4b2cc346f91fee8bad2c23602d9024
+  metadata.gz: 91fa09829edf14034623f97afefccdef77082664b52cfe2ce0176a2d72b10eeb1685847e8ffbdb3368c21bf3bf97212a46aa851d11e86bf3d14f3edcbb4c5203
+  data.tar.gz: 78c1275eef6a9281f034dc59e02862f0c678301ce4d85dc1cd025c2aee126ea4064f6d6eb2bed3628c0f631da1d39663a3c0c6b43f72166b0241d92ab78d5f13

data/.circle.yml

@@ -0,0 +1,3 @@
+machine:
+    ruby:
+          version: rbx-2.2.2

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
+.env

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.2.2
+env:
+- CODECLIMATE_REPO_TOKEN=8ffbec2a216b73652275893dbfb29f9b73035ba8e7d00f4743ec4824f8eacfdd
+script: bundle exec rspec spec

data/README.md

@@ -1,34 +1,53 @@
-# Igdb
+# IGDB: Internet Game Database
+[![Build Status](https://travis-ci.org/ahmetabdi/igdb.svg)](https://travis-ci.org/ahmetabdi/igdb)
+[![Code Climate](https://codeclimate.com/github/ahmetabdi/igdb/badges/gpa.svg)](https://codeclimate.com/github/ahmetabdi/igdb)
+[![Test Coverage](https://codeclimate.com/github/ahmetabdi/igdb/badges/coverage.svg)](https://codeclimate.com/github/ahmetabdi/igdb/coverage)
+[![Gem Version](https://badge.fury.io/rb/igdb.svg)](http://badge.fury.io/rb/igdb)
+[![Dependency Status](https://gemnasium.com/ahmetabdi/igdb.svg)](https://gemnasium.com/ahmetabdi/igdb)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/igdb`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
+    $ gem install igdb
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
 
-## Installation
+##### Connect
 
-Add this line to your application's Gemfile:
+    $ Igdb.connect('api_key')
 
-```ruby
-gem 'igdb'
-```
+##### Game
+  Find game by ID
 
-And then execute:
+    $ Igdb::Game.find(1971)
 
-    $ bundle
+  Search for a game
 
-Or install it yourself as:
+    $ Igdb::Game.search(query: 'batman')
 
-    $ gem install igdb
+  Return the number of games in the database
 
-## Usage
+    $ Igdb::Game.meta
+
+  Return a list of all games with an offset and/or limit
+
+    $ Igdb::Game.all
+    $ Igdb::Game.all(limit: 10) # Limit to 10 results - Default 100
+    $ Igdb::Game.all(offset: 5) # Offset result starting at 5th - Default 0
+
+##### Person
+  Find person by ID or name
+
+    $ Igdb::Person.find(4)
+    $ Igdb::Person.find('derek-watts')
 
-TODO: Write usage instructions here
+  Return the number of people in the database
 
-## Development
+    $ Igdb::Person.meta
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+  Return a list of all games with an offset and/or limit
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    $ Igdb::Person.all
+    $ Igdb::Person.all(limit: 10) # Limit to 10 results - Default 100
+    $ Igdb::Person.all(offset: 5) # Offset result starting at 5th - Default 0
 
 ## Contributing
 

data/igdb.gemspec

@@ -19,18 +19,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', "~> 1.9"
+  spec.add_development_dependency 'rake', "~> 10.0"
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'guard'
   spec.add_development_dependency 'fuubar'
-  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_runtime_dependency 'representable'
   spec.add_runtime_dependency 'multi_json'
-  spec.add_runtime_dependency "rest-client", "~> 1.7.3"
+  spec.add_runtime_dependency 'rest-client'
   spec.add_runtime_dependency 'require_all'
 end

data/lib/igdb.rb

@@ -1,9 +1,8 @@
 require 'require_all'
-
 require_all 'lib'
 
 module Igdb
-  def self.connect(api_key = 'egBf-guz6Z8ZIMYw0GMykId-V0-OumqBwy988YFyq2E')
+  def self.connect(api_key)
     Igdb::Configuration::Api.instance.tap do |api|
       api.connect(api_key)
     end

data/lib/igdb/configuration/api.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+
+module Igdb::Configuration
+  class Api
+    include Singleton
+
+    attr_reader :base_url, :version, :api_key
+
+    def initialize
+      self.base_url = "https://www.igdb.com/api/v1/".freeze
+      self.version = 1.freeze
+    end
+
+    def connect(api_key)
+      @api_key = api_key
+    end
+
+    def url_for(action, params={})
+      url = URI.join(base_url, action)
+      url.query = URI.encode_www_form(params) if params
+      url.to_s
+    end
+
+    private
+      attr_writer :base_url, :api_key, :version, :oauth_url
+  end
+end

data/lib/igdb/exceptions.rb

@@ -0,0 +1,11 @@
+module Igdb::Exception
+  class Base < ::Exception
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  class Api < Base; end
+  class ArgumentError < Base; end
+  class JsonParseError < Base; end
+end

data/lib/igdb/models/api_resource.rb

@@ -0,0 +1,14 @@
+require 'representable/json'
+class Igdb::ApiResource < OpenStruct
+
+  private
+  def self.build_single_resource(response, representer)
+    self.new.extend(representer).from_hash(response)
+  end
+
+  def self.build_collection(response, representer)
+    response.reduce([]) do |resources, response|
+      resources << self.new.extend(representer).from_hash(response)
+    end
+  end
+end

data/lib/igdb/models/company.rb

@@ -0,0 +1,2 @@
+class Igdb::Company < Igdb::ApiResource
+end

data/lib/igdb/models/game.rb

@@ -0,0 +1,27 @@
+class Igdb::Game < Igdb::ApiResource
+
+  def self.meta
+    build_single_resource(Igdb::Requester.get("games/meta"), GameRepresenter).size
+  end
+
+  def self.find(id)
+    build_single_resource(Igdb::Requester.get("games/#{id}")['game'], GameRepresenter)
+  end
+
+  def self.search(opts={})
+    params = Hash.new.tap do |hash|
+      hash['q'] = opts[:query] if opts[:query]
+      hash['filters'] = opts[:filters] if opts[:filters]
+    end
+    build_collection(Igdb::Requester.get("games/search", params)['games'], GameRepresenter)
+  end
+
+  def self.all(opts={})
+    params = Hash.new.tap do |hash|
+      hash['offset'] = opts[:offset] || 0
+      hash['limit'] = opts[:limit] || 100
+    end
+    build_collection(Igdb::Requester.get("games", params)['games'], GameRepresenter)
+  end
+
+end

data/lib/igdb/models/game_company.rb

@@ -0,0 +1,2 @@
+class Igdb::GameCompany < Igdb::ApiResource
+end

data/lib/igdb/models/game_genre.rb

@@ -0,0 +1,2 @@
+class Igdb::GameGenre < Igdb::ApiResource
+end

data/lib/igdb/models/game_release_date.rb

@@ -0,0 +1,2 @@
+class Igdb::GameReleaseDate < Igdb::ApiResource
+end

data/lib/igdb/models/game_screenshot.rb

@@ -0,0 +1,2 @@
+class Igdb::GameScreenshot < Igdb::ApiResource
+end

data/lib/igdb/models/game_theme.rb

@@ -0,0 +1,2 @@
+class Igdb::GameTheme < Igdb::ApiResource
+end

data/lib/igdb/models/game_video.rb

@@ -0,0 +1,2 @@
+class Igdb::GameVideo < Igdb::ApiResource
+end

data/lib/igdb/models/person.rb

@@ -0,0 +1,19 @@
+class Igdb::Person < Igdb::ApiResource
+
+  def self.meta
+    build_single_resource(Igdb::Requester.get('people/meta'), PersonRepresenter).size
+  end
+
+  def self.find(id)
+    build_single_resource(Igdb::Requester.get("people/#{id}")['person'], PersonRepresenter)
+  end
+
+  def self.all(opts={})
+    params = Hash.new.tap do |hash|
+      hash['offset'] = opts[:offset] || 0
+      hash['limit'] = opts[:limit] || 100
+    end
+    build_collection(Igdb::Requester.get("people", params)['people'], PersonRepresenter)
+  end
+
+end

data/lib/igdb/models/shop.rb

@@ -0,0 +1,2 @@
+class Igdb::Shop < Igdb::ApiResource
+end

data/lib/igdb/representers/game_company_representer.rb

@@ -0,0 +1,7 @@
+module GameCompanyRespresenter
+  include Representable::JSON
+
+  property :name
+  property :developer
+  property :publisher
+end

data/lib/igdb/representers/game_genre_representer.rb

@@ -0,0 +1,5 @@
+module GameGenreRepresenter
+  include Representable::JSON
+
+  property :name
+end

data/lib/igdb/representers/game_release_date_representer.rb

@@ -0,0 +1,6 @@
+module GameReleaseDateRespresenter
+  include Representable::JSON
+
+  property :platform_name
+  property :release_date
+end

data/lib/igdb/representers/game_representer.rb

@@ -0,0 +1,26 @@
+module GameRepresenter
+  include Representable::JSON
+
+  property :id # The id of the game.
+  property :name # The name of the game.
+  property :slug # Not documented in V1 API
+  property :summary # Not documented in V1 API
+  property :alternative_name # The alternative name of the game.
+  property :rating # The rating of the game.
+  property :platform_name # The platform name.
+  property :release_date  # Release date of the game.
+  property :developer # True if the company is the developer of the game.
+  property :publisher # True if the company is the publisher of the game.
+  property :name  # The name of the company.
+  property :cover # The cover image of the game.
+  property :subtitle  # The subtitle of the screenshot.
+  property :src # The source of the image in the thumbnail format.
+  property :size # The number of games in the database.
+
+  collection :release_dates, extend: GameReleaseDateRespresenter, class: Igdb::GameReleaseDate # The release dates of the game.
+  collection :screenshots, extend: GameScreenshotRepresenter, class: Igdb::GameScreenshot # The list of screenshots of the game.
+  collection :videos, extend: GameVideoRepresenter, class: Igdb::GameVideo # Not documented in v1 API
+  collection :genres, extend: GameGenreRepresenter, class: Igdb::GameGenre # Not documented in v1 API
+  collection :themes, extend: GameThemeRepresenter, class: Igdb::GameTheme # Not documented in v1 API
+  collection :companies, extend: GameCompanyRespresenter, class: Igdb::GameCompany # List of companies that developed and published.
+end

data/lib/igdb/representers/game_screenshot_representer.rb

@@ -0,0 +1,6 @@
+module GameScreenshotRepresenter
+  include Representable::JSON
+
+  property :title
+  property :thumb
+end

data/lib/igdb/representers/game_theme_representer.rb

@@ -0,0 +1,5 @@
+module GameThemeRepresenter
+  include Representable::JSON
+
+  property :name
+end

data/lib/igdb/representers/game_video_representer.rb

@@ -0,0 +1,6 @@
+module GameVideoRepresenter
+  include Representable::JSON
+
+  property :title
+  property :uid
+end

data/lib/igdb/representers/person_representer.rb

@@ -0,0 +1,11 @@
+module PersonRepresenter
+  include Representable::JSON
+
+  property :id # The id of the person.
+  property :name # The name of the person.
+  property :dob # The day of birth of the person ISO standard is followed.
+  property :country # The country of the person in http://en.wikipedia.org/wiki/ISO_3166-1_numeric .
+  property :bio # The bio of the person.
+  property :slug # Not listed in the API
+  property :size # The number of people in the database.
+end

data/lib/igdb/requester.rb

@@ -0,0 +1,56 @@
+require 'rest_client'
+
+class Igdb::Requester
+  class << self
+
+    def get(action, params={})
+      url = api.url_for(action, params)
+      perform_request do
+        parse_response(RestClient.get(url, request_headers))
+      end
+    end
+
+    def post(action, params={}, form_data={})
+      url = api.url_for(action, params)
+      perform_request do
+        parse_response(RestClient.post(url, form_data.to_json, request_headers))
+      end
+    end
+
+    def delete(action)
+      url = api.url_for(action)
+      perform_request do
+        parse_response(RestClient.post(url, {}, request_headers))
+      end
+    end
+
+    private
+    def api
+      Igdb::Configuration::Api.instance
+    end
+
+    def perform_request(&block)
+      begin
+        block.call
+      rescue RestClient::Exception => e
+        raise Igdb::Exception::Api.new(e.message)
+      end
+    end
+
+    def request_headers
+      Hash.new.tap do |headers|
+        headers['Accept'] = 'application/json'
+        headers['Content-Type'] = 'application/json'
+        headers['Authorization'] = 'Token token="' + api.api_key + '"'
+      end
+    end
+
+    def parse_response(response_body)
+      begin
+        JSON.parse(response_body)
+      rescue JSON::ParserError => e
+        raise Igdb::Exception::JsonParseError.new("Response body could not be parsed: #{e.message}")
+      end
+    end
+  end
+end

data/lib/igdb/version.rb

@@ -1,3 +1,3 @@
 module Igdb
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: igdb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ahmet Abdi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,34 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -168,16 +140,16 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -199,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circle.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -211,6 +183,28 @@ files:
 - bin/setup
 - igdb.gemspec
 - lib/igdb.rb
+- lib/igdb/configuration/api.rb
+- lib/igdb/exceptions.rb
+- lib/igdb/models/api_resource.rb
+- lib/igdb/models/company.rb
+- lib/igdb/models/game.rb
+- lib/igdb/models/game_company.rb
+- lib/igdb/models/game_genre.rb
+- lib/igdb/models/game_release_date.rb
+- lib/igdb/models/game_screenshot.rb
+- lib/igdb/models/game_theme.rb
+- lib/igdb/models/game_video.rb
+- lib/igdb/models/person.rb
+- lib/igdb/models/shop.rb
+- lib/igdb/representers/game_company_representer.rb
+- lib/igdb/representers/game_genre_representer.rb
+- lib/igdb/representers/game_release_date_representer.rb
+- lib/igdb/representers/game_representer.rb
+- lib/igdb/representers/game_screenshot_representer.rb
+- lib/igdb/representers/game_theme_representer.rb
+- lib/igdb/representers/game_video_representer.rb
+- lib/igdb/representers/person_representer.rb
+- lib/igdb/requester.rb
 - lib/igdb/version.rb
 homepage: ''
 licenses:

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)