nintendo_eshop 0.1.0.alpha4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e399f05fe13f9ec613499cf69bc067ea100af0f9ceb26019cb49f5cd87c04e2b
-  data.tar.gz: a8c433708538c30cec7bb587b37a3491ebeee696ad3bc15f1186dc6534061145
+  metadata.gz: 0b5aad1fc3ec9ae00b695d50e092876aeb6db8b5d4c19603ea905ba49fd3e88e
+  data.tar.gz: b5c26c915e8e5cc703c32152dd06b7e56378c964d77cec0ac12ff326ffe9caed
 SHA512:
-  metadata.gz: 421f83bf9d48a559a730102479b4a55e780dcd41ac42bfed343f7684a14e23d5aa332dcdfd4b568048510cf996a8f49accf5ae76b4de68915be481467af52890
-  data.tar.gz: 9cd06480f21d667383580dc57493e4ecf44ac1ac13dff64f92730007e7e41fa3046c9b2323497ecdc94768e93dc337916af310b6fc947706fa85e2ffa727fd67
+  metadata.gz: 7e1a501720baec7391a1e32f0343d3b5379d1e8355acf46b7d89f30276c993f336cfe4a8a2b99e4a4e9c0f4953351d83fa0ea75592035649c95e50b02603dacd
+  data.tar.gz: aeb1fd14ec3b5d370336949a19827c4cb23b4af9c33d29be17e893144e48e13db51ce5095e09469289e0b384c8edac854615493b23b8ea68a8abe2e419ba9f35

data/.codeclimate.yml

@@ -1,11 +1,7 @@
 version: "2"
-# prepare:
-#   fetch:
-#     - url: "https://raw.githubusercontent.com/RamseyInHouse/ramsey-cop/master/default.yml"
-#       path: "alternate-rubocop-path.yml"
 plugins:
   rubocop:
     enabled: true
-    channel: "rubocop-0-67"
+    channel: "rubocop-0-71"
     config:
-      file: "alternate-rubocop-path.yml"
+      file: ".rubocop.yml"

data/.rspec_status

@@ -1,9 +1,11 @@
 example_id                                             | status | run_time        |
 ------------------------------------------------------ | ------ | --------------- |
-./spec/acceptance/retrieve_a_valid_record_spec.rb[1:1] | passed | 0.14289 seconds |
-./spec/nintendo_eshop/game_spec.rb[1:1:1]              | passed | 0.00375 seconds |
-./spec/nintendo_eshop/game_spec.rb[1:1:2]              | passed | 0.00616 seconds |
-./spec/nintendo_eshop/game_spec.rb[1:1:3]              | passed | 0.00564 seconds |
-./spec/nintendo_eshop/games_list_spec.rb[1:1]          | passed | 0.00254 seconds |
-./spec/nintendo_eshop/games_list_spec.rb[1:2:1]        | passed | 0.00393 seconds |
-./spec/nintendo_eshop_spec.rb[1:1]                     | passed | 0.00331 seconds |
+./spec/acceptance/retrieve_a_valid_record_spec.rb[1:1] | passed | 0.12552 seconds |
+./spec/nintendo_eshop/game_spec.rb[1:1:1]              | passed | 0.0032 seconds  |
+./spec/nintendo_eshop/game_spec.rb[1:1:2]              | passed | 0.00406 seconds |
+./spec/nintendo_eshop/game_spec.rb[1:1:3]              | passed | 0.0034 seconds  |
+./spec/nintendo_eshop/game_spec.rb[1:1:4]              | passed | 0.00478 seconds |
+./spec/nintendo_eshop/game_spec.rb[1:1:5]              | passed | 0.00013 seconds |
+./spec/nintendo_eshop/games_list_spec.rb[1:1]          | passed | 0.00227 seconds |
+./spec/nintendo_eshop/games_list_spec.rb[1:2:1]        | passed | 0.00325 seconds |
+./spec/nintendo_eshop_spec.rb[1:1]                     | passed | 0.00127 seconds |

data/.rubocop.yml

@@ -1,6 +1,90 @@
-inherit_gem:
-  ramsey_cop:
-    - default.yml
+require: rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.4
+  Exclude:
+    - db/schema.rb
+    - vendor/**/*
+  TargetRubyVersion: 2.4.6
+
+Documentation:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - config/initializers/*
+    - config/routes.rb
+    - Gemfile
+    - spec/**/*
+    - test/**/*
+    - "*.gemspec"
+    - "**/*.rake"
+
+Metrics/BlockNesting:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - config/routes.rb
+    - config/routes/*
+    - db/migrate/*
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/*
+    - spec/**/*
+    - test/**/*
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DateTime:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': ()
+    '%I': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nintendo_eshop (0.1.0.alpha4)
+    nintendo_eshop (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -36,9 +36,6 @@ GEM
     public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (12.3.2)
-    ramsey_cop (0.14.0)
-      rubocop (~> 0.62)
-      rubocop-performance
     reverse_markdown (1.1.0)
       nokogiri
     rspec (3.8.0)
@@ -69,12 +66,12 @@ GEM
       rake (>= 0.8.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.16.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    solargraph (0.33.2)
+    solargraph (0.34.2)
       backport (~> 1.1)
       bundler (>= 1.17.2)
       htmlentities (~> 4.3, >= 4.3.4)
@@ -93,7 +90,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.19)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -104,9 +101,10 @@ DEPENDENCIES
   nintendo_eshop!
   pry
   rake (~> 12.3)
-  ramsey_cop
   rspec (~> 3.0)
   rspec_junit_formatter
+  rubocop (~> 0.71.0)
+  rubocop-performance
   ruby-debug-ide
   simplecov
   solargraph

data/README.md

@@ -35,14 +35,15 @@ NintendoEshop.base_url = "https://u3b6gr4ua3-dsn.algolia.net"
 NintendoEshop.api_key = "9a20c93440cf63cf1a7008d75f7438bf"
 NintendoEshop.app_id = "U3B6GR4UA3"
 
-### Retrieve a game by ID
+### Retrieve a game by ID (nsuid)
 
-game = NintendoEshop::Game.retrieve("70010000001130")
+game = NintendoEshop::Game.retrieve_by(id: "70010000001130")
 
 game.art # "/content/dam/noa/en_US/games/switch/s/super-mario-odyssey-switch/Switch_SuperMarioOdyssey_box.png"
 game.current_price # 59.99
 game.id # "70010000001130"
 game.msrp # 59.99
+game.object_id # 3ce3fb54-5f95-3a24-9101-7faa694c4b6f
 game.platform # "Nintendo Switch"
 game.sale_price # nil
 game.title # Super Mario Odyssey"
@@ -52,18 +53,34 @@ game.url # "/games/detail/super-mario-odyssey-switch"
 Or a game on sale
 
 ```ruby
-game = NintendoEshop::Game.retrieve("70010000001539")
+game = NintendoEshop::Game.retrieve_by(id: "70010000001539")
 
 game.art # "/content/dam/noa/en_US/games/switch/s/sonic-forces-switch/Switch_SonicForces_box.png"
 game.current_price # 14.99
 game.id # "70010000001539"
 game.msrp # 29.99
+game.object_id # 26322c64-9268-3a24-822e-5e10f9e5cfc9
 game.platform # "Nintendo Switch"
 game.sale_price # 14.99
 game.title # "Sonic Forces"
 game.url # "/games/detail/sonic-forces-switch"
 ```
 
+Or by object_id
+
+```ruby
+game = NintendoEshop::Game.retrieve_by(object_id: "26851cb3-4f10-333a-8d7c-f9cae4a9bc03")
+
+game.id # "70010000001023"
+game.object_id # "26851cb3-4f10-333a-8d7c-f9cae4a9bc03"
+game.art # "/content/dam/noa/en_US/games/switch/b/bridge-constructor-portal-switch/Switch_BridgeConstructorPortal_box_eShop.png"
+game.msrp # 14.99
+game.platform # "Nintendo Switch"
+game.sale_price # 7.49
+game.title # "Bridge Constructor Portal"
+game.url # "/games/detail/bridge-constructor-portal-switch"
+```
+
 ### Search by Title
 
 ```ruby
@@ -77,7 +94,7 @@ games.first.title # "Super Mario Odyssey: Starter"
 Error handling is still a work in progress
 
 ```ruby
-game = NintendoEshop::Game.retrieve("invalid id")
+game = NintendoEshop::Game.retrieve_by(id: "invalid id")
 
 # => NintendoEshop::InvalidRequestError
 ```

data/lib/nintendo_eshop.rb

@@ -24,5 +24,6 @@ module NintendoEshop
   end
 
   class Error < StandardError; end
+  class InvalidArgumentError < Error; end
   class InvalidRequestError < Error; end
 end

data/lib/nintendo_eshop/api_request.rb

@@ -12,10 +12,9 @@ module NintendoEshop
     end
 
     def post(json: {})
-      uri = URI("#{NintendoEshop.base_url}#{self.class::RESOURCE_PATH}?#{url_params}")
+      uri = URI("#{NintendoEshop.base_url}#{resource_path}?#{url_params}")
       response = NintendoEshop.client.post(uri, json: json)
       parsed_response = JSON.parse(response.body, symbolize_names: true)
-      raise InvalidRequestError, "ID not found" if parsed_response.dig(:nbHits).zero?
 
       parsed_response
     end

data/lib/nintendo_eshop/game.rb

@@ -3,20 +3,27 @@ module NintendoEshop
     attr_accessor :art
     attr_accessor :id
     attr_accessor :msrp
+    attr_accessor :object_id
     attr_accessor :platform
     attr_accessor :sale_price
     attr_accessor :title
     attr_accessor :url
 
-    RESOURCE_PATH = "/1/indexes/noa_aem_game_en_us/query".freeze
-
-    def initialize(id)
+    def initialize(id: nil, object_id: nil)
       self.id = id
+      self.object_id = object_id
     end
 
     def refresh
       response = request(:post, to_json: body)
-      result = response.dig(:hits, 0)
+      result = if response.dig(:hits)&.any?
+                 response.dig(:hits, 0)
+               elsif response.dig(:results)&.any?
+                 response.dig(:results, 0)
+               else
+                 raise InvalidRequestError, "ID not found"
+               end
+
       refresh_object(result)
       self
     end
@@ -25,14 +32,32 @@ module NintendoEshop
       sale_price || msrp
     end
 
-    def self.retrieve(id)
-      instance = new(id)
-      instance.refresh
+    class << self
+      def retrieve_by(id_type = {})
+        validate_argument(id_type)
+        instance = new(id_type)
+        instance.refresh
+      end
+
+    private
+
+      def validate_argument(argument)
+        valid_args = argument.keys == [:id] || argument.keys == [:object_id]
+        raise InvalidArgumentError, "Only id: and object_id: have been implemented" unless valid_args
+      end
     end
 
   private
 
     def body
+      if id
+        query_body
+      elsif object_id
+        object_body
+      end
+    end
+
+    def query_body
       {
         "query": id.to_s,
         "restrictSearchableAttributes": [
@@ -41,10 +66,31 @@ module NintendoEshop
       }
     end
 
+    def object_body
+      {
+        "requests": [
+          {
+            "indexName": "noa_aem_game_en_us",
+            "objectID": object_id.to_s,
+            "attributesToRetrieve": "url,objectID,title,nsuid,salePrice,msrp,boxArt,platform"
+          }
+        ]
+      }
+    end
+
+    def resource_path
+      if id
+        "/1/indexes/noa_aem_game_en_us/query".freeze
+      elsif object_id
+        "/1/indexes/*/objects".freeze
+      end
+    end
+
     def refresh_object(result)
       self.art = result.dig(:boxArt)
       self.id = result.dig(:nsuid)
       self.msrp = result.dig(:msrp)
+      self.object_id = result.dig(:objectID)
       self.platform = result.dig(:platform)
       self.sale_price = result.dig(:salePrice)
       self.title = result.dig(:title)

data/lib/nintendo_eshop/games_list.rb

@@ -5,8 +5,6 @@ module NintendoEshop
     attr_accessor :title
     attr_accessor :games
 
-    RESOURCE_PATH = "/1/indexes/noa_aem_game_en_us/query".freeze
-
     def initialize(title)
       self.title = title
     end
@@ -40,11 +38,16 @@ module NintendoEshop
       }
     end
 
-    def refresh_list_objects(objects)
+    def resource_path
+      "/1/indexes/noa_aem_game_en_us/query".freeze
+    end
+
+    def refresh_list_objects(objects) # rubocop:disable Metrics/MethodLength
       objects.map do |object|
-        game = Game.new(object.dig(:nsuid))
+        game = Game.new(id: object.dig(:nsuid))
         game.art = object.dig(:boxArt)
         game.msrp = object.dig(:msrp)
+        game.object_id = object.dig(:objectID)
         game.platform = object.dig(:platform)
         game.sale_price = object.dig(:salePrice)
         game.title = object.dig(:title)

data/lib/nintendo_eshop/version.rb

@@ -1,3 +1,3 @@
 module NintendoEshop
-  VERSION = "0.1.0.alpha4".freeze
+  VERSION = "0.1.0".freeze
 end

data/nintendo_eshop.gemspec

@@ -35,9 +35,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "debase"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "ramsey_cop"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop", "~> 0.71.0"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "solargraph"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nintendo_eshop
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha4
+  version: 0.1.0
 platform: ruby
 authors:
 - Rick Peyton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: ramsey_cop
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,7 +202,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- alternate-rubocop-path.yml
 - bin/console
 - bin/setup
 - lib/nintendo_eshop.rb
@@ -216,9 +229,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/alternate-rubocop-path.yml

@@ -1,90 +0,0 @@
-require: rubocop-performance
-
-AllCops:
-  Exclude:
-    - db/schema.rb
-    - vendor/**/*
-  TargetRubyVersion: 2.4.6
-
-Documentation:
-  Enabled: false
-
-Layout/AccessModifierIndentation:
-  EnforcedStyle: outdent
-
-Metrics/AbcSize:
-  Exclude:
-    - spec/**/*
-    - test/**/*
-
-Metrics/BlockLength:
-  Exclude:
-    - config/initializers/*
-    - config/routes.rb
-    - Gemfile
-    - spec/**/*
-    - test/**/*
-    - "*.gemspec"
-    - "**/*.rake"
-
-Metrics/BlockNesting:
-  Exclude:
-    - spec/**/*
-    - test/**/*
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - spec/**/*
-    - test/**/*
-
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - config/routes.rb
-    - config/routes/*
-    - db/migrate/*
-
-Metrics/MethodLength:
-  Exclude:
-    - db/migrate/*
-    - spec/**/*
-    - test/**/*
-
-Metrics/ModuleLength:
-  Exclude:
-    - spec/**/*
-    - test/**/*
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/AndOr:
-  EnforcedStyle: conditionals
-
-Style/DateTime:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%i': ()
-    '%I': ()
-    '%q': ()
-    '%Q': ()
-    '%r': '{}'
-    '%s': ()
-    '%w': ()
-    '%W': ()
-    '%x': ()
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-  Enabled: true