igdb2 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69b27188f6559dbed98d21041334bf8e110fdf857f1e56f020508fd8008efd02
+  data.tar.gz: df7d26cd5a96c70974999031bb2481571fc6a737e7eaecd51b9aba47bbee5747
+SHA512:
+  metadata.gz: 8f41bc2879a91637689edd54789e9f947e1e5db5daf827035d1da60f7e08ec63f87001497d6cd1f95b016ad1ba13203edce7f39ddbe10c66c7a8017734c0440a
+  data.tar.gz: ae12f2121d43232f1a5f46272fccd421c3a07203a977181e8114e989459e8744fb4eac440a5226f3232ec6667f54c9518deb2f28d7b80f3dd5dca02430c1da7b

data/README.md

@@ -0,0 +1,86 @@
+# IGDB: Internet Game Database
+[![CircleCI](https://circleci.com/gh/kalynrobinson/igdb.svg?style=svg)](https://circleci.com/gh/kalynrobinson/igdb)
+[![Build Status](https://travis-ci.org/kalynrobinson/igdb.svg?branch=master)](https://travis-ci.org/kalynrobinson/igdb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dd41fd1ba6674f21b20c/maintainability)](https://codeclimate.com/github/kalynrobinson/igdb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/dd41fd1ba6674f21b20c/test_coverage)](https://codeclimate.com/github/kalynrobinson/igdb/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/igdb2.svg)](http://badge.fury.io/rb/igdb2)
+[![Dependency Status](https://beta.gemnasium.com/badges/github.com/kalynrobinson/igdb.svg)](https://beta.gemnasium.com/projects/github.com/kalynrobinson/igdb)
+
+## Installation
+```ruby
+$ gem install igdb2
+```
+## Usage
+
+##### Connect
+```ruby
+$ Igdb.connect('api_key')
+```
+If no parameter is given, Igdb will default to ENV['IGDB_KEY'].
+```ruby
+$ Igdb.connect # => Igdb.connect(ENV['IGDB_KEY'])
+```
+##### Usage
+  Find game by ID
+```ruby
+$ Igdb::Game.find(1971)
+```
+  Find game by ID with options
+```ruby
+$ Igdb::Game.find(1971, { fields: 'slug,name' })
+```
+  Find a game by slug
+```ruby
+$ Igdb::Game.slug('batman')
+```
+  Search for a game
+```ruby
+$ Igdb::Game.search(query: 'batman')
+```
+  Return the number of games in the database
+```ruby
+$ Igdb::Game.count
+```
+  Return a list of all games with an offset and/or limit
+```ruby
+$ 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
+```
+  Return the available properties of games
+```ruby
+$ Igdb::Game.meta
+```
+### Endpoints
+```ruby
+Igdb::Character
+Igdb::Collection
+Igdb::Company
+Igdb::Credits
+Igdb::Feed
+Igdb::Franchise
+Igdb::GameEngine
+Igdb::GameMode
+Igdb::Game
+Igdb::Genre
+Igdb::Keyword
+Igdb::Page
+Igdb::Person
+Igdb::Platform
+Igdb::PlayerPerspective
+Igdb::PulseGroup
+Igdb::Pulse
+Igdb::PulseSource
+Igdb::ReleaseDate
+Igdb::Review
+Igdb::Theme
+Igdb::Title
+Igdb::Version
+```
+## Contributing
+
+1. Fork it ( https://github.com/kalynrobinson/igdb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/igdb.rb

@@ -0,0 +1,91 @@
+module Igdb
+  # Utilities
+  autoload :Configuration, 'igdb/configuration/api'
+  autoload :Requester, 'igdb/requester'
+  autoload :Exception, 'igdb/exceptions'
+  autoload :VERSION, 'igdb/version'
+
+  # Models
+  autoload :AlternativeName, 'igdb/models/alternative_name'
+  autoload :ApiResource, 'igdb/models/api_resource'
+  autoload :Character, 'igdb/models/character'
+  autoload :Collection, 'igdb/models/collection'
+  autoload :Company, 'igdb/models/company'
+  autoload :Credits, 'igdb/models/credits'
+  autoload :Esrb, 'igdb/models/esrb'
+  autoload :External, 'igdb/models/external'
+  autoload :Feature, 'igdb/models/feature'
+  autoload :FeatureValue, 'igdb/models/feature_value'
+  autoload :Feed, 'igdb/models/feed'
+  autoload :Franchise, 'igdb/models/franchise'
+  autoload :Game, 'igdb/models/game'
+  autoload :GameEngine, 'igdb/models/game_engine'
+  autoload :GameMode, 'igdb/models/game_mode'
+  autoload :Genre, 'igdb/models/genre'
+  autoload :Image, 'igdb/models/image'
+  autoload :Keyword, 'igdb/models/keyword'
+  autoload :Page, 'igdb/models/page'
+  autoload :Pegi, 'igdb/models/pegi'
+  autoload :Person, 'igdb/models/person'
+  autoload :Platform, 'igdb/models/platform'
+  autoload :PlatformCompany, 'igdb/models/platform_company'
+  autoload :PlatformVersion, 'igdb/models/platform_version'
+  autoload :PlatformVersionReleaseDate, 'igdb/models/platform_version_release_date'
+  autoload :PlayerPerspective, 'igdb/models/player_perspective'
+  autoload :Pulse, 'igdb/models/pulse'
+  autoload :PulseGroup, 'igdb/models/pulse_group'
+  autoload :PulseSource, 'igdb/models/pulse_source'
+  autoload :ReleaseDate, 'igdb/models/release_date'
+  autoload :Review, 'igdb/models/review'
+  autoload :Theme, 'igdb/models/theme'
+  autoload :TimeToBeat, 'igdb/models/time_to_beat'
+  autoload :Title, 'igdb/models/title'
+  autoload :Version, 'igdb/models/version'
+  autoload :Video, 'igdb/models/video'
+  autoload :Website, 'igdb/models/website'
+
+  # Presenters
+  autoload :AlternativeNameRepresenter, 'igdb/representers/alternative_name_representer'
+  autoload :CharacterRepresenter, 'igdb/representers/character_representer'
+  autoload :CollectionRepresenter, 'igdb/representers/collection_representer'
+  autoload :CompanyRepresenter, 'igdb/representers/company_representer'
+  autoload :CreditsRepresenter, 'igdb/representers/credits_representer'
+  autoload :EsrbRepresenter, 'igdb/representers/esrb_representer'
+  autoload :ExternalRepresenter, 'igdb/representers/external_representer'
+  autoload :FeatureRepresenter, 'igdb/representers/feature_representer'
+  autoload :FeatureValueRepresenter, 'igdb/representers/feature_value_representer'
+  autoload :FeedRepresenter, 'igdb/representers/feed_representer'
+  autoload :FranchiseRepresenter, 'igdb/representers/franchise_representer'
+  autoload :GameEngineRepresenter, 'igdb/representers/game_engine_representer'
+  autoload :GameModeRepresenter, 'igdb/representers/game_mode_representer'
+  autoload :GameRepresenter, 'igdb/representers/game_representer'
+  autoload :GenreRepresenter, 'igdb/representers/genre_representer'
+  autoload :ImageRepresenter, 'igdb/representers/image_representer'
+  autoload :KeywordRepresenter, 'igdb/representers/keyword_representer'
+  autoload :PageRepresenter, 'igdb/representers/page_representer'
+  autoload :PegiRepresenter, 'igdb/representers/pegi_representer'
+  autoload :PersonRepresenter, 'igdb/representers/person_representer'
+  autoload :PlatformCompanyRepresenter, 'igdb/representers/platform_company_representer'
+  autoload :PlatformRepresenter, 'igdb/representers/platform_representer'
+  autoload :PlatformVersionReleaseDateRepresenter, 'igdb/representers/platform_version_release_date_representer'
+  autoload :PlatformVersionRepresenter, 'igdb/representers/platform_version_representer'
+  autoload :PlayerPerspectiveRepresenter, 'igdb/representers/player_perspective_representer'
+  autoload :PulseGroupRepresenter, 'igdb/representers/pulse_group_representer'
+  autoload :PulseRepresenter, 'igdb/representers/pulse_representer'
+  autoload :PulseSourceRepresenter, 'igdb/representers/pulse_source_representer'
+  autoload :ReleaseDateRepresenter, 'igdb/representers/release_date_representer'
+  autoload :Representer, 'igdb/representers/representer'
+  autoload :ReviewRepresenter, 'igdb/representers/review_representer'
+  autoload :ThemeRepresenter, 'igdb/representers/theme_representer'
+  autoload :TimeToBeatRepresenter, 'igdb/representers/time_to_beat_representer'
+  autoload :TitleRepresenter, 'igdb/representers/title_representer'
+  autoload :VersionRepresenter, 'igdb/representers/version_representer'
+  autoload :VideoRepresenter, 'igdb/representers/video_representer'
+  autoload :WebsiteRepresenter, 'igdb/representers/website_representer'
+
+  def self.connect(api_key = ENV['IGDB_KEY'])
+    Igdb::Configuration::Api.instance.tap do |api|
+      api.connect(api_key)
+    end
+  end
+end

data/lib/igdb/configuration/api.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+module Igdb
+  module Configuration
+    class Api
+      include Singleton
+
+      attr_reader :base_url, :version, :api_key
+
+      def initialize
+        self.base_url = 'https://api-2445582011268.apicast.io'.freeze
+        self.version = 1
+      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) unless params.empty?
+        url.to_s
+      end
+
+      private
+
+        attr_writer :base_url, :api_key, :version
+    end
+  end
+end

data/lib/igdb/exceptions.rb

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

data/lib/igdb/models/alternative_name.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class AlternativeName < Igdb::ApiResource
+    @representer = Igdb::AlternativeNameRepresenter
+  end
+end

data/lib/igdb/models/api_resource.rb

@@ -0,0 +1,67 @@
+require 'representable/json'
+require 'ostruct'
+
+module Igdb
+  class ApiResource < OpenStruct
+    class << self
+      attr_accessor :path, :representer
+
+      def count
+        Igdb::Requester.get("#{path}/count")['count']
+      end
+
+      def meta
+        Igdb::Requester.get("#{path}/meta")
+      end
+
+      def find(id, options = {})
+        params = options
+        params[:fields] = '*' unless params[:fields]
+
+        if id.class == Array
+          build_collection(Igdb::Requester.get("#{path}/#{id.join(',')}", params), representer)
+        else
+          build_single_resource(Igdb::Requester.get("#{path}/#{id}", params)[0], representer)
+        end
+      end
+
+      def slug(id, options = {})
+        params = options
+        params['fields'] = '*' unless params[:fields]
+        params['filter[slug][eq]'] = id
+
+        build_single_resource(Igdb::Requester.get("#{path}/", params)[0], representer)
+      end
+
+      def search(opts = {})
+        params = {}.tap do |hash|
+          hash['search'] = opts[:query] if opts[:query]
+          hash['filters'] = opts[:filters] if opts[:filters]
+          hash['fields'] = '*'
+        end
+
+        build_collection(Igdb::Requester.get("#{path}/", params), representer)
+      end
+
+      def all(opts = {})
+        params = {}.tap do |hash|
+          hash['offset'] = opts[:offset] || 0
+          hash['limit'] = opts[:limit] || 50
+          hash['fields'] = '*'
+        end
+
+        build_collection(Igdb::Requester.get("#{path}/", opts), representer)
+      end
+
+      private
+
+      def build_single_resource(response, representer)
+        representer.new(new).from_hash(response)
+      end
+
+      def build_collection(response, representer)
+        representer.for_collection.new([]).from_hash(response)
+      end
+    end
+  end
+end

data/lib/igdb/models/character.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Character < Igdb::ApiResource
+    @path = 'characters'
+    @representer = Igdb::CharacterRepresenter
+  end
+end

data/lib/igdb/models/collection.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Collection < Igdb::ApiResource
+    @path = 'collections'
+    @representer = Igdb::CollectionRepresenter
+  end
+end

data/lib/igdb/models/company.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Company < Igdb::ApiResource
+    @path = 'companies'
+    @representer = Igdb::CompanyRepresenter
+  end
+end

data/lib/igdb/models/credits.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Credits < Igdb::ApiResource
+    @path = 'credits'
+    @representer = Igdb::CreditsRepresenter
+  end
+end

data/lib/igdb/models/esrb.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class Esrb < Igdb::ApiResource
+    @representer = Igdb::EsrbRepresenter
+  end
+end

data/lib/igdb/models/external.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class External < Igdb::ApiResource
+    @representer = Igdb::ExternalRepresenter
+  end
+end

data/lib/igdb/models/feature.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class Feature < Igdb::ApiResource
+    @representer = Igdb::FeatureRepresenter
+  end
+end

data/lib/igdb/models/feature_value.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class FeatureValue < Igdb::ApiResource
+    @representer = Igdb::FeatureValueRepresenter
+  end
+end

data/lib/igdb/models/feed.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Feed < Igdb::ApiResource
+    @path = 'feeds'
+    @representer = Igdb::FeedRepresenter
+  end
+end

data/lib/igdb/models/franchise.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Franchise < Igdb::ApiResource
+    @path = 'franchises'
+    @representer = Igdb::FranchiseRepresenter
+  end
+end

data/lib/igdb/models/game.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Game < Igdb::ApiResource
+    @path = 'games'
+    @representer = Igdb::GameRepresenter
+  end
+end

data/lib/igdb/models/game_engine.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class GameEngine < Igdb::ApiResource
+    @path = 'game_engines'
+    @representer = Igdb::GameEngineRepresenter
+  end
+end

data/lib/igdb/models/game_mode.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class GameMode < Igdb::ApiResource
+    @path = 'game_modes'
+    @representer = Igdb::GameModeRepresenter
+  end
+end

data/lib/igdb/models/genre.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Genre < Igdb::ApiResource
+    @path = 'genres'
+    @representer = Igdb::GenreRepresenter
+  end
+end

data/lib/igdb/models/image.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class Image < Igdb::ApiResource
+    @representer = Igdb::ImageRepresenter
+  end
+end

data/lib/igdb/models/keyword.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Keyword < Igdb::ApiResource
+    @path = 'keywords'
+    @representer = Igdb::KeywordRepresenter
+  end
+end

data/lib/igdb/models/page.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Page < Igdb::ApiResource
+    @path = 'pages'
+    @representer = Igdb::PageRepresenter
+  end
+end

data/lib/igdb/models/pegi.rb

@@ -0,0 +1,5 @@
+module Igdb
+  class Pegi < Igdb::ApiResource
+    @representer = Igdb::PegiRepresenter
+  end
+end

data/lib/igdb/models/person.rb

@@ -0,0 +1,6 @@
+module Igdb
+  class Person < Igdb::ApiResource
+    @path = 'people'
+    @representer = Igdb::PersonRepresenter
+  end
+end