amazon_pay 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fe8a7cb7c7d3bf5e8984213b08f09ac8efacc70
-  data.tar.gz: 742f3bf2b4c60bbe6c4fb68f877c7ac58be6415f
+  metadata.gz: d7040fc32759f87f3f3f21b053831138dd4c5c04
+  data.tar.gz: aac1ff85663dffd1cc964b371d9f05f669150bfc
 SHA512:
-  metadata.gz: 68b3f8d645532fd264f6dfdc3450bf5d645534005376f98ab1f7437ba4240952f24e1205eb9aa0e6b1ef0bc3ed72baff9d663bd719784170eeed50e4e731b50c
-  data.tar.gz: d80bb0c8a923dfe4ceae7e7091d8b6f300e79a71f0f3ff9494d0fa5b88079e20348066961b8484949c5b5b82922345f608891d66c274ca0cbd02ce3eb723be88
+  metadata.gz: 6c746d20fd2e12307e06318b78f669656199d0baa849c0d2cd7f8bbe6f383222fe566b8ff7d0e802cb1bdc4784f742bc1c3524b69b38ce32e3738dc3cde5e7f7
+  data.tar.gz: 6bee2aa81e8e8d8aa00f48ff71c5d8fbc7d3519b172bfd1154aa7ce9bd2ec282936eb6ca6b20e25954c86c0421d352e49a91b5582988fe65e2158c5a0f19bd7e

data/lib/amazon_pay.rb

@@ -1,7 +1,9 @@
 require 'amazon_pay/client'
 require 'amazon_pay/client_helper'
 require 'amazon_pay/ipn_handler'
+require 'amazon_pay/log_initializer'
 require 'amazon_pay/login'
 require 'amazon_pay/request'
 require 'amazon_pay/response'
+require 'amazon_pay/sanitize'
 require 'amazon_pay/version'

data/lib/amazon_pay/client.rb

@@ -1,14 +1,14 @@
 require 'time'
+require 'logger'
+require 'stringio'
 
 module AmazonPay
-
   # AmazonPay API
   #
   # This client allows you to make all the necessary API calls
   # to integrate with AmazonPay. This client only
   # uses the standard Ruby library and is not dependant on Rails.
   class Client
-
     attr_reader(
       :merchant_id,
       :access_key,
@@ -19,14 +19,19 @@ module AmazonPay
       :platform_id,
       :throttle,
       :application_name,
-      :application_version)
+      :application_version,
+      :log_enabled,
+      :log_file_name,
+      :log_level
+    )
 
     attr_accessor(
       :sandbox,
       :proxy_addr,
       :proxy_port,
       :proxy_user,
-      :proxy_pass)
+      :proxy_pass
+    )
 
     # API keys are located at:
     # @see https://sellercentral.amazon.com
@@ -40,26 +45,32 @@ module AmazonPay
     # @optional throttle [Boolean] Default: true
     # @optional application_name [String]
     # @optional application_version [String]
+    # @optional log_enabled [Boolean] Default: false
+    # @optional log_file_name [String]
+    # @optional log_level [Symbol] Default: DEBUG
     # @optional proxy_addr [String]
     # @optional proxy_port [String]
     # @optional proxy_user [String]
     # @optional proxy_pass [String]
     def initialize(
-            merchant_id,
-            access_key,
-            secret_key,
-            sandbox: false,
-            currency_code: :usd,
-            region: :na,
-            platform_id: nil,
-            throttle: true,
-            application_name: nil,
-            application_version: nil,
-            proxy_addr: :ENV,
-            proxy_port: nil,
-            proxy_user: nil,
-            proxy_pass: nil)
-
+      merchant_id,
+      access_key,
+      secret_key,
+      sandbox: false,
+      currency_code: :usd,
+      region: :na,
+      platform_id: nil,
+      throttle: true,
+      application_name: nil,
+      application_version: nil,
+      proxy_addr: :ENV,
+      proxy_port: nil,
+      proxy_user: nil,
+      proxy_pass: nil,
+      log_enabled: false,
+      log_file_name: nil,
+      log_level: :DEBUG
+    )
       @merchant_id = merchant_id
       @access_key = access_key
       @secret_key = secret_key
@@ -85,6 +96,10 @@ module AmazonPay
         'Version' => AmazonPay::API_VERSION
       }
 
+      @log_enabled = log_enabled
+      @log_level = log_level
+      @log_file_name = log_file_name
+
       @default_hash['PlatformId'] = @platform_id if @platform_id
     end
 
@@ -115,19 +130,20 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def create_order_reference_for_id(
-            id,
-            id_type,
-            inherit_shipping_address: nil,
-            confirm_now: nil,
-            amount: nil,
-            currency_code: @currency_code,
-            platform_id: nil,
-            seller_note: nil,
-            seller_order_id: nil,
-            store_name: nil,
-            custom_information: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      id,
+      id_type,
+      inherit_shipping_address: nil,
+      confirm_now: nil,
+      amount: nil,
+      currency_code: @currency_code,
+      platform_id: nil,
+      seller_note: nil,
+      seller_order_id: nil,
+      store_name: nil,
+      custom_information: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'CreateOrderReferenceForId',
@@ -159,10 +175,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_billing_agreement_details(
-            amazon_billing_agreement_id,
-            address_consent_token: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      address_consent_token: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'GetBillingAgreementDetails',
@@ -190,14 +207,15 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def set_billing_agreement_details(
-            amazon_billing_agreement_id,
-            platform_id: nil,
-            seller_note: nil,
-            seller_billing_agreement_id: nil,
-            custom_information: nil,
-            store_name: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      platform_id: nil,
+      seller_note: nil,
+      seller_billing_agreement_id: nil,
+      custom_information: nil,
+      store_name: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'SetBillingAgreementDetails',
@@ -224,9 +242,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def confirm_billing_agreement(
-            amazon_billing_agreement_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'ConfirmBillingAgreement',
@@ -248,9 +267,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def validate_billing_agreement(
-            amazon_billing_agreement_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'ValidateBillingAgreement',
@@ -285,22 +305,23 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def authorize_on_billing_agreement(
-            amazon_billing_agreement_id,
-            authorization_reference_id,
-            amount,
-            currency_code: @currency_code,
-            seller_authorization_note: nil,
-            transaction_timeout: nil,
-            capture_now: false,
-            soft_descriptor: nil,
-            seller_note: nil,
-            platform_id: nil,
-            custom_information: nil,
-            seller_order_id: nil,
-            store_name: nil,
-            inherit_shipping_address: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      authorization_reference_id,
+      amount,
+      currency_code: @currency_code,
+      seller_authorization_note: nil,
+      transaction_timeout: nil,
+      capture_now: false,
+      soft_descriptor: nil,
+      seller_note: nil,
+      platform_id: nil,
+      custom_information: nil,
+      seller_order_id: nil,
+      store_name: nil,
+      inherit_shipping_address: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'AuthorizeOnBillingAgreement',
@@ -337,10 +358,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def close_billing_agreement(
-            amazon_billing_agreement_id,
-            closure_reason: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_billing_agreement_id,
+      closure_reason: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'CloseBillingAgreement',
@@ -363,10 +385,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_order_reference_details(
-            amazon_order_reference_id,
-            address_consent_token: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      address_consent_token: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'GetOrderReferenceDetails',
@@ -391,21 +414,26 @@ module AmazonPay
     # @optional platform_id [String]
     # @optional seller_note [String]
     # @optional seller_order_id [String]
+    # @optional request_payment_authorization [Boolean]
     # @optional store_name [String]
+    # @optional order_item_categories Array[String]
     # @optional custom_information [String]
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def set_order_reference_details(
-            amazon_order_reference_id,
-            amount,
-            currency_code: @currency_code,
-            platform_id: nil,
-            seller_note: nil,
-            seller_order_id: nil,
-            store_name: nil,
-            custom_information: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      amount,
+      currency_code: @currency_code,
+      platform_id: nil,
+      seller_note: nil,
+      seller_order_id: nil,
+      request_payment_authorization: nil,
+      store_name: nil,
+      order_item_categories: nil,
+      custom_information: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'SetOrderReferenceDetails',
@@ -417,6 +445,7 @@ module AmazonPay
 
       optional = {
         'OrderReferenceAttributes.PlatformId' => platform_id,
+        'OrderReferenceAttributes.RequestPaymentAuthorization' => request_payment_authorization,
         'OrderReferenceAttributes.SellerNote' => seller_note,
         'OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId' => seller_order_id,
         'OrderReferenceAttributes.SellerOrderAttributes.StoreName' => store_name,
@@ -424,6 +453,79 @@ module AmazonPay
         'MWSAuthToken' => mws_auth_token
       }
 
+      if order_item_categories
+        optional.merge!(
+          get_categories_list(
+            'OrderReferenceAttributes',
+            order_item_categories
+          )
+        )
+      end
+
+      operation(parameters, optional)
+    end
+
+    # Sets order attributes such as the order total and a description
+    # for the order
+    # @see https://pay.amazon.com/documentation/apireference/201751630#201751960
+    # @param amazon_order_reference_id [String]
+    # @optional amount [String]
+    # @optional currency_code [String]
+    # @optional platform_id [String]
+    # @optional seller_note [String]
+    # @optional seller_order_id [String]
+    # @optional request_payment_authorization [Boolean]
+    # @optional store_name [String]
+    # @optional order_item_categories Array[String]
+    # @optional custom_information [String]
+    # @optional merchant_id [String]
+    # @optional mws_auth_token [String]
+    def set_order_attributes(
+      amazon_order_reference_id,
+      amount: nil,
+      currency_code: nil,
+      platform_id: nil,
+      seller_note: nil,
+      seller_order_id: nil,
+      payment_service_provider_id: nil,
+      payment_service_provider_order_id: nil,
+      request_payment_authorization: nil,
+      store_name: nil,
+      order_item_categories: nil,
+      custom_information: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
+
+      parameters = {
+        'Action' => 'SetOrderAttributes',
+        'SellerId' => merchant_id,
+        'AmazonOrderReferenceId' => amazon_order_reference_id
+      }
+
+      optional = {
+        'OrderAttributes.OrderTotal.Amount' => amount,
+        'OrderAttributes.OrderTotal.CurrencyCode' => currency_code,
+        'OrderAttributes.PlatformId' => platform_id,
+        'OrderAttributes.SellerNote' => seller_note,
+        'OrderAttributes.SellerOrderAttributes.SellerOrderId' => seller_order_id,
+        'OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderId' => payment_service_provider_id,
+        'OrderAttributes.PaymentServiceProviderAttributes.PaymentServiceProviderOrderId' => payment_service_provider_order_id,
+        'OrderAttributes.RequestPaymentAuthorization' => request_payment_authorization,
+        'OrderAttributes.SellerOrderAttributes.StoreName' => store_name,
+        'OrderAttributes.SellerOrderAttributes.CustomInformation' => custom_information,
+        'MWSAuthToken' => mws_auth_token
+      }
+
+      if order_item_categories
+        optional.merge!(
+          get_categories_list(
+            'OrderAttributes',
+            order_item_categories
+          )
+        )
+      end
+
       operation(parameters, optional)
     end
 
@@ -434,9 +536,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def confirm_order_reference(
-            amazon_order_reference_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'ConfirmOrderReference',
@@ -458,10 +561,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def cancel_order_reference(
-            amazon_order_reference_id,
-            cancelation_reason: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      cancelation_reason: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'CancelOrderReference',
@@ -492,17 +596,18 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def authorize(
-            amazon_order_reference_id,
-            authorization_reference_id,
-            amount,
-            currency_code: @currency_code,
-            seller_authorization_note: nil,
-            transaction_timeout: nil,
-            capture_now: nil,
-            soft_descriptor: nil,
-            provider_credit_details: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      authorization_reference_id,
+      amount,
+      currency_code: @currency_code,
+      seller_authorization_note: nil,
+      transaction_timeout: nil,
+      capture_now: nil,
+      soft_descriptor: nil,
+      provider_credit_details: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'Authorize',
@@ -533,9 +638,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_authorization_details(
-            amazon_authorization_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_authorization_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'GetAuthorizationDetails',
@@ -562,15 +668,16 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def capture(
-            amazon_authorization_id,
-            capture_reference_id,
-            amount,
-            currency_code: @currency_code,
-            seller_capture_note: nil,
-            soft_descriptor: nil,
-            provider_credit_details: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_authorization_id,
+      capture_reference_id,
+      amount,
+      currency_code: @currency_code,
+      seller_capture_note: nil,
+      soft_descriptor: nil,
+      provider_credit_details: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'Capture',
@@ -599,9 +706,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_capture_details(
-            amazon_capture_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_capture_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'GetCaptureDetails',
@@ -628,15 +736,16 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def refund(
-            amazon_capture_id,
-            refund_reference_id,
-            amount,
-            currency_code: @currency_code,
-            seller_refund_note: nil,
-            soft_descriptor: nil,
-            provider_credit_reversal_details: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_capture_id,
+      refund_reference_id,
+      amount,
+      currency_code: @currency_code,
+      seller_refund_note: nil,
+      soft_descriptor: nil,
+      provider_credit_reversal_details: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'Refund',
@@ -664,9 +773,10 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_refund_details(
-            amazon_refund_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_refund_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'GetRefundDetails',
@@ -688,10 +798,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def close_authorization(
-            amazon_authorization_id,
-            closure_reason: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_authorization_id,
+      closure_reason: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'CloseAuthorization',
@@ -716,10 +827,11 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def close_order_reference(
-            amazon_order_reference_id,
-            closure_reason: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_order_reference_id,
+      closure_reason: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'CloseOrderReference',
@@ -739,42 +851,44 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_provider_credit_details(
-            amazon_provider_credit_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_provider_credit_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
-        parameters = {
-          'Action' => 'GetProviderCreditDetails',
-          'SellerId' => merchant_id,
-          'AmazonProviderCreditId' => amazon_provider_credit_id
-        }
+      parameters = {
+        'Action' => 'GetProviderCreditDetails',
+        'SellerId' => merchant_id,
+        'AmazonProviderCreditId' => amazon_provider_credit_id
+      }
 
-        optional = {
-          'MWSAuthToken' => mws_auth_token
-        }
+      optional = {
+        'MWSAuthToken' => mws_auth_token
+      }
 
-        operation(parameters, optional)
+      operation(parameters, optional)
     end
 
     # @param amazon_provider_credit_reversal_id [String]
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def get_provider_credit_reversal_details(
-            amazon_provider_credit_reversal_id,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_provider_credit_reversal_id,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
-        parameters = {
-          'Action' => 'GetProviderCreditReversalDetails',
-          'SellerId' => merchant_id,
-          'AmazonProviderCreditReversalId' => amazon_provider_credit_reversal_id
-        }
+      parameters = {
+        'Action' => 'GetProviderCreditReversalDetails',
+        'SellerId' => merchant_id,
+        'AmazonProviderCreditReversalId' => amazon_provider_credit_reversal_id
+      }
 
-        optional = {
-          'MWSAuthToken' => mws_auth_token
-        }
+      optional = {
+        'MWSAuthToken' => mws_auth_token
+      }
 
-        operation(parameters, optional)
+      operation(parameters, optional)
     end
 
     # @param amazon_provider_credit_id [String]
@@ -785,13 +899,14 @@ module AmazonPay
     # @optional merchant_id [String]
     # @optional mws_auth_token [String]
     def reverse_provider_credit(
-            amazon_provider_credit_id,
-            credit_reversal_reference_id,
-            amount,
-            currency_code: @currency_code,
-            credit_reversal_note: nil,
-            merchant_id: @merchant_id,
-            mws_auth_token: nil)
+      amazon_provider_credit_id,
+      credit_reversal_reference_id,
+      amount,
+      currency_code: @currency_code,
+      credit_reversal_note: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
 
       parameters = {
         'Action' => 'ReverseProviderCredit',
@@ -814,12 +929,12 @@ module AmazonPay
 
     def region_hash
       {
-        :jp => 'mws.amazonservices.jp',
-        :uk => 'mws-eu.amazonservices.com',
-        :de => 'mws-eu.amazonservices.com',
-        :eu => 'mws-eu.amazonservices.com',
-        :us => 'mws.amazonservices.com',
-        :na => 'mws.amazonservices.com'
+        jp: 'mws.amazonservices.jp',
+        uk: 'mws-eu.amazonservices.com',
+        de: 'mws-eu.amazonservices.com',
+        eu: 'mws-eu.amazonservices.com',
+        us: 'mws.amazonservices.com',
+        na: 'mws.amazonservices.com'
       }
     end
 
@@ -828,14 +943,14 @@ module AmazonPay
     # API call.
     def set_provider_credit_details(provider_credit_details)
       member_details = {}
-      provider_credit_details.each_with_index { |val, index|
+      provider_credit_details.each_with_index do |val, index|
         member = index + 1
         member_details["ProviderCreditList.member.#{member}.ProviderId"] = val[:provider_id]
         member_details["ProviderCreditList.member.#{member}.CreditAmount.Amount"] = val[:amount]
         member_details["ProviderCreditList.member.#{member}.CreditAmount.CurrencyCode"] = val[:currency_code]
-      }
+      end
 
-      return member_details
+      member_details
     end
 
     # This method builds the provider credit reversal
@@ -843,33 +958,45 @@ module AmazonPay
     # API call.
     def set_provider_credit_reversal_details(provider_credit_reversal_details)
       member_details = {}
-      provider_credit_reversal_details.each_with_index { |val, index|
+      provider_credit_reversal_details.each_with_index do |val, index|
         member = index + 1
         member_details["ProviderCreditReversalList.member.#{member}.ProviderId"] = val[:provider_id]
         member_details["ProviderCreditReversalList.member.#{member}.CreditReversalAmount.Amount"] = val[:amount]
         member_details["ProviderCreditReversalList.member.#{member}.CreditReversalAmount.CurrencyCode"] = val[:currency_code]
-      }
+      end
 
-      return member_details
+      member_details
+    end
+
+    def get_categories_list(attribute_key, categories)
+      list = {}
+
+      categories.each_with_index do |val, index|
+          list.merge!({"#{attribute_key}.SellerOrderAttributes.OrderItemCategories.OrderItemCategory.#{index + 1}" => val})
+      end   
+
+      list
     end
 
     def operation(parameters, optional)
       AmazonPay::Request.new(
-          parameters,
-          optional,
-          @default_hash,
-          @mws_endpoint,
-          @sandbox_str,
-          @secret_key,
-          @proxy_addr,
-          @proxy_port,
-          @proxy_user,
-          @proxy_pass,
-          @throttle,
-          @application_name,
-          @application_version).send_post
+        parameters,
+        optional,
+        @default_hash,
+        @mws_endpoint,
+        @sandbox_str,
+        @secret_key,
+        @proxy_addr,
+        @proxy_port,
+        @proxy_user,
+        @proxy_pass,
+        @throttle,
+        @application_name,
+        @application_version,
+        @log_enabled,
+        @log_file_name,
+        @log_level
+      ).send_post
     end
-
   end
-
 end

data/lib/amazon_pay/client_helper.rb

@@ -67,6 +67,48 @@ module AmazonPay
       end
     end
 
+    # Modify order attributes such as CustomInformation
+    # for the order
+    # This is a convenience function for set_order_attributes to prevent accidentally passing
+    # extra variables that can't be modified ater Amazon Order Reference (ORO) is confirmed.
+    # @see https://pay.amazon.com/documentation/apireference/201751630#201751960
+    # @param amazon_order_reference_id [String]
+    # @optional request_payment_authorization [Boolean]
+    # @optional seller_note [String]
+    # @optional seller_order_id [String]
+    # @optional store_name [String]
+    # @optional custom_information [String]
+    # @optional merchant_id [String]
+    # @optional mws_auth_token [String]
+    def modify_order_attributes(
+      amazon_order_reference_id,
+      seller_note: nil,
+      seller_order_id: nil,
+      payment_service_provider_id: nil,
+      payment_service_provider_order_id: nil,
+      request_payment_authorization: nil,
+      store_name: nil,
+      custom_information: nil,
+      merchant_id: @merchant_id,
+      mws_auth_token: nil
+    )
+
+      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)
+    end
+
     private
 
     def call_order_reference_api(

data/lib/amazon_pay/ipn_handler.rb

@@ -4,9 +4,10 @@ require 'net/http'
 require 'net/https'
 require 'openssl'
 require 'uri'
+require 'logger'
+require 'stringio'
 
 module AmazonPay
-
   class IpnWasNotAuthenticError < StandardError
   end
 
@@ -17,19 +18,26 @@ module AmazonPay
   # there are many helper methods in place to extract information received
   # from the ipn notification.
   class IpnHandler
-
-    SIGNABLE_KEYS = [
-      'Message',
-      'MessageId',
-      'Timestamp',
-      'TopicArn',
-      'Type',
+    SIGNABLE_KEYS = %w[
+      Message
+      MessageId
+      Timestamp
+      TopicArn
+      Type
     ].freeze
 
-    COMMON_NAME = 'sns.amazonaws.com'
+    COMMON_NAME = 'sns.amazonaws.com'.freeze
 
-    attr_reader(:headers, :body)
-    attr_accessor(:proxy_addr, :proxy_port, :proxy_user, :proxy_pass)
+    attr_reader(
+      :headers,
+      :body
+    )
+    attr_accessor(
+      :proxy_addr,
+      :proxy_port,
+      :proxy_user,
+      :proxy_pass
+    )
 
     # @param headers [request.headers]
     # @param body [request.body.read]
@@ -38,12 +46,16 @@ module AmazonPay
     # @optional proxy_user [String]
     # @optional proxy_pass [String]
     def initialize(
-            headers,
-            body,
-            proxy_addr: :ENV,
-            proxy_port: nil,
-            proxy_user: nil,
-            proxy_pass: nil)
+      headers,
+      body,
+      proxy_addr: :ENV,
+      proxy_port: nil,
+      proxy_user: nil,
+      proxy_pass: nil,
+      log_enabled: false,
+      log_file_name: nil,
+      log_level: :DEBUG
+    )
 
       @body = body
       @raw = parse_from(@body)
@@ -52,23 +64,30 @@ module AmazonPay
       @proxy_port = proxy_port
       @proxy_user = proxy_user
       @proxy_pass = proxy_pass
+
+      @log_enabled = log_enabled
+      if @log_enabled
+        log_set = AmazonPay::LogInitializer.new(
+          log_file_name,
+          log_level
+        )
+        @logger = log_set.create_logger
+      end
     end
 
     # This method will authenticate the ipn message sent from Amazon.
     # It will return true if everything is verified. It will raise an
     # error message if verification fails.
     def authentic?
-      begin
-        decoded_from_base64 = Base64.decode64(signature)
-        validate_header
-        validate_subject(get_certificate.subject)
-        public_key = get_public_key_from(get_certificate)
-        verify_public_key(public_key, decoded_from_base64, canonical_string)
-
-        return true
-      rescue IpnWasNotAuthenticError => e
-        raise e.message
-      end
+      decoded_from_base64 = Base64.decode64(signature)
+      validate_header
+      validate_subject(get_certificate.subject)
+      public_key = get_public_key_from(get_certificate)
+      verify_public_key(public_key, decoded_from_base64, canonical_string)
+
+      return true
+    rescue IpnWasNotAuthenticError => e
+      raise e.message
     end
 
     def type
@@ -108,27 +127,27 @@ module AmazonPay
     end
 
     def notification_type
-      parse_from(@raw['Message'])["NotificationType"]
+      parse_from(@raw['Message'])['NotificationType']
     end
 
     def seller_id
-      parse_from(@raw['Message'])["SellerId"]
+      parse_from(@raw['Message'])['SellerId']
     end
 
     def environment
-      parse_from(@raw['Message'])["ReleaseEnvironment"]
+      parse_from(@raw['Message'])['ReleaseEnvironment']
     end
 
     def version
-      parse_from(@raw['Message'])["Version"]
+      parse_from(@raw['Message'])['Version']
     end
 
     def notification_data
-      parse_from(@raw['Message'])["NotificationData"]
+      parse_from(@raw['Message'])['NotificationData']
     end
 
     def message_timestamp
-      parse_from(@raw['Message'])["Timestamp"]
+      parse_from(@raw['Message'])['Timestamp']
     end
 
     def parse_from(json)
@@ -150,7 +169,7 @@ module AmazonPay
       text = ''
       SIGNABLE_KEYS.each do |key|
         value = @raw[key]
-        next if value.nil? or value.empty?
+        next if value.nil? || value.empty?
         text << key << "\n"
         text << value << "\n"
       end
@@ -170,8 +189,12 @@ module AmazonPay
       tries = 0
       begin
         resp = https_get(url)
+        if @log_enabled
+          data = AmazonPay::Sanitize.new(resp.body)
+          @logger.debug(data.sanitize_response_data)          
+        end
         resp.body
-      rescue => error
+      rescue StandardError => error
         tries += 1
         retry if tries < 3
         raise error
@@ -193,7 +216,7 @@ module AmazonPay
       unless
         @headers['x-amz-sns-message-type'] == 'Notification'
       then
-        msg = "Error - Header does not contain x-amz-sns-message-type header"
+        msg = 'Error - Header does not contain x-amz-sns-message-type header'
         raise IpnWasNotAuthenticError, msg
       end
     end
@@ -203,7 +226,7 @@ module AmazonPay
       unless
         subject[4][1] == COMMON_NAME
       then
-        msg = "Error - Unable to verify certificate subject issued by Amazon"
+        msg = 'Error - Unable to verify certificate subject issued by Amazon'
         raise IpnWasNotAuthenticError, msg
       end
     end
@@ -212,11 +235,9 @@ module AmazonPay
       unless
         public_key.verify(OpenSSL::Digest::SHA1.new, decoded_signature, signed_string)
       then
-        msg = "Error - Unable to verify public key with signature and signed string"
+        msg = 'Error - Unable to verify public key with signature and signed string'
         raise IpnWasNotAuthenticError, msg
       end
     end
-
   end
-
 end

data/lib/amazon_pay/log_initializer.rb

@@ -0,0 +1,47 @@
+require 'logger'
+require 'stringio'
+
+module AmazonPay
+  # This class creates the logger to use.
+  class LogInitializer
+    def initialize(
+      log_file_name,
+      log_level
+    )
+
+      @log_level_set = log_hash[log_level.upcase]
+      @log_file_name = log_file_name
+    end
+
+    def create_logger
+      @logger = if @log_file_name
+                  Logger.new(@log_file_name)
+                else
+                  Logger.new(STDOUT)
+                end
+
+      @logger.level = @log_level_set
+      # a simple formatter
+      @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+      # e.g. "2004-01-03 00:54:26"
+      @logger.formatter = proc do |_severity, datetime, progname, msg|
+        %({time: "#{datetime}\n", message: "#{msg} from #{progname}"}\n)
+      end
+
+      @logger
+    end
+
+    private
+
+    def log_hash
+      {
+        UNKNOWN: Logger::UNKNOWN,
+        FATAL: Logger::FATAL,
+        ERROR: Logger::ERROR,
+        WARN: Logger::WARN,
+        INFO: Logger::INFO,
+        DEBUG: Logger::DEBUG
+      }
+    end
+  end
+end

data/lib/amazon_pay/request.rb

@@ -3,29 +3,33 @@ require 'net/http'
 require 'net/https'
 require 'base64'
 require 'openssl'
+require 'logger'
+require 'stringio'
 
 module AmazonPay
-
   # This class creates the request to send to the
   # specified MWS endpoint.
   class Request
-        
     MAX_RETRIES = 3
 
     def initialize(
-            parameters,
-            optional,
-            default_hash,
-            mws_endpoint,
-            sandbox_str,
-            secret_key,
-            proxy_addr,
-            proxy_port,
-            proxy_user,
-            proxy_pass,
-            throttle,
-            application_name,
-            application_version)
+      parameters,
+      optional,
+      default_hash,
+      mws_endpoint,
+      sandbox_str,
+      secret_key,
+      proxy_addr,
+      proxy_port,
+      proxy_user,
+      proxy_pass,
+      throttle,
+      application_name,
+      application_version,
+      log_enabled,
+      log_file_name,
+      log_level
+    )
 
       @parameters = parameters
       @optional = optional
@@ -33,6 +37,7 @@ module AmazonPay
       @mws_endpoint = mws_endpoint
       @sandbox_str = sandbox_str
       @secret_key = secret_key
+      @log_enabled = log_enabled
       @proxy_addr = proxy_addr
       @proxy_port = proxy_port
       @proxy_user = proxy_user
@@ -40,6 +45,14 @@ module AmazonPay
       @throttle = throttle
       @application_name = application_name
       @application_version = application_version
+
+      if @log_enabled
+        log_set = AmazonPay::LogInitializer.new(
+          log_file_name,
+          log_level
+        )
+        @logger = log_set.create_logger
+      end
     end
 
     # This method sends the post request.
@@ -56,10 +69,15 @@ module AmazonPay
     def build_post_url
       @optional.map { |k, v| @parameters[k] = v unless v.nil? }
       @parameters = @default_hash.merge(@parameters)
-      post_url = @parameters.sort.map { |k, v| "#{k}=#{ custom_escape(v) }" }.join("&")
-      post_body = ["POST", "#{@mws_endpoint}", "/#{@sandbox_str}/#{AmazonPay::API_VERSION}", post_url].join("\n")
-      post_url += "&Signature=" + sign(post_body)
-      return post_url
+      post_url = @parameters.sort.map { |k, v| "#{k}=#{custom_escape(v)}" }.join('&')
+      post_body = ['POST', @mws_endpoint.to_s, "/#{@sandbox_str}/#{AmazonPay::API_VERSION}", post_url].join("\n")
+      post_url += '&Signature=' + sign(post_body)
+      if @log_enabled
+        data = AmazonPay::Sanitize.new(post_url)
+        @logger.debug("request/Post: #{data.sanitize_request_data}")
+      end
+
+      post_url
     end
 
     # This method signs the post body that is being sent
@@ -76,12 +94,16 @@ module AmazonPay
       https = Net::HTTP.new(uri.host, uri.port, @proxy_addr, @proxy_port, @proxy_user, @proxy_pass)
       https.use_ssl = true
       https.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      
-      user_agent = {"User-Agent" => "#{AmazonPay::SDK_NAME}/#{AmazonPay::VERSION}; (#{@application_name + '/' if @application_name }#{@application_version.to_s + ';' if @application_version} #{RUBY_VERSION}; #{RUBY_PLATFORM})"}
+
+      user_agent = { 'User-Agent' => "#{AmazonPay::SDK_NAME}/#{AmazonPay::VERSION}; (#{@application_name + '/' if @application_name}#{@application_version.to_s + ';' if @application_version} #{RUBY_VERSION}; #{RUBY_PLATFORM})" }
 
       tries = 0
       begin
         response = https.post(uri.path, post_url, user_agent)
+        if @log_enabled
+          data = AmazonPay::Sanitize.new(response.body)
+          @logger.debug("response: #{data.sanitize_response_data}")
+        end
         if @throttle.eql?(true)
           if response.code.eql?('500')
             raise 'InternalServerError'
@@ -90,7 +112,7 @@ module AmazonPay
           end
         end
         AmazonPay::Response.new(response)
-      rescue => error
+      rescue StandardError => error
         tries += 1
         sleep(get_seconds_for_try_count(tries))
         retry if tries <= MAX_RETRIES
@@ -99,16 +121,14 @@ module AmazonPay
     end
 
     def get_seconds_for_try_count(try_count)
-      seconds = { 1=>1, 2=>4, 3=>10, 4=>0 }
+      seconds = { 1 => 1, 2 => 4, 3 => 10, 4 => 0 }
       seconds[try_count]
     end
 
     def custom_escape(val)
       val.to_s.gsub(/([^\w.~-]+)/) do
-        "%" + $1.unpack("H2" * $1.bytesize).join("%").upcase
+        '%' + Regexp.last_match(1).unpack('H2' * Regexp.last_match(1).bytesize).join('%').upcase
       end
     end
-
   end
-
 end

data/lib/amazon_pay/sanitize.rb

@@ -0,0 +1,48 @@
+module AmazonPay
+  class Sanitize
+    def initialize(input_data)
+      @copy = input_data ? input_data.dup : ''
+    end
+
+    def sanitize_request_data
+      # Array of item to remove
+
+      patterns = %w[
+        Buyer
+        PhysicalDestination
+        BillingAddress
+        AuthorizationBillingAddress
+        SellerNote
+        SellerAuthorizationNote
+        SellerCaptureNote
+        SellerRefundNote
+      ]
+
+      patterns.each do |s|
+        @copy.gsub!(/([?|&]#{s}=)[^\&]+/ms, s + '=*REMOVED*')
+      end
+
+      @copy
+    end
+
+    def sanitize_response_data
+      # Array of item to remove
+
+      patterns = []
+      patterns.push(/(?<=<Buyer>).*(?=<\/Buyer>)/s)
+      patterns.push(/(?<=<PhysicalDestination>).*(?=<\/PhysicalDestination>)/ms)
+      patterns.push(/(?<=<BillingAddress>).*(?=<\/BillingAddress>)/s)
+      patterns.push(/(?<=<SellerNote>).*(?=<\/SellerNote>)/s)
+      patterns.push(/(?<=<AuthorizationBillingAddress>).*(?=<\/AuthorizationBillingAddress>)/s)
+      patterns.push(/(?<=<SellerAuthorizationNote>).*(?=<\/SellerAuthorizationNote>)/s)
+      patterns.push(/(?<=<SellerCaptureNote>).*(?=<\/SellerCaptureNote>)/s)
+      patterns.push(/(?<=<SellerRefundNote>).*(?=<\/SellerRefundNote>)/s)
+
+      patterns.each do |s|
+        @copy.gsub!(s, '*REMOVED*')
+      end
+
+      @copy
+    end
+  end
+end

data/lib/amazon_pay/version.rb

@@ -1,5 +1,5 @@
 module AmazonPay
-  VERSION = "2.0.0"
+  VERSION = "2.1.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.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies: []
 description: AmazonPay Ruby SDK
 email: amazon-pay-sdk@amazon.com
@@ -23,9 +23,11 @@ files:
 - lib/amazon_pay/client.rb
 - lib/amazon_pay/client_helper.rb
 - lib/amazon_pay/ipn_handler.rb
+- lib/amazon_pay/log_initializer.rb
 - lib/amazon_pay/login.rb
 - lib/amazon_pay/request.rb
 - lib/amazon_pay/response.rb
+- lib/amazon_pay/sanitize.rb
 - lib/amazon_pay/version.rb
 homepage: https://github.com/amzn/amazon-pay-sdk-ruby
 licenses:
@@ -47,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: AmazonPay Ruby SDK