gwitch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5d7c8e1ed024ba5333231113ae82e55743789dbf45eef7c5d7fd3fdcd50caeb
+  data.tar.gz: dc6eba3677e8fcf0ee4038dfc275398b2ddc31e1fd1a70793c7505fc2eb60298
+SHA512:
+  metadata.gz: 1e78faf779696cf21b962d04085eb0dea98f14a9c2a9baca056109f12a0c3099c370fb12c43f4e02a74aad7a1b20f8af82a585ce84f7f14ca5be23b587e6bb85
+  data.tar.gz: 9f5d471a7c462a01744eafa8560dddc82edb7f8fc864ddd36b6ce450d8741c27d70844c912540ca375048ab96055ee4a81aa567dd1816d2b27f49ab9fad5e0ad

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.0.1](https://github.com/dounx/gwitch/releases/tag/0.0.1) (2020-05-21)
+
+* Initial import

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2005-2020 Dounx
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Gwitch
+
+Gwitch can get switch games info (including price) from nintendo official API.
+
+## Prerequisites
+
+* ruby >= 2.3
+
+## Installation
+
+```bash
+gem install gwitch
+```
+
+Or you can install via Bundler if you are using Rails. Add this line to your application's Gemfile:
+
+```ruby
+gem 'gwitch'
+```
+
+And then execute:
+
+    $ bundle
+
+## Basic Usage
+
+```ruby
+require 'gwitch'
+```
+
+Get all games from americas, asia and europe eshops.
+
+```ruby
+games = Gwitch::Game.all
+```
+
+Get all games from one eshops.
+
+```ruby
+# Americas, Asia and Europe
+games = Gwitch::Game.all('Americas')
+```
+
+Get all avaliable countries.
+
+```ruby
+countries = Gwitch::Country.all
+```
+
+Get country's info.
+
+```ruby
+country = Gwitch::Country.new('US')
+country.alpha2   # => 'US'
+country.region   # => 'Americas'
+country.currency # => 'USD'
+```
+
+Query game's price.
+
+```ruby
+price = Gwitch::Game.price('US', 'en', '70010000000141')
+```
+
+## Build
+
+```bash
+git clone https://github.com/Dounx/gwitch
+cd gwitch
+gem build gwitch.gemspec
+gem install --local gwitch-0.0.1.gem
+```
+
+## License
+
+Gwitch is an open-sourced software licensed under the [MIT license](LICENSE).

data/lib/gwitch/country.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'countries'
+require_relative 'game'
+
+module Gwitch
+  class Country
+    class << self
+      # All avaliable countries
+      def all
+        ISO3166::Country.all.map(&:alpha2).select do |alpha2|
+          avaliable?(alpha2)
+        end.map { |alpha2| Country.new(alpha2) }
+      end
+
+      private
+
+      def avaliable?(alpha2)
+        # An americas game
+        nsuid = '70010000000141'
+        
+        !Game.price(alpha2, nsuid).nil?
+      end
+    end
+
+    def initialize(alpha2)
+      @country = ISO3166::Country[alpha2]
+    end
+
+    def alpha2
+      @country.alpha2
+    end
+
+    def region
+      @country.region
+    end
+
+    def currency
+      @country.currency_code
+    end
+  end
+end

data/lib/gwitch/game.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'region'
+
+module Gwitch
+  class Game
+    IdsExceedMaxError = Class.new(StandardError)
+
+    class << self
+      def all(area = nil)
+        case area
+        when 'Americas'
+          Region::Americas.games
+        when 'Asia'
+          Region::Asia.games
+        when 'Europe'
+          Region::Europe.games
+        else
+          Region.games
+        end
+      end
+
+      # ids can be String or Array
+      def price(alpha2, ids, lang = 'en')
+        raise IdsExceedMaxError if ids.is_a?(Array) && ids.size > 50
+
+        api_url = 'https://api.ec.nintendo.com/v1/price'
+        queries = {
+          country: alpha2,
+          lang: lang,
+          ids: ids
+        }
+
+        uri = URI.parse(api_url)
+        uri.query = URI.encode_www_form(queries)
+
+        JSON.parse(uri.read)
+      rescue OpenURI::HTTPError
+        nil
+      end
+    end
+  end
+end

data/lib/gwitch/region/americas.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'algoliasearch'
+
+module Gwitch
+  class Region
+
+    # A class which get games from americas eshop.
+    class Americas
+      CLIENT = Algolia::Client.new(
+        application_id: 'U3B6GR4UA3',
+        api_key: '9a20c93440cf63cf1a7008d75f7438bf'
+      )
+
+      INDEX = CLIENT.init_index('noa_aem_game_en_us')
+
+      PLATFORM = 'platform:Nintendo Switch'
+
+      # Trick for API limitation.
+      # Nintendo limit each facet can only get 1000 results.
+      # So we use as much as possible to get results.
+      # Maybe incompletely got.
+      # DON'T use this directly.
+      # Use filters method.
+      FACETS = { 
+        generalFilters: ['Deals', 'DLC available', 'Demo available', 'Online Play via Nintendo Switch Online', 'Nintendo Switch Game Voucher'],
+        availability: ['New releases', 'Available now', 'Pre-purchase', 'Coming soon'],
+        categories: ['Action', 'Adventure', 'Application', 'Education', 'Fitness', 'Indie', 'Music', 'Party', 'Puzzle', 'Racing', 'Role-Playing', 'Simulation', 'Sports', 'Strategy'],
+        filterShops: ['At retail', 'On Nintendo.com'],
+        virtualConsole: ['NES', 'Super NES', 'Game Boy', 'Game Boy Color', 'Nintendo 64', 'Game Boy Advance', 'Nintendo DS', 'Other'],
+        characters: ['Mario', 'Zelda', 'Donkey Kong', 'Metroid', 'Pokémon', 'Mii', 'Kirby', 'Animal Crossing'],
+        priceRange: ['Free to start', '$0 - $4.99', '$5 - $9.99', '$10 - $19.99', '$20 - $39.99', '$40+'],
+        esrb: ['Everyone', 'Everyone 10+', 'Teen', 'Mature'],
+        filterPlayers: ['1+', '2+', '3+', '4+']
+      }.freeze
+
+      class << self
+        def games
+          games = []
+
+          # No facets
+          games += fetch
+
+          # Each facet
+          filters.each do |filter|
+            games += fetch(filter)
+          end
+
+          parse(games.uniq)
+        end
+
+        private
+
+        def fetch(filter = nil)
+          hits = []
+        
+          # Empty string means all
+          query = ''
+        
+          # histPerPage max can be 500
+          search_params = {
+            hitsPerPage: 500
+          }
+        
+          search_params.merge!(facetFilters: filter) if filter
+        
+          page = 0
+        
+          loop do
+            response = INDEX.search(query, search_params.merge(page: page))
+            total_pages = response['nbPages']
+            hits += response['hits']
+            page += 1
+
+            break unless page < total_pages
+          end
+        
+          hits
+        end
+
+        # GalleryParsedError = Class.new
+
+        def parse(raw)
+          host = 'https://www.nintendo.com'
+          microsite_host = 'https://assets.nintendo.com/image/upload/f_auto,q_auto,w_960,h_540'
+          legacy_host = 'https://assets.nintendo.com/video/upload/f_auto,q_auto,w_960,h_540'
+          asset_host = 'https://assets.nintendo.com/image/upload/f_auto,q_auto,w_960,h_540/Legacy%20Videos/posters/'
+
+          raw.map do |game|
+            image_urls = []
+            image_urls << (host + game['boxArt']) if game['boxArt']
+
+            gallery_path = game['gallery']
+            if gallery_path.nil?
+              nil
+            # Begin with '/'
+            elsif gallery_path[0] == '/'
+              # If prefix is 'content'
+              if gallery_path[1] == 'c'
+                image_urls << host + gallery_path
+              # Prefix is 'Microsites'
+              # Just one game
+              elsif  gallery_path[1] == 'M'
+                url = microsite_host + gallery_path
+                last_slash = url.rindex('/')
+                image_urls << url.insert(last_slash + 1, 'posters/')
+              # Prefix is 'Nintendo'
+              elsif gallery_path[1] == 'N'
+                # TODO Nintendo* url have many situations
+                # https://assets.nintendo.com/image/upload/f_auto,q_auto,w_960,h_540/Nintendo Switch/Games/Third Party/Overcooked 2/Video/posters/Overcooked_2_Gourmet_Edition_Trailer
+                # /Nintendo Switch/Games/Third Party/Overcooked 2/Video/Overcooked_2_Gourmet_Edition_Trailer
+
+                # https://assets.nintendo.com/video/upload/f_auto,q_auto,w_960,h_540/Nintendo Switch/Games/NES and Super NES/Video/NES_Super_NES_May_2020_Game_Updates_Nintendo_Switch_Online
+                # /Nintendo Switch/Games/NES and Super NES/Video/NES_Super_NES_May_2020_Game_Updates_Nintendo_Switch_Online
+              # Prefix is 'Legacy Videos'
+              elsif gallery_path[1] == 'L'
+                image_urls << legacy_host + gallery_path
+              else
+                raise GalleryParsedError
+              end
+            # Just id
+            else
+              image_urls << asset_host + gallery_path
+            end
+
+            url = game['url'] ? host + game['url'] : nil
+
+            {
+              nsuid: game['nsuid'],
+              title: game['title'],
+              description: game['description'],
+              categories: game['categories'],
+              maker: game['publishers']&.join(', '),
+              player: game['players'],
+              images: image_urls,
+              url: url,
+              release_at: game['releaseDateMask']
+            }
+          end
+        end
+
+        def filters
+          filters = []
+          
+          FACETS.each do |facet, options|
+            options.each do |option|
+              filters << [PLATFORM, "#{facet}:#{option}"]
+            end
+          end
+
+          filters
+        end
+      end
+    end
+  end
+end

data/lib/gwitch/region/asia.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'json'
+
+module Gwitch
+  class Region
+
+    # A class which get games from asia eshop.
+    class Asia
+      API_URL = 'https://search.nintendo.jp/nintendo_soft/search.json'
+      QUERIES = {
+        opt_sshow: 1,
+        opt_osale: 1,
+        opt_hard: '1_HAC',
+        limit: 300
+      }.freeze
+
+      class << self
+        # Get all games from asia eshop.
+        def games
+          games = []
+          uri = URI.parse(API_URL)
+          page = 1
+
+          loop do
+            uri.query = URI.encode_www_form(QUERIES.merge(page: page))
+
+            result = JSON.parse(uri.read)['result']
+
+            total = result['total']
+            games += result['items']
+            page += 1
+
+            break unless games.size < total
+          end
+
+          parse(games)
+        end
+
+        private
+
+        def parse(raw)
+          host = 'https://ec.nintendo.com/JP/ja/titles/'
+          image_host = 'https://img-eshop.cdn.nintendo.net/i/'
+          image_extension = '.jpg'
+
+          raw.map do |game|
+            modes = []
+            modes += game['pmode']&.map { |mode| mode.delete_suffix('_MODE') } || []
+
+            image_urls = []
+            image_urls += game['sslurl']&.map { |id| image_host + id + image_extension } if game['sslurl']
+            image_urls << image_host + game['iurl'] + image_extension if game['iurl']
+
+            url = game['nsuid'] ? host + game['nsuid'] : nil
+
+            {
+              nsuid: game['nsuid'],
+              code: game['icode'],
+              title: game['title'],
+              description: game['text'],
+              categories: game['genre'],
+              maker: game['maker'],
+              player: game['player']&.first,
+              languages: game['lang'],
+              modes: modes,
+              dlcs: game['cnsuid'] || [],
+              images: image_urls,
+              url: url,
+              release_at: game['pdate']
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gwitch/region/europe.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'json'
+
+module Gwitch
+  class Region
+
+    # A class which get games from europe eshop.
+    class Europe
+      RowsTooSmallError = Class.new(StandardError)
+
+      API_URL = 'https://search.nintendo-europe.com/en/select'
+      MAX_ROWS = 100000
+
+      # ((playable_on_txt:"HAC")) means platform is nintendo switch
+      QUERIES = {
+        q: '*',
+        fq: '((playable_on_txt:"HAC"))',
+        wt: 'json',
+        rows: MAX_ROWS,
+        start: 0
+      }.freeze
+
+      class << self
+        # Get all games from asia eshop.
+        def games
+          uri = URI.parse(API_URL)
+          uri.query = URI.encode_www_form(QUERIES)
+          response = JSON.parse(uri.read)['response']
+
+          raise RowsTooSmallError if response['numFound'] > MAX_ROWS
+
+          parse(response['docs'])
+        end
+
+        private
+
+        def parse(raw)
+          host = 'https://www.nintendo.co.uk'
+          schema = 'https:'
+
+          raw.map do |game|
+            code = game['product_code_txt']&.first
+            code = code[4..8] if code
+
+            modes = []
+            modes << 'TV' if game['play_mode_tv_mode_b']
+            modes << 'TABLETOP' if game['play_mode_tabletop_mode_b']
+            modes << 'HANDHELD' if game['play_mode_handheld_mode_b']
+
+            url = game['url'] ? host + game['url'] : nil
+
+            {
+              nsuid: game['nsuid_txt'] || [],
+              code: code,
+              title: game['title'],
+              description: game['excerpt'],
+              categories: game['pretty_game_categories_txt'] || [],
+              maker: game['publisher'],
+              player: game['players_to'],
+              languages: game['language_availability']&.first&.split(',') || [],
+              modes: modes,
+              cloud_save: game['cloud_saves_b'],
+              images: [
+                schema + game['image_url'],
+                schema + game['image_url_sq_s'],
+                schema + game['image_url_h2x1_s'],
+                schema + game['gift_finder_carousel_image_url_s'],
+                schema + game['gift_finder_detail_page_image_url_s'],
+                schema + game['gift_finder_wishlist_image_url_s'],
+                schema + game['wishlist_email_square_image_url_s'],
+                schema + game['wishlist_email_banner460w_image_url_s'],
+                schema + game['wishlist_email_banner640w_image_url_s']
+              ],
+              url: url,
+              release_at: game['dates_released_dts']&.first
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gwitch/region.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'region/americas'
+require_relative 'region/asia'
+require_relative 'region/europe'
+
+module Gwitch
+  
+  # Get all games from americas, asia and europe eshops
+  class Region
+    def self.games
+      Hash[
+        [Americas, Asia, Europe].collect do |region| 
+          [region.name.split('::').last, region.games]
+        end
+      ]
+    end
+  end
+end

data/lib/gwitch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gwitch
+  VERSION = '0.0.1'
+end

data/lib/gwitch.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'gwitch/game'
+require_relative 'gwitch/country'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: gwitch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dounx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: algoliasearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem can get switch games info from nintendo official API.
+email: imdounx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/gwitch.rb
+- lib/gwitch/country.rb
+- lib/gwitch/game.rb
+- lib/gwitch/region.rb
+- lib/gwitch/region/americas.rb
+- lib/gwitch/region/asia.rb
+- lib/gwitch/region/europe.rb
+- lib/gwitch/version.rb
+homepage: https://github.com/dounx/gwitch
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dounx/gwitch/issues
+  changelog_uri: https://github.com/dounx/gwitch/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/dounx/gwitch/blob/master/README.md
+  source_code_uri: https://github.com/dounx/gwitch
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Nintendo switch game API.
+test_files: []