activemerchant 1.45.0 → 1.126.0

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

@@ -1,66 +1,147 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class TransFirstGateway < Gateway
-      self.live_url = self.test_url = 'https://webservices.primerchants.com/creditcard.asmx/CCSale'
+      self.test_url = 'https://ws.cert.transfirst.com'
+      self.live_url = 'https://webservices.primerchants.com'
 
       self.supported_countries = ['US']
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_cardtypes = %i[visa master american_express discover]
       self.homepage_url = 'http://www.transfirst.com/'
       self.display_name = 'TransFirst'
 
-      UNUSED_FIELDS = %w(ECIValue UserId CAVVData TrackData POSInd EComInd MerchZIP MerchCustPNum MCC InstallmentNum InstallmentOf POSEntryMode POSConditionCode AuthCharInd CardCertData)
+      UNUSED_CREDIT_CARD_FIELDS = %w(UserId TrackData MerchZIP MerchCustPNum MCC InstallmentNum InstallmentOf POSInd POSEntryMode POSConditionCode EComInd AuthCharInd CardCertData CAVVData)
 
       DECLINED = 'The transaction was declined'
 
+      ACTIONS = {
+        purchase: 'CCSale',
+        purchase_echeck: 'ACHDebit',
+        refund: 'CreditCardCredit',
+        refund_echeck: 'ACHVoidTransaction',
+        void: 'CreditCardAutoRefundorVoid'
+      }
+
+      ENDPOINTS = {
+        purchase: 'creditcard.asmx',
+        purchase_echeck: 'checkverifyws/checkverifyws.asmx',
+        refund: 'creditcard.asmx',
+        refund_echeck: 'checkverifyws/checkverifyws.asmx',
+        void: 'creditcard.asmx'
+      }
+
       def initialize(options = {})
         requires!(options, :login, :password)
         super
       end
 
-      def purchase(money, credit_card, options = {})
+      def purchase(money, payment, options = {})
         post = {}
 
         add_amount(post, money)
-        add_invoice(post, options)
-        add_credit_card(post, credit_card)
+        add_payment(post, payment)
         add_address(post, options)
+        add_invoice(post, options) if payment.credit_card?
+        add_pair(post, :RefID, options[:order_id], required: true)
 
-        commit(post)
+        commit((payment.is_a?(Check) ? :purchase_echeck : :purchase), post)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+
+        transaction_id, payment_type = split_authorization(authorization)
+        add_amount(post, money)
+        add_pair(post, :TransID, transaction_id)
+        add_pair(post, :RefID, options[:order_id], required: true)
+
+        commit((payment_type == 'check' ? :refund_echeck : :refund), post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+
+        transaction_id, = split_authorization(authorization)
+        add_pair(post, :TransID, transaction_id)
+
+        commit(:void, post)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((&?RegKey=)\w*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?CardNumber=)\d*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?CVV2=)\d*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?TransRoute=)\d*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?BankAccountNo=)\d*(&?)), '\1[FILTERED]\2')
       end
 
       private
+
       def add_amount(post, money)
-        add_pair(post, :Amount, amount(money), :required => true)
+        add_pair(post, :Amount, amount(money), required: true)
       end
 
       def add_address(post, options)
         address = options[:billing_address] || options[:address]
 
         if address
-          add_pair(post, :Address, address[:address1])
-          add_pair(post, :ZipCode, address[:zip])
+          add_pair(post, :Address, address[:address1], required: true)
+          add_pair(post, :ZipCode, address[:zip], required: true)
+        else
+          add_pair(post, :Address, '', required: true)
+          add_pair(post, :ZipCode, '', required: true)
         end
       end
 
       def add_invoice(post, options)
-        add_pair(post, :RefID, options[:order_id], :required => true)
-        add_pair(post, :PONumber, options[:invoice], :required => true)
+        add_pair(post, :SECCCode, options[:invoice], required: true)
+        add_pair(post, :PONumber, options[:invoice], required: true)
         add_pair(post, :SaleTaxAmount, amount(options[:tax] || 0))
-        add_pair(post, :PaymentDesc, options[:description], :required => true)
         add_pair(post, :TaxIndicator, 0)
+        add_pair(post, :PaymentDesc, options[:description] || '', required: true)
+        add_pair(post, :CompanyName, options[:company_name] || '', required: true)
       end
 
-      def add_credit_card(post, credit_card)
-        add_pair(post, :CardHolderName, credit_card.name, :required => true)
-        add_pair(post, :CardNumber, credit_card.number, :required => true)
+      def add_payment(post, payment)
+        if payment.is_a?(Check)
+          add_echeck(post, payment)
+        else
+          add_credit_card(post, payment)
+        end
+      end
 
-        add_pair(post, :Expiration, expdate(credit_card), :required => true)
-        add_pair(post, :CVV2, credit_card.verification_value)
+      def add_credit_card(post, payment)
+        add_pair(post, :CardHolderName, payment.name, required: true)
+        add_pair(post, :CardNumber, payment.number, required: true)
+        add_pair(post, :Expiration, expdate(payment), required: true)
+        add_pair(post, :CVV2, payment.verification_value, required: true)
       end
 
-      def add_unused_fields(post)
-        UNUSED_FIELDS.each do |f|
-          post[f] = ""
+      def add_echeck(post, payment)
+        add_pair(post, :TransRoute, payment.routing_number, required: true)
+        add_pair(post, :BankAccountNo, payment.account_number, required: true)
+        add_pair(post, :BankAccountType, add_or_use_default(payment.account_type, 'Checking'), required: true)
+        add_pair(post, :CheckType, add_or_use_default(payment.account_holder_type, 'Personal'), required: true)
+        add_pair(post, :Name, payment.name, required: true)
+        add_pair(post, :ProcessDate, Time.now.strftime('%m%d%y'), required: true)
+        add_pair(post, :Description, '', required: true)
+      end
+
+      def add_or_use_default(payment_data, default_value)
+        return payment_data.capitalize if payment_data
+
+        return default_value
+      end
+
+      def add_unused_fields(action, post)
+        return unless action == :purchase
+
+        UNUSED_CREDIT_CARD_FIELDS.each do |f|
+          post[f] = ''
         end
       end
 
@@ -75,7 +156,7 @@ module ActiveMerchant #:nodoc:
         response = {}
 
         xml = REXML::Document.new(data)
-        root = REXML::XPath.first(xml, "//CCSaleDebitResponse")
+        root = REXML::XPath.first(xml, '*')
 
         if root.nil?
           response[:message] = data.to_s.strip
@@ -88,17 +169,42 @@ module ActiveMerchant #:nodoc:
         response
       end
 
-      def commit(params)
-        response = parse( ssl_post(self.live_url, post_data(params)) )
-
-        Response.new(response[:status] == "Authorized", message_from(response), response,
-          :test => test?,
-          :authorization => response[:trans_id],
-          :avs_result => { :code => response[:avs_code] },
-          :cvv_result => response[:cvv2_code]
+      def commit(action, params)
+        response = parse(ssl_post(url(action), post_data(action, params)))
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          test: test?,
+          authorization: authorization_from(response),
+          avs_result: { code: response[:avs_code] },
+          cvv_result: response[:cvv2_code]
         )
       end
 
+      def authorization_from(response)
+        if response[:status] == 'APPROVED'
+          "#{response[:trans_id]}|check"
+        else
+          "#{response[:trans_id]}|creditcard"
+        end
+      end
+
+      def success_from(response)
+        case response[:status]
+        when 'Authorized'
+          true
+        when 'Voided'
+          true
+        when 'APPROVED'
+          true
+        when 'VOIDED'
+          true
+        else
+          false
+        end
+      end
+
       def message_from(response)
         case response[:message]
         when 'Call Voice Center'
@@ -108,19 +214,27 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def post_data(params = {})
-        add_unused_fields(params)
+      def post_data(action, params = {})
+        add_unused_fields(action, params)
         params[:MerchantID] = @options[:login]
         params[:RegKey] = @options[:password]
 
-        request = params.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        request = params.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
         request
       end
 
       def add_pair(post, key, value, options = {})
         post[key] = value if !value.blank? || options[:required]
       end
+
+      def url(action)
+        base_url = test? ? test_url : live_url
+        "#{base_url}/#{ENDPOINTS[action]}/#{ACTIONS[action]}"
+      end
+
+      def split_authorization(authorization)
+        authorization.split('|')
+      end
     end
   end
 end
-