amzn_sp_api 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783fb91c0553c49156529d65ab4e732e558298acd851a4dc6f6fd23a13043f86
-  data.tar.gz: d5977f856aeccf993eabd1f9e52a965488f40ca5c1b75273438097ca83386b8c
+  metadata.gz: f1b9dfde3c75d07c2a76693888913160222066f2c31fede720af510bcf7346ee
+  data.tar.gz: a613ae63a0917235adc069b61b5d0f7dcadfcb43a3b5ac5ce2dc7c42354c7fa1
 SHA512:
-  metadata.gz: 81572d91c6d2ade6fe31b61407b2090f38742243bab11b53f25065b654fe339a0446ac627815129c262cac55f8ae4ce512abfaf5528e1280931eb4be8830b361
-  data.tar.gz: 7562fd0d734b27d1ce27f4d31120ad1bd64c576c86ea0609571a30d236b33b78cf4824d717b655aa0418dacb942bf9a95d3a98aab0c6f8f722aed69760a50023
+  metadata.gz: 2e59e68086459de5aa0914c253caacd15587ad0d87f2e00eb549f7516f06ad9e9664d1f5cf9be29a9b1a7d0367ffb1974fd0a54c1dadf0e6113e43b384161153
+  data.tar.gz: a655720eb4b4e7674966bb546f7eb247fa4e8f58649c2b43b4c0fafa11480fe73e065b48e05b069713d98fbfc3839f640ed661a5715ba0998cee496ede949383

data/.rubocop.yml

@@ -0,0 +1,22 @@
+Style/AsciiComments:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyElse:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/ZeroLengthPredicate:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in amzn_sp_api.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
+
+gem 'rubocop', '~> 1.49'

data/Gemfile.lock

@@ -1,34 +1,30 @@
 PATH
   remote: .
   specs:
-    amzn_sp_api (0.1.0)
-      aws-sdk-sts (= 1.7.0)
+    amzn_sp_api (1.0.1)
       aws-sigv4 (~> 1.5)
-      json (~> 2.6, >= 2.6.1)
+      json (~> 2.6)
       typhoeus (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.600.0)
-    aws-sdk-core (3.131.1)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
-      jmespath (~> 1, >= 1.6.1)
-    aws-sdk-sts (1.7.0)
-      aws-sdk-core (~> 3, >= 3.110.0)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.5.0)
+    aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
     diff-lcs (1.5.0)
-    ethon (0.15.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
-    jmespath (1.6.1)
     json (2.6.2)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -42,16 +38,32 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
   amzn_sp_api!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop (~> 1.49)
 
 BUNDLED WITH
-   2.3.3
+   2.3.22

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 tianzhenfei
+Copyright (c) 2022 zevinto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,26 +1,22 @@
 # AmznSpApi
 
-This project rocks and uses MIT License.
+Ruby Gem for Amazon Selling Partner API (SP-API) (Unoffical).
 
-## Installation
-
-Add this line to your application's Gemfile:
+Automatically generated by running Swagger Codegen on each model from https://github.com/amzn/selling-partner-api-models.
 
-```ruby
-gem 'amzn_sp_api'
-```
+## Installation
 
-And then execute:
+Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle install
+    $ bundle add amzn_sp_api
 
-Or install it yourself as:
+If bundler is not being used to manage dependencies, install the gem by executing:
 
     $ gem install amzn_sp_api
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Write usage instructions here(To be added).
 
 ## Development
 
@@ -30,4 +26,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/amzn_sp_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/amzn_sp_api/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/zevinto/amzn_sp_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zevinto/amzn_sp_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/amzn_sp_api.gemspec

@@ -1,25 +1,23 @@
-# frozen_string_literal: true
-
-require_relative "lib/amzn_sp_api/amzn_sp_api_version.rb"
+require_relative 'lib/amzn_sp_api/amzn_sp_api_version'
 
 Gem::Specification.new do |spec|
-  spec.name = "amzn_sp_api"
+  spec.name = 'amzn_sp_api'
   spec.version = AmznSpApi::VERSION
-  spec.authors = ["aarontzf"]
-  spec.email = ["aarontzf@163.com"]
+  spec.authors = ['zevinto']
+  spec.email = ['aarontzf@163.com']
 
-  spec.summary = "Amazon Selling Partner API (SP-API) Ruby Gem (Unofficial)."
-  spec.description = "Automatically generated by running Swagger Codegen on each model from https://github.com/amzn/selling-partner-api-models."
-  spec.homepage = "https://github.com/Aarontzf/amzn_sp_api"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = 'Ruby Gem for Amazon Selling Partner API (SP-API).'
+  spec.description = 'Ruby Gem for Amazon Selling Partner API (SP-API).'
+  spec.homepage = 'https://github.com/zevinto/amzn_sp_api'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
 
-  spec.add_runtime_dependency 'aws-sdk-sts', '1.7.0'
   spec.add_runtime_dependency 'aws-sigv4', '~> 1.5'
-  spec.add_runtime_dependency 'json', '~> 2.6', '>= 2.6.1'
+  spec.add_runtime_dependency 'json', '~> 2.6'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
+
   spec.add_development_dependency 'rspec', '~> 3.0'
 
   # Specify which files should be added to the gem when it is released.
@@ -29,7 +27,7 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

data/config.json

@@ -1,9 +1,9 @@
 {
   "gemName": "GEMNAME",
   "moduleName": "AmznSpApi::MODULENAME",
-  "gemVersion": "0.1.0",
-  "gemAuthor": "Aarontzf",
+  "gemVersion": "1.0.0",
+  "gemAuthor": "Zevinto",
   "gemAuthorEmail": "aarontzf@163.com",
-  "gemHomepage": "https://github.com/Aarontzf/amzn_sp_api",
+  "gemHomepage": "https://github.com/zevinto/amzn_sp_api",
   "gemLicense": "MIT"
 }

data/lib/amzn_sp_api/amzn_sp_api_version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module AmznSpApi
-  VERSION = '0.1.0'
+  VERSION = '1.0.1'
 end

data/lib/amzn_sp_api/api_client.rb

@@ -1,14 +1,3 @@
-# frozen_string_literal: true
-
-# #Selling Partner API for Orders
-#
-# The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
-#
-# OpenAPI spec version: v0
-#
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
-# Swagger Codegen version: 3.0.34
-
 require 'date'
 require 'json'
 require 'logger'
@@ -31,10 +20,7 @@ module AmznSpApi
     def initialize(config = Configuration.default)
       @config = config
       @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
-      @default_headers = {
-        'Content-Type' => 'application/json',
-        'User-Agent' => @user_agent
-      }
+      @default_headers = { 'Content-Type' => 'application/json', 'User-Agent' => @user_agent }
     end
 
     def self.default
@@ -56,12 +42,9 @@ module AmznSpApi
           raise ApiError, 'Connection timed out'
         elsif response.code.zero?
           # Errors from libcurl will be made visible here
-          raise ApiError.new(code: 0,
-                             message: response.return_message)
+          raise ApiError.new(code: 0, message: response.return_message)
         else
-          raise ApiError.new(code: response.code,
-                             response_headers: response.headers,
-                             response_body: response.body),
+          raise ApiError.new(code: response.code, response_headers: response.headers, response_body: response.body),
                 response.status_message
         end
       end
@@ -181,11 +164,9 @@ module AmznSpApi
       begin
         data = JSON.parse("[#{body}]", symbolize_names: true)[0]
       rescue JSON::ParserError => e
-        if %w[String Date DateTime].include?(return_type)
-          data = body
-        else
-          raise e
-        end
+        raise e unless %w[String Date DateTime].include?(return_type)
+
+        data = body
       end
 
       convert_to_type data, return_type
@@ -302,7 +283,7 @@ module AmznSpApi
 
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
         else raise ArgumentError, 'Authentication token must be in `query` of `header`'
         end
       end
@@ -345,7 +326,6 @@ module AmznSpApi
     def object_to_http_body(model)
       return model if model.nil? || model.is_a?(String)
 
-      local_body = nil
       local_body = if model.is_a?(Array)
                      model.map { |m| object_to_hash(m) }
                    else

data/lib/amzn_sp_api/api_error.rb

@@ -1,12 +1,3 @@
-# #Selling Partner API for Orders
-#
-# The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
-#
-# OpenAPI spec version: v0
-#
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
-# Swagger Codegen version: 3.0.34
-
 module AmznSpApi
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body
@@ -38,16 +29,10 @@ module AmznSpApi
     end
 
     def message
-      msg = if @message.nil?
-              'Error message: the server returns an error'
-            else
-              @message
-            end
-
+      msg = @message.nil? ? 'Error message: the server returns an error' : @message
       msg += "\nHTTP status code: #{code}" if code
       msg += "\nResponse headers: #{response_headers}" if response_headers
       msg += "\nResponse body: #{response_body}" if response_body
-
       msg
     end
   end

data/lib/amzn_sp_api/configuration.rb

@@ -1,12 +1,3 @@
-# #Selling Partner API for Orders
-#
-# The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
-#
-# OpenAPI spec version: v0
-#
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
-# Swagger Codegen version: 3.0.34
-
 module AmznSpApi
   class Configuration
     # Defines url scheme
@@ -187,8 +178,7 @@ module AmznSpApi
 
     # Returns Auth Settings hash for api client.
     def auth_settings
-      {
-      }
+      {}
     end
   end
 end

data/lib/amzn_sp_api/sp_api_client.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'aws-sigv4'
 
 require 'amzn_sp_api/api_error'
@@ -40,21 +38,19 @@ module AmznSpApi
       new_access_token.config = config.dup
       new_access_token.config.host = 'api.amazon.com'
 
-      data, status_code, headers = new_access_token.super_call_api(:POST, '/auth/o2/token',
-                                                                   header_params: {
-                                                                     'Content-Type' => 'application/x-www-form-urlencoded'
-                                                                   },
-                                                                   form_params: {
-                                                                     grant_type: 'refresh_token',
-                                                                     refresh_token: config.refresh_token,
-                                                                     client_id: config.client_id,
-                                                                     client_secret: config.client_secret
-                                                                   },
-                                                                   return_type: 'Object')
+      header_params = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      grant_type = config.scope.present? ? 'client_credentials' : 'refresh_token'
+      form_params = {
+        grant_type: grant_type,
+        refresh_token: config.refresh_token,
+        client_id: config.client_id,
+        client_secret: config.client_secret,
+        scope: config.scope
+      }
+      data, status_code, headers = new_access_token.super_call_api(:POST, '/auth/o2/token', header_params: header_params,
+                                                                                            form_params: form_params, return_type: 'Object')
 
-      unless data && data[:access_token]
-        raise ApiError.new(code: status_code, response_headers: headers, response_body: data)
-      end
+      raise ApiError.new(code: status_code, response_headers: headers, response_body: data) unless data && data[:access_token]
 
       data
     end
@@ -76,11 +72,7 @@ module AmznSpApi
     end
 
     def auth_headers(http_method, url, body)
-      signed_request_headers(http_method, url, body).merge(
-        {
-          'x-amz-access-token' => retrieve_lwa_access_token
-        }
-      )
+      signed_request_headers(http_method, url, body).merge({ 'x-amz-access-token' => retrieve_lwa_access_token })
     end
   end
 end

data/lib/amzn_sp_api/sp_api_configuration.rb

@@ -1,12 +1,21 @@
-# frozen_string_literal: true
-
 require 'amzn_sp_api/configuration'
 
+# from https://developer-docs.amazon.com/sp-api/docs/connecting-to-the-selling-partner-api
 module AmznSpApi
   class SpApiConfiguration < Configuration
+    # The type of access grant requested.
+    # @values: refresh_token Use this for calling operations that require authorization from a selling partner. All operations that are not grantless operations require authorization from a selling partner. When specifying this value, include the refresh_token parameter.
+    # @values: client_credentials Use this for calling grantless operations. When specifying this value, include the parameter.scope
+    attr_accessor :grant_type
+
     # The LWA refresh token.
     attr_accessor :refresh_token
 
+    # The scope of the LWA authorization grant.
+    # @values: sellingpartnerapi::notifications. For the Notifications API.
+    # @values: sellingpartnerapi::migration. For the Authorization API.
+    attr_accessor :scope
+
     # The LWA client identifier.
     attr_accessor :client_id
 
@@ -33,6 +42,12 @@ module AmznSpApi
 
     attr_accessor :get_access_token
 
+    # from https://developer-docs.amazon.com/sp-api/docs/connecting-to-the-selling-partner-api#step-1-request-a-login-with-amazon-access-token
+    SCOPE = {
+      'refresh_token' => 'sellingpartnerapi::notifications',
+      'client_credentials' => 'sellingpartnerapi::migration'
+    }.freeze
+
     # from https://developer-docs.amazon.com/sp-api/docs/sp-api-endpoints
     AWS_REGION_MAP = {
       'na' => 'us-east-1',
@@ -46,10 +61,7 @@ module AmznSpApi
 
     def region=(region)
       @region = region
-      unless aws_region
-        raise ApiError,
-              "#{region} is not supported or does not exist. Region must be one of the following: #{AWS_REGION_MAP.keys.join(', ')}"
-      end
+      raise ApiError, "#{region} is not supported or does not exist. Region must be one of the following: #{AWS_REGION_MAP.keys.join(', ')}" unless aws_region
 
       self.host = "#{sandbox ? 'sandbox.' : ''}sellingpartnerapi-#{region}.amazon.com"
       self.base_path = '/'

data/lib/amzn_sp_api.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative 'amzn_sp_api/amzn_sp_api_version'
 require 'amzn_sp_api/api_error'
 require 'amzn_sp_api/sp_api_client'
@@ -19,46 +17,12 @@ module AmznSpApi
       end
     end
 
-    def encrypt_feed(feed_content, document_response_payload)
-      cipher = document_cipher(document_response_payload, encrypt: true)
-      cipher.update(feed_content) + cipher.final
-    end
-
-    def decrypt_and_inflate_document(ciphertext, document_response_payload)
-      body = if cipher = document_cipher(document_response_payload, encrypt: false)
-               cipher.update(ciphertext) + cipher.final
-             else
-               ciphertext
-             end
-
-      inflate_document(body, document_response_payload)
-    end
-
-    alias decrypt_and_inflate_feed decrypt_and_inflate_document
-    def inflate_document(body, document_response_payload)
-      compression = document_response_payload[:compressionAlgorithm]
+    def inflate_document(body, document_response)
+      compression = document_response.compression_algorithm
       return body unless compression
-      raise AmznSpApi::ApiError, "unknown compressionAlgorithm #{compression}" if compression != 'GZIP'
+      raise AmzSpApi::ApiError, "unknown compressionAlgorithm #{compression}" if compression != 'GZIP'
 
       Zlib.gunzip(body)
     end
-
-    # From https://github.com/amzn/selling-partner-api-models/blob/main/clients/sellingpartner-api-documents-helper-java/src/main/java/com/amazon/spapi/documents/impl/AESCryptoStreamFactory.java
-    def document_cipher(response, encrypt:)
-      if key = response.dig(:encryptionDetails, :key)
-        key = Base64.decode64(key)
-        cipher = case response.dig(:encryptionDetails, :standard)
-                 when 'AES'
-                   OpenSSL::Cipher.new("AES-#{key.size * 8}-CBC")
-                 else
-                   raise AmznSpApi::ApiError, "unknown encryption standard #{response.inspect}"
-                 end
-
-        encrypt ? cipher.encrypt : cipher.decrypt
-        cipher.key = key
-        cipher.iv = Base64.decode64(response.dig(:encryptionDetails, :initializationVector))
-        cipher
-      end
-    end
   end
 end

data/lib/aplus_content_api_model/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
+  gem 'rake', '~> 13.0.1'
   gem 'rubocop', '~> 0.66.0'
 end

data/lib/aplus_content_api_model/README.md

@@ -7,7 +7,7 @@ With the A+ Content API, you can build applications that help selling partners a
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2020-11-01
-- Package version: 0.1.0
+- Package version: 1.0.0
 - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
 For more information, please visit [https://sellercentral.amazon.com/gp/mws/contactus.html](https://sellercentral.amazon.com/gp/mws/contactus.html)
 
@@ -24,15 +24,15 @@ gem build aplus_content_api_model.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./aplus_content_api_model-0.1.0.gem
+gem install ./aplus_content_api_model-1.0.0.gem
 ```
-(for development, run `gem install --dev ./aplus_content_api_model-0.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./aplus_content_api_model-1.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'aplus_content_api_model', '~> 0.1.0'
+    gem 'aplus_content_api_model', '~> 1.0.0'
 
 ### Install from Git