thegamesdb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d3d0b45cd2e27b775840b9e21ca69ac31eff3425da1c20087cd92ff7185037
-  data.tar.gz: d53c14fa8fdfca34ea4f0284712ad330a56cc3daa3b1a2657aec46a5387bd47c
+  metadata.gz: '09c223ffcdbfefc714627f7673aac31836b8d20f76f4aa51f5cdb583ed4aaef6'
+  data.tar.gz: 692abf6425da4f35d557fb3dba738b14584680822baf0d21dcf0ccd777045e44
 SHA512:
-  metadata.gz: 8ae9f566ec2099c108e58b2aac390f20146990db555d8b5d1ffbb9ebd41336fef77102e8ea3124a870d092fbd431a5e788fc28890fc7437bc8c785f7c919e168
-  data.tar.gz: 9d4ef8f0d6d96df24d61f7a1395689aa20d6c15aa986bf99395611c4796b1fa261571669e50b3e0d2725f370a2a717b33f0de45e25e42393ad87153edf12e74a
+  metadata.gz: a64df3a9904963cac3782dd221eca0e77ece3af43a08fc84e098dd21eb24abc1211dda4b49fec7fe50422117b102c8329df8ed4f8646c7da5bd3292e7ca6bfc3
+  data.tar.gz: a141723f13ae4fc5fcfc597fd27def6f2a79eaf9a32e0ad6ecab8c9705af14deea7960857443dae3c084e9bafaba27ad2212a8770292febf4cddc0e010f254c6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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

@@ -11,14 +11,15 @@ module Gamesdb
   # Method for listing platform's games
   # https://api.thegamesdb.net/#/operations/Games/GamesByPlatformID
   #
-  # Parameters: platform id (int)
+  # Parameters: platform id (int), page (int)
   #
   # == Returns:
   # Array of Hashes with games info
   #
-  def self.games_by_platform_id(platform_id)
+  def self.games_by_platform_id(platform_id, page = 1)
     url = 'Games/ByPlatformID'
-    data = json_response(url, id: platform_id)
+    params = {id: platform_id, page: page, include: 'boxart'}
+    data = json_response(url, params)
     process_platform_games(data)
   end
 
@@ -32,14 +33,12 @@ module Gamesdb
   #
   def self.platforms
     url = 'Platforms'
-    data = json_response(url)
-    platforms = []
+    params = { fields: 'icon,console,controller,developer,manufacturer,media,cpu,memory,graphics,sound,maxcontrollers,display,overview,youtube' }
+    data = json_response(url, params)
 
-    data['platforms'].each do |p|
-      platform = p.last
-      platforms << { name: platform['name'], id: platform['id'].to_i, slug: platform['alias'] }
+    data['data']['platforms'].map do |p|
+      symbolize_keys(p.last)
     end
-    platforms
   end
 
   # This API feature returns a set of metadata and artwork data for a
@@ -60,7 +59,7 @@ module Gamesdb
     }
     data = json_response(url, params)
 
-    response = data['platforms'].values.first
+    response = data['data']['platforms'].values.first
     symbolize_keys(response)
   end
 
@@ -82,8 +81,8 @@ module Gamesdb
       include: 'boxart,platform'
     }
     data = json_response(url, params)
-    return [] if data["count"] == 0
-    symbolize_keys(data['games'].first)
+    return [] if data['data']['count'] == 0
+    symbolize_keys(data['data']['games'].first)
   end
 
   # The GetGamesList API search returns a listing of games matched up
@@ -100,7 +99,7 @@ module Gamesdb
   def self.games_by_name(name)
     url = 'Games/ByGameName'
     data = json_response(url, name: name)
-    data['games'].map { |game| symbolize_keys(game) }
+    data['data']['games'].map { |game| symbolize_keys(game) }
   end
 
   # This API feature returns a list of available artwork types and
@@ -120,14 +119,14 @@ module Gamesdb
   def self.game_images(id)
     url = 'Games/Images'
     data = json_response(url, games_id: id)
-    return [] if data['count'] == 0
+    return [] if data['data']['count'] == 0
 
     response = {}
-    response[:base_url] = data['base_url']['original']
-    response[:logo] = process_logo(data, id)
-    response[:boxart] = process_covers(data, id)
-    response[:screenshot] = process_screenshots(data, id)
-    response[:fanart] = process_fanart(data, id)
+    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
   end
 
@@ -192,19 +191,23 @@ module Gamesdb
     uri.query = URI.encode_www_form(params)
     request = Net::HTTP.get_response(uri)
     response = JSON.parse(request.body)
-    response['data']
+    response
   end
 
   # Process games for platform_games
   def self.process_platform_games(data)
     games = []
 
-    data['games'].each do |elem|
+    data['data']['games'].each do |elem|
       name = elem['game_title']
       id = elem['id']
       date = elem['release_date']
       developers = elem['developers']
-      games << { name: name, id: id, release_date: date, developers: 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 }
     end
     games
   end
@@ -217,21 +220,6 @@ module Gamesdb
     game
   end
 
-  # Method for processing the fan art and screenshots into a uniform
-  # collection with url, width, height and thumb url
-  def self.images_from_nodes(data)
-    images = []
-    data.each do |art|
-      images << {
-        url: art.original.nodes[0],
-        width: art.nodes.first.attributes[:width],
-        height: art.nodes.first.attributes[:height],
-        thumb: art.thumb.text
-      }
-    end
-    images
-  end
-
   def self.symbolize_keys(hash)
     hash.keys.each do |key|
       hash[key.to_sym] = hash.delete(key)

data/lib/thegamesdb/version.rb

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

data/test/platform_test.rb

@@ -8,6 +8,7 @@ describe 'GamesDB - platforms', :vcr do
 
     it 'should get gaming platforms' do
       @platforms.count.wont_be :<, 0
+      @platforms.count.must_equal 109
     end
 
     it 'should have a valid name' do
@@ -18,26 +19,50 @@ describe 'GamesDB - platforms', :vcr do
       @platforms[0][:id].must_be_kind_of Integer
     end
 
-    it 'should have a valid slug' do
-      @platforms[0][:slug].must_be_kind_of String
+    it 'should have a valid alias' do
+      @platforms[0][:alias].must_be_kind_of String
+    end
+
+    it 'should have valid fields for other stuff' do
+      nes = @platforms.select { |p| p[:id] == 7 }.first
+      nes[:icon].must_be_kind_of String
+      nes[:console].must_be_kind_of String
+      nes[:controller].must_be_kind_of String
+      nes[:developer].must_be_kind_of String
+      nes[:manufacturer].must_be_kind_of String
+      nes[:maxcontrollers].must_be_kind_of String
+      nes[:cpu].must_be_kind_of String
+      nes[:memory].must_be_kind_of String
+      nes[:sound].must_be_kind_of String
+      nes[:display].must_be_kind_of String
+      nes[:overview].must_be_kind_of String
     end
   end
 
   describe 'platform_games' do
     before do
       platforms = Gamesdb.platforms
-      @games_by_id = Gamesdb.games_by_platform_id(platforms[0][:id])
+      @first_page = Gamesdb.games_by_platform_id(platforms[0][:id])
+      @second_page = Gamesdb.games_by_platform_id(platforms[0][:id], 2)
     end
 
     it 'should return games in platform by id' do
-      @games_by_id.count.wont_be :<, 0
+      @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 'platform' do
     describe 'assigning basic info' do
       before do
-        @platform = Gamesdb.platform_by_id 6
+        @platform = Gamesdb.platform_by_id(6)
       end
 
       it 'should return valid platform info' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegamesdb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2019-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Client for TheGamesDB API (thegamesdb.net).