thegamesdb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f764717699d2e66db9ff42a82e6077ca5499fb2e2e27215276492c135bad22ad
-  data.tar.gz: ef3c70003d768e26fcb5f6f21a1ca42279a8671b83c12072624a2881da026207
+  metadata.gz: 4dff06dfb7c9c5737a8f737a1dcf365cdd3c13ac9f7af2efef21d52548d91f2b
+  data.tar.gz: a6aa0de586fddb22974910bd6937a18e228209adc9555ee795e254e3bcbc6f84
 SHA512:
-  metadata.gz: 0467cf3be3a2e1838f04c50536a985776ff96cb4e13616ac9560cacb02f298cc952972ea59322563d3ade61dc6847e4fb7facf2b8fc57f87aaa60fa6a3c1f15d
-  data.tar.gz: 8d6d965a417ca7a64b85a8c41932ea683ce879acb01eb515c91c5e52d28454c265fa2d179fdb6e74bb3aeafb3dbf4f5c553c5fceaf93fc8285081158ad57590a
+  metadata.gz: d37e33b44631f031287f6047b79f15fa7d0c112ee1d021724693020e796e9936c2d5b95b2cf0933b4fe0092467bf4c19ca85ca10bf3196382213d6f2f7d21475
+  data.tar.gz: 154aebc525bdec5ae98b1209d42ad1edc1101f354c7a47607405870888d37fd18bc0303da4cb9053cc0ecd8aa02025b5102509d609e8c298859d5669a64f62e0

data/.github/workflows/{master.yml → main.yml}

@@ -2,10 +2,10 @@ name: Tests
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 jobs:
   build:
     env:
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', 'jruby', 'truffleruby' ]
+        ruby: [ '3.0', '3.1', '3.2', 'jruby', 'truffleruby' ]
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2

data/.github/workflows/rubocop.yml

@@ -2,10 +2,10 @@ name: Rubocop
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   build:
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.0
       - run: |
           bundle install
           bundle exec rubocop

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 Lint/DuplicateBranch: # (new in 1.3)
   Enabled: true
 Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.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`.
+
 ## 2.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.

data/lib/thegamesdb/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Gamesdb
+  # Gamesdb errors
+  class Error < StandardError
+    def initialize(code, status)
+      @code = code
+      @status = status
+      super("Gamesdb: #{code} - #{status}")
+    end
+  end
+end

data/lib/thegamesdb/games.rb

@@ -41,9 +41,9 @@ module Gamesdb
       return [] if (data['data']['count']).zero?
 
       games = data['data']['games']
-      return symbolize_keys(games.first) if games.count == 1
+      return Gamesdb::Utils.symbolize_keys(games.first) if games.count == 1
 
-      games.map { |game| symbolize_keys(game) }
+      games.map { |game| Gamesdb::Utils.symbolize_keys(game) }
     end
     # rubocop:enable Metrics/MethodLength
 
@@ -95,10 +95,10 @@ module Gamesdb
 
       response = {}
       response[:base_url] = data['data']['base_url']['original']
-      response[:logo] = process_logo(data['data'], id)
-      response[:boxart] = process_covers(data['data'], id)
-      response[:screenshot] = process_screenshots(data['data'], id)
-      response[:fanart] = process_fanart(data['data'], id)
+      response[:logo] = Gamesdb::Utils.process_logo(data['data'], id)
+      response[:boxart] = Gamesdb::Utils.process_covers(data['data'], id)
+      response[:screenshot] = Gamesdb::Utils.process_screenshots(data['data'], id)
+      response[:fanart] = Gamesdb::Utils.process_fanart(data['data'], id)
       response
     end
 

data/lib/thegamesdb/platforms.rb

@@ -17,7 +17,7 @@ module Gamesdb
       data = perform_request(url, params)
 
       data['data']['platforms'].map do |p|
-        symbolize_keys(p.last)
+        Gamesdb::Utils.symbolize_keys(p.last)
       end
     end
 
@@ -93,9 +93,9 @@ module Gamesdb
 
       response = case platforms
                  when Hash
-                   platforms.map { |_k, platform| symbolize_keys(platform) }
+                   platforms.map { |_k, platform| Gamesdb::Utils.symbolize_keys(platform) }
                  when Array
-                   platforms.map { |platform| symbolize_keys(platform) }
+                   platforms.map { |platform| Gamesdb::Utils.symbolize_keys(platform) }
                  end
 
       return response.first if response.count == 1

data/lib/thegamesdb/utils.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Gamesdb
+  # Several reusable functions
+  module Utils
+    class << self
+      def process_logo(data, id)
+        logo = data['images'][id.to_s].select { |a| a['type'] == 'clearlogo' }
+        logo.empty? ? '' : logo.first['filename']
+      end
+
+      def process_fanart(data, id)
+        fanart = select_images(data, id, 'fanart')
+        return [] if fanart.empty?
+
+        fanart.map { |art| build_individual_fanart(art) }
+      end
+
+      def process_covers(data, id)
+        covers = {}
+        boxart = select_images(data, id, 'boxart')
+        return [] if boxart.empty?
+
+        boxart.each do |art|
+          width, height = art['resolution'].split('x') unless art['resolution'].nil?
+          covers[art['side'].to_sym] = art_structure(art, width, height)
+        end
+        covers
+      end
+
+      def build_individual_fanart(art)
+        width, height = art['resolution'].split('x') unless art['resolution'].nil?
+        art_structure(art, width, height)
+      end
+
+      def art_structure(art, width, height)
+        {
+          url: art['filename'],
+          resolution: art['resolution'],
+          width: width,
+          height: height
+        }
+      end
+
+      def process_screenshots(data, id)
+        select_images(data, id, 'screenshot').map do |b|
+          Gamesdb::Utils.symbolize_keys(b)
+        end
+      end
+
+      def select_images(data, id, image_type)
+        data['images'][id.to_s].select do |a|
+          a['type'] == image_type
+        end
+      end
+
+      def symbolize_keys(hash)
+        new_hash = {}
+        hash.each_key do |key|
+          new_hash[key.to_sym] = hash.delete(key)
+        end
+        new_hash
+      end
+    end
+  end
+end

data/lib/thegamesdb/version.rb

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

data/lib/thegamesdb.rb

@@ -2,10 +2,12 @@
 
 require 'thegamesdb/version'
 require 'thegamesdb/developers'
+require 'thegamesdb/error'
 require 'thegamesdb/games'
 require 'thegamesdb/genres'
 require 'thegamesdb/platforms'
 require 'thegamesdb/publishers'
+require 'thegamesdb/utils'
 require 'net/http'
 require 'json'
 
@@ -42,10 +44,11 @@ module Gamesdb
       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
     rescue StandardError => e
-      # TODO: Handle errors
       raise e
     end
 
@@ -57,52 +60,9 @@ module Gamesdb
       @allowance_refresh_timer = response['allowance_refresh_timer']
     end
 
-    def process_logo(data, id)
-      logo = data['images'][id.to_s].select { |a| a['type'] == 'clearlogo' }
-      logo.empty? ? '' : logo.first['filename']
-    end
-
-    def process_fanart(data, id)
-      fanart = select_images(data, id, 'fanart')
-      return [] if fanart.empty?
-
-      fanart.map { |art| build_individual_fanart(art) }
-    end
-
-    def process_covers(data, id)
-      covers = {}
-      boxart = select_images(data, id, 'boxart')
-      return [] if boxart.empty?
-
-      boxart.each do |art|
-        width, height = art['resolution'].split('x') unless art['resolution'].nil?
-        covers[art['side'].to_sym] = art_structure(art, width, height)
-      end
-      covers
-    end
-
-    def build_individual_fanart(art)
-      width, height = art['resolution'].split('x') unless art['resolution'].nil?
-      art_structure(art, width, height)
-    end
-
-    def art_structure(art, width, height)
-      {
-        url: art['filename'],
-        resolution: art['resolution'],
-        width: width,
-        height: height
-      }
-    end
-
-    def process_screenshots(data, id)
-      select_images(data, id, 'screenshot').map { |b| symbolize_keys(b) }
-    end
-
-    def select_images(data, id, image_type)
-      data['images'][id.to_s].select do |a|
-        a['type'] == image_type
-      end
+    # TODO: More granular errors
+    def http_error(response)
+      raise Gamesdb::Error.new(response['code'], response['status'])
     end
 
     # Process games for platform_games
@@ -134,13 +94,5 @@ module Gamesdb
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
-
-    def symbolize_keys(hash)
-      new_hash = {}
-      hash.each_key do |key|
-        new_hash[key.to_sym] = hash.delete(key)
-      end
-      new_hash
-    end
   end
 end

data/test/client_test.rb

@@ -12,5 +12,15 @@ describe 'Gamesdb - client', :vcr do
       client.games_by_id(1527)
       expect(client.remaining_monthly_allowance).must_equal(monthly - 1)
     end
+
+    describe 'errors' do
+      let(:client) { Gamesdb::Client.new('invalid_api_key') }
+
+      it 'should raise http error' do
+        assert_raises Gamesdb::Error do
+          client.games_by_id(1904)
+        end
+      end
+    end
   end
 end

data/test/developers_test.rb

@@ -9,7 +9,7 @@ describe 'Gamesdb - developers', :vcr do
     it 'should return the developers' do
       @developers = client.developers
 
-      expect(@developers.count).must_equal 8168
+      expect(@developers.count.positive?)
       expect(@developers.first.keys).must_equal(['id', 'name'])
     end
   end

data/test/games_test.rb

@@ -137,7 +137,7 @@ describe 'Gamesdb - games', :vcr do
           {
             'edit_id' => 2,
             'game_id' => 38_113,
-            'timestamp' => '2018-06-28 16:20:54',
+            'timestamp' => '2018-06-28 15:20:54',
             'type' => 'boxart',
             'value' => 'boxart/front/38113-1.jpg'
           }
@@ -146,7 +146,7 @@ describe 'Gamesdb - games', :vcr do
           {
             'edit_id' => 101,
             'game_id' => 22_208,
-            'timestamp' => '2018-06-29 02:36:38',
+            'timestamp' => '2018-06-29 01:36:38',
             'type' => 'rating',
             'value' => 'E - Everyone'
           }

data/test/platform_test.rb

@@ -12,7 +12,7 @@ describe 'GamesDB - platforms', :vcr do
 
     it 'should get gaming platforms' do
       expect(@platforms.count).wont_be :<, 0
-      expect(@platforms.count).must_equal 114
+      expect(@platforms.count).must_equal 147
     end
 
     it 'should have a valid name' do
@@ -71,7 +71,7 @@ describe 'GamesDB - platforms', :vcr do
 
     it 'supports comma separated list' do
       expect(@games1.count).must_equal 20
-      expect(@games2.count).must_equal 1
+      expect(@games2.count).must_equal 20
       expect(@games3.count).must_equal 20
 
       expect(@games3 - @games1).must_equal @games2

data/test/publishers_test.rb

@@ -9,7 +9,7 @@ describe 'GamesDB - Publishers', :vcr do
     it 'should return publishers' do
       publishers = client.publishers
 
-      expect(publishers.count).must_equal 4371
+      expect(publishers.count.positive?)
       expect(publishers.first.keys).must_equal(['id', 'name'])
     end
   end

data/thegamesdb.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '> 2.5.0'
+  spec.required_ruby_version = '> 2.7.0'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
   spec.add_development_dependency 'minitest-reporters'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegamesdb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/master.yml"
+- ".github/workflows/main.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -140,11 +140,13 @@ files:
 - Rakefile
 - lib/thegamesdb.rb
 - lib/thegamesdb/developers.rb
+- lib/thegamesdb/error.rb
 - lib/thegamesdb/games.rb
 - lib/thegamesdb/genres.rb
 - lib/thegamesdb/images.rb
 - lib/thegamesdb/platforms.rb
 - lib/thegamesdb/publishers.rb
+- lib/thegamesdb/utils.rb
 - lib/thegamesdb/version.rb
 - test/client_test.rb
 - test/developers_test.rb
@@ -171,14 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Client for TheGamesDB API (thegamesdb.net).