amz_sp_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee4098faefbf5cd215a7bc4e6c11830acb94de49
-  data.tar.gz: 81907b713cc2d88ba565a0e88a8c98334081404d
+  metadata.gz: 129a4bc559aca17253362d03710e1fb6b5dcc55c
+  data.tar.gz: 7e0dbcb797f06e10deaebb2532add432cb58ac1f
 SHA512:
-  metadata.gz: cc89c9f8dbb50680584948b29aa79232d9fa762b8fddba04411f94a6bc359936866c711f35ea6cec758bb06556edd2962bfc3c905378bc0d3d539909abe47622
-  data.tar.gz: 2f9831e66d81599745ddf667c0c65f571324fe2853a777cec492d2cb1ded13b975f14913d741355e95970f16fb80d1fb6344a9b182b2f14f44e3a23abecbc770
+  metadata.gz: 16ea2e4a0c8843c7f4a034d2bbfd5dff049079a1391a44da6d4aa864f48c351233ebcab67ca7b219850ca4a601f4ec4a8c7b79534bc3b268634e55497523b91b
+  data.tar.gz: 5c4154fd81e34f66f0c1ad31960cf338762097a705b147c44a496769f555520f0ea5250955cd707f8364d78b018288e02043e445d45efa596b79ea06ba6910ac

data/README.md

@@ -8,32 +8,7 @@ Auto-generated documentation is nested here, but the references in https://githu
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build amz_sp_api.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./amz_sp_api-0.1.0.gem
-```
-(for development, run `gem install --dev ./amz_sp_api-0.1.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 'amz_sp_api', '~> 0.1'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/ericcj/amz_sp_api, then add the following in the Gemfile:
-
-    gem 'amz_sp_api', :git => 'https://github.com/ericcj/amz_sp_api.git', branch: 'main'
+Add the gem to your Gemfile as per https://rubygems.org/gems/amz_sp_api
 
 ## Getting Started
 
@@ -48,8 +23,19 @@ require 'fulfillment-outbound-api-model'
     config.refresh_token = 
     config.client_id = 
     config.client_secret = 
+
+    # either use these:
     config.aws_access_key_id = 
     config.aws_secret_access_key = 
+
+    # OR config.credentials_provider which is passed along to https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html, e.g.
+    # require 'aws-sdk-core'
+    # config.credentials_provider = Aws::STS::Client.new(
+    #     region: AmzSpApi::SpConfiguration::AWS_REGION_MAP['eu'],
+    #     access_key_id: ,
+    #     secret_access_key: 
+    #   ).assume_role(role_arn: , role_session_name: SecureRandom.uuid)
+
     config.region = 'eu'
     config.timeout = 20 # seconds
     # config.debugging = true
@@ -69,6 +55,31 @@ require 'fulfillment-outbound-api-model'
   end
 ```
 
+## Documentation
+
+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 
+
+## Feeds
+
+This gem also offers encrypt/decrypt helper methods for feeds, but actually using that API as per https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/feeds-api-use-case-guide requires the following calls:
+
+```ruby
+feeds = AmzSpApi::FeedsApiModel::FeedsApi.new(AmzSpApi::SpApiClient.new)
+response = feeds.create_feed_document({"contentType" => content_type})
+feed_document_id = response&.payload&.dig(:feedDocumentId)
+url = response.payload[:url]
+encrypted = AmzSpApi.encrypt_feed(feed_content, response.payload)
+# PUT to url with lowercase "content-type" header, it's already pre-signed
+response = feeds.create_feed({"feedType" => feed_type, "marketplaceIds" => marketplace_ids, "inputFeedDocumentId" => feed_document_id})
+feed_id = response&.payload&.dig(:feedId)
+response = feeds.get_feed(feed_id)
+result_feed_document_id = response&.payload&.dig(:resultFeedDocumentId) # present once it is successful
+response = feeds.get_feed_document(result_feed_document_id)
+url = response&.payload&.dig(:url)
+# GET response&.payload&.dig(:url) into ciphertext, again it's pre-signed so no authorization needed
+AmzSpApi.decrypt_and_inflate_feed(ciphertext, response.payload)
+```
+
 ## Thanks
 
 to https://github.com/patterninc/muffin_man as the basis for [sp_api_client.rb](lib/sp_api_client.rb)

data/lib/amz_sp_api.rb

@@ -15,5 +15,38 @@ module AmzSpApi
         SpConfiguration.default
       end
     end
+
+    def encrypt_feed(feed_content, feed_document_response_payload)
+      cipher = feed_cipher(feed_document_response_payload, encrypt: true)
+      cipher.update(feed_content) + cipher.final
+    end
+
+    def decrypt_and_inflate_feed(ciphertext, feed_document_response_payload)
+      cipher = feed_cipher(feed_document_response_payload, encrypt: false)
+
+      compression = feed_document_response_payload[:compressionAlgorithm]
+      raise "unknown compressionAlgorithm #{compression}" if compression && compression != "GZIP"
+
+      result = cipher.update(ciphertext) + cipher.final
+      result = Zlib::Inflate.inflate(result) if compression
+      result
+    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 feed_cipher(response, encrypt:)
+      key = Base64.decode64(response.dig(:encryptionDetails, :key))
+
+      cipher = case response.dig(:encryptionDetails, :standard)
+      when "AES"
+        OpenSSL::Cipher.new("AES-#{key.size * 8}-CBC")
+      else
+        raise "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

data/lib/amz_sp_api_version.rb

@@ -1,3 +1,3 @@
 module AmzSpApi
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amz_sp_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Eric Jensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -96,6 +96,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- amz_sp_api-0.2.0.gem
 - amz_sp_api.gemspec
 - codegen.sh
 - config.json