rawg_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56bed91b0a89c745a1ccf5cda9cf9eabba95a610116596fc4616561bf30d8bd1
+  data.tar.gz: 96f5a0f131659d1d79748ed74c69e3e11ad61256e15d539a3f89182f73521130
+SHA512:
+  metadata.gz: f4aabcecdbf465b46ebd9d4a8f284699a54eb075b6dc9d11a9f526c1a85121ecff9d332c8d777318f93664b0db0bd9b1c2d5ae398e474f34501dd5b4a0cb6c2c
+  data.tar.gz: 972879b2b6a9da10a288cd3a0b31a077c26bbe2698e49cc8cb067cab9cd391adc34feb169294f74b45893a2b5927e276e875822e97514b32dd326eabf4a50d3a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.irb_history
+.rakeTasks
+.env
+.ruby-version
+/.idea

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    rawg_api (0.1.1)
+      api_struct (~> 1.0, >= 1.0.5)
+      dotenv
+      dry-configurable (~> 0.9.0)
+      dry-monads (~> 1.3, >= 1.3.5)
+      hashie (~> 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    api_struct (1.0.5)
+      dry-configurable
+      dry-inflector
+      dry-monads (~> 1)
+      hashie
+      http
+    byebug (11.1.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-monads (1.3.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    hashie (4.1.0)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    httplog (1.4.2)
+      rack (>= 1.0)
+      rainbow (>= 2.0.0)
+    method_source (1.0.0)
+    minitest (5.14.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.4)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    safe_yaml (1.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vcr (3.0.3)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  httplog
+  minitest (~> 5.0)
+  pry
+  pry-byebug (~> 3.7)
+  rake (~> 12.3)
+  rawg_api!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Harry Georgilas
+
+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,234 @@
+# RawgApi
+
+RawgApi gem is a ruby wrapper for the [rawg.io](https://rawg.io/) REST API.
+
+It exposes every endpoint through the `RawgApi::Clients` interface 
+that returns raw responses from the API. 
+
+Moreover it provides a `RawgApi::Entities` interface that will return serialized data
+for every endpoint using the [Hashie](https://github.com/hashie/hashie) gem
+## Installation
+
+Ruby required: `>= 2.5.0`
+
+Add this line to your application's Gemfile:
+
+
+```ruby
+gem 'rawg_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rawg_api
+
+## Configuration
+You can configure your default settings using
+```
+RawgApi.configure do |config|
+  # No need to change the endpoint, this option was provided
+  # to override the endpoint in the future 
+  # if there is a need to do so
+  config.endpoint = 'https://api.rawg.io/api'
+
+  # This is mandatory and going to be appended
+  # to the headers of each request
+  config.app_name = 'Your app name' 
+
+  # Any custom headers in JSON format 
+  config.headers = {}
+
+  # Default page size for results returned by the API
+  config.page_size = 50
+end
+```
+
+## Usage
+
+#### Clients
+You can access any resource on [rawg.io](https://rawg.io/) using the `RawgApi::Clients` interface
+Most of these clients expose `#find` and `#all` methods, with the exception of the `RawgApi::Clients::Games`
+which also exposes a `#search` method.
+
+Responses are wrapped around `Success` or `Failure` structures provided by [dry-monads](https://github.com/dry-rb/dry-monads)
+In order to fetch the actual values as `Hash` you will have to call `#value!` on the response
+#### Using Clients
+```
+# General Usage
+response = RawgApi::Clients::{CLIENT_NAME}.new.{METHOD} # returns Success/Failure
+result = response.value! # returns Hash
+
+# Get all games
+response = RawgApi::Clients::Games.new.all
+result = response.value! 
+
+# Set page and page_size. 
+# Returns the second page of the results with a limit of 20 resources per page
+# page_size defaults to the page_size you have set on your configuration
+response = RawgApi::Clients::Games.new.all(page:2, page_size: 20)
+
+# Search for a game
+response = RawgApi::Clients::Games.new.search(title: 'Portal 2')
+result = response.value!
+
+# Get game by id
+# Get The Witcher 3 details
+response = RawgApi::Clients::Games::Details.new.find(3328)
+result = response.value!
+
+# Find with pagination
+RawgApi::Clients::Games::Additions.new.find(3328, page:1, page_size:1)
+```
+#### Using `Rawg::Api::Clients::Games#search` with multiple filters criteria
+`#search` accepts the following arguments
+- `page`:`Integer`
+- `page_size`:`Integer`
+- `title`:`String`
+- `exclude_collection`:`Boolean`
+- `exclude_parents`:`Boolean`
+- `exclude_game_series`:`Boolean`
+- `parent_platforms`:`Array`
+- `platforms`:`Array`
+- `stores`:`Array`
+- `developers`:`Array`
+- `publishers`:`Array`
+- `genres`:`Array`
+- `tags`:`Array`
+- `creators`:`Array`
+- `dates`:`Array`
+- `platforms_count`:`Array`
+- `order`:`String` 
+    - Ascending: `name`, `release`, `added`, `created`, `rating`
+    - Descending: `-name`, `-release`, `-added`, `-created`, `-rating`
+
+
+#### List of clients and methods
+- `RawgApi::Clients::Genres`: `#find`,`#all`
+- `RawgApi::Clients::Publishers`: `#find`,`#all`
+- `RawgApi::Clients::Platforms`: `#find`,`#all`
+- `RawgApi::Clients::Creators`: `#find`,`#all`
+- `RawgApi::Clients::Developers`: `#find`,`#all`
+- `RawgApi::Clients::Stores`: `#find`,`#all`
+- `RawgApi::Clients::CreatorRoles`: `#all`
+- `RawgApi::Clients::Tags`: `#all`
+- `RawgApi::Clients::ParentPlatforms`: `#all`
+- `RawgApi::Clients::TagDetails`: `#find`
+- `RawgApi::Clients::Games`: `#all`, `#search`
+- `RawgApi::Clients::Games::Achievements`: `#find`
+- `RawgApi::Clients::Games::Twitch`: `#find`
+- `RawgApi::Clients::Games::SuggestedGames`: `#find`
+- `RawgApi::Clients::Games::Stores`: `#find`
+- `RawgApi::Clients::Games::DevelopmentTeam`: `#find`
+- `RawgApi::Clients::Games::Series`: `#find`
+- `RawgApi::Clients::Games::Trailers`: `#find`
+- `RawgApi::Clients::Games::ParentGames`: `#find`
+- `RawgApi::Clients::Games::Additions`: `#find`
+- `RawgApi::Clients::Games::Details`: `#find`
+- `RawgApi::Clients::Games::Youtube`: `#find`
+- `RawgApi::Clients::Games::Screenshots`: `#find`
+- `RawgApi::Clients::Games::Reddit`: `#find`
+
+#### Using Entities
+You can also use `Entities` to receive a serialized response.
+
+All methods declared in the clients can be invoked as class methods on the `Entity` class
+and accept the same parameters as their `Client` counterpart. 
+```
+# General Usage
+response = RawgApi::Entities::{ENTITY_NAME}.{METHOD} # returns Hashie Object
+# If response is a collection
+results = response.results
+# Returns info regarding the request, such as current page, page size etc...
+metadata = response.metadata 
+
+# Get all games
+response = RawgApi::Entities::Game::Entity.all
+result = response.results 
+
+# Set page and page_size. 
+# Returns the second page of the results with a limit of 20 resources per page
+# page_size defaults to the page_size you have set on your configuration
+response = RawgApi::Entities::Entity.all(page:2, page_size: 20)
+
+# Search for a game
+response = RawgApi::Clients::Game::Entity.search(title: 'Portal 2')
+
+# Get game by id
+# Get The Witcher 3 details
+response =  RawgApi::Entities::Game::Additions.find(3328)
+
+# Access value by attribute
+response.name # => "The Witcher 3: Wild Hunt"
+
+# Find with pagination
+RawgApi::Entities::Game::Additions.find(3328, page:1, page_size:1)
+```
+
+`RawgApi::Entities::Game::Entity` has the ability to delegate methods to other entities
+
+```
+# Get additions through RawgApi::Entities::Game::Entity class
+
+# Returns game additions for The Witcher 3
+RawgApi::Entities::Game::Entity.find_additions(3328)
+
+# Returns tags for The Witcher 3
+RawgApi::Entities::Game::Entity.find_tags(3328)
+
+```
+#### List of entities and methods
+
+- `RawgApi::Entities::Genres`: `#find`,`#all`
+- `RawgApi::Entities::TagDetails`: `#find`
+- `RawgApi::Entities::Developer`: `#find`,`#all`
+- `RawgApi::Entities::Creator`: `#find`,`#all`
+- `RawgApi::Entities::CreatorRole`: `#all`
+- `RawgApi::Entities::Store`: `#find`,`#all`
+- `RawgApi::Entities::Platform`: `#find`,`#all`
+- `RawgApi::Entities::Publisher`: `#find`,`#all`
+- `RawgApi::Entities::Tag`: `#all`,`#find`
+- `RawgApi::Entities::Game::Achievements`: `#find`
+- `RawgApi::Entities::Game::YouTube`: `#find`
+- `RawgApi::Entities::Game::Twitch`: `#find`
+- `RawgApi::Entities::Game::SuggestedGames`: `#find`
+- `RawgApi::Entities::Game::Stores`: `#find`
+- `RawgApi::Entities::Game::DevelopmentTeam`: `#find`
+- `RawgApi::Entities::Game::Series`: `#find`
+- `RawgApi::Entities::Game::Entity`: 
+  - `#find`,`#all`,`#find_suggested_games`,`#find_series`,`#find_screenshots`,`#find_stores`,`#find_reddit`,`#find_additions`,`#find_youtube`,`#find_twitch`
+- `RawgApi::Entities::Game::Details`: `#find`
+- `RawgApi::Entities::Game::Trailers`: `#find`
+- `RawgApi::Entities::Game::ParentGames`: `#find`
+- `RawgApi::Entities::Game::Additions`: `#find`
+- `RawgApi::Entities::Game::Screenshots`: `#find`
+- `RawgApi::Entities::Game::Reddit`: `#find`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Debugging
+Create an `.env` file on your root directory and add the following variable
+```
+ENVIRONMENT=development
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hgeorgilas/rawg_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rawg_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RawgApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hgeorgilas/rawg_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rawg_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rawg_api/boot.rb

@@ -0,0 +1,39 @@
+require_relative 'version'
+require 'dotenv/load'
+require 'api_struct'
+require_relative "configuration"
+if ENV.fetch('ENVIRONMENT', 'production') == 'development'
+  require 'pry'
+  require 'httplog'
+end
+ENTITIES_LOAD_ORDER = %w(
+entities/game/additions
+entities/game/suggested_games
+entities/game/stores
+entities/game/development_team
+entities/game/series
+entities/game/trailers
+entities/game/twitch
+entities/game/parent_games
+entities/game/youtube
+entities/game/screenshots
+entities/game/reddit
+entities/game/achievements
+entities/game/details
+entities/game/entity
+entities/developer
+entities/creator
+entities/base_entity
+entities/creator_role
+entities/genre
+entities/platform
+entities/publisher
+entities/store
+entities/tag_details
+entities/tag)
+
+Dir[File.join(__dir__, 'extensions', '*.rb')].each { |f| require_relative  f }
+require_relative "clients/base_client"
+Dir[File.join(__dir__,  'clients', '**', '*.rb')].each { |f| require_relative  f }
+require_relative "entities/base_entity"
+ENTITIES_LOAD_ORDER.each { |f| require_relative "#{f}.rb" }

data/lib/rawg_api/clients/base_client.rb

@@ -0,0 +1,31 @@
+module RawgApi
+  module Clients
+    class BaseClient < ::ApiStruct::Client
+
+      DEFAULT_PAGE_SIZE = RawgApi.configuration.page_size
+
+      private
+
+      def transform_key(key)
+        keys_transformer.dig(key) || key
+      end
+
+      def transform_value(key, value)
+        return value unless self.respond_to?(:transformer_) && values_transformer.key?(key)
+        value.public_send(values_transformer[key][:method], *values_transformer[key][:args])
+      end
+
+      def key_params_to_hash(m_binding)
+        m_binding.local_variables.map { |x| [x, m_binding.local_variable_get(x)] }.to_h.compact
+      end
+
+      def array_join_transformer(delimiter: ',')
+        {
+            method: :join,
+            args: [delimiter]
+        }
+      end
+
+    end
+  end
+end

data/lib/rawg_api/clients/creator_roles.rb

@@ -0,0 +1,12 @@
+module RawgApi
+  module Clients
+    class CreatorRoles < BaseClient
+      rawg_api :'creator-roles'
+
+      def all(page: 1, page_size: DEFAULT_PAGE_SIZE)
+        get(params: {page: page, page_size: page_size})
+      end
+
+    end
+  end
+end

data/lib/rawg_api/clients/creators.rb

@@ -0,0 +1,16 @@
+module RawgApi
+  module Clients
+    class Creators < BaseClient
+      rawg_api :creators
+
+      def all(page: 1, page_size: DEFAULT_PAGE_SIZE)
+        get(params: {page: page, page_size: page_size})
+      end
+
+      def find(id)
+        get(id)
+      end
+
+    end
+  end
+end

data/lib/rawg_api/clients/developers.rb

@@ -0,0 +1,16 @@
+module RawgApi
+  module Clients
+    class Developers < BaseClient
+      rawg_api :developers
+
+      def all(page: 1, page_size: DEFAULT_PAGE_SIZE)
+        get(params: {page: page, page_size: page_size})
+      end
+
+      def find(id)
+        get(id)
+      end
+
+    end
+  end
+end

data/lib/rawg_api/clients/game/achievements.rb

@@ -0,0 +1,14 @@
+module RawgApi
+  module Clients
+    class Games
+      class Achievements < Clients::BaseClient
+        rawg_api :achievements
+
+        def find(id, page: 1, page_size: DEFAULT_PAGE_SIZE)
+          get(prefix: [:games, id], params: {page: page, page_size: page_size})
+        end
+
+      end
+    end
+  end
+end

data/lib/rawg_api/clients/game/additions.rb

@@ -0,0 +1,14 @@
+module RawgApi
+  module Clients
+    class Games
+      class Additions < Clients::BaseClient
+        rawg_api :additions
+
+        def find(id, page: 1, page_size: DEFAULT_PAGE_SIZE)
+          get(prefix: [:games, id], params: {page: page, page_size: page_size})
+        end
+
+      end
+    end
+  end
+end

data/lib/rawg_api/clients/game/details.rb

@@ -0,0 +1,14 @@
+module RawgApi
+  module Clients
+    class Games
+      class Details < Clients::BaseClient
+        rawg_api :games
+
+        def find(id)
+          get(id)
+        end
+
+      end
+    end
+  end
+end

data/lib/rawg_api/clients/game/development_team.rb

@@ -0,0 +1,14 @@
+module RawgApi
+  module Clients
+    class Games
+      class DevelopmentTeam < Clients::BaseClient
+        rawg_api :'development-team'
+
+        def find(id, page: 1, page_size: DEFAULT_PAGE_SIZE)
+          get(prefix: [:games, id], params: {page: page, page_size: page_size})
+        end
+
+      end
+    end
+  end
+end