Releases: picandocodigo/gamesdb
v2.1.1
v2.1.0
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
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 toplatforms_by_id
. -
game_by_id
changes togames_by_id
. -
game_images
changes togames_images
.
These APIs now support a string of comma delimited ids as parameters as well as the id Integer.
v1.1.2
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
andtruffleruby
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
1.1.1
- Adds
platform_id
parameter togames_by_name
- Adds
page
parameter togames_by_name
- Adds extra fields and boxart to
games_by_name
response - Refactors
process_platform_games
Check the CHANGELOG for other changes.
Updates `games_by_platform` and `platform` responses
1.1.0
- Adds
page
parameter togames_by_platform_id
and includesboxart
. - 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 useincludes
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.