thegamesdb 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09c223ffcdbfefc714627f7673aac31836b8d20f76f4aa51f5cdb583ed4aaef6'
-  data.tar.gz: 692abf6425da4f35d557fb3dba738b14584680822baf0d21dcf0ccd777045e44
+  metadata.gz: 477e3d9d2b073a86b77e82e6032a49f7c196e9eb9493ddbe233d5d1a569a4a95
+  data.tar.gz: 968a97e6b32aa648e40c443aca798c80eae9bec40275a350a2e762215a78fbcf
 SHA512:
-  metadata.gz: a64df3a9904963cac3782dd221eca0e77ece3af43a08fc84e098dd21eb24abc1211dda4b49fec7fe50422117b102c8329df8ed4f8646c7da5bd3292e7ca6bfc3
-  data.tar.gz: a141723f13ae4fc5fcfc597fd27def6f2a79eaf9a32e0ad6ecab8c9705af14deea7960857443dae3c084e9bafaba27ad2212a8770292febf4cddc0e010f254c6
+  metadata.gz: c6a757afd1711766e6de821fd4f7470751ba757e2b001db9ed013619ea106d7ac02ffd29f151324469cb474f58e019e585a983c448fc4165bffbb7fcf1768835
+  data.tar.gz: 90a01c2548018e0c3f6366bf13494fe67d9425e3230ec893684fb9ec09ad2ccb32fef56e578dc74a783fe942dc59669670e23f92cbedf9b633e5a783c127a140

data/CHANGELOG.md

@@ -1,11 +1,16 @@
 # Changelog
 
+## 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`
+
 ## 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.
 
-
 ## 1.0.0
 
 * Updated to new API endpoint, API key is now required to use the gem. Request an API Key here: https://forums.thegamesdb.net/viewforum.php?f=10

data/lib/thegamesdb.rb

@@ -9,6 +9,7 @@ module Gamesdb
   IMAGES_BASE_URL = 'https://legacy.thegamesdb.net/banners/'.freeze
 
   # Method for listing platform's games
+  # TODO: check (and test) that we support ',' delimited list
   # https://api.thegamesdb.net/#/operations/Games/GamesByPlatformID
   #
   # Parameters: platform id (int), page (int)
@@ -64,7 +65,7 @@ module Gamesdb
   end
 
   # Method for getting game info
-  # TODO: name and platform parameters (for search)
+  # TODO: check (and test) that we support ',' delimited list
   # https://api.thegamesdb.net/#/operations/Games/GamesByGameID
   #
   # Parameters:
@@ -91,15 +92,27 @@ module Gamesdb
   #
   # Parameters:
   # - name (required)
+  # - platform (optional - platform id)
+  # - page (optional)
   #
   # == Returns:
   # Hash with game info:  id, name (not-unique), release_date,
-  # platform
+  # platform, etc.
   #
-  def self.games_by_name(name)
+  def self.games_by_name(name, platform: nil, page: 1)
     url = 'Games/ByGameName'
-    data = json_response(url, name: name)
-    data['data']['games'].map { |game| symbolize_keys(game) }
+    params = {
+      fields: 'players,publishers,genres,overview,last_updated,rating,platform,coop,youtube,os,processor,ram,hdd,video,sound,alternates',
+      include: 'boxart',
+      name: name,
+      page: page
+    }
+    unless platform.nil?
+      params.merge!("filter[platform]" => platform)
+    end
+
+    data = json_response(url, params)
+    process_platform_games(data)
   end
 
   # This API feature returns a list of available artwork types and
@@ -119,7 +132,7 @@ module Gamesdb
   def self.game_images(id)
     url = 'Games/Images'
     data = json_response(url, games_id: id)
-    return [] if data['data']['count'] == 0
+    return [] if data.dig('data', 'count') == (0 || nil)
 
     response = {}
     response[:base_url] = data['data']['base_url']['original']
@@ -199,15 +212,27 @@ module Gamesdb
     games = []
 
     data['data']['games'].each do |elem|
-      name = elem['game_title']
       id = elem['id']
-      date = elem['release_date']
-      developers = elem['developers']
-      if boxart = data.dig('include', 'boxart', 'data', id.to_s)
-        image = data['include']['boxart']['base_url']['original'] +
-          boxart.select { |a| a['side'] == 'front' }.first['filename'] || ''
-      end
-      games << { name: name, id: id, release_date: date, developers: developers, image: image }
+      games << {
+        name: elem['game_title'],
+        id: id,
+        release_date: elem['release_date'],
+        platform: elem['platform'],
+        developers: elem['developers'],
+        players: elem['players'],
+        publishers: elem['publishers'],
+        genres: elem['genres'],
+        overview: elem['overview'],
+        last_updated: elem['last_updated'],
+        rating: elem['rating'],
+        coop: elem['coop'],
+        youtube: elem['youtube'],
+        alternates: elem['alternates'],
+        image: if boxart = data.dig('include', 'boxart', 'data', id.to_s)
+                 data['include']['boxart']['base_url']['original'] +
+                   boxart.select { |a| a['side'] == 'front' }.first['filename'] || ''
+               end
+    }
     end
     games
   end

data/lib/thegamesdb/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module Gamesdb
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/test/games_test.rb

@@ -35,12 +35,45 @@ describe 'Gamesdb - games', :vcr do
     it 'should return a list' do
       game = @games_list.first
       game[:id].must_be_kind_of Integer
-      game[:game_title].must_be_kind_of String
+      game[:name].must_be_kind_of String
       game[:platform].must_be_kind_of Integer
       game[:release_date].must_be_kind_of String
     end
   end
 
+  describe 'games by name pages' do
+    before do
+      @first_page = Gamesdb.games_by_name('mario', page: 1)
+      @second_page = Gamesdb.games_by_name('mario', page: 2)
+    end
+
+    it 'should return games in platform by id' do
+      @first_page.count.wont_be :<, 0
+      @first_page.count.must_equal 20
+    end
+
+    it 'should return games in the platform for the second page' do
+      @second_page.count.wont_be :<, 0
+      @second_page.count.must_equal 20
+      (@first_page & @second_page).must_equal []
+    end
+  end
+
+  describe 'games by name and platform' do
+    before do
+      @games_list = Gamesdb.games_by_name('mario', platform: 7)
+    end
+
+    it 'should return a list' do
+      @games_list.each do |game|
+        game[:id].must_be_kind_of Integer
+        game[:id].must_be_kind_of Integer
+        game[:name].must_be_kind_of String
+        game[:platform].must_equal 7
+      end
+    end
+  end
+
   describe 'games art', :vcr do
     describe 'when most of the art is available' do
       before do

data/test/platform_test.rb

@@ -39,7 +39,7 @@ describe 'GamesDB - platforms', :vcr do
     end
   end
 
-  describe 'platform_games' do
+  describe 'platform_games pages' do
     before do
       platforms = Gamesdb.platforms
       @first_page = Gamesdb.games_by_platform_id(platforms[0][:id])
@@ -56,7 +56,6 @@ describe 'GamesDB - platforms', :vcr do
       @second_page.count.must_equal 20
       (@first_page & @second_page).must_equal []
     end
-
   end
 
   describe 'platform' do

data/thegamesdb.gemspec

@@ -25,4 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr', '~> 4'
   spec.add_development_dependency 'webmock'
+  spec.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/picandocodigo/gamesdb/issues",
+    "changelog_uri"     => "https://github.com/picandocodigo/gamesdb/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/picandocodigo/gamesdb/blob/master/README.md#gamesdb",
+    "homepage_uri"      => "https://github.com/picandocodigo/gamesdb",
+    "source_code_uri"   => "https://github.com/picandocodigo/gamesdb",
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegamesdb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,7 +146,12 @@ files:
 homepage: http://github.com/picandocodigo/gamesdb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/picandocodigo/gamesdb/issues
+  changelog_uri: https://github.com/picandocodigo/gamesdb/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/picandocodigo/gamesdb/blob/master/README.md#gamesdb
+  homepage_uri: https://github.com/picandocodigo/gamesdb
+  source_code_uri: https://github.com/picandocodigo/gamesdb
 post_install_message: 
 rdoc_options: []
 require_paths: