activemerchant 1.114.0 → 1.120.0

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

@@ -14,12 +14,12 @@ module ActiveMerchant #:nodoc:
       self.money_format = :dollars
       self.supported_cardtypes = %i[visa master discover diners_club]
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :login, :password)
         super
       end
 
-      def purchase(amount, payment_method, options={})
+      def purchase(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)
@@ -28,7 +28,7 @@ module ActiveMerchant #:nodoc:
         commit('purchase', post)
       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)
@@ -37,7 +37,7 @@ module ActiveMerchant #:nodoc:
         commit('authorize', post)
       end
 
-      def capture(amount, authorization, options={})
+      def capture(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -46,7 +46,7 @@ module ActiveMerchant #:nodoc:
         commit('capture', post)
       end
 
-      def refund(amount, authorization, options={})
+      def refund(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -57,7 +57,7 @@ module ActiveMerchant #:nodoc:
 
       private
 
-      CURRENCY_CODES = Hash.new { |h, k| raise ArgumentError.new("Unsupported currency for HDFC: #{k}") }
+      CURRENCY_CODES = Hash.new { |_h, k| raise ArgumentError.new("Unsupported currency for HDFC: #{k}") }
       CURRENCY_CODES['AED'] = '784'
       CURRENCY_CODES['AUD'] = '036'
       CURRENCY_CODES['CAD'] = '124'
@@ -81,14 +81,14 @@ module ActiveMerchant #:nodoc:
         post[:udf2] = escape(options[:email]) if options[:email]
         if address = (options[:billing_address] || options[:address])
           post[:udf3] = escape(address[:phone]) if address[:phone]
-          post[:udf4] = escape(<<~EOA)
+          post[:udf4] = escape(<<~ADDRESS)
             #{address[:name]}
             #{address[:company]}
             #{address[:address1]}
             #{address[:address2]}
             #{address[:city]} #{address[:state]} #{address[:zip]}
             #{address[:country]}
-          EOA
+          ADDRESS
         end
       end
 
@@ -194,7 +194,7 @@ module ActiveMerchant #:nodoc:
         [tranid, member]
       end
 
-      def escape(string, max_length=250)
+      def escape(string, max_length = 250)
         return '' unless string
 
         string = string[0...max_length] if max_length

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

@@ -25,12 +25,12 @@ module ActiveMerchant #:nodoc:
         google_pay:       'GooglePayApp'
       }
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :secret_api_key)
         super
       end
 
-      def authorize(money, card_or_token, options={})
+      def authorize(money, card_or_token, options = {})
         commit('CreditAuth') do |xml|
           add_amount(xml, money)
           add_allow_dup(xml)
@@ -39,25 +39,28 @@ module ActiveMerchant #:nodoc:
           add_descriptor_name(xml, options)
           add_card_or_token_payment(xml, card_or_token, options)
           add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
         end
       end
 
-      def capture(money, transaction_id, options={})
+      def capture(money, transaction_id, options = {})
         commit('CreditAddToBatch', transaction_id) do |xml|
           add_amount(xml, money)
           add_reference(xml, transaction_id)
         end
       end
 
-      def purchase(money, payment_method, options={})
+      def purchase(money, payment_method, options = {})
         if payment_method.is_a?(Check)
           commit_check_sale(money, payment_method, options)
+        elsif options.dig(:stored_credential, :reason_type) == 'recurring'
+          commit_recurring_billing_sale(money, payment_method, options)
         else
           commit_credit_sale(money, payment_method, options)
         end
       end
 
-      def refund(money, transaction_id, options={})
+      def refund(money, transaction_id, options = {})
         commit('CreditReturn') do |xml|
           add_amount(xml, money)
           add_allow_dup(xml)
@@ -67,7 +70,16 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def verify(card_or_token, options={})
+      def credit(money, payment_method, options = {})
+        commit('CreditReturn') do |xml|
+          add_amount(xml, money)
+          add_allow_dup(xml)
+          add_card_or_token_payment(xml, payment_method, options)
+          add_details(xml, options)
+        end
+      end
+
+      def verify(card_or_token, options = {})
         commit('CreditAccountVerify') do |xml|
           add_card_or_token_customer_data(xml, card_or_token, options)
           add_descriptor_name(xml, options)
@@ -75,7 +87,7 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def void(transaction_id, options={})
+      def void(transaction_id, options = {})
         if options[:check_void]
           commit('CheckVoid') do |xml|
             add_reference(xml, transaction_id)
@@ -122,6 +134,21 @@ module ActiveMerchant #:nodoc:
           add_descriptor_name(xml, options)
           add_card_or_token_payment(xml, card_or_token, options)
           add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
+        end
+      end
+
+      def commit_recurring_billing_sale(money, card_or_token, options)
+        commit('RecurringBilling') do |xml|
+          add_amount(xml, money)
+          add_allow_dup(xml)
+          add_card_or_token_customer_data(xml, card_or_token, options)
+          add_details(xml, options)
+          add_descriptor_name(xml, options)
+          add_card_or_token_payment(xml, card_or_token, options)
+          add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
+          add_stored_credentials_for_recurring_billing(xml, options)
         end
       end
 
@@ -148,7 +175,7 @@ module ActiveMerchant #:nodoc:
             xml.hps :CardHolderAddr, billing_address[:address1] if billing_address[:address1]
             xml.hps :CardHolderCity, billing_address[:city] if billing_address[:city]
             xml.hps :CardHolderState, billing_address[:state] if billing_address[:state]
-            xml.hps :CardHolderZip, billing_address[:zip] if billing_address[:zip]
+            xml.hps :CardHolderZip, alphanumeric_zip(billing_address[:zip]) if billing_address[:zip]
           end
         end
       end
@@ -210,7 +237,7 @@ module ActiveMerchant #:nodoc:
       def add_details(xml, options)
         xml.hps :AdditionalTxnFields do
           xml.hps :Description, options[:description] if options[:description]
-          xml.hps :InvoiceNbr, options[:order_id] if options[:order_id]
+          xml.hps :InvoiceNbr, options[:order_id][0..59] if options[:order_id]
           xml.hps :CustomerID, options[:customer_id] if options[:customer_id]
         end
       end
@@ -256,6 +283,38 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      # We do not currently support installments on this gateway.
+      # The HPS gateway treats recurring transactions as a seperate transaction type
+      def add_stored_credentials(xml, options)
+        return unless options[:stored_credential]
+
+        xml.hps :CardOnFileData do
+          if options[:stored_credential][:initiator] == 'customer'
+            xml.hps :CardOnFile, 'C'
+          elsif options[:stored_credential][:initiator] == 'merchant'
+            xml.hps :CardOnFile, 'M'
+          else
+            return
+          end
+
+          if options[:stored_credential][:network_transaction_id]
+            xml.hps :CardBrandTxnId, options[:stored_credential][:network_transaction_id]
+          else
+            return
+          end
+        end
+      end
+
+      def add_stored_credentials_for_recurring_billing(xml, options)
+        xml.hps :RecurringData do
+          if options[:stored_credential][:reason_type] = 'recurring'
+            xml.hps :OneTime, 'N'
+          else
+            xml.hps :OneTime, 'Y'
+          end
+        end
+      end
+
       def strip_leading_zero(value)
         return value unless value[0] == '0'
 
@@ -380,6 +439,10 @@ module ActiveMerchant #:nodoc:
         @options[:secret_api_key]&.include?('_cert_')
       end
 
+      def alphanumeric_zip(zip)
+        zip.gsub(/[^0-9a-z]/i, '')
+      end
+
       ISSUER_MESSAGES = {
         '13' => 'Must be greater than or equal 0.',
         '14' => 'The card number is incorrect.',

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

@@ -23,7 +23,7 @@ module ActiveMerchant #:nodoc:
         unstore: 'DeleteCustomerCode'
       }
 
-      def initialize(options={})
+      def initialize(options = {})
         if options[:login]
           ActiveMerchant.deprecated("The 'login' option is deprecated in favor of 'agent_code' and will be removed in a future version.")
           options[:agent_code] = options[:login]
@@ -35,18 +35,19 @@ module ActiveMerchant #:nodoc:
         super
       end
 
-      def purchase(money, payment, options={})
+      def purchase(money, payment, options = {})
         post = {}
         add_invoice(post, money, options)
         add_payment(post, payment)
         add_address(post, options)
         add_ip(post, options)
         add_description(post, options)
+        add_customer_details(post, options)
 
         commit(determine_purchase_type(payment), post)
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         post = {}
         transaction_id, payment_type = split_authorization(authorization)
         post[:transaction_id] = transaction_id
@@ -160,6 +161,10 @@ module ActiveMerchant #:nodoc:
         post[:amount] = 0
       end
 
+      def add_customer_details(post, options)
+        post[:email] = options[:email] if options[:email]
+      end
+
       def expdate(creditcard)
         year  = sprintf('%.4i', creditcard.year)
         month = sprintf('%.2i', creditcard.month)
@@ -181,7 +186,7 @@ module ActiveMerchant #:nodoc:
 
       def commit(action, parameters)
         response = parse(ssl_post(url(action), post_data(action, parameters),
-          { 'Content-Type' => 'application/soap+xml; charset=utf-8'}))
+          { 'Content-Type' => 'application/soap+xml; charset=utf-8' }))
 
         Response.new(
           success_from(response),

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

@@ -5,7 +5,7 @@ module ActiveMerchant #:nodoc:
       self.live_redirect_url = 'https://www.paypal.com/checkoutnow'
 
       def redirect_url_for(token, options = {})
-        options = {review: true}.update(options)
+        options = { review: true }.update(options)
         url  = "#{redirect_url}?token=#{token}"
         url += '&useraction=commit' unless options[:review]
         url

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

@@ -96,7 +96,7 @@ module ActiveMerchant #:nodoc:
         authorize(100, creditcard, options.merge(store: billing_id))
       end
 
-      alias_method :unstore, :delete
+      alias unstore delete
 
       private
 
@@ -124,7 +124,7 @@ module ActiveMerchant #:nodoc:
         post[:orderdescription] = options[:description]
       end
 
-      def add_payment_source(params, source, options={})
+      def add_payment_source(params, source, options = {})
         case determine_funding_source(source)
         when :vault       then add_customer_vault_id(params, source)
         when :credit_card then add_creditcard(params, source, options)
@@ -176,8 +176,7 @@ module ActiveMerchant #:nodoc:
           authorization: response['transactionid'],
           test: test?,
           cvv_result: response['cvvresponse'],
-          avs_result: { code: response['avsresponse'] }
-        )
+          avs_result: { code: response['avsresponse'] })
       end
 
       def message_from(response)

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

@@ -143,8 +143,7 @@ module ActiveMerchant #:nodoc:
         Response.new(response[:success], response[:message], response,
           authorization: response[:transaction_id],
           avs_result: { code: response[:avs_result] },
-          cvv_result: response[:cvv_result]
-        )
+          cvv_result: response[:cvv_result])
       end
 
       def post_data(action, parameters = {})

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

@@ -21,13 +21,13 @@ module ActiveMerchant #:nodoc:
         '54' => STANDARD_ERROR_CODE[:expired_card]
       }
 
-      def initialize(options={})
+      def initialize(options = {})
         ActiveMerchant.deprecated('IPP gateway is now named Bambora Asia-Pacific')
         requires!(options, :username, :password)
         super
       end
 
-      def purchase(money, payment, options={})
+      def purchase(money, payment, options = {})
         commit('SubmitSinglePayment') do |xml|
           xml.Transaction do
             xml.CustRef options[:order_id]
@@ -40,7 +40,7 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def authorize(money, payment, options={})
+      def authorize(money, payment, options = {})
         commit('SubmitSinglePayment') do |xml|
           xml.Transaction do
             xml.CustRef options[:order_id]
@@ -53,7 +53,7 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def capture(money, authorization, options={})
+      def capture(money, authorization, options = {})
         commit('SubmitSingleCapture') do |xml|
           xml.Capture do
             xml.Receipt authorization
@@ -63,7 +63,7 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         commit('SubmitSingleRefund') do |xml|
           xml.Refund do
             xml.Receipt authorization

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

@@ -251,16 +251,16 @@ module ActiveMerchant #:nodoc:
         commit(build_reference_request('COLLECTION', money, authorization, options), options)
       end
 
-      def credit(money, authorization, options={})
+      def credit(money, authorization, options = {})
         ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 
-      def refund(money, authorization, options={})
+      def refund(money, authorization, options = {})
         commit(build_reference_request('REFUND', money, authorization, options), options)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         commit(build_reference_request('VOID', nil, authorization, options), options)
       end
 
@@ -292,12 +292,12 @@ module ActiveMerchant #:nodoc:
         build_request(options) do |xml|
           if money
             currency = options[:currency] || currency(money)
-            details = {'CurrencyCode' => currency_code(currency), 'Amount' => localized_amount(money, currency)}
+            details = { 'CurrencyCode' => currency_code(currency), 'Amount' => localized_amount(money, currency) }
           else
-            details = {'CurrencyCode' => currency_code(default_currency), 'Amount' => '0'}
+            details = { 'CurrencyCode' => currency_code(default_currency), 'Amount' => '0' }
           end
           xml.tag! 'TransactionDetails', details do
-            xml.tag! 'MessageDetails', {'TransactionType' => type, 'CrossReference' => cross_reference}
+            xml.tag! 'MessageDetails', { 'TransactionType' => type, 'CrossReference' => cross_reference }
             xml.tag! 'OrderID', (options[:order_id] || order_id)
           end
         end
@@ -309,9 +309,9 @@ module ActiveMerchant #:nodoc:
         xml.instruct!(:xml, version: '1.0', encoding: 'utf-8')
         xml.tag! 'soap:Envelope', { 'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
                                     'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-                                    'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema'} do
+                                    'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema' } do
           xml.tag! 'soap:Body' do
-            xml.tag! options[:action], {'xmlns' => 'https://www.thepaymentgateway.net/'} do
+            xml.tag! options[:action], { 'xmlns' => 'https://www.thepaymentgateway.net/' } do
               xml.tag! 'PaymentMessage' do
                 add_merchant_data(xml, options)
                 yield(xml)
@@ -330,8 +330,8 @@ module ActiveMerchant #:nodoc:
       def add_purchase_data(xml, type, money, options)
         currency = options[:currency] || currency(money)
         requires!(options, :order_id)
-        xml.tag! 'TransactionDetails', {'Amount' => localized_amount(money, currency), 'CurrencyCode' => currency_code(currency)} do
-          xml.tag! 'MessageDetails', {'TransactionType' => type}
+        xml.tag! 'TransactionDetails', { 'Amount' => localized_amount(money, currency), 'CurrencyCode' => currency_code(currency) } do
+          xml.tag! 'MessageDetails', { 'TransactionType' => type }
           xml.tag! 'OrderID', options[:order_id]
           xml.tag! 'TransactionControl' do
             xml.tag! 'ThreeDSecureOverridePolicy', 'FALSE'
@@ -371,13 +371,13 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_merchant_data(xml, options)
-        xml.tag! 'MerchantAuthentication', {'MerchantID' => @options[:login], 'Password' => @options[:password]}
+        xml.tag! 'MerchantAuthentication', { 'MerchantID' => @options[:login], 'Password' => @options[:password] }
       end
 
       def commit(request, options)
         requires!(options, :action)
         response = parse(ssl_post(test? ? self.test_url : self.live_url, request,
-          {'SOAPAction' => 'https://www.thepaymentgateway.net/' + options[:action],
+          { 'SOAPAction' => 'https://www.thepaymentgateway.net/' + options[:action],
            'Content-Type' => 'text/xml; charset=utf-8' }))
 
         success = response[:transaction_result][:status_code] == '0'
@@ -391,14 +391,13 @@ module ActiveMerchant #:nodoc:
             street_match: AVS_CODE[ response[:transaction_output_data][:address_numeric_check_result] ],
             postal_match: AVS_CODE[ response[:transaction_output_data][:post_code_check_result] ]
           },
-          cvv_result: CVV_CODE[ response[:transaction_output_data][:cv2_check_result] ]
-        )
+          cvv_result: CVV_CODE[ response[:transaction_output_data][:cv2_check_result] ])
       end
 
       def parse(xml)
         reply = {}
         xml = REXML::Document.new(xml)
-        if (root = REXML::XPath.first(xml, '//CardDetailsTransactionResponse')) or
+        if (root = REXML::XPath.first(xml, '//CardDetailsTransactionResponse')) ||
            (root = REXML::XPath.first(xml, '//CrossReferenceTransactionResponse'))
           root.elements.to_a.each do |node|
             case node.name