activemerchant 1.79.2 → 1.129.0

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

@@ -0,0 +1,342 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class DLocalGateway < Gateway
+      self.test_url = 'https://sandbox.dlocal.com'
+      self.live_url = 'https://api.dlocal.com'
+
+      self.supported_countries = %w[AR BD BO BR CL CM CN CO CR DO EC EG GH GT IN ID JP KE MY MX MA NG PA PY PE PH SN SV TH TR TZ UG UY VN ZA]
+      self.default_currency = 'USD'
+      self.supported_cardtypes = %i[visa master american_express discover jcb diners_club maestro naranja cabal elo alia carnet]
+
+      self.homepage_url = 'https://dlocal.com/'
+      self.display_name = 'dLocal'
+
+      def initialize(options = {})
+        requires!(options, :login, :trans_key, :secret_key)
+        super
+      end
+
+      def purchase(money, payment, options = {})
+        post = {}
+        add_auth_purchase_params(post, money, payment, 'purchase', options)
+        add_three_ds(post, options)
+
+        commit('purchase', post, options)
+      end
+
+      def authorize(money, payment, options = {})
+        post = {}
+        add_auth_purchase_params(post, money, payment, 'authorize', options)
+        add_three_ds(post, options)
+        post[:card][:verify] = true if options[:verify].to_s == 'true'
+
+        commit('authorize', post, options)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        post[:authorization_id] = authorization
+        add_invoice(post, money, options) if money
+        commit('capture', post, options)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        post[:payment_id] = authorization
+        post[:notification_url] = options[:notification_url]
+        add_invoice(post, money, options) if money
+        commit('refund', post, options)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        post[:authorization_id] = authorization
+        commit('void', post, options)
+      end
+
+      def verify(credit_card, options = {})
+        authorize(0, credit_card, options.merge(verify: 'true'))
+      end
+
+      def inquire(authorization, options = {})
+        post = {}
+        post[:payment_id] = authorization
+        action = authorization ? 'status' : 'orders'
+        commit(action, post, options)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def supports_network_tokenization?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((X-Trans-Key: )\w+), '\1[FILTERED]').
+          gsub(%r((\"number\\\":\\\")\d+), '\1[FILTERED]').
+          gsub(%r((\"cvv\\\":\\\")\d+), '\1[FILTERED]')
+      end
+
+      private
+
+      def add_auth_purchase_params(post, money, card, action, options)
+        add_invoice(post, money, options)
+        post[:payment_method_id] = 'CARD'
+        post[:payment_method_flow] = 'DIRECT'
+        add_country(post, card, options)
+        add_payer(post, card, options)
+        add_card(post, card, action, options)
+        add_additional_data(post, options)
+        post[:order_id] = options[:order_id] || generate_unique_id
+        post[:original_order_id] = options[:original_order_id] if options[:original_order_id]
+        post[:description] = options[:description] if options[:description]
+      end
+
+      def add_invoice(post, money, options)
+        post[:amount] = amount(money)
+        post[:currency] = (options[:currency] || currency(money))
+      end
+
+      def add_additional_data(post, options)
+        post[:additional_risk_data] = options[:additional_data]
+      end
+
+      def add_country(post, card, options)
+        return unless address = options[:billing_address] || options[:address]
+
+        post[:country] = lookup_country_code(address[:country])
+      end
+
+      def lookup_country_code(country_field)
+        Country.find(country_field).code(:alpha2).value
+      rescue InvalidCountryCodeError
+        nil
+      end
+
+      def add_payer(post, card, options)
+        address = options[:billing_address] || options[:address]
+        post[:payer] = {}
+        post[:payer][:name] = card.name
+        post[:payer][:email] = options[:email] if options[:email]
+        post[:payer][:birth_date] = options[:birth_date] if options[:birth_date]
+        post[:payer][:phone] = address[:phone] if address && address[:phone]
+        post[:payer][:document] = options[:document] if options[:document]
+        post[:payer][:document2] = options[:document2] if options[:document2]
+        post[:payer][:user_reference] = options[:user_reference] if options[:user_reference]
+        post[:payer][:event_uuid] = options[:device_id] if options[:device_id]
+        post[:payer][:onboarding_ip_address] = options[:ip] if options[:ip]
+        post[:payer][:address] = add_address(post, card, options)
+      end
+
+      def add_address(post, card, options)
+        return unless address = options[:billing_address] || options[:address]
+
+        address_object = {}
+        address_object[:state] = address[:state] if address[:state]
+        address_object[:city] = address[:city] if address[:city]
+        address_object[:zip_code] = address[:zip] if address[:zip]
+        address_object[:street] = address[:street] || parse_street(address) if parse_street(address)
+        address_object[:number] = address[:number] || parse_house_number(address) if parse_house_number(address)
+        address_object
+      end
+
+      def parse_street(address)
+        return unless address[:address1]
+
+        street = address[:address1].split(/\s+/).keep_if { |x| x !~ /\d/ }.join(' ')
+        street.empty? ? nil : street
+      end
+
+      def parse_house_number(address)
+        return unless address[:address1]
+
+        house = address[:address1].split(/\s+/).keep_if { |x| x =~ /\d/ }.join(' ')
+        house.empty? ? nil : house
+      end
+
+      def add_card(post, card, action, options = {})
+        post[:card] = {}
+        if card.is_a?(NetworkTokenizationCreditCard)
+          post[:card][:network_token] = card.number
+          post[:card][:cryptogram] = card.payment_cryptogram
+          post[:card][:eci] = card.eci
+          # used case of Network Token: 'CARD_ON_FILE', 'SUBSCRIPTION', 'UNSCHEDULED_CARD_ON_FILE'
+          if options.dig(:stored_credential, :reason_type) == 'unscheduled'
+            if options.dig(:stored_credential, :initiator) == 'merchant'
+              post[:card][:stored_credential_type] = 'UNSCHEDULED_CARD_ON_FILE'
+            else
+              post[:card][:stored_credential_type] = 'CARD_ON_FILE'
+            end
+          else
+            post[:card][:stored_credential_type] = 'SUBSCRIPTION'
+          end
+          # required for MC debit recurrent in BR 'USED'(subsecuence Payments) . 'FIRST' an inital payment
+          post[:card][:stored_credential_usage] = (options[:stored_credential][:initial_transaction] ? 'FIRST' : 'USED') if options[:stored_credential]
+        else
+          post[:card][:number] = card.number
+          post[:card][:cvv] = card.verification_value
+        end
+
+        post[:card][:holder_name] = card.name
+        post[:card][:expiration_month] = card.month
+        post[:card][:expiration_year] = card.year
+        post[:card][:descriptor] = options[:dynamic_descriptor] if options[:dynamic_descriptor]
+        post[:card][:capture] = (action == 'purchase')
+        post[:card][:installments] = options[:installments] if options[:installments]
+        post[:card][:installments_id] = options[:installments_id] if options[:installments_id]
+        post[:card][:force_type] = options[:force_type].to_s.upcase if options[:force_type]
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def commit(action, parameters, options = {})
+        three_ds_errors = validate_three_ds_params(parameters[:three_dsecure]) if parameters[:three_dsecure].present?
+        return three_ds_errors if three_ds_errors
+
+        url = url(action, parameters, options)
+        post = post_data(action, parameters)
+        begin
+          raw = if %w(status orders).include?(action)
+                  ssl_get(url, headers(nil, options))
+                else
+                  ssl_post(url, post, headers(post, options))
+                end
+          response = parse(raw)
+        rescue ResponseError => e
+          raw = e.response.body
+          response = parse(raw)
+        end
+
+        Response.new(
+          success_from(action, response),
+          message_from(action, response),
+          response,
+          authorization: authorization_from(response),
+          avs_result: AVSResult.new(code: response['some_avs_response_key']),
+          cvv_result: CVVResult.new(response['some_cvv_response_key']),
+          test: test?,
+          error_code: error_code_from(action, response)
+        )
+      end
+
+      # A refund may not be immediate, and return a status_code of 100, "Pending".
+      # Since we aren't handling async notifications of eventual success,
+      # we count 100 as a success.
+      def success_from(action, response)
+        return false unless response['status_code']
+
+        %w[100 200 400 600 700].include? response['status_code'].to_s
+      end
+
+      def message_from(action, response)
+        response['status_detail'] || response['message']
+      end
+
+      def authorization_from(response)
+        response['id']
+      end
+
+      def error_code_from(action, response)
+        return if success_from(action, response)
+
+        code = response['status_code'] || response['code']
+        code&.to_s
+      end
+
+      def url(action, parameters, options = {})
+        "#{(test? ? test_url : live_url)}/#{endpoint(action, parameters, options)}/"
+      end
+
+      def endpoint(action, parameters, options)
+        case action
+        when 'purchase'
+          'secure_payments'
+        when 'authorize'
+          'secure_payments'
+        when 'refund'
+          'refunds'
+        when 'capture'
+          'payments'
+        when 'void'
+          "payments/#{parameters[:authorization_id]}/cancel"
+        when 'status'
+          "payments/#{parameters[:payment_id]}/status"
+        when 'orders'
+          "orders/#{options[:order_id]}"
+        end
+      end
+
+      def headers(post, options = {})
+        timestamp = Time.now.utc.iso8601
+        headers = {
+          'Content-Type' => 'application/json',
+          'X-Date' => timestamp,
+          'X-Login' => @options[:login],
+          'X-Trans-Key' => @options[:trans_key],
+          'X-Version' => '2.1',
+          'Authorization' => signature(post, timestamp)
+        }
+        headers['X-Idempotency-Key'] = options[:idempotency_key] if options[:idempotency_key]
+        headers
+      end
+
+      def signature(post, timestamp)
+        content = "#{@options[:login]}#{timestamp}#{post}"
+        digest = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @options[:secret_key], content)
+        "V2-HMAC-SHA256, Signature: #{digest}"
+      end
+
+      def post_data(action, parameters = {})
+        parameters.to_json
+      end
+
+      def xid_or_ds_trans_id(three_d_secure)
+        if three_d_secure[:version].to_f >= 2
+          { ds_transaction_id: three_d_secure[:ds_transaction_id] }
+        else
+          { xid: three_d_secure[:xid] }
+        end
+      end
+
+      def add_three_ds(post, options)
+        return unless three_d_secure = options[:three_d_secure]
+
+        post[:three_dsecure] = {
+          mpi: true,
+          three_dsecure_version: three_d_secure[:version],
+          cavv: three_d_secure[:cavv],
+          eci: three_d_secure[:eci],
+          enrollment_response: formatted_enrollment(three_d_secure[:enrolled]),
+          authentication_response: three_d_secure[:authentication_response_status]
+        }.merge(xid_or_ds_trans_id(three_d_secure))
+      end
+
+      def validate_three_ds_params(three_ds)
+        errors = {}
+        supported_version = %w{1.0 2.0 2.1.0 2.2.0}.include?(three_ds[:three_dsecure_version])
+        supported_enrollment = ['Y', 'N', 'U', nil].include?(three_ds[:enrollment_response])
+        supported_auth_response = ['Y', 'N', 'U', nil].include?(three_ds[:authentication_response])
+
+        errors[:three_ds_version] = 'ThreeDs version not supported' unless supported_version
+        errors[:enrollment] = 'Enrollment value not supported' unless supported_enrollment
+        errors[:auth_response] = 'Authentication response value not supported' unless supported_auth_response
+        errors.compact!
+
+        errors.present? ? Response.new(false, 'ThreeDs data is invalid', errors) : nil
+      end
+
+      def formatted_enrollment(val)
+        case val
+        when 'Y', 'N', 'U' then val
+        when true, 'true' then 'Y'
+        when false, 'false' then 'N'
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require "active_support/core_ext/string/access"
+require 'active_support/core_ext/string/access'
 
 module ActiveMerchant
   module Billing
@@ -6,7 +6,7 @@ module ActiveMerchant
       self.default_currency = 'GBP'
       self.supported_countries = ['GB']
 
-      self.supported_cardtypes = [ :visa, :master, :american_express, :discover, :diners_club, :jcb, :maestro, :switch, :solo, :laser ]
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb maestro]
 
       self.homepage_url = 'http://www.datacash.com/'
       self.display_name = 'DataCash'
@@ -92,9 +92,9 @@ module ActiveMerchant
 
       def build_void_or_capture_request(type, money, authorization, options)
         parsed_authorization = parse_authorization_string(authorization)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
-        xml.tag! :Request, :version => '2' do
+        xml.tag! :Request, version: '2' do
           add_authentication(xml)
 
           xml.tag! :Transaction do
@@ -107,7 +107,7 @@ module ActiveMerchant
             if money
               xml.tag! :TxnDetails do
                 xml.tag! :merchantreference, format_reference_number(options[:order_id])
-                xml.tag! :amount, amount(money), :currency => options[:currency] || currency(money)
+                xml.tag! :amount, amount(money), currency: options[:currency] || currency(money)
                 xml.tag! :capturemethod, 'ecomm'
               end
             end
@@ -117,22 +117,20 @@ module ActiveMerchant
       end
 
       def build_purchase_or_authorization_request_with_credit_card_request(type, money, credit_card, options)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
-        xml.tag! :Request, :version => '2' do
+        xml.tag! :Request, version: '2' do
           add_authentication(xml)
 
           xml.tag! :Transaction do
-            if options[:set_up_continuous_authority]
-              xml.tag! :ContAuthTxn, :type => 'setup'
-            end
+            xml.tag! :ContAuthTxn, type: 'setup' if options[:set_up_continuous_authority]
             xml.tag! :CardTxn do
               xml.tag! :method, type
               add_credit_card(xml, credit_card, options[:billing_address])
             end
             xml.tag! :TxnDetails do
               xml.tag! :merchantreference, format_reference_number(options[:order_id])
-              xml.tag! :amount, amount(money), :currency => options[:currency] || currency(money)
+              xml.tag! :amount, amount(money), currency: options[:currency] || currency(money)
               xml.tag! :capturemethod, 'ecomm'
             end
           end
@@ -142,21 +140,21 @@ module ActiveMerchant
 
       def build_purchase_or_authorization_request_with_continuous_authority_reference_request(type, money, authorization, options)
         parsed_authorization = parse_authorization_string(authorization)
-        raise ArgumentError, "The continuous authority reference is required for continuous authority transactions" if parsed_authorization[:ca_reference].blank?
+        raise ArgumentError, 'The continuous authority reference is required for continuous authority transactions' if parsed_authorization[:ca_reference].blank?
 
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
-        xml.tag! :Request, :version => '2' do
+        xml.tag! :Request, version: '2' do
           add_authentication(xml)
           xml.tag! :Transaction do
-            xml.tag! :ContAuthTxn, :type => 'historic'
+            xml.tag! :ContAuthTxn, type: 'historic'
             xml.tag! :HistoricTxn do
               xml.tag! :reference, parsed_authorization[:ca_reference]
               xml.tag! :method, type
             end
             xml.tag! :TxnDetails do
               xml.tag! :merchantreference, format_reference_number(options[:order_id])
-              xml.tag! :amount, amount(money), :currency => options[:currency] || currency(money)
+              xml.tag! :amount, amount(money), currency: options[:currency] || currency(money)
               xml.tag! :capturemethod, 'cont_auth'
             end
           end
@@ -166,9 +164,9 @@ module ActiveMerchant
 
       def build_transaction_refund_request(money, authorization)
         parsed_authorization = parse_authorization_string(authorization)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
-        xml.tag! :Request, :version => '2' do
+        xml.tag! :Request, version: '2' do
           add_authentication(xml)
           xml.tag! :Transaction do
             xml.tag! :HistoricTxn do
@@ -187,9 +185,9 @@ module ActiveMerchant
       end
 
       def build_credit_request(money, credit_card, options)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
-        xml.tag! :Request, :version => '2' do
+        xml.tag! :Request, version: '2' do
           add_authentication(xml)
           xml.tag! :Transaction do
             xml.tag! :CardTxn do
@@ -214,23 +212,11 @@ module ActiveMerchant
       end
 
       def add_credit_card(xml, credit_card, address)
-
         xml.tag! :Card do
-
           # DataCash calls the CC number 'pan'
           xml.tag! :pan, credit_card.number
           xml.tag! :expirydate, format_date(credit_card.month, credit_card.year)
 
-          # optional values - for Solo etc
-          if [ 'switch', 'solo' ].include?(card_brand(credit_card).to_s)
-
-            xml.tag! :issuenumber, credit_card.issue_number unless credit_card.issue_number.blank?
-
-            if !credit_card.start_month.blank? && !credit_card.start_year.blank?
-              xml.tag! :startdate, format_date(credit_card.start_month, credit_card.start_year)
-            end
-          end
-
           xml.tag! :Cv2Avs do
             xml.tag! :cv2, credit_card.verification_value if credit_card.verification_value?
             if address
@@ -249,23 +235,23 @@ module ActiveMerchant
             # a predefined one
             xml.tag! :ExtendedPolicy do
               xml.tag! :cv2_policy,
-              :notprovided =>   POLICY_REJECT,
-              :notchecked =>    POLICY_REJECT,
-              :matched =>       POLICY_ACCEPT,
-              :notmatched =>    POLICY_REJECT,
-              :partialmatch =>  POLICY_REJECT
+                notprovided: POLICY_REJECT,
+                notchecked: POLICY_REJECT,
+                matched: POLICY_ACCEPT,
+                notmatched: POLICY_REJECT,
+                partialmatch: POLICY_REJECT
               xml.tag! :postcode_policy,
-              :notprovided =>   POLICY_ACCEPT,
-              :notchecked =>    POLICY_ACCEPT,
-              :matched =>       POLICY_ACCEPT,
-              :notmatched =>    POLICY_REJECT,
-              :partialmatch =>  POLICY_ACCEPT
+                notprovided: POLICY_ACCEPT,
+                notchecked: POLICY_ACCEPT,
+                matched: POLICY_ACCEPT,
+                notmatched: POLICY_REJECT,
+                partialmatch: POLICY_ACCEPT
               xml.tag! :address_policy,
-              :notprovided =>   POLICY_ACCEPT,
-              :notchecked =>    POLICY_ACCEPT,
-              :matched =>       POLICY_ACCEPT,
-              :notmatched =>    POLICY_REJECT,
-              :partialmatch =>  POLICY_ACCEPT
+                notprovided: POLICY_ACCEPT,
+                notchecked: POLICY_ACCEPT,
+                matched: POLICY_ACCEPT,
+                notmatched: POLICY_REJECT,
+                partialmatch: POLICY_ACCEPT
             end
           end
         end
@@ -275,20 +261,18 @@ module ActiveMerchant
         response = parse(ssl_post(test? ? self.test_url : self.live_url, request))
 
         Response.new(response[:status] == '1', response[:reason], response,
-          :test => test?,
-          :authorization => "#{response[:datacash_reference]};#{response[:authcode]};#{response[:ca_reference]}"
-        )
+          test: test?,
+          authorization: "#{response[:datacash_reference]};#{response[:authcode]};#{response[:ca_reference]}")
       end
 
       def format_date(month, year)
-        "#{format(month,:two_digits)}/#{format(year, :two_digits)}"
+        "#{format(month, :two_digits)}/#{format(year, :two_digits)}"
       end
 
       def parse(body)
-
         response = {}
         xml = REXML::Document.new(body)
-        root = REXML::XPath.first(xml, "//Response")
+        root = REXML::XPath.first(xml, '//Response')
 
         root.elements.to_a.each do |node|
           parse_element(response, node)
@@ -299,19 +283,19 @@ module ActiveMerchant
 
       def parse_element(response, node)
         if node.has_elements?
-          node.elements.each{|e| parse_element(response, e) }
+          node.elements.each { |e| parse_element(response, e) }
         else
           response[node.name.underscore.to_sym] = node.text
         end
       end
 
       def format_reference_number(number)
-        number.to_s.gsub(/[^A-Za-z0-9]/, '').rjust(6, "0").first(30)
+        number.to_s.gsub(/[^A-Za-z0-9]/, '').rjust(6, '0').first(30)
       end
 
       def parse_authorization_string(authorization)
         reference, auth_code, ca_reference = authorization.to_s.split(';')
-        {:reference => reference, :auth_code => auth_code, :ca_reference => ca_reference}
+        { reference: reference, auth_code: auth_code, ca_reference: ca_reference }
       end
     end
   end