activemerchant 1.42.6 → 1.90.0

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

@@ -0,0 +1,307 @@
+require 'nokogiri'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    #
+    # == Monei gateway
+    # This class implements Monei gateway for Active Merchant. For more information about Monei
+    # gateway please go to http://www.monei.net
+    #
+    # === Setup
+    # In order to set-up the gateway you need four paramaters: sender_id, channel_id, login and pwd.
+    # Request that data to Monei.
+    class MoneiGateway < Gateway
+      self.test_url = 'https://test.monei-api.net/payment/ctpe'
+      self.live_url = 'https://monei-api.net/payment/ctpe'
+
+      self.supported_countries = ['AD', 'AT', 'BE', 'BG', 'CA', 'CH', 'CY', 'CZ', 'DE', 'DK', 'EE', 'ES', 'FI', 'FO', 'FR', 'GB', 'GI', 'GR', 'HU', 'IE', 'IL', 'IS', 'IT', 'LI', 'LT', 'LU', 'LV', 'MT', 'NL', 'NO', 'PL', 'PT', 'RO', 'SE', 'SI', 'SK', 'TR', 'US', 'VA']
+      self.default_currency = 'EUR'
+      self.supported_cardtypes = [:visa, :master, :maestro, :jcb, :american_express]
+
+      self.homepage_url = 'http://www.monei.net/'
+      self.display_name = 'Monei'
+
+      # Constructor
+      #
+      # options - Hash containing the gateway credentials, ALL MANDATORY
+      #           :sender_id  Sender ID
+      #           :channel_id Channel ID
+      #           :login      User login
+      #           :pwd        User password
+      #
+      def initialize(options={})
+        requires!(options, :sender_id, :channel_id, :login, :pwd)
+        super
+      end
+
+      # Public: Performs purchase operation
+      #
+      # money       - Amount of purchase
+      # credit_card - Credit card
+      # options     - Hash containing purchase options
+      #               :order_id         Merchant created id for the purchase
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created purchase description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object
+      def purchase(money, credit_card, options={})
+        execute_new_order(:purchase, money, credit_card, options)
+      end
+
+      # Public: Performs authorization operation
+      #
+      # money       - Amount to authorize
+      # credit_card - Credit card
+      # options     - Hash containing authorization options
+      #               :order_id         Merchant created id for the authorization
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created authorization description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object
+      def authorize(money, credit_card, options={})
+        execute_new_order(:authorize, money, credit_card, options)
+      end
+
+      # Public: Performs capture operation on previous authorization
+      #
+      # money         - Amount to capture
+      # authorization - Reference to previous authorization, obtained from response object returned by authorize
+      # options       - Hash containing capture options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #                 :description      Merchant created authorization description (optional)
+      #                 :currency         Sale currency to override money object or default (optional)
+      #
+      # Note: you should pass either order_id or description
+      #
+      # Returns Active Merchant response object
+      def capture(money, authorization, options={})
+        execute_dependant(:capture, money, authorization, options)
+      end
+
+      # Public: Refunds from previous purchase
+      #
+      # money         - Amount to refund
+      # authorization - Reference to previous purchase, obtained from response object returned by purchase
+      # options       - Hash containing refund options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #                 :description      Merchant created authorization description (optional)
+      #                 :currency         Sale currency to override money object or default (optional)
+      #
+      # Note: you should pass either order_id or description
+      #
+      # Returns Active Merchant response object
+      def refund(money, authorization, options={})
+        execute_dependant(:refund, money, authorization, options)
+      end
+
+      # Public: Voids previous authorization
+      #
+      # authorization - Reference to previous authorization, obtained from response object returned by authorize
+      # options       - Hash containing capture options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #
+      # Returns Active Merchant response object
+      def void(authorization, options={})
+        execute_dependant(:void, nil, authorization, options)
+      end
+
+      # Public: Verifies credit card. Does this by doing a authorization of 1.00 Euro and then voiding it.
+      #
+      # credit_card - Credit card
+      # options     - Hash containing authorization options
+      #               :order_id         Merchant created id for the authorization
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created authorization description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object of Authorization operation
+      def verify(credit_card, options={})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(100, credit_card, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
+      private
+
+      # Private: Execute purchase or authorize operation
+      def execute_new_order(action, money, credit_card, options)
+        request = build_request do |xml|
+          add_identification_new_order(xml, options)
+          add_payment(xml, action, money, options)
+          add_account(xml, credit_card)
+          add_customer(xml, credit_card, options)
+        end
+
+        commit(request)
+      end
+
+      # Private: Execute operation that depends on authorization code from previous purchase or authorize operation
+      def execute_dependant(action, money, authorization, options)
+        request = build_request do |xml|
+          add_identification_authorization(xml, authorization, options)
+          add_payment(xml, action, money, options)
+        end
+
+        commit(request)
+      end
+
+      # Private: Build XML wrapping code yielding to code to fill the transaction information
+      def build_request
+        builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+          xml.Request(:version => '1.0') do
+            xml.Header { xml.Security(:sender => @options[:sender_id]) }
+            xml.Transaction(:mode => test? ? 'CONNECTOR_TEST' : 'LIVE', :response => 'SYNC', :channel => @options[:channel_id]) do
+              xml.User(:login => @options[:login], :pwd => @options[:pwd])
+              yield xml
+            end
+          end
+        end
+        builder.to_xml
+      end
+
+      # Private: Add identification part to XML for new orders
+      def add_identification_new_order(xml, options)
+        requires!(options, :order_id)
+        xml.Identification do
+          xml.TransactionID options[:order_id]
+        end
+      end
+
+      # Private: Add identification part to XML for orders that depend on authorization from previous operation
+      def add_identification_authorization(xml, authorization, options)
+        xml.Identification do
+          xml.ReferenceID authorization
+          xml.TransactionID options[:order_id]
+        end
+      end
+
+      # Private: Add payment part to XML
+      def add_payment(xml, action, money, options)
+        code = tanslate_payment_code(action)
+
+        xml.Payment(:code => code) do
+          xml.Presentation do
+            xml.Amount amount(money)
+            xml.Currency options[:currency] || currency(money)
+            xml.Usage options[:description] || options[:order_id]
+          end unless money.nil?
+        end
+      end
+
+      # Private: Add account part to XML
+      def add_account(xml, credit_card)
+        xml.Account do
+          xml.Holder credit_card.name
+          xml.Number credit_card.number
+          xml.Brand credit_card.brand.upcase
+          xml.Expiry(:month => credit_card.month, :year => credit_card.year)
+          xml.Verification credit_card.verification_value
+        end
+      end
+
+      # Private: Add customer part to XML
+      def add_customer(xml, credit_card, options)
+        requires!(options, :billing_address)
+        address = options[:billing_address]
+        xml.Customer do
+          xml.Name do
+            xml.Given credit_card.first_name
+            xml.Family credit_card.last_name
+          end
+          xml.Address do
+            xml.Street address[:address1].to_s
+            xml.Zip address[:zip].to_s
+            xml.City address[:city].to_s
+            xml.State address[:state].to_s if address.has_key? :state
+            xml.Country address[:country].to_s
+          end
+          xml.Contact do
+            xml.Email options[:email] || 'noemail@monei.net'
+            xml.Ip options[:ip] || '0.0.0.0'
+          end
+        end
+      end
+
+      # Private: Parse XML response from Monei servers
+      def parse(body)
+        xml = Nokogiri::XML(body)
+        {
+            :unique_id => xml.xpath('//Response/Transaction/Identification/UniqueID').text,
+            :status => translate_status_code(xml.xpath('//Response/Transaction/Processing/Status/@code').text),
+            :reason => translate_status_code(xml.xpath('//Response/Transaction/Processing/Reason/@code').text),
+            :message => xml.xpath('//Response/Transaction/Processing/Return').text
+        }
+      end
+
+      # Private: Send XML transaction to Monei servers and create AM response
+      def commit(xml)
+        url = (test? ? test_url : live_url)
+
+        response = parse(ssl_post(url, post_data(xml), 'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8'))
+
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          authorization: authorization_from(response),
+          test: test?,
+          error_code: error_code_from(response)
+        )
+      end
+
+      # Private: Decide success from servers response
+      def success_from(response)
+        response[:status] == :success || response[:status] == :new
+      end
+
+      # Private: Get message from servers response
+      def message_from(response)
+        response[:message]
+      end
+
+      # Private: Get error code from servers response
+      def error_code_from(response)
+        success_from(response) ? nil : STANDARD_ERROR_CODE[:card_declined]
+      end
+
+      # Private: Get authorization code from servers response
+      def authorization_from(response)
+        response[:unique_id]
+      end
+
+      # Private: Encode POST parameters
+      def post_data(xml)
+        "load=#{CGI.escape(xml)}"
+      end
+
+      # Private: Translate Monei status code to native ruby symbols
+      def translate_status_code(code)
+        {
+            '00' => :success,
+            '40' => :neutral,
+            '59' => :waiting_bank,
+            '60' => :rejected_bank,
+            '64' => :waiting_risk,
+            '65' => :rejected_risk,
+            '70' => :rejected_validation,
+            '80' => :waiting,
+            '90' => :new
+        }[code]
+      end
+
+      # Private: Translate AM operations to Monei operations codes
+      def tanslate_payment_code(action)
+        {
+            :purchase => 'CC.DB',
+            :authorize => 'CC.PA',
+            :capture => 'CC.CP',
+            :refund => 'CC.RF',
+            :void => 'CC.RV'
+        }[action]
+      end
+    end
+  end
+end

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

@@ -2,7 +2,6 @@ require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-
     # To learn more about the Moneris gateway, please contact
     # eselectplus@moneris.com for a copy of their integration guide. For
     # information on remote testing, please see "Test Environment Penny Value
@@ -33,7 +32,9 @@ module ActiveMerchant #:nodoc:
       def initialize(options = {})
         requires!(options, :login, :password)
         @cvv_enabled = options[:cvv_enabled]
-        options = { :crypt_type => 7 }.merge(options)
+        @avs_enabled = options[:avs_enabled]
+        @cof_enabled = options[:cof_enabled]
+        options[:crypt_type] = 7 unless options.has_key?(:crypt_type)
         super
       end
 
@@ -45,12 +46,19 @@ module ActiveMerchant #:nodoc:
       def authorize(money, creditcard_or_datakey, options = {})
         requires!(options, :order_id)
         post = {}
-        add_payment_source(post, creditcard_or_datakey)
-        post[:amount]     = amount(money)
-        post[:order_id]   = options[:order_id]
-        post[:cust_id]    = options[:customer]
+        add_payment_source(post, creditcard_or_datakey, options)
+        post[:amount] = amount(money)
+        post[:order_id] = options[:order_id]
+        post[:address] = options[:billing_address] || options[:address]
         post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
-        action = (post[:data_key].blank?) ? 'preauth' : 'res_preauth_cc'
+        add_cof(post, options) if @cof_enabled
+        action = if post[:cavv]
+                   'cavv_preauth'
+                 elsif post[:data_key].blank?
+                   'preauth'
+                 else
+                   'res_preauth_cc'
+                 end
         commit(action, post)
       end
 
@@ -61,12 +69,19 @@ module ActiveMerchant #:nodoc:
       def purchase(money, creditcard_or_datakey, options = {})
         requires!(options, :order_id)
         post = {}
-        add_payment_source(post, creditcard_or_datakey)
-        post[:amount]     = amount(money)
-        post[:order_id]   = options[:order_id]
-        post[:cust_id]    = options[:customer]
+        add_payment_source(post, creditcard_or_datakey, options)
+        post[:amount] = amount(money)
+        post[:order_id] = options[:order_id]
+        post[:address] = options[:billing_address] || options[:address]
         post[:crypt_type] = options[:crypt_type] || @options[:crypt_type]
-        action = (post[:data_key].blank?) ? 'purchase' : 'res_purchase_cc'
+        add_cof(post, options) if @cof_enabled
+        action = if post[:cavv]
+                   'cavv_purchase'
+                 elsif post[:data_key].blank?
+                   'purchase'
+                 else
+                   'res_purchase_cc'
+                 end
         commit(action, post)
       end
 
@@ -111,7 +126,7 @@ module ActiveMerchant #:nodoc:
       # Moneris interface consistent with other gateways. (See +capture+ for
       # details.)
       def credit(money, authorization, options = {})
-        deprecated CREDIT_DEPRECATION_MESSAGE
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 
@@ -119,6 +134,13 @@ module ActiveMerchant #:nodoc:
         commit 'refund', crediting_params(authorization, :amount => amount(money))
       end
 
+      def verify(credit_card, options={})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(100, credit_card, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
       def store(credit_card, options = {})
         post = {}
         post[:pan] = credit_card.number
@@ -142,22 +164,51 @@ module ActiveMerchant #:nodoc:
         commit('res_update_cc', post)
       end
 
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((<store_id>).+(</store_id>)), '\1[FILTERED]\2').
+          gsub(%r((<api_token>).+(</api_token>)), '\1[FILTERED]\2').
+          gsub(%r((<pan>).+(</pan>)), '\1[FILTERED]\2').
+          gsub(%r((<cvd_value>).+(</cvd_value>)), '\1[FILTERED]\2').
+          gsub(%r((<cavv>).+(</cavv>)), '\1[FILTERED]\2')
+      end
+
       private # :nodoc: all
 
       def expdate(creditcard)
-        sprintf("%.4i", creditcard.year)[-2..-1] + sprintf("%.2i", creditcard.month)
+        sprintf('%.4i', creditcard.year)[-2..-1] + sprintf('%.2i', creditcard.month)
       end
 
-      def add_payment_source(post, source)
-        if source.is_a?(String)
-          post[:data_key]   = source
+      def add_payment_source(post, payment_method, options)
+        if payment_method.is_a?(String)
+          post[:data_key] = payment_method
+          post[:cust_id] = options[:customer]
         else
-          post[:pan]        = source.number
-          post[:expdate]    = expdate(source)
-          post[:cvd_value]  = source.verification_value if source.verification_value?
+          if payment_method.respond_to?(:track_data) && payment_method.track_data.present?
+            post[:pos_code] = '00'
+            post[:track2] = payment_method.track_data
+          else
+            post[:pan] = payment_method.number
+            post[:expdate] = expdate(payment_method)
+            post[:cvd_value] = payment_method.verification_value if payment_method.verification_value?
+            post[:cavv] = payment_method.payment_cryptogram if payment_method.is_a?(NetworkTokenizationCreditCard)
+            post[:wallet_indicator] = wallet_indicator(payment_method.source.to_s) if payment_method.is_a?(NetworkTokenizationCreditCard)
+            post[:crypt_type] = (payment_method.eci || 7) if payment_method.is_a?(NetworkTokenizationCreditCard)
+          end
+          post[:cust_id] = options[:customer] || payment_method.name
         end
       end
 
+      def add_cof(post, options)
+        post[:issuer_id] = options[:issuer_id] if options[:issuer_id]
+        post[:payment_indicator] = options[:payment_indicator] if options[:payment_indicator]
+        post[:payment_information] = options[:payment_information] if options[:payment_information]
+      end
+
       # Common params used amongst the +credit+, +void+ and +capture+ methods
       def crediting_params(authorization, options = {})
         {
@@ -183,11 +234,14 @@ module ActiveMerchant #:nodoc:
         raw = ssl_post(url, data)
         response = parse(raw)
 
-        Response.new(successful?(response), message_from(response[:message]), response,
-          :test          => test?,
-          :cvv_result    => response[:cvd_result_code].try(:last),
-          :authorization => authorization_from(response)
-        )
+        Response.new(
+          successful?(response),
+          message_from(response[:message]),
+          response,
+          :test => test?,
+          :avs_result => {:code => response[:avs_result_code]},
+          :cvv_result => response[:cvd_result_code] && response[:cvd_result_code][-1, 1],
+          :authorization => authorization_from(response))
       end
 
       # Generates a Moneris authorization string of the form 'trans_id;receipt_id'.
@@ -201,11 +255,11 @@ module ActiveMerchant #:nodoc:
       def successful?(response)
         response[:response_code] &&
         response[:complete] &&
-        (0..49).include?(response[:response_code].to_i)
+        (0..49).cover?(response[:response_code].to_i)
       end
 
       def parse(xml)
-        response = { :message => "Global Error Receipt", :complete => false }
+        response = { :message => 'Global Error Receipt', :complete => false }
         hashify_xml!(xml, response)
         response
       end
@@ -219,10 +273,10 @@ module ActiveMerchant #:nodoc:
       end
 
       def post_data(action, parameters = {})
-        xml   = REXML::Document.new
-        root  = xml.add_element("request")
-        root.add_element("store_id").text  = options[:login]
-        root.add_element("api_token").text = options[:password]
+        xml = REXML::Document.new
+        root = xml.add_element('request')
+        root.add_element('store_id').text = options[:login]
+        root.add_element('api_token').text = options[:password]
         root.add_element(transaction_element(action, parameters))
 
         xml.to_s
@@ -233,8 +287,13 @@ module ActiveMerchant #:nodoc:
 
         # Must add the elements in the correct order
         actions[action].each do |key|
-          if((key == :cvd_info) && @cvv_enabled)
-            transaction.add_element(cvd_element(parameters[:cvd_value]))
+          case key
+          when :avs_info
+            transaction.add_element(avs_element(parameters[:address])) if @avs_enabled && parameters[:address]
+          when :cvd_info
+            transaction.add_element(cvd_element(parameters[:cvd_value])) if @cvv_enabled
+          when :cof_info
+            transaction.add_element(credential_on_file(parameters)) if @cof_enabled && cof_details_present?(parameters)
           else
             transaction.add_element(key.to_s).text = parameters[key] unless parameters[key].blank?
           end
@@ -243,52 +302,75 @@ module ActiveMerchant #:nodoc:
         transaction
       end
 
+      def avs_element(address)
+        full_address = "#{address[:address1]} #{address[:address2]}"
+        tokens = full_address.split(/\s+/)
+
+        element = REXML::Element.new('avs_info')
+        element.add_element('avs_street_number').text = tokens.select { |x| x =~ /\d/ }.join(' ')
+        element.add_element('avs_street_name').text = tokens.reject { |x| x =~ /\d/ }.join(' ')
+        element.add_element('avs_zipcode').text = address[:zip]
+        element
+      end
+
       def cvd_element(cvd_value)
         element = REXML::Element.new('cvd_info')
         if cvd_value
-          element.add_element('cvd_indicator').text = "1"
+          element.add_element('cvd_indicator').text = '1'
           element.add_element('cvd_value').text = cvd_value
         else
-          element.add_element('cvd_indicator').text = "0"
+          element.add_element('cvd_indicator').text = '0'
         end
         element
       end
 
-      def message_from(message)
-        return 'Unspecified error' if message.blank?
-        message.gsub(/[^\w]/, ' ').split.join(" ").capitalize
+      def cof_details_present?(parameters)
+        parameters[:issuer_id] && parameters[:payment_indicator] && parameters[:payment_information]
       end
 
-      # Make a Ruby type out of the response string
-      def normalize(field)
-        case field
-          when "true"     then true
-          when "false"    then false
-          when '', "null" then nil
-          else field
-        end
+      def credential_on_file(parameters)
+        issuer_id = parameters[:issuer_id]
+        payment_indicator = parameters[:payment_indicator]
+        payment_information = parameters[:payment_information]
+
+        cof_info = REXML::Element.new('cof_info')
+        cof_info.add_element('issuer_id').text = issuer_id
+        cof_info.add_element('payment_indicator').text = payment_indicator
+        cof_info.add_element('payment_information').text = payment_information
+        cof_info
+      end
+
+      def wallet_indicator(token_source)
+        return 'APP' if token_source == 'apple_pay'
+        return 'ANP' if token_source == 'android_pay'
+        nil
+      end
+
+      def message_from(message)
+        return 'Unspecified error' if message.blank?
+        message.gsub(/[^\w]/, ' ').split.join(' ').capitalize
       end
 
       def actions
         {
-          "purchase"           => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type, :cvd_info],
-          "preauth"            => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type, :cvd_info],
-          "command"            => [:order_id],
-          "refund"             => [:order_id, :amount, :txn_number, :crypt_type],
-          "indrefund"          => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
-          "completion"         => [:order_id, :comp_amount, :txn_number, :crypt_type],
-          "purchasecorrection" => [:order_id, :txn_number, :crypt_type],
-          "cavvpurcha"         => [:order_id, :cust_id, :amount, :pan, :expdate, :cav],
-          "cavvpreaut"         => [:order_id, :cust_id, :amount, :pan, :expdate, :cavv],
-          "transact"           => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
-          "Batchcloseall"      => [],
-          "opentotals"         => [:ecr_number],
-          "batchclose"         => [:ecr_number],
-          "res_add_cc"         => [:pan, :expdate, :crypt_type],
-          "res_delete"         => [:data_key],
-          "res_update_cc"      => [:data_key, :pan, :expdate, :crypt_type],
-          "res_purchase_cc"    => [:data_key, :order_id, :cust_id, :amount, :crypt_type],
-          "res_preauth_cc"     => [:data_key, :order_id, :cust_id, :amount, :crypt_type]
+            'purchase' => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type, :avs_info, :cvd_info, :track2, :pos_code, :cof_info],
+            'preauth' => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type, :avs_info, :cvd_info, :track2, :pos_code, :cof_info],
+            'command' => [:order_id],
+            'refund' => [:order_id, :amount, :txn_number, :crypt_type],
+            'indrefund' => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+            'completion' => [:order_id, :comp_amount, :txn_number, :crypt_type],
+            'purchasecorrection' => [:order_id, :txn_number, :crypt_type],
+            'cavv_preauth' => [:order_id, :cust_id, :amount, :pan, :expdate, :cavv, :crypt_type, :wallet_indicator],
+            'cavv_purchase' => [:order_id, :cust_id, :amount, :pan, :expdate, :cavv, :crypt_type, :wallet_indicator],
+            'transact' => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+            'Batchcloseall' => [],
+            'opentotals' => [:ecr_number],
+            'batchclose' => [:ecr_number],
+            'res_add_cc' => [:pan, :expdate, :crypt_type, :cof_info],
+            'res_delete' => [:data_key],
+            'res_update_cc' => [:data_key, :pan, :expdate, :crypt_type],
+            'res_purchase_cc' => [:data_key, :order_id, :cust_id, :amount, :crypt_type, :cof_info],
+            'res_preauth_cc' => [:data_key, :order_id, :cust_id, :amount, :crypt_type, :cof_info]
         }
       end
     end