Skip to content

Releases: picandocodigo/gamesdb

v2.1.1

20 Jan 13:40
Compare
Choose a tag to compare
  • Small update to error handling. Catches Net::HTTP errors such as 503 Service Unavailable and raises Gamesdb::Error.

v2.1.0

17 Jan 18:50
Compare
Choose a tag to compare

Now testing Ruby versions 3.0, 3.1, 3.2, JRuby and TruffleRuby.

  • Added some better error handling. Now you can catch from Gamesdb::Error if there's any response from the server with status >= 300 (e.g. 403 for wrong API Key). I'll improve on this in future releases.
  • Refactored main client class and extracted utilitary functions into Gamesdb::Utils.

v2.0.0

30 Nov 19:53
Compare
Choose a tag to compare

Refactored code and functionality. The library was refactored in a way you need to instantiate a client with the API key to use it (more info in "Breaking changes"). 100% of the documented API is now supported and implemented.

The base API Response includes the remaining_monthly_allowance for your API key, extra_allowance and allowance_refresh_timer. These values are updated on the client instance on every request so you can use client.remaining_monthly_client to check how many requests the API key has left.

New APIs

  • developers
  • games_update
  • genres
  • platforms_by_name
  • platforms_images
  • publishers

Breaking changes:

  • Dropped support for Ruby 2.4. The gem might still work on Ruby 2.4, but it's not being regularly tested for any version lower than 2.5.

  • You now need to instantiate the Gamesdb::Client class passing in the api_key. E.g:

> client = Gamesdb::Client.new(ENV['GAMESDB_API_KEY'])


> client = Gamesdb::Client.new('my_api_key')
> client.platforms
...
  • Changes in methods:

  • platform_by_id changes to platforms_by_id.

  • game_by_id changes to games_by_id.

  • game_images changes to games_images.
    These APIs now support a string of comma delimited ids as parameters as well as the id Integer.

v1.1.2

16 Feb 21:20
Compare
Choose a tag to compare

The most important change for this version is the GamesDB API endpoint changed the url, so the gem is working again with this update.

CHANGELOG:

  • Updates the API endpoint url (adds v1). From the forum:

We've prefixed the api url with /v1/ path to make it easier to version control the API going forward, so please update your apps to reflect that.
e.g https://api.thegamesdb.net/v1/Games/ByG ... e=platform

  • Updates the tests
  • Allow failures for ruby-head and truffleruby in the Travis build. They look like config issues but I don't have time to look into it at the moment. Looking forward to work on the gem some more in the near future and I'll look into it.

v1.1.1

11 Sep 22:41
Compare
Choose a tag to compare

1.1.1

  • Adds platform_id parameter to games_by_name
  • Adds page parameter to games_by_name
  • Adds extra fields and boxart to games_by_name response
  • Refactors process_platform_games

Check the CHANGELOG for other changes.

Download from RubyGems

Updates `games_by_platform` and `platform` responses

07 Sep 19:31
Compare
Choose a tag to compare

1.1.0

  • Adds page parameter to games_by_platform_id and includes boxart.
  • Adds all available fields from Platforms in platforms, updates tests. Changes :slug to :alias in platforms response, to map to same response from API.
  • Refactored json_response to use includes and extra data from the API response

Changes in 1.0.0

  • Updated to new API endpoint, API key is now required to use the gem. Request an API Key here.
  • Legacy API no longer supported since it's been shutdown.
  • Since the API has changed, some endpoints are no longer supported and some new ones are supported.
  • Removed ox dependency, the new API returns JSON instead of XML.

Check the CHANGELOG for other changes.

Download from RubyGems