activemerchant 1.79.2 → 1.129.0

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

@@ -10,26 +10,26 @@ module ActiveMerchant #:nodoc:
 
       self.ignore_http_status = true
 
-      CARD_CODE_ERRORS = %w( N S )
-      AVS_ERRORS = %w( A E N R W Z )
+      CARD_CODE_ERRORS = %w(N S)
+      AVS_ERRORS = %w(A E N R W Z)
       AVS_REASON_CODES = %w(27 45)
 
       FIELD_MAP = {
         'TRANS_ID' => :transaction_id,
         'STATUS' => :response_code,
         'AVS' => :avs_result_code,
-        'CVV2'=> :card_code,
+        'CVV2' => :card_code,
         'AUTH_CODE' => :authorization,
         'MESSAGE' => :message,
         'REBID' => :rebid,
         'TRANS_TYPE' => :trans_type,
         'PAYMENT_ACCOUNT_MASK' => :acct_mask,
-        'CARD_TYPE' => :card_type,
+        'CARD_TYPE' => :card_type
       }
 
       REBILL_FIELD_MAP = {
         'REBILL_ID' => :rebill_id,
-        'ACCOUNT_ID'=> :account_id,
+        'ACCOUNT_ID' => :account_id,
         'USER_ID' => :user_id,
         'TEMPLATE_ID' => :template_id,
         'STATUS' => :status,
@@ -41,10 +41,11 @@ module ActiveMerchant #:nodoc:
         'REB_AMOUNT' => :rebill_amount,
         'NEXT_AMOUNT' => :next_amount,
         'USUAL_DATE' => :undoc_usual_date, # Not found in the bp20rebadmin API doc.
+        'CUST_TOKEN' => :cust_token
       }
 
-      self.supported_countries = ['US', 'CA']
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+      self.supported_countries = %w[US CA]
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb]
       self.homepage_url        = 'http://www.bluepay.com/'
       self.display_name        = 'BluePay'
       self.money_format        = :dollars
@@ -83,8 +84,9 @@ module ActiveMerchant #:nodoc:
         add_customer_data(post, options)
         add_rebill(post, options) if options[:rebill]
         add_duplicate_override(post, options)
-        post[:TRANS_TYPE]  = 'AUTH'
-        commit('AUTH_ONLY', money, post)
+        add_stored_credential(post, options)
+        post[:TRANS_TYPE] = 'AUTH'
+        commit('AUTH_ONLY', money, post, options)
       end
 
       # Perform a purchase, which is essentially an authorization and capture in a single operation.
@@ -106,8 +108,9 @@ module ActiveMerchant #:nodoc:
         add_customer_data(post, options)
         add_rebill(post, options) if options[:rebill]
         add_duplicate_override(post, options)
-        post[:TRANS_TYPE]  = 'SALE'
-        commit('AUTH_CAPTURE', money, post)
+        add_stored_credential(post, options)
+        post[:TRANS_TYPE] = 'SALE'
+        commit('AUTH_CAPTURE', money, post, options)
       end
 
       # Captures the funds from an authorize transaction.
@@ -123,7 +126,7 @@ module ActiveMerchant #:nodoc:
         add_customer_data(post, options)
         post[:MASTER_ID] = identification
         post[:TRANS_TYPE] = 'CAPTURE'
-        commit('PRIOR_AUTH_CAPTURE', money, post)
+        commit('PRIOR_AUTH_CAPTURE', money, post, options)
       end
 
       # Void a previous transaction
@@ -136,7 +139,7 @@ module ActiveMerchant #:nodoc:
         post = {}
         post[:MASTER_ID] = identification
         post[:TRANS_TYPE] = 'VOID'
-        commit('VOID', nil, post)
+        commit('VOID', nil, post, options)
       end
 
       # Performs a credit.
@@ -154,8 +157,8 @@ module ActiveMerchant #:nodoc:
       #   If the payment_object is either a CreditCard or Check object, then the transaction type will be an unmatched credit placing funds in the specified account. This is referred to a CREDIT transaction in BluePay.
       # * <tt>options</tt> -- A hash of parameters.
       def refund(money, identification, options = {})
-        if(identification && !identification.kind_of?(String))
-          ActiveMerchant.deprecated "refund should only be used to refund a referenced transaction"
+        if identification && !identification.kind_of?(String)
+          ActiveMerchant.deprecated 'refund should only be used to refund a referenced transaction'
           return credit(money, identification, options)
         end
 
@@ -163,18 +166,19 @@ module ActiveMerchant #:nodoc:
         post[:PAYMENT_ACCOUNT] = ''
         post[:MASTER_ID]  = identification
         post[:TRANS_TYPE] = 'REFUND'
-        post[:NAME1] = (options[:first_name] ? options[:first_name] : "")
+        post[:DOC_TYPE] = options[:doc_type] if options[:doc_type]
+        post[:NAME1] = options[:first_name] || ''
         post[:NAME2] = options[:last_name] if options[:last_name]
         post[:ZIP] = options[:zip] if options[:zip]
         add_invoice(post, options)
         add_address(post, options)
         add_customer_data(post, options)
-        commit('CREDIT', money, post)
+        commit('CREDIT', money, post, options)
       end
 
       def credit(money, payment_object, options = {})
-        if(payment_object && payment_object.kind_of?(String))
-          ActiveMerchant.deprecated "credit should only be used to credit a payment method"
+        if payment_object&.kind_of?(String)
+          ActiveMerchant.deprecated 'credit should only be used to credit a payment method'
           return refund(money, payment_object, options)
         end
 
@@ -182,14 +186,15 @@ module ActiveMerchant #:nodoc:
         post[:PAYMENT_ACCOUNT] = ''
         add_payment_method(post, payment_object)
         post[:TRANS_TYPE] = 'CREDIT'
+        post[:DOC_TYPE] = options[:doc_type] if options[:doc_type]
 
-        post[:NAME1] = (options[:first_name] ? options[:first_name] : "")
+        post[:NAME1] = options[:first_name] || ''
         post[:NAME2] = options[:last_name] if options[:last_name]
         post[:ZIP] = options[:zip] if options[:zip]
         add_invoice(post, options)
         add_address(post, options)
         add_customer_data(post, options)
-        commit('CREDIT', money, post)
+        commit('CREDIT', money, post, options)
       end
 
       # Create a new recurring payment.
@@ -313,10 +318,11 @@ module ActiveMerchant #:nodoc:
 
       private
 
-      def commit(action, money, fields)
-        fields[:AMOUNT] = amount(money) unless(fields[:TRANS_TYPE] == 'VOID' || action == 'rebill')
+      def commit(action, money, fields, options = {})
+        fields[:AMOUNT] = amount(money) unless fields[:TRANS_TYPE] == 'VOID' || action == 'rebill'
         fields[:MODE] = (test? ? 'TEST' : 'LIVE')
         fields[:ACCOUNT_ID] = @options[:login]
+        fields[:CUSTOMER_IP] = options[:ip] if options[:ip]
 
         if action == 'rebill'
           url = rebilling_url
@@ -328,9 +334,9 @@ module ActiveMerchant #:nodoc:
         parse(ssl_post(url, post_data(action, fields)))
       end
 
-      def parse_recurring(response_fields, opts={}) # expected status?
+      def parse_recurring(response_fields, opts = {}) # expected status?
         parsed = {}
-        response_fields.each do |k,v|
+        response_fields.each do |k, v|
           mapped_key = REBILL_FIELD_MAP.include?(k) ? REBILL_FIELD_MAP[k] : k
           parsed[mapped_key] = v
         end
@@ -339,20 +345,18 @@ module ActiveMerchant #:nodoc:
         message = parsed[:status]
 
         Response.new(success, message, parsed,
-          :test          => test?,
-          :authorization => parsed[:rebill_id])
+          test: test?,
+          authorization: parsed[:rebill_id])
       end
 
       def parse(body)
         # The bp20api has max one value per form field.
-        response_fields = Hash[CGI::parse(body).map{|k,v| [k.upcase,v.first]}]
+        response_fields = Hash[CGI::parse(body).map { |k, v| [k.upcase, v.first] }]
 
-        if response_fields.include? "REBILL_ID"
-          return parse_recurring(response_fields)
-        end
+        return parse_recurring(response_fields) if response_fields.include? 'REBILL_ID'
 
         parsed = {}
-        response_fields.each do |k,v|
+        response_fields.each do |k, v|
           mapped_key = FIELD_MAP.include?(k) ? FIELD_MAP[k] : k
           parsed[mapped_key] = v
         end
@@ -361,29 +365,28 @@ module ActiveMerchant #:nodoc:
         message = message_from(parsed)
         success = parsed[:response_code] == '1'
         Response.new(success, message, parsed,
-          :test          => test?,
-          :authorization => (parsed[:rebid] && parsed[:rebid] != '' ? parsed[:rebid] : parsed[:transaction_id]),
-          :avs_result    => { :code => parsed[:avs_result_code] },
-          :cvv_result    => parsed[:card_code]
-        )
+          test: test?,
+          authorization: (parsed[:rebid] && parsed[:rebid] != '' ? parsed[:rebid] : parsed[:transaction_id]),
+          avs_result: { code: parsed[:avs_result_code] },
+          cvv_result: parsed[:card_code])
       end
 
       def message_from(parsed)
         message = parsed[:message]
-        if(parsed[:response_code].to_i == 2)
+        if parsed[:response_code].to_i == 2
           if CARD_CODE_ERRORS.include?(parsed[:card_code])
             message = CVVResult.messages[parsed[:card_code]]
           elsif AVS_ERRORS.include?(parsed[:avs_result_code])
-            message = AVSResult.messages[ parsed[:avs_result_code] ]
+            message = AVSResult.messages[parsed[:avs_result_code]]
           else
             message = message.chomp('.')
           end
-        elsif message == "Missing ACCOUNT_ID"
-          message = "The merchant login ID or password is invalid"
-        elsif message =~ /Approved/
-          message = "This transaction has been approved"
-        elsif message =~  /Expired/
-          message =  "The credit card has expired"
+        elsif message == 'Missing ACCOUNT_ID'
+          message = 'The merchant login ID or password is invalid'
+        elsif /Approved/.match?(message)
+          message = 'This transaction has been approved'
+        elsif /Expired/.match?(message)
+          message = 'The credit card has expired'
         end
         message
       end
@@ -418,13 +421,13 @@ module ActiveMerchant #:nodoc:
       end
 
       CHECK_ACCOUNT_TYPES = {
-        "checking" => "C",
-        "savings" => "S"
+        'checking' => 'C',
+        'savings' => 'S'
       }
 
       def add_check(post, check)
         post[:PAYMENT_TYPE]     = 'ACH'
-        post[:PAYMENT_ACCOUNT]  = [CHECK_ACCOUNT_TYPES[check.account_type], check.routing_number, check.account_number].join(":")
+        post[:PAYMENT_ACCOUNT]  = [CHECK_ACCOUNT_TYPES[check.account_type], check.routing_number, check.account_number].join(':')
         post[:NAME1]            = check.first_name
         post[:NAME2]            = check.last_name
       end
@@ -460,20 +463,47 @@ module ActiveMerchant #:nodoc:
         post[:REB_CYCLES]      = options[:rebill_cycles]
       end
 
+      def add_stored_credential(post, options)
+        post[:cof] = initiator(options)
+        post[:cofscheduled] = scheduled(options)
+      end
+
+      def initiator(options)
+        return unless initiator = options.dig(:stored_credential, :initiator)
+
+        case initiator
+        when 'merchant'
+          'M'
+        when 'cardholder'
+          'C'
+        end
+      end
+
+      def scheduled(options)
+        return unless reason_type = options.dig(:stored_credential, :reason_type)
+
+        case reason_type
+        when 'recurring', 'installment'
+          'Y'
+        when 'unscheduled'
+          'N'
+        end
+      end
+
       def post_data(action, parameters = {})
         post = {}
         post[:version]        = '1'
         post[:login]          = ''
         post[:tran_key]       = ''
-        post[:relay_response] = "FALSE"
+        post[:relay_response] = 'FALSE'
         post[:type]           = action
-        post[:delim_data]     = "TRUE"
-        post[:delim_char]     = ","
-        post[:encap_char]     = "$"
+        post[:delim_data]     = 'TRUE'
+        post[:delim_char]     = ','
+        post[:encap_char]     = '$'
         post[:card_num]       = '4111111111111111'
         post[:exp_date]       = '1212'
         post[:solution_ID]    = application_id if application_id
-        post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
       end
 
       def expdate(creditcard)
@@ -494,7 +524,7 @@ module ActiveMerchant #:nodoc:
             post[:MASTER_ID],
             post[:NAME1],
             post[:PAYMENT_ACCOUNT]
-          ].join("")
+          ].join('')
         )
       end
 
@@ -505,14 +535,13 @@ module ActiveMerchant #:nodoc:
             @options[:login],
             post[:TRANS_TYPE],
             post[:REBILL_ID]
-          ].join("")
+          ].join('')
         )
       end
 
       def handle_response(response)
-        if ignore_http_status || (200...300).include?(response.code.to_i)
-          return response.body
-        end
+        return response.body if ignore_http_status || (200...300).cover?(response.code.to_i)
+
         raise ResponseError.new(response)
       end
     end