amz_sp_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297170c943d4b963e390e8a4afa5b8e54b80ddc9b8ccb6022b52d4104e0c2a7e
-  data.tar.gz: d123bc9dc6f76ccdba0ed4bbfe75d0f81ee3514d5a5adeda4774f14c23cae9a3
+  metadata.gz: af5701c2fe08efdbaa850f795f22fe0a28896bf25d6a9931450000b0e74c215b
+  data.tar.gz: a20507de180c513ffecfe398b7083575dfd9e4afea3fa749e9bf60c7a2d39711
 SHA512:
-  metadata.gz: adcb19947942ef2fa703c3d14da33011b847da0b64d2a8f2ecede9eecc1bf4aec9a50e69f796e4c971ac0f846db193c0a66171a6710ca3510aaa55f095df6f3a
-  data.tar.gz: 53966218ee1e7258a740390984fe0ddcdf3d0355ff9e58ab921a92b85737e4aedb139aa8d37d91a175b4eda5d151e168282cb7aa1a4908e859072fd1aa5960f5
+  metadata.gz: 7b1b9c1df6b1021a6e8764c07e87eade52c150da5a25e5c7b7865496c3c06660ada15837fa4f7036a66869cda7d34df20fe722925098285d8be3a4f24984f437
+  data.tar.gz: ef6fd443e3b8ee3f958ebdf17b5bb497d870d860e0204866ac11b22edccce4487b1c6846e01a47313a8ae530ac87184ef3345b30089ceca915ed0c82c614e981

data/README.md

@@ -4,7 +4,9 @@ AmzSpApi - Unofficial Ruby gem for the Amazon Selling Partner API (SP-API)
 
 This SDK is automatically generated by running [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) on each model from https://github.com/amzn/selling-partner-api-models using the [codegen.sh](codegen.sh) script.  
 
-Auto-generated documentation is nested here, but the references in https://github.com/amzn/selling-partner-api-docs are more comprehensive. 
+Auto-generated documentation is nested here:  This is a handy way to see all the API model class names and corresponding files you need to require for them, e.g. require 'finances-api-model' to use https://www.rubydoc.info/gems/amz_sp_api/AmzSpApi/FinancesApiModel/DefaultApi
+
+but https://developer-docs.amazon.com/sp-api is more comprehensive. 
 
 ## Installation
 
@@ -55,9 +57,40 @@ require 'fulfillment-outbound-api-model'
   end
 ```
 
-## Documentation
+## Restricted operations
+
+Configure as per above but also create a new client for each restrictedResources you need, e.g.:
 
-This is a handy way to see all the API model class names and corresponding files you need to require for them, e.g. require 'finances-api-model' to use https://www.rubydoc.info/gems/amz_sp_api/AmzSpApi/FinancesApiModel/DefaultApi 
+```
+require 'orders-api-model'
+
+client = AmzSpApi::RestrictedSpApiClient.new({
+  'restrictedResources' => [
+    {
+      'method' => 'GET',
+      'path' => "/orders/v0/orders",
+      'dataElements' => ['buyerInfo', 'shippingAddress']
+    }
+  ]
+})
+api_orders = AmzSpApi::OrdersApiModel::OrdersV0Api.new(client)
+api_orders.get_orders(marketplace_ids, created_after: 1.day.ago.iso8601)
+
+client = AmzSpApi::RestrictedSpApiClient.new({
+  'restrictedResources' => [
+    {
+      'method' => 'GET',
+      'path' => "/orders/v0/orders/#{my_order_id}",
+      'dataElements' => ['buyerInfo', 'shippingAddress']
+    }
+  ]
+})
+api_orders = AmzSpApi::OrdersApiModel::OrdersV0Api.new(client)
+api_orders.get_order(my_order_id)
+
+# or you can use models AmzSpApi::RestrictedSpApiClient.new(AmzSpApi::TokensApiModel::CreateRestrictedDataTokenRequest.new(restricted_resources: [
+        AmzSpApi::TokensApiModel::RestrictedResource.new(...
+```
 
 ## Feeds and reports
 

data/amz_sp_api.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'aws-sigv4', '~> 1.2'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

data/lib/amz_sp_api.rb

@@ -1,7 +1,8 @@
 require 'amz_sp_api_version'
 require 'api_error'
-require 'sp_api_client'
 require 'sp_configuration'
+require 'sp_api_client'
+require 'restricted_sp_api_client'
 
 module AmzSpApi
   class << self

data/lib/amz_sp_api_version.rb

@@ -1,3 +1,3 @@
 module AmzSpApi
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/restricted_sp_api_client.rb

@@ -0,0 +1,56 @@
+require 'api_error'
+require 'api_client'
+require 'configuration'
+require 'sp_api_client'
+
+require 'tokens-api-model'
+
+module AmzSpApi
+  class RestrictedSpApiClient < ApiClient
+
+    def initialize(create_restricted_data_token_request, config = SpConfiguration.default)
+      super(config)
+      raise "pass create_restricted_data_token_request to RestrictedSpApiClient.new" if create_restricted_data_token_request.kind_of?(Configuration)
+      @wrapped_client = SpApiClient.new(config)
+      @create_restricted_data_token_request = create_restricted_data_token_request
+      @cache_key = config.access_token_key + "-RDT-" + Digest::MD5.hexdigest(create_restricted_data_token_request.to_s)
+    end
+
+    alias_method :super_call_api, :call_api
+    def call_api(http_method, path, opts = {})
+      unsigned_request = build_request(http_method, path, opts)
+      aws_headers = auth_headers(http_method, unsigned_request.url, unsigned_request.encoded_body)
+      signed_opts = opts.merge(:header_params => aws_headers.merge(opts[:header_params] || {}))
+      super(http_method, path, signed_opts)
+    end
+
+    private
+
+    def retrieve_rdt_access_token
+      return request_rdt_access_token[:access_token] unless config.get_access_token
+      stored_token = config.get_access_token.call(@cache_key)
+      if stored_token.nil?
+        new_token = request_rdt_access_token
+        config.save_access_token.call(@cache_key, new_token) if config.save_access_token
+        return new_token[:access_token]
+      else
+        return stored_token
+      end
+    end
+
+    def request_rdt_access_token
+      api_tokens = AmzSpApi::TokensApiModel::TokensApi.new(@wrapped_client)
+      response = api_tokens.create_restricted_data_token(@create_restricted_data_token_request)
+
+      {access_token: response.restricted_data_token,
+        expires_in: response.expires_in}
+    end
+
+    def auth_headers(http_method, url, body)
+      SpApiClient.signed_request_headers(config, http_method, url, body).merge({
+        'x-amz-access-token' => retrieve_rdt_access_token
+      })
+    end
+
+  end
+end

data/lib/sp_api_client.rb

@@ -18,6 +18,21 @@ module AmzSpApi
       super(http_method, path, signed_opts)
     end
 
+    def self.signed_request_headers(config, http_method, url, body)
+      request_config = {
+        service: 'execute-api',
+        region: config.aws_region
+      }
+      if config.credentials_provider
+        request_config[:credentials_provider] = config.credentials_provider
+      else
+        request_config[:access_key_id] = config.aws_access_key_id
+        request_config[:secret_access_key] = config.aws_secret_access_key
+      end
+      signer = Aws::Sigv4::Signer.new(request_config)
+      signer.sign_request(http_method: http_method.to_s, url: url, body: body).headers
+    end
+
     private
 
     def retrieve_lwa_access_token
@@ -58,23 +73,8 @@ module AmzSpApi
       data
     end
 
-    def signed_request_headers(http_method, url, body)
-      request_config = {
-        service: 'execute-api',
-        region: config.aws_region
-      }
-      if config.credentials_provider
-        request_config[:credentials_provider] = config.credentials_provider
-      else
-        request_config[:access_key_id] = config.aws_access_key_id
-        request_config[:secret_access_key] = config.aws_secret_access_key
-      end
-      signer = Aws::Sigv4::Signer.new(request_config)
-      signer.sign_request(http_method: http_method.to_s, url: url, body: body).headers
-    end
-
     def auth_headers(http_method, url, body)
-      signed_request_headers(http_method, url, body).merge({
+      self.class.signed_request_headers(config, http_method, url, body).merge({
         'x-amz-access-token' => retrieve_lwa_access_token
       })
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amz_sp_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Eric Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -36,20 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -96,9 +90,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- amz_sp_api-0.2.0.gem
-- amz_sp_api-0.2.1.gem
-- amz_sp_api-0.2.2.gem
 - amz_sp_api.gemspec
 - codegen.sh
 - config.json
@@ -3129,6 +3120,7 @@ files:
 - lib/reports-api-model/spec/models/report_spec.rb
 - lib/reports-api-model/spec/spec_helper.rb
 - lib/reports-api-model/version.rb
+- lib/restricted_sp_api_client.rb
 - lib/sales-api-model.rb
 - lib/sales-api-model/.gitignore
 - lib/sales-api-model/.rspec