gwitch 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5d7c8e1ed024ba5333231113ae82e55743789dbf45eef7c5d7fd3fdcd50caeb
-  data.tar.gz: dc6eba3677e8fcf0ee4038dfc275398b2ddc31e1fd1a70793c7505fc2eb60298
+  metadata.gz: 82b6169c6117ff674bb11ac60e62d9eadaa6445755e6b6ebc0c1ea23d62a0254
+  data.tar.gz: 1b83dd4d0243c328917d997f6c9463cc4b464711560172d8cf2afb6d45167a1e
 SHA512:
-  metadata.gz: 1e78faf779696cf21b962d04085eb0dea98f14a9c2a9baca056109f12a0c3099c370fb12c43f4e02a74aad7a1b20f8af82a585ce84f7f14ca5be23b587e6bb85
-  data.tar.gz: 9f5d471a7c462a01744eafa8560dddc82edb7f8fc864ddd36b6ce450d8741c27d70844c912540ca375048ab96055ee4a81aa567dd1816d2b27f49ab9fad5e0ad
+  metadata.gz: eff925c25baaba1530f03d0389669e337249a4997420e2ca22760950e2ecaf5055e7c724ccbf407d1f0cd3b1702de0a93eab734cdd680e2adb532f883df9d4a3
+  data.tar.gz: b3099b85d58a4c74ac6aa6a6d5bf971b038484d03b501da5c6f6026f37b3758b1f4ddf8ad5565fff49993c3b278dd7cea816730ea6ed5e2e43d7b20e9b347106

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.0.0](https://github.com/dounx/gwitch/releases/tag/1.0.0) (2020-05-25)
+
+* Fix typo
+* Fix a bug
+* Update gemspec
+* Update readme
+* Refactor code
+* Add some rake tasks
+* Add gitignore
+* Add mutex for multi threads
+* Remove redundant comments
+* Make get all games simultaneously
+* Add cli
+* Add some tests
+
 ## [0.0.1](https://github.com/dounx/gwitch/releases/tag/0.0.1) (2020-05-21)
 
 * Initial import

data/README.md

@@ -1,6 +1,6 @@
 # Gwitch
 
-Gwitch can get switch games info (including price) from nintendo official API.
+Gwitch can get switch games' info (including price) from nintendo official API.
 
 ## Prerequisites
 
@@ -24,21 +24,37 @@ And then execute:
 
 ## Basic Usage
 
-```ruby
-require 'gwitch'
+### Bash
+
+```
+Usage: gwitch [options]
+    -g, --games                      Get all games (without price info)
+    -p, --price alpha2,nsuid1,nsuid2 Get games' price (Max 50 nsuids)
+    -c, --countries                  Get avaliable countries' alpha2 code
+    -v, --version                    Print version and exit
+    -h, --help                       Show help
+```
+
+The returned data will always be in json format.
+
+Can be used with pipes and redirects.
+
+eg.
+
+```bash
+gwitch -g >> games.json
 ```
 
-Get all games from americas, asia and europe eshops.
+### Ruby
 
 ```ruby
-games = Gwitch::Game.all
+require 'gwitch'
 ```
 
-Get all games from one eshops.
+Get all games.
 
 ```ruby
-# Americas, Asia and Europe
-games = Gwitch::Game.all('Americas')
+games = Gwitch::Game.all
 ```
 
 Get all avaliable countries.
@@ -50,16 +66,21 @@ countries = Gwitch::Country.all
 Get country's info.
 
 ```ruby
-country = Gwitch::Country.new('US')
-country.alpha2   # => 'US'
-country.region   # => 'Americas'
-country.currency # => 'USD'
+country = countries.first
+country.alpha2     # => 'US'
+country.region     # => 'Americas'
+country.currency   # => 'USD'
+country.avaliable? # => true
 ```
 
-Query game's price.
+Query games' price (Max 50 games).
 
 ```ruby
-price = Gwitch::Game.price('US', 'en', '70010000000141')
+prices = Gwitch::Game.price('US', 'en', '70010000000141,70010000000142')
+
+prices = Gwitch::Game.price('US', 'en', ['70010000000141', '70010000000142'])
+
+prices = Gwitch::Game.price('US', 'en', [70010000000141, 70010000000142])
 ```
 
 ## Build
@@ -68,7 +89,15 @@ price = Gwitch::Game.price('US', 'en', '70010000000141')
 git clone https://github.com/Dounx/gwitch
 cd gwitch
 gem build gwitch.gemspec
-gem install --local gwitch-0.0.1.gem
+gem install --local gwitch-*.gem
+```
+
+## Rake
+
+List of available tasks
+
+```bash
+rake --tasks
 ```
 
 ## License

data/bin/gwitch

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative "../lib/gwitch"
+require_relative "../lib/gwitch/cli"
+
+cli = Gwitch::CLI.new
+cli.parse
+
+options = cli.options
+
+if options[:game]
+  puts Gwitch::Game.all.to_json
+elsif options[:price]
+  opts = options[:price]
+  country = Gwitch::Country.new opts[0]
+  nsuids = opts.drop(1).map(&:to_i)
+  puts Gwitch::Game.price(country.alpha2, nsuids.join(',')).to_json
+elsif options[:country]
+  puts Gwitch::Country.all.map(&:alpha2).to_json
+else
+  puts cli.parser
+end

data/lib/gwitch.rb

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

data/lib/gwitch/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "version"
+
+module Gwitch
+  class CLI
+    attr_reader :options, :parser
+
+    def parse(args = ARGV)
+      @options = setup_options(args)
+    end
+
+    private
+
+    def setup_options(args)
+      parse_options(args)
+    end
+
+    def parse_options(argv)
+      opts = {}
+      @parser = option_parser(opts)
+      @parser.parse!(argv)
+      opts
+    end
+
+    def option_parser(opts)
+      parser = OptionParser.new { |o|
+        o.on "-g", "--games", "Get all games (without price info)" do |arg|
+          opts[:game] = arg
+        end
+
+        o.on "-p", "--price alpha2,nsuid1,nsuid2", Array, "Get games' price (Max 50 nsuids)" do |arg|
+          opts[:price] = arg
+        end
+
+        o.on "-c", "--countries", "Get avaliable countries' alpha2 code" do |arg|
+          opts[:country] = arg
+        end
+
+        o.on "-v", "--version", "Print version and exit" do |arg|
+          puts "Gwitch #{VERSION}"
+          exit 0
+        end
+      }
+
+      parser.banner = "Usage: gwitch [options]"
+      parser.on_tail "-h", "--help", "Show help" do
+        puts parser
+        exit 1
+      end
+
+      parser
+    end
+  end
+end

data/lib/gwitch/country.rb

@@ -1,30 +1,26 @@
 # frozen_string_literal: true
 
-require 'countries'
-require_relative 'game'
+require "countries"
+require_relative "game"
 
 module Gwitch
   class Country
+    InvaildAlpha2CodeError = Class.new(StandardError)
+
     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
+        countries = ISO3166::Country.all.map do |country|
+          Country.new(country.alpha2)
+        end
 
-      def avaliable?(alpha2)
-        # An americas game
-        nsuid = '70010000000141'
-        
-        !Game.price(alpha2, nsuid).nil?
+        countries.select{ |country| country.avaliable? }
       end
     end
 
     def initialize(alpha2)
       @country = ISO3166::Country[alpha2]
+      raise InvaildAlpha2CodeError unless @country
     end
 
     def alpha2
@@ -38,5 +34,12 @@ module Gwitch
     def currency
       @country.currency_code
     end
+
+    def avaliable?
+      # An americas game
+      nsuid = '70010000000141'
+      
+      !Game.price(alpha2, nsuid).nil?
+    end
   end
 end

data/lib/gwitch/game.rb

@@ -1,34 +1,27 @@
 # frozen_string_literal: true
 
-require_relative 'region'
+require_relative "region"
 
 module Gwitch
   class Game
     IdsExceedMaxError = Class.new(StandardError)
 
+    MAX_IDS_SIZE = 50
+
     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
+      def all
+        Region.games
       end
 
-      # ids can be String or Array
       def price(alpha2, ids, lang = 'en')
-        raise IdsExceedMaxError if ids.is_a?(Array) && ids.size > 50
+        ids = ids.split(',') if ids.is_a?(String)
+        raise IdsExceedMaxError if ids.size > MAX_IDS_SIZE
 
         api_url = 'https://api.ec.nintendo.com/v1/price'
         queries = {
           country: alpha2,
           lang: lang,
-          ids: ids
+          ids: ids.join(',')
         }
 
         uri = URI.parse(api_url)

data/lib/gwitch/region.rb

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
-require_relative 'region/americas'
-require_relative 'region/asia'
-require_relative 'region/europe'
+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]
+      semaphore = Mutex.new
+      games = []
+
+      threads = 
+        [Americas, Asia, Europe].map do |region|
+          Thread.new do
+            semaphore.synchronize {
+              games += region.games
+            }
+          end
         end
-      ]
+      threads.each(&:join)
+      games
     end
   end
 end

data/lib/gwitch/region/americas.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require 'algoliasearch'
+require "algoliasearch"
 
 module Gwitch
   class Region
-
-    # A class which get games from americas eshop.
     class Americas
       CLIENT = Algolia::Client.new(
         application_id: 'U3B6GR4UA3',
@@ -18,10 +16,8 @@ module Gwitch
 
       # Trick for API limitation.
       # Nintendo limit each facet can only get 1000 results.
-      # So we use as much as possible to get results.
+      # So use facets 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'],
@@ -78,8 +74,6 @@ module Gwitch
           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'
@@ -132,6 +126,7 @@ module Gwitch
               categories: game['categories'],
               maker: game['publishers']&.join(', '),
               player: game['players'],
+              region: 'Americas',
               images: image_urls,
               url: url,
               release_at: game['releaseDateMask']

data/lib/gwitch/region/asia.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'open-uri'
-require 'json'
+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 = {
@@ -17,7 +15,6 @@ module Gwitch
       }.freeze
 
       class << self
-        # Get all games from asia eshop.
         def games
           games = []
           uri = URI.parse(API_URL)
@@ -66,6 +63,7 @@ module Gwitch
               languages: game['lang'],
               modes: modes,
               dlcs: game['cnsuid'] || [],
+              region: 'Asia',
               images: image_urls,
               url: url,
               release_at: game['pdate']

data/lib/gwitch/region/europe.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'open-uri'
-require 'json'
+require "open-uri"
+require "json"
 
 module Gwitch
   class Region
-
-    # A class which get games from europe eshop.
     class Europe
       RowsTooSmallError = Class.new(StandardError)
 
@@ -23,7 +21,6 @@ module Gwitch
       }.freeze
 
       class << self
-        # Get all games from asia eshop.
         def games
           uri = URI.parse(API_URL)
           uri.query = URI.encode_www_form(QUERIES)
@@ -62,6 +59,7 @@ module Gwitch
               languages: game['language_availability']&.first&.split(',') || [],
               modes: modes,
               cloud_save: game['cloud_saves_b'],
+              region: 'Europe',
               images: [
                 schema + game['image_url'],
                 schema + game['image_url_sq_s'],

data/lib/gwitch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gwitch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Dounx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -38,16 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem can get switch games info from nintendo official API.
+description: Gwitch can get switch games' info (including price) from nintendo official
+  API.
 email: imdounx@gmail.com
-executables: []
+executables:
+- gwitch
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/gwitch
 - lib/gwitch.rb
+- lib/gwitch/cli.rb
 - lib/gwitch/country.rb
 - lib/gwitch/game.rb
 - lib/gwitch/region.rb
@@ -81,5 +85,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Nintendo switch game API.
+summary: Nintendo switch games' info API.
 test_files: []