archetype2142_activemerchant 1.124.0

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

@@ -0,0 +1,253 @@
+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 IN ID KE MY MX MA NG PA PY PE PH SN ZA TR UY VN]
+      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)
+
+        commit('purchase', post, options)
+      end
+
+      def authorize(money, payment, options = {})
+        post = {}
+        add_auth_purchase_params(post, money, payment, 'authorize', 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 supports_scrubbing?
+        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[: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] = {}
+        post[:card][:holder_name] = card.name
+        post[:card][:expiration_month] = card.month
+        post[:card][:expiration_year] = card.year
+        post[:card][:number] = card.number
+        post[:card][:cvv] = card.verification_value
+        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]
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def commit(action, parameters, options = {})
+        url = url(action, parameters, options)
+        post = post_data(action, parameters)
+        begin
+          raw = ssl_post(url, post, headers(post, options))
+          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"
+        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],
+          'Authorization' => signature(post, timestamp)
+        }
+        headers.merge('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
+    end
+  end
+end

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

@@ -0,0 +1,302 @@
+require 'active_support/core_ext/string/access'
+
+module ActiveMerchant
+  module Billing
+    class DataCashGateway < Gateway
+      self.default_currency = 'GBP'
+      self.supported_countries = ['GB']
+
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb maestro]
+
+      self.homepage_url = 'http://www.datacash.com/'
+      self.display_name = 'DataCash'
+
+      self.test_url = 'https://testserver.datacash.com/Transaction'
+      self.live_url = 'https://mars.transaction.datacash.com/Transaction'
+
+      AUTH_TYPE = 'auth'
+      CANCEL_TYPE = 'cancel'
+      FULFILL_TYPE = 'fulfill'
+      PRE_TYPE = 'pre'
+      REFUND_TYPE = 'refund'
+      TRANSACTION_REFUND_TYPE = 'txn_refund'
+
+      POLICY_ACCEPT = 'accept'
+      POLICY_REJECT = 'reject'
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+
+      def purchase(money, authorization_or_credit_card, options = {})
+        requires!(options, :order_id)
+
+        if authorization_or_credit_card.is_a?(String)
+          request = build_purchase_or_authorization_request_with_continuous_authority_reference_request(AUTH_TYPE, money, authorization_or_credit_card, options)
+        else
+          request = build_purchase_or_authorization_request_with_credit_card_request(AUTH_TYPE, money, authorization_or_credit_card, options)
+        end
+
+        commit(request)
+      end
+
+      def authorize(money, authorization_or_credit_card, options = {})
+        requires!(options, :order_id)
+
+        if authorization_or_credit_card.is_a?(String)
+          request = build_purchase_or_authorization_request_with_continuous_authority_reference_request(AUTH_TYPE, money, authorization_or_credit_card, options)
+        else
+          request = build_purchase_or_authorization_request_with_credit_card_request(PRE_TYPE, money, authorization_or_credit_card, options)
+        end
+
+        commit(request)
+      end
+
+      def capture(money, authorization, options = {})
+        commit(build_void_or_capture_request(FULFILL_TYPE, money, authorization, options))
+      end
+
+      def void(authorization, options = {})
+        request = build_void_or_capture_request(CANCEL_TYPE, nil, authorization, options)
+
+        commit(request)
+      end
+
+      def credit(money, reference_or_credit_card, options = {})
+        if reference_or_credit_card.is_a?(String)
+          ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+          refund(money, reference_or_credit_card)
+        else
+          request = build_credit_request(money, reference_or_credit_card, options)
+          commit(request)
+        end
+      end
+
+      def refund(money, reference, options = {})
+        commit(build_transaction_refund_request(money, reference))
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(/(<pan>)\d+(<\/pan>)/i, '\1[FILTERED]\2').
+          gsub(/(<cv2>)\d+(<\/cv2>)/i, '\1[FILTERED]\2').
+          gsub(/(<password>).+(<\/password>)/i, '\1[FILTERED]\2')
+      end
+
+      private
+
+      def build_void_or_capture_request(type, money, authorization, options)
+        parsed_authorization = parse_authorization_string(authorization)
+        xml = Builder::XmlMarkup.new indent: 2
+        xml.instruct!
+        xml.tag! :Request, version: '2' do
+          add_authentication(xml)
+
+          xml.tag! :Transaction do
+            xml.tag! :HistoricTxn do
+              xml.tag! :reference, parsed_authorization[:reference]
+              xml.tag! :authcode, parsed_authorization[:auth_code]
+              xml.tag! :method, type
+            end
+
+            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! :capturemethod, 'ecomm'
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_purchase_or_authorization_request_with_credit_card_request(type, money, credit_card, options)
+        xml = Builder::XmlMarkup.new indent: 2
+        xml.instruct!
+        xml.tag! :Request, version: '2' do
+          add_authentication(xml)
+
+          xml.tag! :Transaction do
+            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! :capturemethod, 'ecomm'
+            end
+          end
+        end
+        xml.target!
+      end
+
+      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?
+
+        xml = Builder::XmlMarkup.new indent: 2
+        xml.instruct!
+        xml.tag! :Request, version: '2' do
+          add_authentication(xml)
+          xml.tag! :Transaction do
+            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! :capturemethod, 'cont_auth'
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_transaction_refund_request(money, authorization)
+        parsed_authorization = parse_authorization_string(authorization)
+        xml = Builder::XmlMarkup.new indent: 2
+        xml.instruct!
+        xml.tag! :Request, version: '2' do
+          add_authentication(xml)
+          xml.tag! :Transaction do
+            xml.tag! :HistoricTxn do
+              xml.tag! :reference, parsed_authorization[:reference]
+              xml.tag! :method, TRANSACTION_REFUND_TYPE
+            end
+            unless money.nil?
+              xml.tag! :TxnDetails do
+                xml.tag! :amount, amount(money)
+                xml.tag! :capturemethod, 'ecomm'
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_credit_request(money, credit_card, options)
+        xml = Builder::XmlMarkup.new indent: 2
+        xml.instruct!
+        xml.tag! :Request, version: '2' do
+          add_authentication(xml)
+          xml.tag! :Transaction do
+            xml.tag! :CardTxn do
+              xml.tag! :method, REFUND_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)
+              xml.tag! :capturemethod, 'ecomm'
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def add_authentication(xml)
+        xml.tag! :Authentication do
+          xml.tag! :client, @options[:login]
+          xml.tag! :password, @options[:password]
+        end
+      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)
+
+          xml.tag! :Cv2Avs do
+            xml.tag! :cv2, credit_card.verification_value if credit_card.verification_value?
+            if address
+              xml.tag! :street_address1, address[:address1] unless address[:address1].blank?
+              xml.tag! :street_address2, address[:address2] unless address[:address2].blank?
+              xml.tag! :street_address3, address[:address3] unless address[:address3].blank?
+              xml.tag! :street_address4, address[:address4] unless address[:address4].blank?
+              xml.tag! :postcode, address[:zip] unless address[:zip].blank?
+            end
+
+            # The ExtendedPolicy defines what to do when the passed data
+            # matches, or not...
+            #
+            # All of the following elements MUST be present for the
+            # xml to be valid (or can drop the ExtendedPolicy and use
+            # 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
+              xml.tag! :postcode_policy,
+                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
+            end
+          end
+        end
+      end
+
+      def commit(request)
+        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]}")
+      end
+
+      def format_date(month, year)
+        "#{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.elements.to_a.each do |node|
+          parse_element(response, node)
+        end
+
+        response
+      end
+
+      def parse_element(response, node)
+        if node.has_elements?
+          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)
+      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 }
+      end
+    end
+  end
+end