amz_sp_api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129a4bc559aca17253362d03710e1fb6b5dcc55c
-  data.tar.gz: 7e0dbcb797f06e10deaebb2532add432cb58ac1f
+  metadata.gz: b1935461ccb847a6cbcde207477ffc65875ffaf6
+  data.tar.gz: c218101c0d50578bd07847e6cd0c277b8e68a12b
 SHA512:
-  metadata.gz: 16ea2e4a0c8843c7f4a034d2bbfd5dff049079a1391a44da6d4aa864f48c351233ebcab67ca7b219850ca4a601f4ec4a8c7b79534bc3b268634e55497523b91b
-  data.tar.gz: 5c4154fd81e34f66f0c1ad31960cf338762097a705b147c44a496769f555520f0ea5250955cd707f8364d78b018288e02043e445d45efa596b79ea06ba6910ac
+  metadata.gz: 39e75fe5e3a4a7ea79b884e57bb723df123b025eb46128d99374d3e96a00b34f422e54757526d53fe7f361cd81f238615fbff16308ca6fdeac0324cd149bc1f1
+  data.tar.gz: 2c23f34bfc73d8c09df0c219b677a7b1ae66901533f4595d22285bd6302f865bd9f6c83daaade2dc4a5e2e20740adc607dfdd7fae50e2a3a569661eef84ed6de

data/README.md

@@ -59,9 +59,9 @@ require 'fulfillment-outbound-api-model'
 
 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
+## Feeds and reports
 
-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:
+This gem also offers encrypt/decrypt helper methods for feeds and reports, 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, e.g. for feeds but reports is the same pattern:
 
 ```ruby
 feeds = AmzSpApi::FeedsApiModel::FeedsApi.new(AmzSpApi::SpApiClient.new)
@@ -77,7 +77,7 @@ result_feed_document_id = response&.payload&.dig(:resultFeedDocumentId) # presen
 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)
+AmzSpApi.decrypt_and_inflate_document(ciphertext, response.payload)
 ```
 
 ## Thanks

data/lib/amz_sp_api.rb

@@ -1,4 +1,5 @@
 require 'amz_sp_api_version'
+require 'api_error'
 require 'sp_api_client'
 require 'sp_configuration'
 
@@ -16,37 +17,43 @@ module AmzSpApi
       end
     end
 
-    def encrypt_feed(feed_content, feed_document_response_payload)
-      cipher = feed_cipher(feed_document_response_payload, encrypt: true)
+    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_feed(ciphertext, feed_document_response_payload)
-      cipher = feed_cipher(feed_document_response_payload, encrypt: false)
+    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
 
-      compression = feed_document_response_payload[:compressionAlgorithm]
-      raise "unknown compressionAlgorithm #{compression}" if compression && compression != "GZIP"
+      inflate_document(body, document_response_payload)
+    end
+    alias_method :decrypt_and_inflate_feed, :decrypt_and_inflate_document
 
-      result = cipher.update(ciphertext) + cipher.final
-      result = Zlib::Inflate.inflate(result) if compression
-      result
+    def inflate_document(body, document_response_payload)
+      compression = document_response_payload[:compressionAlgorithm]
+      raise AmzSpApi::ApiError.new("unknown compressionAlgorithm #{compression}") if compression && compression != "GZIP"
+      compression ? Zlib::Inflate.inflate(body) : 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 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}"
+    def document_cipher(response, encrypt:)
+      if 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 AmzSpApi::ApiError.new("unknown encryption standard #{response.inspect}")
+        end
+
+        encrypt ? cipher.encrypt : cipher.decrypt
+        cipher.key = key
+        cipher.iv = Base64.decode64(response.dig(:encryptionDetails, :initializationVector))
+        cipher
       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.1'
+  VERSION = '0.2.2'
 end

metadata

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