activemerchant 1.45.0 → 1.126.0

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

@@ -0,0 +1,334 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class EbanxGateway < Gateway
+      self.test_url = 'https://sandbox.ebanxpay.com/ws/'
+      self.live_url = 'https://api.ebanxpay.com/ws/'
+
+      self.supported_countries = %w(BR MX CO CL AR PE)
+      self.default_currency = 'USD'
+      self.supported_cardtypes = %i[visa master american_express discover diners_club]
+
+      self.homepage_url = 'http://www.ebanx.com/'
+      self.display_name = 'EBANX'
+
+      CARD_BRAND = {
+        visa: 'visa',
+        master: 'master_card',
+        american_express: 'amex',
+        discover: 'discover',
+        diners_club: 'diners'
+      }
+
+      URL_MAP = {
+        purchase: 'direct',
+        authorize: 'direct',
+        capture: 'capture',
+        refund: 'refund',
+        void: 'cancel',
+        store: 'token'
+      }
+
+      HTTP_METHOD = {
+        purchase: :post,
+        authorize: :post,
+        capture: :get,
+        refund: :post,
+        void: :get,
+        store: :post
+      }
+
+      VERIFY_AMOUNT_PER_COUNTRY = {
+        'br' => 100,
+        'ar' => 100,
+        'co' => 100,
+        'pe' => 300,
+        'mx' => 2000,
+        'cl' => 80000
+      }
+
+      def initialize(options = {})
+        requires!(options, :integration_key)
+        super
+      end
+
+      def purchase(money, payment, options = {})
+        post = { payment: {} }
+        add_integration_key(post)
+        add_operation(post)
+        add_invoice(post, money, options)
+        add_customer_data(post, payment, options)
+        add_card_or_token(post, payment)
+        add_address(post, options)
+        add_customer_responsible_person(post, payment, options)
+        add_additional_data(post, options)
+
+        commit(:purchase, post)
+      end
+
+      def authorize(money, payment, options = {})
+        post = { payment: {} }
+        add_integration_key(post)
+        add_operation(post)
+        add_invoice(post, money, options)
+        add_customer_data(post, payment, options)
+        add_card_or_token(post, payment)
+        add_address(post, options)
+        add_customer_responsible_person(post, payment, options)
+        add_additional_data(post, options)
+        post[:payment][:creditcard][:auto_capture] = false
+
+        commit(:authorize, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_integration_key(post)
+        post[:hash] = authorization
+        post[:amount] = amount(money) if options[:include_capture_amount].to_s == 'true'
+
+        commit(:capture, post)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        add_integration_key(post)
+        add_operation(post)
+        add_authorization(post, authorization)
+        post[:amount] = amount(money)
+        post[:description] = options[:description]
+
+        commit(:refund, post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_integration_key(post)
+        add_authorization(post, authorization)
+
+        commit(:void, post)
+      end
+
+      def store(credit_card, options = {})
+        post = {}
+        add_integration_key(post)
+        add_payment_details(post, credit_card)
+        post[:country] = customer_country(options)
+
+        commit(:store, post)
+      end
+
+      def verify(credit_card, options = {})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(VERIFY_AMOUNT_PER_COUNTRY[customer_country(options)], credit_card, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(/(integration_key\\?":\\?")(\w*)/, '\1[FILTERED]').
+          gsub(/(card_number\\?":\\?")(\d*)/, '\1[FILTERED]').
+          gsub(/(card_cvv\\?":\\?")(\d*)/, '\1[FILTERED]')
+      end
+
+      private
+
+      def add_integration_key(post)
+        post[:integration_key] = @options[:integration_key].to_s
+      end
+
+      def add_operation(post)
+        post[:operation] = 'request'
+      end
+
+      def add_authorization(post, authorization)
+        post[:hash] = authorization
+      end
+
+      def add_customer_data(post, payment, options)
+        post[:payment][:name] = customer_name(payment, options)
+        post[:payment][:email] = options[:email] || 'unspecified@example.com'
+        post[:payment][:document] = options[:document]
+        post[:payment][:birth_date] = options[:birth_date] if options[:birth_date]
+      end
+
+      def add_customer_responsible_person(post, payment, options)
+        post[:payment][:person_type] = options[:person_type] if options[:person_type]
+        if options[:person_type]&.casecmp('business')&.zero?
+          post[:payment][:responsible] = {}
+          post[:payment][:responsible][:name] = options[:responsible_name] if options[:responsible_name]
+          post[:payment][:responsible][:document] = options[:responsible_document] if options[:responsible_document]
+          post[:payment][:responsible][:birth_date] = options[:responsible_birth_date] if options[:responsible_birth_date]
+        end
+      end
+
+      def add_address(post, options)
+        if address = options[:billing_address] || options[:address]
+          post[:payment][:address] = address[:address1].split[1..-1].join(' ') if address[:address1]
+          post[:payment][:street_number] = address[:address1].split.first if address[:address1]
+          post[:payment][:city] = address[:city]
+          post[:payment][:state] = address[:state]
+          post[:payment][:zipcode] = address[:zip]
+          post[:payment][:country] = address[:country].downcase
+          post[:payment][:phone_number] = address[:phone]
+        end
+      end
+
+      def add_invoice(post, money, options)
+        post[:payment][:amount_total] = amount(money)
+        post[:payment][:currency_code] = (options[:currency] || currency(money))
+        post[:payment][:merchant_payment_code] = Digest::MD5.hexdigest(options[:order_id])
+        post[:payment][:instalments] = options[:instalments] || 1
+        post[:payment][:order_number] = options[:order_id][0..39] if options[:order_id]
+      end
+
+      def add_card_or_token(post, payment)
+        payment, brand = payment.split('|') if payment.is_a?(String)
+        post[:payment][:payment_type_code] = payment.is_a?(String) ? brand : CARD_BRAND[payment.brand.to_sym]
+        post[:payment][:creditcard] = payment_details(payment)
+      end
+
+      def add_payment_details(post, payment)
+        post[:payment_type_code] = CARD_BRAND[payment.brand.to_sym]
+        post[:creditcard] = payment_details(payment)
+      end
+
+      def payment_details(payment)
+        if payment.is_a?(String)
+          { token: payment }
+        else
+          {
+            card_number: payment.number,
+            card_name: payment.name,
+            card_due_date: "#{payment.month}/#{payment.year}",
+            card_cvv: payment.verification_value
+          }
+        end
+      end
+
+      def add_additional_data(post, options)
+        post[:device_id] = options[:device_id] if options[:device_id]
+        post[:metadata] = options[:metadata] if options[:metadata]
+        post[:metadata] = {} if post[:metadata].nil?
+        post[:metadata][:merchant_payment_code] = options[:order_id] if options[:order_id]
+        post[:processing_type] = options[:processing_type] if options[:processing_type]
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def commit(action, parameters)
+        url = url_for((test? ? test_url : live_url), action, parameters)
+
+        response = parse(ssl_request(HTTP_METHOD[action], url, post_data(action, parameters), headers(parameters)))
+
+        success = success_from(action, response)
+
+        Response.new(
+          success,
+          message_from(response),
+          response,
+          authorization: authorization_from(action, parameters, response),
+          test: test?,
+          error_code: error_code_from(response, success)
+        )
+      end
+
+      def headers(params)
+        processing_type = params[:processing_type]
+        commit_headers = { 'x-ebanx-client-user-agent': "ActiveMerchant/#{ActiveMerchant::VERSION}" }
+
+        add_processing_type_to_commit_headers(commit_headers, processing_type) if processing_type == 'local'
+
+        commit_headers
+      end
+
+      def add_processing_type_to_commit_headers(commit_headers, processing_type)
+        commit_headers['x-ebanx-api-processing-type'] = processing_type
+      end
+
+      def success_from(action, response)
+        if %i[purchase capture refund].include?(action)
+          response.try(:[], 'payment').try(:[], 'status') == 'CO'
+        elsif action == :authorize
+          response.try(:[], 'payment').try(:[], 'status') == 'PE'
+        elsif action == :void
+          response.try(:[], 'payment').try(:[], 'status') == 'CA'
+        elsif action == :store
+          response.try(:[], 'status') == 'SUCCESS'
+        else
+          false
+        end
+      end
+
+      def message_from(response)
+        return response['status_message'] if response['status'] == 'ERROR'
+
+        response.try(:[], 'payment').try(:[], 'transaction_status').try(:[], 'description')
+      end
+
+      def authorization_from(action, parameters, response)
+        if action == :store
+          "#{response.try(:[], 'token')}|#{CARD_BRAND[parameters[:payment_type_code].to_sym]}"
+        else
+          response.try(:[], 'payment').try(:[], 'hash')
+        end
+      end
+
+      def post_data(action, parameters = {})
+        return nil if requires_http_get(action)
+        return convert_to_url_form_encoded(parameters) if action == :refund
+
+        "request_body=#{parameters.to_json}"
+      end
+
+      def url_for(hostname, action, parameters)
+        return "#{hostname}#{URL_MAP[action]}?#{convert_to_url_form_encoded(parameters)}" if requires_http_get(action)
+
+        "#{hostname}#{URL_MAP[action]}"
+      end
+
+      def requires_http_get(action)
+        return true if %i[capture void].include?(action)
+
+        false
+      end
+
+      def convert_to_url_form_encoded(parameters)
+        parameters.map do |key, value|
+          next if value != false && value.blank?
+
+          "#{key}=#{value}"
+        end.compact.join('&')
+      end
+
+      def error_code_from(response, success)
+        unless success
+          return response['status_code'] if response['status'] == 'ERROR'
+
+          response.try(:[], 'payment').try(:[], 'transaction_status').try(:[], 'code')
+        end
+      end
+
+      def customer_country(options)
+        if country = options[:country] || (options[:billing_address][:country] if options[:billing_address])
+          country.downcase
+        end
+      end
+
+      def customer_name(payment, options)
+        address_name = options[:billing_address][:name] if options[:billing_address] && options[:billing_address][:name]
+        if payment.is_a?(String)
+          address_name || 'Not Provided'
+        else
+          payment.name
+        end
+      end
+    end
+  end
+end

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

@@ -2,10 +2,9 @@ require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-
     class EfsnetGateway < Gateway
       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.concordefsnet.com/'
       self.display_name = 'Efsnet'
 
@@ -54,8 +53,8 @@ module ActiveMerchant #:nodoc:
 
       def void(identification, options = {})
         requires!(options, :order_id)
-        original_transaction_id, _ = identification.split(";")
-        commit(:void_transaction, {:reference_number => format_reference_number(options[:order_id]), :transaction_id => original_transaction_id})
+        original_transaction_id, = identification.split(';')
+        commit(:void_transaction, { reference_number: format_reference_number(options[:order_id]), transaction_id: original_transaction_id })
       end
 
       def voice_authorize(money, authorization_code, creditcard, options = {})
@@ -77,16 +76,16 @@ module ActiveMerchant #:nodoc:
       private
 
       def build_refund_or_settle_request(money, identification, options = {})
-        original_transaction_id, original_transaction_amount = identification.split(";")
+        original_transaction_id, original_transaction_amount = identification.split(';')
 
         requires!(options, :order_id)
 
         {
-          :reference_number => format_reference_number(options[:order_id]),
-          :transaction_amount => amount(money),
-          :original_transaction_amount => original_transaction_amount,
-          :original_transaction_id => original_transaction_id,
-          :client_ip_address => options[:ip]
+          reference_number: format_reference_number(options[:order_id]),
+          transaction_amount: amount(money),
+          original_transaction_amount: original_transaction_amount,
+          original_transaction_id: original_transaction_id,
+          client_ip_address: options[:ip]
         }
       end
 
@@ -94,65 +93,63 @@ module ActiveMerchant #:nodoc:
         requires!(options, :order_id)
 
         post = {
-          :reference_number => format_reference_number(options[:order_id]),
-          :authorization_number => options[:authorization_number],
-          :transaction_amount => amount(money),
-          :client_ip_address => options[:ip]
+          reference_number: format_reference_number(options[:order_id]),
+          authorization_number: options[:authorization_number],
+          transaction_amount: amount(money),
+          client_ip_address: options[:ip]
 
         }
-        add_creditcard(post,creditcard)
-        add_address(post,options)
+        add_creditcard(post, creditcard)
+        add_address(post, options)
         post
       end
 
       def format_reference_number(number)
-        number.to_s.slice(0,12)
+        number.to_s.slice(0, 12)
       end
 
-      def add_address(post,options)
+      def add_address(post, options)
         if address = options[:billing_address] || options[:address]
           if address[:address2]
-            post[:billing_address]    = address[:address1].to_s << ' ' <<  address[:address2].to_s
+            post[:billing_address]    = address[:address1].to_s << ' ' << address[:address2].to_s
           else
             post[:billing_address]    = address[:address1].to_s
           end
           post[:billing_city]         = address[:city].to_s
-          post[:billing_state]        = address[:state].blank?  ? 'n/a' : address[:state]
+          post[:billing_state]        = address[:state].blank? ? 'n/a' : address[:state]
           post[:billing_postal_code]  = address[:zip].to_s
           post[:billing_country]      = address[:country].to_s
         end
 
         if address = options[:shipping_address]
           if address[:address2]
-            post[:shipping_address]   = address[:address1].to_s << ' ' <<  address[:address2].to_s
+            post[:shipping_address]   = address[:address1].to_s << ' ' << address[:address2].to_s
           else
             post[:shipping_address]   = address[:address1].to_s
           end
           post[:shipping_city]        = address[:city].to_s
-          post[:shipping_state]       = address[:state].blank?  ? 'n/a' : address[:state]
+          post[:shipping_state]       = address[:state].blank? ? 'n/a' : address[:state]
           post[:shipping_postal_code] = address[:zip].to_s
           post[:shipping_country]     = address[:country].to_s
         end
       end
 
       def add_creditcard(post, creditcard)
-        post[:billing_name]  = creditcard.name if creditcard.name
-        post[:account_number]  = creditcard.number
+        post[:billing_name] = creditcard.name if creditcard.name
+        post[:account_number] = creditcard.number
         post[:card_verification_value] = creditcard.verification_value if creditcard.verification_value?
-        post[:expiration_month]  = sprintf("%.2i", creditcard.month)
-        post[:expiration_year]  = sprintf("%.4i", creditcard.year)[-2..-1]
+        post[:expiration_month] = sprintf('%.2i', creditcard.month)
+        post[:expiration_year] = sprintf('%.4i', creditcard.year)[-2..-1]
       end
 
-
       def commit(action, parameters)
         response = parse(ssl_post(test? ? self.test_url : self.live_url, post_data(action, parameters), 'Content-Type' => 'text/xml'))
 
         Response.new(success?(response), message_from(response[:result_message]), response,
-          :test => test?,
-          :authorization => authorization_from(response, parameters),
-          :avs_result => { :code => response[:avs_response_code] },
-          :cvv_result => response[:cvv_response_code]
-        )
+          test: test?,
+          authorization: authorization_from(response, parameters),
+          avs_result: { code: response[:avs_response_code] },
+          cvv_result: response[:cvv_response_code])
       end
 
       def success?(response)
@@ -160,7 +157,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def authorization_from(response, params)
-        [ response[:transaction_id], params[:transaction_amount] ].compact.join(';')
+        [response[:transaction_id], params[:transaction_amount]].compact.join(';')
       end
 
       def parse(xml)
@@ -169,9 +166,7 @@ module ActiveMerchant #:nodoc:
         xml = REXML::Document.new(xml)
 
         xml.elements.each('//Reply//TransactionReply/*') do |node|
-
           response[node.name.underscore.to_sym] = normalize(node.text)
-
         end unless xml.root.nil?
 
         response
@@ -179,10 +174,10 @@ module ActiveMerchant #:nodoc:
 
       def post_data(action, parameters = {})
         xml   = REXML::Document.new("<?xml version='1.0' encoding='UTF-8'?>")
-        root  = xml.add_element("Request")
-        root.attributes["StoreID"] = options[:login]
-        root.attributes["StoreKey"] = options[:password]
-        root.attributes["ApplicationID"] = 'ot 1.0'
+        root  = xml.add_element('Request')
+        root.attributes['StoreID'] = options[:login]
+        root.attributes['StoreKey'] = options[:password]
+        root.attributes['ApplicationID'] = 'ot 1.0'
         transaction = root.add_element(action.to_s.camelize)
 
         actions[action].each do |key|
@@ -194,25 +189,26 @@ module ActiveMerchant #:nodoc:
 
       def message_from(message)
         return 'Unspecified error' if message.blank?
-        message.gsub(/[^\w]/, ' ').split.join(" ").capitalize
+
+        message.gsub(/[^\w]/, ' ').split.join(' ').capitalize
       end
 
       def actions
         ACTIONS
       end
 
-      CREDIT_CARD_FIELDS =  %w(AuthorizationNumber ClientIpAddress BillingAddress BillingCity BillingState BillingPostalCode BillingCountry BillingName CardVerificationValue ExpirationMonth ExpirationYear ReferenceNumber TransactionAmount AccountNumber )
+      CREDIT_CARD_FIELDS = %w(AuthorizationNumber ClientIpAddress BillingAddress BillingCity BillingState BillingPostalCode BillingCountry BillingName CardVerificationValue ExpirationMonth ExpirationYear ReferenceNumber TransactionAmount AccountNumber)
 
       ACTIONS = {
-           :credit_card_authorize		=> CREDIT_CARD_FIELDS,
-           :credit_card_charge			=> CREDIT_CARD_FIELDS,
-           :credit_card_voice_authorize		=> CREDIT_CARD_FIELDS,
-           :credit_card_capture			=> CREDIT_CARD_FIELDS,
-           :credit_card_credit			=> CREDIT_CARD_FIELDS + ["OriginalTransactionAmount"],
-           :credit_card_refund			=> %w(ReferenceNumber TransactionAmount OriginalTransactionAmount OriginalTransactionID ClientIpAddress),
-           :void_transaction			=> %w(ReferenceNumber TransactionID),
-           :credit_card_settle			=> %w(ReferenceNumber TransactionAmount OriginalTransactionAmount OriginalTransactionID ClientIpAddress),
-           :system_check			=> %w(SystemCheck),
+        credit_card_authorize: CREDIT_CARD_FIELDS,
+        credit_card_charge: CREDIT_CARD_FIELDS,
+        credit_card_voice_authorize: CREDIT_CARD_FIELDS,
+        credit_card_capture: CREDIT_CARD_FIELDS,
+        credit_card_credit: CREDIT_CARD_FIELDS + ['OriginalTransactionAmount'],
+        credit_card_refund: %w(ReferenceNumber TransactionAmount OriginalTransactionAmount OriginalTransactionID ClientIpAddress),
+        void_transaction: %w(ReferenceNumber TransactionID),
+        credit_card_settle: %w(ReferenceNumber TransactionAmount OriginalTransactionAmount OriginalTransactionID ClientIpAddress),
+        system_check: %w(SystemCheck)
       }
     end
   end