activemerchant 1.133.0 → 1.138.0

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

@@ -1,8 +1,10 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class Shift4Gateway < Gateway
-      self.test_url = 'https://utgapi.shift4test.com/api/rest/v1/'
-      self.live_url = 'https://utg.shift4api.net/api/rest/v1/'
+      version 'v1'
+
+      self.test_url = "https://utgapi.shift4test.com/api/rest/#{fetch_version}/"
+      self.live_url = "https://utg.shift4api.net/api/rest/#{fetch_version}/"
 
       self.supported_countries = %w(US CA CU HT DO PR JM TT GP MQ BS BB LC CW AW VC VI GD AG DM KY KN SX TC MF VG BQ AI BL MS)
       self.default_currency = 'USD'
@@ -20,22 +22,6 @@ module ActiveMerchant #:nodoc:
         'add' => 'tokens',
         'verify' => 'cards'
       }
-      STANDARD_ERROR_CODE_MAPPING = {
-        'incorrect_number' => STANDARD_ERROR_CODE[:incorrect_number],
-        'invalid_number' => STANDARD_ERROR_CODE[:invalid_number],
-        'invalid_expiry_month' => STANDARD_ERROR_CODE[:invalid_expiry_date],
-        'invalid_expiry_year' => STANDARD_ERROR_CODE[:invalid_expiry_date],
-        'invalid_cvc' => STANDARD_ERROR_CODE[:invalid_cvc],
-        'expired_card' => STANDARD_ERROR_CODE[:expired_card],
-        'insufficient_funds' => STANDARD_ERROR_CODE[:card_declined],
-        'incorrect_cvc' => STANDARD_ERROR_CODE[:incorrect_cvc],
-        'incorrect_zip' => STANDARD_ERROR_CODE[:incorrect_zip],
-        'card_declined' => STANDARD_ERROR_CODE[:card_declined],
-        'processing_error' => STANDARD_ERROR_CODE[:processing_error],
-        'lost_or_stolen' => STANDARD_ERROR_CODE[:card_declined],
-        'suspected_fraud' => STANDARD_ERROR_CODE[:card_declined],
-        'expired_token' => STANDARD_ERROR_CODE[:card_declined]
-      }
 
       def initialize(options = {})
         requires!(options, :client_guid, :auth_token)
@@ -147,7 +133,7 @@ module ActiveMerchant #:nodoc:
           gsub(%r(("expirationDate\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
           gsub(%r(("FirstName\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
           gsub(%r(("LastName\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
-          gsub(%r(("securityCode\\?":{\\?"[\w]+\\?":[\d]+,\\?"value\\?":\\?")[\d]*)i, '\1[FILTERED]')
+          gsub(%r(("securityCode\\?":{\\?"\w+\\?":\d+,\\?"value\\?":\\?")\d*)i, '\1[FILTERED]')
       end
 
       def setup_access_token
@@ -186,7 +172,7 @@ module ActiveMerchant #:nodoc:
 
       def add_transaction(post, options)
         post[:transaction] = {}
-        post[:transaction][:invoice] = options[:invoice] || Time.new.to_i.to_s[1..3] + rand.to_s[2..7]
+        post[:transaction][:invoice] = options[:invoice] || (Time.new.to_i.to_s[1..3] + rand.to_s[2..7])
         post[:transaction][:notes] = options[:notes] if options[:notes].present?
         post[:transaction][:vendorReference] = options[:order_id]
 
@@ -263,6 +249,7 @@ module ActiveMerchant #:nodoc:
           message_from(action, response),
           response,
           authorization: authorization_from(action, response),
+          avs_result: avs_result_from(response),
           test: test?,
           error_code: error_code_from(action, response)
         )
@@ -284,13 +271,34 @@ module ActiveMerchant #:nodoc:
       end
 
       def message_from(action, response)
-        success_from(action, response) ? 'Transaction successful' : (error(response)&.dig('longText') || 'Transaction declined')
+        if success_from(action, response)
+          'Transaction successful'
+        else
+          error(response)&.dig('longText') ||
+            response['result'].first&.dig('transaction', 'hostresponse', 'reasonDescription') ||
+            response['result'].first&.dig('transaction', 'hostResponse', 'reasonDescription') ||
+            'Transaction declined'
+        end
       end
 
       def error_code_from(action, response)
-        return unless success_from(action, response)
+        code = response['result'].first&.dig('transaction', 'responseCode')
+        primary_code = response['result'].first['error'].present?
+        return unless code == 'D' || primary_code == true || success_from(action, response)
+
+        if response['result'].first&.dig('transaction', 'hostresponse')
+          response['result'].first&.dig('transaction', 'hostresponse', 'reasonCode')
+        elsif response['result'].first&.dig('transaction', 'hostResponse')
+          response['result'].first&.dig('transaction', 'hostResponse', 'reasonCode')
+        elsif response['result'].first['error']
+          response['result'].first&.dig('error', 'primaryCode')
+        else
+          response['result'].first&.dig('transaction', 'responseCode')
+        end
+      end
 
-        STANDARD_ERROR_CODE_MAPPING[response['primaryCode']]
+      def avs_result_from(response)
+        AVSResult.new(code: response['result'].first&.dig('transaction', 'avs', 'result')) if response['result'].first&.dig('transaction', 'avs')
       end
 
       def authorization_from(action, response)
@@ -317,7 +325,7 @@ module ActiveMerchant #:nodoc:
         headers['AccessToken'] = @access_token
         headers['Invoice'] = options[:invoice] if action != 'capture' && options[:invoice].present?
         headers['InterfaceVersion'] = '1'
-        headers['InterfaceName'] = 'Spreedly'
+        headers['InterfaceName'] = options[:interface_name]
         headers['CompanyName'] = 'Spreedly'
         headers
       end

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

@@ -0,0 +1,117 @@
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
+    class Shift4V2Gateway < SecurionPayGateway
+      # same endpont for testing
+      self.live_url = 'https://api.shift4.com/'
+      self.display_name = 'Shift4'
+      self.homepage_url = 'https://dev.shift4.com/us/'
+
+      def credit(money, payment, options = {})
+        post = create_post_for_auth_or_purchase(money, payment, options)
+        commit('credits', post, options)
+      end
+
+      def store(payment_method, options = {})
+        post = case payment_method
+               when CreditCard
+                 cc = {}.tap { |card| add_creditcard(card, payment_method, options) }[:card]
+                 options[:customer_id].blank? ? { email: options[:email], card: cc } : cc
+               when Check
+                 bank_account_object(payment_method, options)
+               else
+                 raise ArgumentError.new("Unhandled payment method #{payment_method.class}.")
+               end
+
+        commit url_for_store(payment_method, options), post, options
+      end
+
+      def url_for_store(payment_method, options = {})
+        case payment_method
+        when CreditCard
+          options[:customer_id].blank? ? 'customers' : "customers/#{options[:customer_id]}/cards"
+        when Check then 'payment-methods'
+        end
+      end
+
+      def unstore(reference, options = {})
+        commit("customers/#{options[:customer_id]}/cards/#{reference}", nil, options, :delete)
+      end
+
+      def create_post_for_auth_or_purchase(money, payment, options)
+        super.tap do |post|
+          add_stored_credentials(post, options)
+        end
+      end
+
+      def add_stored_credentials(post, options)
+        return unless options[:stored_credential].present?
+
+        initiator = options.dig(:stored_credential, :initiator)
+        reason_type = options.dig(:stored_credential, :reason_type)
+
+        post_type = {
+          %w[cardholder recurring] => 'first_recurring',
+          %w[merchant recurring] => 'subsequent_recurring',
+          %w[cardholder unscheduled] => 'customer_initiated',
+          %w[merchant installment] => 'merchant_initiated'
+        }[[initiator, reason_type]]
+        post[:type] = post_type if post_type
+      end
+
+      def headers(options = {})
+        super.tap do |headers|
+          headers['User-Agent'] = "Shift4/v2 ActiveMerchantBindings/#{ActiveMerchant::VERSION}"
+        end
+      end
+
+      def scrub(transcript)
+        super.
+          gsub(%r((card\[expMonth\]=)\d+), '\1[FILTERED]').
+          gsub(%r((card\[expYear\]=)\d+), '\1[FILTERED]').
+          gsub(%r((card\[cardholderName\]=)\w+[^ ]\w+), '\1[FILTERED]')
+      end
+
+      def json_error(raw_response)
+        super(raw_response, 'Shift4 V2')
+      end
+
+      def add_amount(post, money, options, include_currency = false)
+        super
+        post[:currency]&.upcase!
+      end
+
+      def add_creditcard(post, payment_method, options)
+        return super unless payment_method.is_a?(Check)
+
+        post[:paymentMethod] = bank_account_object(payment_method, options)
+      end
+
+      def bank_account_object(payment_method, options)
+        {
+          type: :ach,
+          fraudCheckData: {
+            ipAddress: options[:ip],
+            email: options[:email]
+          }.compact,
+          billing: {
+            name: payment_method.name,
+            address: { country: options.dig(:billing_address, :country) }
+          }.compact,
+          ach: {
+            account: {
+              routingNumber: payment_method.routing_number,
+              accountNumber: payment_method.account_number,
+              accountType: get_account_type(payment_method)
+            },
+            verificationProvider: :external
+          }
+        }
+      end
+
+      def get_account_type(check)
+        holder = (check.account_holder_type || '').match(/business/i) ? :corporate : :personal
+        "#{holder}_#{check.account_type}"
+      end
+    end
+  end
+end

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

@@ -1,15 +1,18 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class SimetrikGateway < Gateway
-      self.test_url = 'https://payments.sta.simetrik.com/v1'
-      self.live_url = 'https://payments.simetrik.com/v1'
+      version 'v1'
+      version 'v2', :audience_api
+
+      self.test_url = "https://payments.sta.simetrik.com/#{fetch_version}"
+      self.live_url = "https://payments.simetrik.com/#{fetch_version}"
 
       class_attribute :test_auth_url, :live_auth_url, :test_audience, :live_audience
       self.test_auth_url = 'https://tenant-payments-dev.us.auth0.com/oauth/token'
       self.live_auth_url = 'https://tenant-payments-prod.us.auth0.com/oauth/token'
 
-      self.test_audience = 'https://tenant-payments-dev.us.auth0.com/api/v2/'
-      self.live_audience = 'https://tenant-payments-prod.us.auth0.com/api/v2/'
+      self.test_audience = "https://tenant-payments-dev.us.auth0.com/api/#{fetch_version(:audience_api)}/"
+      self.live_audience = "https://tenant-payments-prod.us.auth0.com/api/#{fetch_version(:audience_api)}/"
 
       self.supported_countries = %w(PE AR)
       self.default_currency = 'USD'
@@ -44,7 +47,7 @@ module ActiveMerchant #:nodoc:
       def initialize(options = {})
         requires!(options, :client_id, :client_secret)
         super
-        @access_token = {}
+        @access_token = options[:access_token] || {}
         sign_access_token()
       end
 
@@ -280,12 +283,12 @@ module ActiveMerchant #:nodoc:
       def commit(action, parameters, url_params = {})
         begin
           response = JSON.parse ssl_post(url(action, url_params), post_data(parameters), authorized_headers())
-        rescue ResponseError => exception
-          case exception.response.code.to_i
+        rescue ResponseError => e
+          case e.response.code.to_i
           when 400...499
-            response = JSON.parse exception.response.body
+            response = JSON.parse e.response.body
           else
-            raise exception
+            raise e
           end
         end
 
@@ -318,7 +321,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def url(action, url_params)
-        "#{(test? ? test_url : live_url)}/#{url_params[:token_acquirer]}/#{action}"
+        "#{test? ? test_url : live_url}/#{url_params[:token_acquirer]}/#{action}"
       end
 
       def post_data(data = {})
@@ -356,12 +359,18 @@ module ActiveMerchant #:nodoc:
         login_info[:client_secret] = @options[:client_secret]
         login_info[:audience] = test? ? test_audience : live_audience
         login_info[:grant_type] = 'client_credentials'
-        response = parse(ssl_post(auth_url(), login_info.to_json, {
-          'content-Type' => 'application/json'
-        }))
 
-        @access_token[:access_token] = response['access_token']
-        @access_token[:expires_at] = Time.new.to_i + response['expires_in']
+        begin
+          raw_response = ssl_post(auth_url(), login_info.to_json, {
+            'content-Type' => 'application/json'
+          })
+        rescue ResponseError => e
+          raise OAuthResponseError.new(e)
+        else
+          response = parse(raw_response)
+          @access_token[:access_token] = response['access_token']
+          @access_token[:expires_at] = Time.new.to_i + response['expires_in']
+        end
       end
     end
   end

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class SkipJackGateway < Gateway
       API_VERSION = '?.?'
 
@@ -263,11 +263,15 @@ module ActiveMerchant #:nodoc:
         response = parse(ssl_post(url_for(action), post_data(action, money, parameters)), action)
 
         # Pass along the original transaction id in the case an update transaction
-        Response.new(response[:success], message_from(response, action), response,
+        Response.new(
+          response[:success],
+          message_from(response, action),
+          response,
           test: test?,
           authorization: response[:szTransactionFileName] || parameters[:szTransactionId],
           avs_result: { code: response[:szAVSResponseCode] },
-          cvv_result: response[:szCVV2ResponseCode])
+          cvv_result: response[:szCVV2ResponseCode]
+        )
       end
 
       def url_for(action)

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

@@ -1,8 +1,8 @@
 require File.join(File.dirname(__FILE__), '..', 'check.rb')
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
-    class SmartPs < Gateway #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
+    class SmartPs < Gateway # :nodoc:
       ##
       # This is the base gateway for processors who use the smartPS processing system
 
@@ -226,11 +226,15 @@ module ActiveMerchant #:nodoc:
       def commit(action, money, parameters)
         parameters[:amount] = localized_amount(money, parameters[:currency] || default_currency) if money
         response = parse(ssl_post(self.live_url, post_data(action, parameters)))
-        Response.new(response['response'] == '1', message_from(response), response,
+        Response.new(
+          response['response'] == '1',
+          message_from(response),
+          response,
           authorization: (response['transactionid'] || response['customer_vault_id']),
           test: test?,
           cvv_result: response['cvvresponse'],
-          avs_result: { code: response['avsresponse'] })
+          avs_result: { code: response['avsresponse'] }
+        )
       end
 
       def expdate(creditcard)
@@ -257,8 +261,7 @@ module ActiveMerchant #:nodoc:
         post[:password]   = @options[:password]
         post[:type]       = action if action
 
-        request = post.merge(parameters).map { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
-        request
+        post.merge(parameters).map { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
       end
 
       def determine_funding_source(source)

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class SoEasyPayGateway < Gateway
       self.live_url = self.test_url = 'https://secure.soeasypay.com/gateway.asmx'
       self.money_format = :cents
@@ -161,11 +161,13 @@ module ActiveMerchant #:nodoc:
                    'Content-Type' => 'text/xml; charset=utf-8' }
         response_string = ssl_post(test? ? self.test_url : self.live_url, soap, headers)
         response = parse(response_string, soap_action)
-        return Response.new(response['errorcode'] == '000',
+        return Response.new(
+          response['errorcode'] == '000',
           response['errormessage'],
           response,
           test: test?,
-          authorization: response['transaction_id'])
+          authorization: response['transaction_id']
+        )
       end
 
       def build_soap(request)

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

@@ -1,7 +1,7 @@
 require 'nokogiri'
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     # Public: This gateway allows you to interact with any gateway you've
     # created in Spreedly (https://spreedly.com).  It's an adapter which can be
     # particularly useful if you already have code interacting with
@@ -271,11 +271,9 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def build_xml_request(root)
+      def build_xml_request(root, &block)
         builder = Nokogiri::XML::Builder.new
-        builder.__send__(root) do |doc|
-          yield(doc)
-        end
+        builder.__send__(root, &block)
         builder.to_xml
       end