activemerchant 1.114.0 → 1.120.0

data/lib/active_merchant/billing/gateways/firstdata_e4.rb

@@ -32,7 +32,7 @@ module ActiveMerchant #:nodoc:
         discover: 'Discover'
       }
 
-      E4_BRANDS = BRANDS.merge({mastercard: 'Mastercard'})
+      E4_BRANDS = BRANDS.merge({ mastercard: 'Mastercard' })
 
       DEFAULT_ECI = '07'
 
@@ -302,7 +302,8 @@ module ActiveMerchant #:nodoc:
           first_name: params[2],
           last_name: params[3],
           month: params[4],
-          year: params[5])
+          year: params[5]
+        )
 
         xml.tag! 'TransarmorToken', params[0]
         xml.tag! 'Expiry_Date', expdate(credit_card)
@@ -356,10 +357,9 @@ module ActiveMerchant #:nodoc:
         Response.new(successful?(response), message_from(response), response,
           test: test?,
           authorization: successful?(response) ? response_authorization(action, response, credit_card) : '',
-          avs_result: {code: response[:avs]},
+          avs_result: { code: response[:avs] },
           cvv_result: response[:cvv2],
-          error_code: standard_error_code(response)
-        )
+          error_code: standard_error_code(response))
       end
 
       def successful?(response)
@@ -395,7 +395,7 @@ module ActiveMerchant #:nodoc:
             credit_card.last_name,
             credit_card.month,
             credit_card.year
-          ].map { |value| value.to_s.gsub(/;/, '') }.join(';')
+          ].map { |value| value.to_s.delete(';') }.join(';')
         else
           raise StandardError, "TransArmor support is not enabled on your #{display_name} account"
         end
@@ -439,7 +439,7 @@ module ActiveMerchant #:nodoc:
           parse_elements(response, root)
         end
 
-        response.delete_if { |k, v| SENSITIVE_FIELDS.include?(k) }
+        response.delete_if { |k, _v| SENSITIVE_FIELDS.include?(k) }
       end
 
       def parse_elements(response, root)

data/lib/active_merchant/billing/gateways/firstdata_e4_v27.rb

@@ -212,8 +212,8 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'Expiry_Date', expdate(credit_card)
           xml.tag! 'CardHoldersName', credit_card.name
           xml.tag! 'CardType', card_type(credit_card.brand)
-          xml.tag! 'WalletProviderID', options[:wallet_provider_id] if options[:wallet_provider_id]
 
+          add_wallet_provider_id(xml, credit_card, options)
           add_credit_card_eci(xml, credit_card, options)
           add_credit_card_verification_strings(xml, credit_card, options)
         end
@@ -221,10 +221,9 @@ module ActiveMerchant #:nodoc:
 
       def add_credit_card_eci(xml, credit_card, options)
         eci = if credit_card.is_a?(NetworkTokenizationCreditCard) && credit_card.source == :apple_pay && card_brand(credit_card) == 'discover'
-                # Discover requires any Apple Pay transaction, regardless of in-app
-                # or web, and regardless of the ECI contained in the PKPaymentToken,
-                # to have an ECI value explicitly of 04.
-                '04'
+                # Payeezy requires an ECI of 5 for apple pay transactions
+                # See: https://support.payeezy.com/hc/en-us/articles/203730589-Ecommerce-Flag-Values
+                '05'
               else
                 (credit_card.respond_to?(:eci) ? credit_card.eci : nil) || options[:eci] || DEFAULT_ECI
               end
@@ -269,16 +268,29 @@ module ActiveMerchant #:nodoc:
           first_name: params[2],
           last_name: params[3],
           month: params[4],
-          year: params[5])
+          year: params[5]
+        )
 
         xml.tag! 'TransarmorToken', params[0]
         xml.tag! 'Expiry_Date', expdate(credit_card)
         xml.tag! 'CardHoldersName', credit_card.name
         xml.tag! 'CardType', card_type(credit_card.brand)
-        xml.tag! 'WalletProviderID', options[:wallet_provider_id] if options[:wallet_provider_id]
+
+        add_wallet_provider_id(xml, credit_card, options)
         add_card_authentication_data(xml, options)
       end
 
+      def add_wallet_provider_id(xml, credit_card, options)
+        provider_id = if options[:wallet_provider_id]
+                        options[:wallet_provider_id]
+                      elsif credit_card.is_a?(NetworkTokenizationCreditCard) && credit_card.source == :apple_pay
+                        # See: https://support.payeezy.com/hc/en-us/articles/206601408-First-Data-Payeezy-Gateway-Web-Service-API-Reference-Guide#3.9
+                        4
+                      end
+
+        xml.tag! 'WalletProviderID', provider_id if provider_id
+      end
+
       def add_customer_data(xml, options)
         xml.tag! 'Customer_Ref', options[:customer] if options[:customer]
         xml.tag! 'Client_IP', options[:ip] if options[:ip]
@@ -371,10 +383,9 @@ module ActiveMerchant #:nodoc:
         Response.new(successful?(response), message_from(response), response,
           test: test?,
           authorization: successful?(response) ? response_authorization(action, response, credit_card) : '',
-          avs_result: {code: response[:avs]},
+          avs_result: { code: response[:avs] },
           cvv_result: response[:cvv2],
-          error_code: standard_error_code(response)
-        )
+          error_code: standard_error_code(response))
       end
 
       def headers(method, url, request)

data/lib/active_merchant/billing/gateways/flo2cash.rb

@@ -19,19 +19,19 @@ module ActiveMerchant #:nodoc:
         'diners_club' => 'DINERS'
       }
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :username, :password, :account_id)
         super
       end
 
-      def purchase(amount, payment_method, options={})
+      def purchase(amount, payment_method, options = {})
         MultiResponse.run do |r|
           r.process { authorize(amount, payment_method, options) }
           r.process { capture(amount, r.authorization, options) }
         end
       end
 
-      def authorize(amount, payment_method, options={})
+      def authorize(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)
@@ -40,7 +40,7 @@ module ActiveMerchant #:nodoc:
         commit('ProcessAuthorise', post)
       end
 
-      def capture(amount, authorization, options={})
+      def capture(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -49,7 +49,7 @@ module ActiveMerchant #:nodoc:
         commit('ProcessCapture', post)
       end
 
-      def refund(amount, authorization, options={})
+      def refund(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -71,7 +71,7 @@ module ActiveMerchant #:nodoc:
 
       private
 
-      CURRENCY_CODES = Hash.new { |h, k| raise ArgumentError.new("Unsupported currency: #{k}") }
+      CURRENCY_CODES = Hash.new { |_h, k| raise ArgumentError.new("Unsupported currency: #{k}") }
       CURRENCY_CODES['NZD'] = '554'
 
       def add_invoice(post, money, options)
@@ -142,7 +142,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def envelope_wrap(action, body)
-        <<~EOS
+        <<~XML
           <?xml version="1.0" encoding="utf-8"?>
           <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
             <soap12:Body>
@@ -151,7 +151,7 @@ module ActiveMerchant #:nodoc:
               </#{action}>
             </soap12:Body>
           </soap12:Envelope>
-        EOS
+        XML
       end
 
       def url

data/lib/active_merchant/billing/gateways/flo2cash_simple.rb

@@ -3,7 +3,7 @@ module ActiveMerchant #:nodoc:
     class Flo2cashSimpleGateway < Flo2cashGateway
       self.display_name = 'Flo2Cash Simple'
 
-      def purchase(amount, payment_method, options={})
+      def purchase(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)

data/lib/active_merchant/billing/gateways/forte.rb

@@ -15,36 +15,40 @@ module ActiveMerchant #:nodoc:
       self.homepage_url = 'https://www.forte.net'
       self.display_name = 'Forte'
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :api_key, :secret, :location_id, :account_id)
         super
       end
 
-      def purchase(money, payment_method, options={})
+      def purchase(money, payment_method, options = {})
         post = {}
         add_amount(post, money, options)
+        add_service_fee(post, options)
         add_invoice(post, options)
         add_payment_method(post, payment_method, options)
         add_billing_address(post, payment_method, options)
         add_shipping_address(post, options)
+        add_xdata(post, options)
         post[:action] = 'sale'
 
         commit(:post, post)
       end
 
-      def authorize(money, payment_method, options={})
+      def authorize(money, payment_method, options = {})
         post = {}
         add_amount(post, money, options)
+        add_service_fee(post, options)
         add_invoice(post, options)
         add_payment_method(post, payment_method, options)
         add_billing_address(post, payment_method, options)
         add_shipping_address(post, options)
+        add_xdata(post, options)
         post[:action] = 'authorize'
 
         commit(:post, post)
       end
 
-      def capture(money, authorization, options={})
+      def capture(money, authorization, options = {})
         post = {}
         post[:transaction_id] = transaction_id_from(authorization)
         post[:authorization_code] = authorization_code_from(authorization) || ''
@@ -53,7 +57,7 @@ module ActiveMerchant #:nodoc:
         commit(:put, post)
       end
 
-      def credit(money, payment_method, options={})
+      def credit(money, payment_method, options = {})
         post = {}
         add_amount(post, money, options)
         add_invoice(post, options)
@@ -64,7 +68,7 @@ module ActiveMerchant #:nodoc:
         commit(:post, post)
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         post = {}
         add_amount(post, money, options)
         post[:original_transaction_id] = transaction_id_from(authorization)
@@ -74,7 +78,7 @@ module ActiveMerchant #:nodoc:
         commit(:post, post)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         post = {}
         post[:transaction_id] = transaction_id_from(authorization)
         post[:authorization_code] = authorization_code_from(authorization)
@@ -83,7 +87,7 @@ module ActiveMerchant #:nodoc:
         commit(:put, post)
       end
 
-      def verify(credit_card, options={})
+      def verify(credit_card, options = {})
         MultiResponse.run(:use_first_response) do |r|
           r.process { authorize(100, credit_card, options) }
           r.process(:ignore_result) { void(r.authorization, options) }
@@ -116,6 +120,20 @@ module ActiveMerchant #:nodoc:
         post[:authorization_amount] = amount(money)
       end
 
+      def add_service_fee(post, options)
+        post[:service_fee_amount] = options[:service_fee_amount] if options[:service_fee_amount]
+      end
+
+      def add_xdata(post, options)
+        post[:xdata] = {}
+        if xdata = options[:xdata]
+          (1..9).each do |n|
+            field = "xdata_#{n}".to_sym
+            post[:xdata][field] = xdata[field] if xdata[field]
+          end
+        end
+      end
+
       def add_billing_address(post, payment, options)
         post[:billing_address] = {}
         if address = options[:billing_address] || options[:address]

data/lib/active_merchant/billing/gateways/global_collect.rb

@@ -12,19 +12,19 @@ module ActiveMerchant #:nodoc:
       self.money_format = :cents
       self.supported_cardtypes = %i[visa master american_express discover naranja cabal]
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :merchant_id, :api_key_id, :secret_api_key)
         super
       end
 
-      def purchase(money, payment, options={})
+      def purchase(money, payment, options = {})
         MultiResponse.run do |r|
           r.process { authorize(money, payment, options) }
           r.process { capture(money, r.authorization, options) } if should_request_capture?(r, options[:requires_approval])
         end
       end
 
-      def authorize(money, payment, options={})
+      def authorize(money, payment, options = {})
         post = nestable_hash
         add_order(post, money, options)
         add_payment(post, payment, options)
@@ -32,10 +32,11 @@ module ActiveMerchant #:nodoc:
         add_address(post, payment, options)
         add_creator_info(post, options)
         add_fraud_fields(post, options)
+        add_external_cardholder_authentication_data(post, options)
         commit(:authorize, post)
       end
 
-      def capture(money, authorization, options={})
+      def capture(money, authorization, options = {})
         post = nestable_hash
         add_order(post, money, options, capture: true)
         add_customer_data(post, options)
@@ -43,7 +44,7 @@ module ActiveMerchant #:nodoc:
         commit(:capture, post, authorization)
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         post = nestable_hash
         add_amount(post, money, options)
         add_refund_customer_data(post, options)
@@ -51,13 +52,13 @@ module ActiveMerchant #:nodoc:
         commit(:refund, post, authorization)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         post = nestable_hash
         add_creator_info(post, options)
         commit(:void, post, authorization)
       end
 
-      def verify(payment, options={})
+      def verify(payment, options = {})
         MultiResponse.run(:use_first_response) do |r|
           r.process { authorize(100, payment, options) }
           r.process { void(r.authorization, options) }
@@ -142,7 +143,7 @@ module ActiveMerchant #:nodoc:
         post['shoppingCartExtension']['extensionID'] = options[:extension_ID] if options[:extension_ID]
       end
 
-      def add_amount(post, money, options={})
+      def add_amount(post, money, options = {})
         post['amountOfMoney'] = {
           'amount' => amount(money),
           'currencyCode' => options[:currency] || currency(money)
@@ -200,21 +201,21 @@ module ActiveMerchant #:nodoc:
         shipping_address = options[:shipping_address]
         if billing_address = options[:billing_address] || options[:address]
           post['order']['customer']['billingAddress'] = {
-            'street' => billing_address[:address1],
-            'additionalInfo' => billing_address[:address2],
+            'street' => truncate(billing_address[:address1], 50),
+            'additionalInfo' => truncate(billing_address[:address2], 50),
             'zip' => billing_address[:zip],
             'city' => billing_address[:city],
-            'state' => billing_address[:state],
+            'state' => truncate(billing_address[:state], 35),
             'countryCode' => billing_address[:country]
           }
         end
         if shipping_address
           post['order']['customer']['shippingAddress'] = {
-            'street' => shipping_address[:address1],
-            'additionalInfo' => shipping_address[:address2],
+            'street' => truncate(shipping_address[:address1], 50),
+            'additionalInfo' => truncate(shipping_address[:address2], 50),
             'zip' => shipping_address[:zip],
             'city' => shipping_address[:city],
-            'state' => shipping_address[:state],
+            'state' => truncate(shipping_address[:state], 35),
             'countryCode' => shipping_address[:country]
           }
           post['order']['customer']['shippingAddress']['name'] = {
@@ -232,6 +233,24 @@ module ActiveMerchant #:nodoc:
         post['fraudFields'] = fraud_fields unless fraud_fields.empty?
       end
 
+      def add_external_cardholder_authentication_data(post, options)
+        return unless threeds_2_options = options[:three_d_secure]
+
+        authentication_data = {}
+        authentication_data[:acsTransactionId] = threeds_2_options[:acs_transaction_id] if threeds_2_options[:acs_transaction_id]
+        authentication_data[:cavv] = threeds_2_options[:cavv] if threeds_2_options[:cavv]
+        authentication_data[:cavvAlgorithm] = threeds_2_options[:cavv_algorithm] if threeds_2_options[:cavv_algorithm]
+        authentication_data[:directoryServerTransactionId] = threeds_2_options[:ds_transaction_id] if threeds_2_options[:ds_transaction_id]
+        authentication_data[:eci] = threeds_2_options[:eci] if threeds_2_options[:eci]
+        authentication_data[:threeDSecureVersion] = threeds_2_options[:version] if threeds_2_options[:version]
+        authentication_data[:validationResult] = threeds_2_options[:authentication_response_status] if threeds_2_options[:authentication_response_status]
+        authentication_data[:xid] = threeds_2_options[:xid] if threeds_2_options[:xid]
+
+        post['cardPaymentMethodSpecificInput'] ||= {}
+        post['cardPaymentMethodSpecificInput']['threeDSecure'] ||= {}
+        post['cardPaymentMethodSpecificInput']['threeDSecure']['externalCardholderAuthenticationData'] = authentication_data unless authentication_data.empty?
+      end
+
       def add_number_of_installments(post, options)
         post['order']['additionalInput']['numberOfInstallments'] = options[:number_of_installments] if options[:number_of_installments]
       end
@@ -296,12 +315,12 @@ module ActiveMerchant #:nodoc:
       end
 
       def auth_digest(action, post, authorization = nil)
-        data = <<~EOS
+        data = <<~REQUEST
           POST
           #{content_type}
           #{date}
           #{uri(action, authorization)}
-        EOS
+        REQUEST
         digest = OpenSSL::Digest.new('sha256')
         key = @options[:secret_api_key]
         "GCS v1HMAC:#{@options[:api_key_id]}:#{Base64.strict_encode64(OpenSSL::HMAC.digest(digest, key, data))}"

data/lib/active_merchant/billing/gateways/global_transport.rb

@@ -20,12 +20,12 @@ module ActiveMerchant #:nodoc:
       #           :global_password  - Your Global password
       #           :term_type        - 3 character field assigned by Global Transport after
       #                             - your application is certified.
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :global_user_name, :global_password, :term_type)
         super
       end
 
-      def purchase(money, payment_method, options={})
+      def purchase(money, payment_method, options = {})
         post = {}
         add_invoice(post, money, options)
         add_payment_method(post, payment_method)
@@ -34,7 +34,7 @@ module ActiveMerchant #:nodoc:
         commit('Sale', post, options)
       end
 
-      def authorize(money, payment_method, options={})
+      def authorize(money, payment_method, options = {})
         post = {}
         add_invoice(post, money, options)
         add_payment_method(post, payment_method)
@@ -43,7 +43,7 @@ module ActiveMerchant #:nodoc:
         commit('Auth', post, options)
       end
 
-      def capture(money, authorization, options={})
+      def capture(money, authorization, options = {})
         post = {}
         add_invoice(post, money, options)
         add_auth(post, authorization)
@@ -51,7 +51,7 @@ module ActiveMerchant #:nodoc:
         commit('Force', post, options)
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         post = {}
         add_invoice(post, money, options)
         add_auth(post, authorization)
@@ -59,14 +59,14 @@ module ActiveMerchant #:nodoc:
         commit('Return', post, options)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         post = {}
         add_auth(post, authorization)
 
         commit('Void', post, options)
       end
 
-      def verify(payment_method, options={})
+      def verify(payment_method, options = {})
         post = {}
         add_payment_method(post, payment_method)
         add_address(post, options)