activemerchant 1.130.0 → 1.137.0

data/lib/active_merchant/billing/gateways/first_pay/first_pay_json.rb

@@ -0,0 +1,190 @@
+require 'active_merchant/billing/gateways/first_pay/first_pay_common'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class FirstPayJsonGateway < Gateway
+      include FirstPayCommon
+
+      ACTIONS = {
+        purchase: 'Sale',
+        authorize: 'Auth',
+        capture: 'Settle',
+        refund: 'Refund',
+        void: 'Void'
+      }.freeze
+
+      WALLET_TYPES = {
+        apple_pay: 'ApplePay',
+        google_pay: 'GooglePay'
+      }.freeze
+
+      self.test_url = 'https://secure-v.1stPaygateway.net/secure/RestGW/Gateway/Transaction/'
+      self.live_url = 'https://secure.1stPaygateway.net/secure/RestGW/Gateway/Transaction/'
+
+      # Creates a new FirstPayJsonGateway
+      #
+      # The gateway requires two values for connection to be passed
+      # in the +options+ hash.
+      #
+      # ==== Options
+      #
+      # * <tt>:merchant_key</tt>  -- FirstPay's merchant_key (REQUIRED)
+      # * <tt>:processor_id</tt>  -- FirstPay's processor_id or processorId (REQUIRED)
+      def initialize(options = {})
+        requires!(options, :merchant_key, :processor_id)
+        super
+      end
+
+      def purchase(money, payment, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_payment(post, payment, options)
+        add_address(post, payment, options)
+
+        commit(:purchase, post)
+      end
+
+      def authorize(money, payment, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_payment(post, payment, options)
+        add_address(post, payment, options)
+
+        commit(:authorize, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_reference(post, authorization)
+
+        commit(:capture, post)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_reference(post, authorization)
+
+        commit(:refund, post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_reference(post, authorization)
+
+        commit(:void, post)
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r(("processorId\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
+          gsub(%r(("merchantKey\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
+          gsub(%r(("cardNumber\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
+          gsub(%r(("paymentCryptogram\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
+          gsub(%r(("cvv\\?"\s*:\s*\\?)[^,]*)i, '\1[FILTERED]')
+      end
+
+      private
+
+      def add_address(post, creditcard, options)
+        if address = options[:billing_address] || options[:address]
+          post[:ownerName] = address[:name]
+          post[:ownerStreet] = address[:address1]
+          post[:ownerCity] = address[:city]
+          post[:ownerState] = address[:state]
+          post[:ownerZip] = address[:zip]
+          post[:ownerCountry] = address[:country]
+        end
+      end
+
+      def add_invoice(post, money, options)
+        post[:orderId] = options[:order_id]
+        post[:transactionAmount] = amount(money)
+      end
+
+      def add_payment(post, payment, options)
+        post[:cardNumber] = payment.number
+        post[:cardExpMonth] = payment.month
+        post[:cardExpYear] = format(payment.year, :two_digits)
+        post[:cvv] = payment.verification_value
+        post[:recurring] = options[:recurring] if options[:recurring]
+        post[:recurringStartDate] = options[:recurring_start_date] if options[:recurring_start_date]
+        post[:recurringEndDate] = options[:recurring_end_date] if options[:recurring_end_date]
+
+        case payment
+        when NetworkTokenizationCreditCard
+          post[:walletType] = WALLET_TYPES[payment.source]
+          other_fields = post[:otherFields] = {}
+          other_fields[:paymentCryptogram] = payment.payment_cryptogram
+          other_fields[:eciIndicator] = payment.eci || '07'
+        when CreditCard
+          post[:cvv] = payment.verification_value
+        end
+      end
+
+      def add_reference(post, authorization)
+        post[:refNumber] = authorization
+      end
+
+      def commit(action, parameters)
+        response = parse(api_request(base_url + ACTIONS[action], post_data(parameters)))
+
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          authorization: authorization_from(response),
+          error_code: error_code_from(response),
+          test: test?
+        )
+      end
+
+      def base_url
+        test? ? self.test_url : self.live_url
+      end
+
+      def api_request(url, data)
+        ssl_post(url, data, headers)
+      rescue ResponseError => e
+        e.response.body
+      end
+
+      def parse(data)
+        JSON.parse data
+      end
+
+      def headers
+        { 'Content-Type' => 'application/json' }
+      end
+
+      def format_messages(messages)
+        return unless messages.present?
+
+        messages.map { |message| message['message'] || message }.join('; ')
+      end
+
+      def success_from(response)
+        response['isSuccess']
+      end
+
+      def message_from(response)
+        format_messages(response['errorMessages'] + response['validationFailures']) || response['data']['authResponse']
+      end
+
+      def error_code_from(response)
+        return 'isError' if response['isError']
+
+        return 'validationHasFailed' if response['validationHasFailed']
+      end
+
+      def authorization_from(response)
+        response.dig('data', 'referenceNumber') || ''
+      end
+
+      def post_data(params)
+        params.merge({ processorId: @options[:processor_id], merchantKey: @options[:merchant_key] }).to_json
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/first_pay/first_pay_xml.rb

@@ -0,0 +1,183 @@
+require 'active_merchant/billing/gateways/first_pay/first_pay_common'
+require 'nokogiri'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class FirstPayXmlGateway < Gateway
+      include FirstPayCommon
+
+      self.live_url = 'https://secure.goemerchant.com/secure/gateway/xmlgateway.aspx'
+
+      # Creates a new FirstPayXmlGateway
+      #
+      # The gateway requires two values for connection to be passed
+      # in the +options+ hash
+      #
+      # ==== Options
+      #
+      # * <tt>:gateway_id</tt>            -- FirstPay's gateway_id (REQUIRED)
+      # * <tt>:transaction_center_id</tt> -- FirstPay's transaction_center_id or processorId (REQUIRED)
+      #   Otherwise, perform transactions against the production server.
+      def initialize(options = {})
+        requires!(options, :gateway_id, :transaction_center_id)
+        super
+      end
+
+      def purchase(money, payment, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_payment(post, payment, options)
+        add_address(post, payment, options)
+        add_customer_data(post, options)
+
+        commit('sale', post)
+      end
+
+      def authorize(money, payment, options = {})
+        post = {}
+        add_invoice(post, money, options)
+        add_payment(post, payment, options)
+        add_address(post, payment, options)
+        add_customer_data(post, options)
+
+        commit('auth', post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_reference(post, 'settle', money, authorization)
+        commit('settle', post)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        add_reference(post, 'credit', money, authorization)
+        commit('credit', post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_reference(post, 'void', nil, authorization)
+        commit('void', post)
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((gateway_id)[^<]*(</FIELD>))i, '\1[FILTERED]\2').
+          gsub(%r((card_number)[^<]*(</FIELD>))i, '\1[FILTERED]\2').
+          gsub(%r((cvv2)[^<]*(</FIELD>))i, '\1[FILTERED]\2')
+      end
+
+      private
+
+      def add_authentication(post, options)
+        post[:transaction_center_id] = options[:transaction_center_id]
+        post[:gateway_id] = options[:gateway_id]
+      end
+
+      def add_customer_data(post, options)
+        post[:owner_email] = options[:email] if options[:email]
+        post[:remote_ip_address] = options[:ip] if options[:ip]
+        post[:processor_id] = options[:processor_id] if options[:processor_id]
+      end
+
+      def add_address(post, creditcard, options)
+        if address = options[:billing_address] || options[:address]
+          post[:owner_name] = address[:name]
+          post[:owner_street] = address[:address1]
+          post[:owner_street2] = address[:address2] if address[:address2]
+          post[:owner_city] = address[:city]
+          post[:owner_state] = address[:state]
+          post[:owner_zip] = address[:zip]
+          post[:owner_country] = address[:country]
+          post[:owner_phone] = address[:phone] if address[:phone]
+        end
+      end
+
+      def add_invoice(post, money, options)
+        post[:order_id] = options[:order_id]
+        post[:total] = amount(money)
+      end
+
+      def add_payment(post, payment, options)
+        post[:card_name] = payment.brand # Unclear if need to map to known names or open text field??
+        post[:card_number] = payment.number
+        post[:card_exp] = expdate(payment)
+        post[:cvv2] = payment.verification_value
+        post[:recurring] = options[:recurring] if options[:recurring]
+        post[:recurring_start_date] = options[:recurring_start_date] if options[:recurring_start_date]
+        post[:recurring_end_date] = options[:recurring_end_date] if options[:recurring_end_date]
+        post[:recurring_type] = options[:recurring_type] if options[:recurring_type]
+      end
+
+      def add_reference(post, action, money, authorization)
+        post[:"#{action}_amount1"] = amount(money) if money
+        post[:total_number_transactions] = 1
+        post[:reference_number1] = authorization
+      end
+
+      def parse(xml)
+        response = {}
+
+        doc = Nokogiri::XML(xml)
+        doc.root&.xpath('//RESPONSE/FIELDS/FIELD')&.each do |field|
+          response[field['KEY']] = field.text
+        end
+
+        response
+      end
+
+      def commit(action, parameters)
+        response = parse(ssl_post(live_url, post_data(action, parameters)))
+
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          authorization: authorization_from(response),
+          error_code: error_code_from(response),
+          test: test?
+        )
+      end
+
+      def success_from(response)
+        (
+          (response['status'] == '1') ||
+          (response['status1'] == '1')
+        )
+      end
+
+      def message_from(response)
+        # Silly inconsistent gateway. Always make capitalized (but not all caps)
+        msg = (response['auth_response'] || response['response1'])
+        msg&.downcase&.capitalize
+      end
+
+      def error_code_from(response)
+        response['error']
+      end
+
+      def authorization_from(response)
+        response['reference_number'] || response['reference_number1']
+      end
+
+      def post_data(action, parameters = {})
+        parameters[:transaction_center_id] = @options[:transaction_center_id]
+        parameters[:gateway_id] = @options[:gateway_id]
+
+        parameters[:operation_type] = action
+
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.tag! 'TRANSACTION' do
+          xml.tag! 'FIELDS' do
+            parameters.each do |key, value|
+              xml.tag! 'FIELD', value, { 'KEY' => key }
+            end
+          end
+        end
+        xml.target!
+      end
+    end
+  end
+end

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

@@ -1,181 +1,15 @@
-require 'nokogiri'
+require 'active_merchant/billing/gateways/first_pay/first_pay_xml'
+require 'active_merchant/billing/gateways/first_pay/first_pay_json'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class FirstPayGateway < Gateway
-      self.live_url = 'https://secure.goemerchant.com/secure/gateway/xmlgateway.aspx'
+      self.abstract_class = true
 
-      self.supported_countries = ['US']
-      self.default_currency = 'USD'
-      self.money_format = :dollars
-      self.supported_cardtypes = %i[visa master american_express discover]
+      def self.new(options = {})
+        return FirstPayJsonGateway.new(options) if options[:merchant_key]
 
-      self.homepage_url = 'http://1stpaygateway.net/'
-      self.display_name = '1stPayGateway.Net'
-
-      def initialize(options = {})
-        requires!(options, :transaction_center_id, :gateway_id)
-        super
-      end
-
-      def purchase(money, payment, options = {})
-        post = {}
-        add_invoice(post, money, options)
-        add_payment(post, payment, options)
-        add_address(post, payment, options)
-        add_customer_data(post, options)
-
-        commit('sale', post)
-      end
-
-      def authorize(money, payment, options = {})
-        post = {}
-        add_invoice(post, money, options)
-        add_payment(post, payment, options)
-        add_address(post, payment, options)
-        add_customer_data(post, options)
-
-        commit('auth', post)
-      end
-
-      def capture(money, authorization, options = {})
-        post = {}
-        add_reference(post, 'settle', money, authorization)
-        commit('settle', post)
-      end
-
-      def refund(money, authorization, options = {})
-        post = {}
-        add_reference(post, 'credit', money, authorization)
-        commit('credit', post)
-      end
-
-      def void(authorization, options = {})
-        post = {}
-        add_reference(post, 'void', nil, authorization)
-        commit('void', post)
-      end
-
-      def supports_scrubbing?
-        true
-      end
-
-      def scrub(transcript)
-        transcript.
-          gsub(%r((gateway_id)[^<]*(</FIELD>))i, '\1[FILTERED]\2').
-          gsub(%r((card_number)[^<]*(</FIELD>))i, '\1[FILTERED]\2').
-          gsub(%r((cvv2)[^<]*(</FIELD>))i, '\1[FILTERED]\2')
-      end
-
-      private
-
-      def add_authentication(post, options)
-        post[:transaction_center_id] = options[:transaction_center_id]
-        post[:gateway_id] = options[:gateway_id]
-      end
-
-      def add_customer_data(post, options)
-        post[:owner_email] = options[:email] if options[:email]
-        post[:remote_ip_address] = options[:ip] if options[:ip]
-        post[:processor_id] = options[:processor_id] if options[:processor_id]
-      end
-
-      def add_address(post, creditcard, options)
-        if address = options[:billing_address] || options[:address]
-          post[:owner_name] = address[:name]
-          post[:owner_street] = address[:address1]
-          post[:owner_street2] = address[:address2] if address[:address2]
-          post[:owner_city] = address[:city]
-          post[:owner_state] = address[:state]
-          post[:owner_zip] = address[:zip]
-          post[:owner_country] = address[:country]
-          post[:owner_phone] = address[:phone] if address[:phone]
-        end
-      end
-
-      def add_invoice(post, money, options)
-        post[:order_id] = options[:order_id]
-        post[:total] = amount(money)
-      end
-
-      def add_payment(post, payment, options)
-        post[:card_name] = payment.brand # Unclear if need to map to known names or open text field??
-        post[:card_number] = payment.number
-        post[:card_exp] = expdate(payment)
-        post[:cvv2] = payment.verification_value
-        post[:recurring] = options[:recurring] if options[:recurring]
-        post[:recurring_start_date] = options[:recurring_start_date] if options[:recurring_start_date]
-        post[:recurring_end_date] = options[:recurring_end_date] if options[:recurring_end_date]
-        post[:recurring_type] = options[:recurring_type] if options[:recurring_type]
-      end
-
-      def add_reference(post, action, money, authorization)
-        post[:"#{action}_amount1"] = amount(money) if money
-        post[:total_number_transactions] = 1
-        post[:reference_number1] = authorization
-      end
-
-      def parse(xml)
-        response = {}
-
-        doc = Nokogiri::XML(xml)
-        doc.root&.xpath('//RESPONSE/FIELDS/FIELD')&.each do |field|
-          response[field['KEY']] = field.text
-        end
-
-        response
-      end
-
-      def commit(action, parameters)
-        response = parse(ssl_post(live_url, post_data(action, parameters)))
-
-        Response.new(
-          success_from(response),
-          message_from(response),
-          response,
-          authorization: authorization_from(response),
-          error_code: error_code_from(response),
-          test: test?
-        )
-      end
-
-      def success_from(response)
-        (
-          (response['status'] == '1') ||
-          (response['status1'] == '1')
-        )
-      end
-
-      def message_from(response)
-        # Silly inconsistent gateway. Always make capitalized (but not all caps)
-        msg = (response['auth_response'] || response['response1'])
-        msg&.downcase&.capitalize
-      end
-
-      def error_code_from(response)
-        response['error']
-      end
-
-      def authorization_from(response)
-        response['reference_number'] || response['reference_number1']
-      end
-
-      def post_data(action, parameters = {})
-        parameters[:transaction_center_id] = @options[:transaction_center_id]
-        parameters[:gateway_id] = @options[:gateway_id]
-
-        parameters[:operation_type] = action
-
-        xml = Builder::XmlMarkup.new
-        xml.instruct!
-        xml.tag! 'TRANSACTION' do
-          xml.tag! 'FIELDS' do
-            parameters.each do |key, value|
-              xml.tag! 'FIELD', value, { 'KEY' => key }
-            end
-          end
-        end
-        xml.target!
+        FirstPayXmlGateway.new(options)
       end
     end
   end

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

@@ -354,12 +354,16 @@ module ActiveMerchant #:nodoc:
           response = parse_error(e.response)
         end
 
-        Response.new(successful?(response), message_from(response), response,
+        Response.new(
+          successful?(response),
+          message_from(response),
+          response,
           test: test?,
           authorization: successful?(response) ? response_authorization(action, response, credit_card) : '',
           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)

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

@@ -316,7 +316,7 @@ module ActiveMerchant #:nodoc:
       def strip_line_breaks(address)
         return unless address.is_a?(Hash)
 
-        Hash[address.map { |k, s| [k, s&.tr("\r\n", ' ')&.strip] }]
+        address.map { |k, s| [k, s&.tr("\r\n", ' ')&.strip] }.to_h
       end
 
       def add_invoice(xml, options)
@@ -380,12 +380,16 @@ module ActiveMerchant #:nodoc:
           response = parse_error(e.response)
         end
 
-        Response.new(successful?(response), message_from(response), response,
+        Response.new(
+          successful?(response),
+          message_from(response),
+          response,
           test: test?,
           authorization: successful?(response) ? response_authorization(action, response, credit_card) : '',
           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)