thegamesdb 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dff06dfb7c9c5737a8f737a1dcf365cdd3c13ac9f7af2efef21d52548d91f2b
-  data.tar.gz: a6aa0de586fddb22974910bd6937a18e228209adc9555ee795e254e3bcbc6f84
+  metadata.gz: 4ded70fb01850d93f701c54ad8c22a3bb7499b0f5898e2dca9fd57bd61a74530
+  data.tar.gz: 315ddaeb3dcdbb9fa908322851fab3592e093249697f1825693b20d99f9df733
 SHA512:
-  metadata.gz: d37e33b44631f031287f6047b79f15fa7d0c112ee1d021724693020e796e9936c2d5b95b2cf0933b4fe0092467bf4c19ca85ca10bf3196382213d6f2f7d21475
-  data.tar.gz: 154aebc525bdec5ae98b1209d42ad1edc1101f354c7a47607405870888d37fd18bc0303da4cb9053cc0ecd8aa02025b5102509d609e8c298859d5669a64f62e0
+  metadata.gz: c5eadd3bc0189b5e2f70a308f01f34985684234c25d358a1401622410509f0a87e050545553d95b5abff0674f9e107a11a857a1f069020bf170b59e6706379ca
+  data.tar.gz: 8f6e27ba722964459af0c382c6d7fdaaf42f2e8f61b49c040b1a99382987e30a67f87a57e83a95b8d9c871278ece70ff66c911c2fa3d7978ab388fce3889e669

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.1.1
+
+- Small update to error handling. Catches `Net::HTTP` errors such as 503 Service Unavailable and raises `Gamesdb::Error`.
+
 ## 2.1.0
 
 Now testing Ruby versions 3.0, 3.1, 3.2, JRuby and TruffleRuby.

data/README.md

@@ -3,7 +3,7 @@ A Ruby gem to interact with [TheGamesDB](http://thegamesdb.net) API.
 
 The Legacy API has been shutdown. The gem is now using the new API and you need to [request an API key](https://forums.thegamesdb.net/viewforum.php?f=10) to use it.
 
-![Build Status](https://github.com/picandocodigo/gamesdb/workflows/Tests/badge.svg?branch=master)
+[![Tests](https://github.com/picandocodigo/gamesdb/actions/workflows/main.yml/badge.svg)](https://github.com/picandocodigo/gamesdb/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/thegamesdb.svg)](https://badge.fury.io/rb/thegamesdb)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2dcf3cdcbe37adcea569/maintainability)](https://codeclimate.com/github/picandocodigo/gamesdb/maintainability)
 
@@ -23,6 +23,7 @@ The Legacy API has been shutdown. The gem is now using the new API and you need
   * [Genres](#genres)
   * [Developers](#developers)
   * [Publishers](#publishers)
+  * [Error Handling](#error-handling)
 * [RubyDoc](https://www.rubydoc.info/gems/thegamesdb)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -384,6 +385,10 @@ Usage:
    ]
 ```
 
+### Error Handling
+
+If there's an error from the API (e.g. 401) or `Net::HTTP` (e.g. 503 - Service Unavailable), the client will raise a `Gamesdb::Error` with the status code and message.
+
 ## Development
 
 Run all tests:

data/lib/thegamesdb/version.rb

@@ -2,5 +2,5 @@
 
 # Gem version
 module Gamesdb
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/lib/thegamesdb.rb

@@ -40,20 +40,25 @@ module Gamesdb
     def perform_request(url, params = {})
       raise ArgumentError, 'You need to set the API KEY to use the GamesDB API' unless @api_key
 
-      params = params.merge({ apikey: @api_key })
-      uri = URI(BASE_URL + url)
-      uri.query = URI.encode_www_form(params)
-      response = JSON.parse(Net::HTTP.get_response(uri).body)
-      http_error(response) if response['code'] >= 300
-
-      refresh_allowances(response)
-      response
+      uri = prepare_uri(params, url)
+      response = Net::HTTP.get_response(uri)
+      check_http_errors(response)
+      json_response = JSON.parse(response.body)
+      refresh_allowances(json_response)
+      json_response
     rescue StandardError => e
       raise e
     end
 
     private
 
+    def prepare_uri(params, url)
+      params = params.merge({ apikey: @api_key })
+      uri = URI(BASE_URL + url)
+      uri.query = URI.encode_www_form(params)
+      uri
+    end
+
     def refresh_allowances(response)
       @remaining_monthly_allowance = response['remaining_monthly_allowance']
       @extra_allowance = response['extra_allowance']
@@ -61,8 +66,8 @@ module Gamesdb
     end
 
     # TODO: More granular errors
-    def http_error(response)
-      raise Gamesdb::Error.new(response['code'], response['status'])
+    def check_http_errors(response)
+      raise Gamesdb::Error.new(response.code, response.message) if response.code.to_i >= 300
     end
 
     # Process games for platform_games

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegamesdb
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler