amazon_pay 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7040fc32759f87f3f3f21b053831138dd4c5c04
-  data.tar.gz: aac1ff85663dffd1cc964b371d9f05f669150bfc
+SHA256:
+  metadata.gz: 294f94d2300bab4c088fe8f4609bcf25ae97b615cff07c7d5603e272a579c7d7
+  data.tar.gz: 8a438dbee412d742240305b6e338cb0be4ffff769d84d1fe3bb13a4ffdc035e7
 SHA512:
-  metadata.gz: 6c746d20fd2e12307e06318b78f669656199d0baa849c0d2cd7f8bbe6f383222fe566b8ff7d0e802cb1bdc4784f742bc1c3524b69b38ce32e3738dc3cde5e7f7
-  data.tar.gz: 6bee2aa81e8e8d8aa00f48ff71c5d8fbc7d3519b172bfd1154aa7ce9bd2ec282936eb6ca6b20e25954c86c0421d352e49a91b5582988fe65e2158c5a0f19bd7e
+  metadata.gz: 348548089b4b8290b71a429b6fcb7b1836c2a8cf411387419d9c9c480e9c9cab652b04b9a45868afb8bb69cd1283348e61c46953691bef29d4635756513301f2
+  data.tar.gz: 2f0f99a204da9a5e9119470fc7b5502f080199e794c0d3ef170f6b58a6d8e63c672ee2625196dbe6cae4d6e12d16b234135584805db2e20e06cb5b2259bb0f44

data/README.md

@@ -113,6 +113,101 @@ client.get_order_reference_details(
 
 ```
 
+Below is an example on how to query using the Seller Order ID using the
+ListOrderReference API call:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key
+)
+
+seller_order_id = 'merchant_id:Test 4321'
+# These are examples of input 
+# for the option values
+query_id = '1234-example-order'
+query_id_type = 'SellerOrderId'
+created_time_range_start_time = '2017-09-20T17:39:27.925Z'
+created_time_range_end_time = '2017-09-25T17:39:27.925Z'
+sort_order = 'Descending'
+order_reference_status_list_filter = ['canceled', 'open', 'closed']
+page_size = 1
+
+response = client.list_order_reference(
+  query_id,
+  query_id_type,
+  created_time_range_start: created_time_range_start_time,
+  created_time_range_end: created_time_range_end_time,
+  sort_order: sort_order,
+  page_size: page_size,
+  order_reference_status_list_filter: order_reference_status_list_filter,
+  mws_auth_token: nil
+  )
+
+```
+
+Below is an example on how to query using the next token received
+from ListOrderReference using the ListOrderReferenceByNextToken 
+API call:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key
+)
+
+response = client.list_order_reference_by_next_token(
+  'eyJuZXh0UGFnZVRva2VuIjoiQUFBQUFBQUFBQUZXL0x3dE50TDBTUWhla29JVk5VNWgvbURhSWJXc1E2MnlVdzVuaURCTURFN2g4U0xja3EweWpCSlY4S2pVRHFJWC9wcDBKOG8rMnJDcFREa2xjWjViVmJweFhPS2xuYUJXL0pQeTB4UGIwNjlUU3dlcnVSSHB5TUREMUV2aiswM3pvY3FWbkRZL0p3VTVpWUV4cUdaeGpYbzg0WVI2NkVmek9tbTRjVUZSbDNJL2ZOOC9kMWRuMkMyaWxaMy9nNlRtU2cvMG9CdTJ2U1FVVy9rcThxc1dmS1dQNkFQaGhKK08xOFlmVko5NS9WWFRPeXliMWJVdEl0U3h5K2FlYlN1YXBoWHZybGdqR3BERE1zeFhsRFozLzlsc2hPNE1lZTQ2MlVIU3lndFVjN0htLzQ2NFFzVTlMRmE0N0UrZ05hOVRSeU1XMTJ5ZU1Mc3ZydkdES2lTcFVuSTB1Rk83RnZFK01GbzdOQUtsWUhSbDVsSUgrSy9LYmJhQ2lsLzZxaFdwbkJjK3J6WmQrOVg0ZmRrWG9YcWpXK3oyVTdUTUZWVjFkaEVnOHZ0cmgvaGxHb0N6ZUZiSVg3SWVNOCtwS0pkbWtPdjlpUUlxbTNYM1hZQXBTamtEMUtWNnNaTWsvNkphREpQazhoanVUVjFMV1JiZVREeVQ2eElBeVRJeFIrOXZkTlozYW1YdHA4cklxRGNSMzh2aTdwTi9UYXo3WFR2Y1c0aDF3UEFCOTVNU3J5WmJTYUpVMjEybVZhclZwdFZ4aEMyWlRBVUR6MkltRlZUbU05bXZRL1ZWNEhWSExQZE9kQ1BrVFVWWHFZNGo4Z3Q3YTlUdkhKWlFyQzd2Q2o1djUrc0RNNkZXT0gwWWZscW1wV0NZc2ZGMko0V0dFcnkvS3ZMQTZHWm0xVitxVmVwd21lZEx5bDgzZXdFS0JUbDhVTkVTZklIRW5ETVdaRHBORmdXNmhVaUNzWTFZbEdwemxnZUpUbUpVR1lBQXRrY3BxQjMrb29rRCtBTWRPM05lZFpQeVYvM1d2M1B6dTI1VkVHQVNWRU90RDVieTl3WUUxczQ1bU83alZWa1JJakxlMndnQUNJTTlVc3hnZXlGRDZOY1dNclk5VWZ2UTNiKzZibjdqU0ljcTYrdkgrWG1Zb0V4ekM4K1pHWDVJcnlUUmVpRjBGMW1vRHNTUkowVW1kNGxyVldNNmNJTE0rOHFpb0IzMGF6dXdQNnZDb3VsVkZwWS9vK0o0Wmc9PSIsIm1hcmtldHBsYWNlSWQiOiJBM0JYQjBZTjNYSDE3SCJ9'
+  )
+
+```
+
+Below is an example on how to enable Logging for the SDK:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  log_enabled: true,
+  # If you don't specify a log file like
+  # the example below, logging will be
+  # output to the standard out stream
+  log_file_name: 'log.txt',
+  # Currently only the debug level has been
+  # implemented in the SDK. This is done
+  # by default.
+  log_level: :debug
+)
+
+```
+
 ### Response Parsing
 
 ```ruby

data/lib/amazon_pay/client.rb

@@ -378,6 +378,72 @@ module AmazonPay
       operation(parameters, optional)
     end
 
+    # Allows the search of any Amazon Pay order made using secondary
+    # seller order IDs generated manually, a solution provider, or a custom
+    # order fulfillment service.
+    # @param query_id [String]
+    # @param query_id_type [String]
+    # @optional created_time_range_start [String]
+    # @optional created_time_range_end [String]
+    # @optional sort_order [String]
+    # @optional page_size [Integer]
+    # @optional order_reference_status_list_filter Array[String]
+    # @optional merchant_id [String]
+    # @optional mws_auth_token [String]
+    def list_order_reference(
+      query_id,
+      query_id_type,
+      created_time_range_start: nil,
+      created_time_range_end: nil,
+      sort_order: nil,
+      page_size: nil,
+      order_reference_status_list_filter: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
+
+      payment_domain = payment_domain_hash[@region]
+
+      parameters = {
+        'Action' => 'ListOrderReference',
+        'SellerId' => merchant_id,
+        'QueryId' => query_id,
+        'QueryIdType' => query_id_type
+      }
+
+      optional = {
+        'CreatedTimeRange.StartTime' => created_time_range_start,
+        'CreatedTimeRange.EndTime' => created_time_range_end,
+        'SortOrder' => sort_order,
+        'PageSize' => page_size,
+        'PaymentDomain' => payment_domain,
+        'MWSAuthToken' => mws_auth_token
+      }
+
+      if order_reference_status_list_filter
+        order_reference_status_list_filter.each_with_index do |val, index|
+          optional_key = "OrderReferenceStatusListFilter.OrderReferenceStatus.#{index + 1}"
+          optional[optional_key] = val
+        end
+      end
+
+      operation(parameters, optional)
+    end
+
+    # When ListOrderReference returns multiple pages
+    # you can continue by using the NextPageToken returned
+    # by ListOrderReference
+    # @param next_page_token [String]
+    def list_order_reference_by_next_token(next_page_token)
+      parameters = {
+        'Action' => 'ListOrderReferenceByNextToken',
+        'SellerId' => @merchant_id,
+        'NextPageToken' => next_page_token
+      }
+
+      operation(parameters, {})
+    end
+
     # Returns details about the Order Reference object and its current state
     # @see https://pay.amazon.com/documentation/apireference/201751630#201751970
     # @param amazon_order_reference_id [String]
@@ -938,6 +1004,17 @@ module AmazonPay
       }
     end
 
+    def payment_domain_hash
+      {
+        jp: 'FE_JPY',
+        uk: 'EU_GBP',
+        de: 'EU_EUR',
+        eu: 'EU_EUR',
+        us: 'NA_USD',
+        na: 'NA_USD'
+      }
+    end
+
     # This method builds the provider credit details hash
     # that will be combined with either the authorize or capture
     # API call.

data/lib/amazon_pay/client_helper.rb

@@ -1,9 +1,7 @@
 module AmazonPay
-
   # This will extend the client class to add additional
   # helper methods that combine core API calls.
   class Client
-
     # This method combines multiple API calls to perform
     # a complete transaction with minimum requirements.
     # @param amazon_reference_id [String]
@@ -19,50 +17,53 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def charge(
-            amazon_reference_id,
-            authorization_reference_id,
-            charge_amount,
-            charge_currency_code: @currency_code,
-            charge_note: nil,
-            charge_order_id: nil,
-            store_name: nil,
-            custom_information: nil,
-            soft_descriptor: nil,
-            platform_id: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_reference_id,
+      authorization_reference_id,
+      charge_amount,
+      charge_currency_code: @currency_code,
+      charge_note: nil,
+      charge_order_id: nil,
+      store_name: nil,
+      custom_information: nil,
+      soft_descriptor: nil,
+      platform_id: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       if is_order_reference?(amazon_reference_id)
         response = call_order_reference_api(
-                       amazon_reference_id,
-                       authorization_reference_id,
-                       charge_amount,
-                       charge_currency_code,
-                       charge_note,
-                       charge_order_id,
-                       store_name,
-                       custom_information,
-                       soft_descriptor,
-                       platform_id,
-                       merchant_id,
-                       mws_auth_token)
+          amazon_reference_id,
+          authorization_reference_id,
+          charge_amount,
+          charge_currency_code,
+          charge_note,
+          charge_order_id,
+          store_name,
+          custom_information,
+          soft_descriptor,
+          platform_id,
+          merchant_id,
+          mws_auth_token
+        )
         return response
       end
 
       if is_billing_agreement?(amazon_reference_id)
         response = call_billing_agreement_api(
-                       amazon_reference_id,
-                       authorization_reference_id,
-                       charge_amount,
-                       charge_currency_code,
-                       charge_note,
-                       charge_order_id,
-                       store_name,
-                       custom_information,
-                       soft_descriptor,
-                       platform_id,
-                       merchant_id,
-                       mws_auth_token)
+          amazon_reference_id,
+          authorization_reference_id,
+          charge_amount,
+          charge_currency_code,
+          charge_note,
+          charge_order_id,
+          store_name,
+          custom_information,
+          soft_descriptor,
+          platform_id,
+          merchant_id,
+          mws_auth_token
+        )
         return response
       end
     end
@@ -94,36 +95,38 @@ module AmazonPay
     )
 
       set_order_attributes(amazon_order_reference_id,
-                           # amount:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
-                           # currency_code:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
-                           # platform_id:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
-                           seller_note: seller_note,
-                           seller_order_id: seller_order_id,
-                           payment_service_provider_id: payment_service_provider_id,
-                           payment_service_provider_order_id: payment_service_provider_order_id,
-                           request_payment_authorization: request_payment_authorization,
-                           store_name: store_name,
-                           # order_item_categories:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
-                           custom_information: custom_information,
-                           merchant_id: merchant_id,
-                           mws_auth_token: mws_auth_token)
+        # amount:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
+        # currency_code:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
+        # platform_id:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
+        seller_note: seller_note,
+        seller_order_id: seller_order_id,
+        payment_service_provider_id: payment_service_provider_id,
+        payment_service_provider_order_id: payment_service_provider_order_id,
+        request_payment_authorization: request_payment_authorization,
+        store_name: store_name,
+        # order_item_categories:(This value can't be modified after order is confirmed so it isn't passed to set_order_attributes)
+        custom_information: custom_information,
+        merchant_id: merchant_id,
+        mws_auth_token: mws_auth_token
+      )
     end
 
     private
 
     def call_order_reference_api(
-            amazon_reference_id,
-            authorization_reference_id,
-            charge_amount,
-            charge_currency_code,
-            charge_note,
-            charge_order_id,
-            store_name,
-            custom_information,
-            soft_descriptor,
-            platform_id,
-            merchant_id,
-            mws_auth_token)
+      amazon_reference_id,
+      authorization_reference_id,
+      charge_amount,
+      charge_currency_code,
+      charge_note,
+      charge_order_id,
+      store_name,
+      custom_information,
+      soft_descriptor,
+      platform_id,
+      merchant_id,
+      mws_auth_token
+    )
 
       response = set_order_reference_details(
         amazon_reference_id,
@@ -135,12 +138,14 @@ module AmazonPay
         store_name: store_name,
         custom_information: custom_information,
         merchant_id: merchant_id,
-        mws_auth_token: mws_auth_token)
+        mws_auth_token: mws_auth_token
+      )
       if response.success
         response = confirm_order_reference(
           amazon_reference_id,
           merchant_id: merchant_id,
-          mws_auth_token: mws_auth_token)
+          mws_auth_token: mws_auth_token
+        )
         if response.success
           response = authorize(
             amazon_reference_id,
@@ -152,35 +157,34 @@ module AmazonPay
             capture_now: true,
             soft_descriptor: soft_descriptor,
             merchant_id: merchant_id,
-            mws_auth_token: mws_auth_token)
-          return response
-        else
-          return response
+            mws_auth_token: mws_auth_token
+          )
         end
-      else
-        return response
       end
+      return response
     end
 
     def call_billing_agreement_api(
-            amazon_reference_id,
-            authorization_reference_id,
-            charge_amount,
-            charge_currency_code,
-            charge_note,
-            charge_order_id,
-            store_name,
-            custom_information,
-            soft_descriptor,
-            platform_id,
-            merchant_id,
-            mws_auth_token)
+          amazon_reference_id,
+          authorization_reference_id,
+          charge_amount,
+          charge_currency_code,
+          charge_note,
+          charge_order_id,
+          store_name,
+          custom_information,
+          soft_descriptor,
+          platform_id,
+          merchant_id,
+          mws_auth_token
+    )
 
       response = get_billing_agreement_details(
         amazon_reference_id,
         merchant_id: merchant_id,
-        mws_auth_token: mws_auth_token)
-      if response.get_element('GetBillingAgreementDetailsResponse/GetBillingAgreementDetailsResult/BillingAgreementDetails/BillingAgreementStatus','State').eql?('Draft')
+        mws_auth_token: mws_auth_token
+      )
+      if response.get_element('GetBillingAgreementDetailsResponse/GetBillingAgreementDetailsResult/BillingAgreementDetails/BillingAgreementStatus', 'State').eql?('Draft')
         response = set_billing_agreement_details(
           amazon_reference_id,
           platform_id: platform_id,
@@ -189,15 +193,15 @@ module AmazonPay
           store_name: store_name,
           custom_information: custom_information,
           merchant_id: merchant_id,
-          mws_auth_token: mws_auth_token)
+          mws_auth_token: mws_auth_token
+        )
         if response.success
           response = confirm_billing_agreement(
             amazon_reference_id,
             merchant_id: merchant_id,
-            mws_auth_token: mws_auth_token)
-          if response.success.eql?(false)
-            return response
-          end
+            mws_auth_token: mws_auth_token
+          )
+          return response if response.success.eql?(false)
         end
       end
 
@@ -217,19 +221,17 @@ module AmazonPay
         custom_information: custom_information,
         inherit_shipping_address: true,
         merchant_id: merchant_id,
-        mws_auth_token: mws_auth_token)
+        mws_auth_token: mws_auth_token
+      )
       return response
     end
 
-
     def is_order_reference?(amazon_reference_id)
-      amazon_reference_id.start_with?('S','P')
+      amazon_reference_id.start_with?('S', 'P')
     end
 
     def is_billing_agreement?(amazon_reference_id)
-      amazon_reference_id.start_with?('C','B')
+      amazon_reference_id.start_with?('C', 'B')
     end
-
   end
-
 end

data/lib/amazon_pay/version.rb

@@ -1,5 +1,5 @@
 module AmazonPay
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
   SDK_NAME = "amazon-pay-sdk-ruby"
   API_VERSION = "2013-01-01"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon_pay
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies: []
 description: AmazonPay Ruby SDK
 email: amazon-pay-sdk@amazon.com
@@ -31,7 +31,7 @@ files:
 - lib/amazon_pay/version.rb
 homepage: https://github.com/amzn/amazon-pay-sdk-ruby
 licenses:
-- Apache License, Version 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: AmazonPay Ruby SDK