activemerchant 1.38.0 → 1.79.2

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

@@ -18,7 +18,10 @@ module ActiveMerchant #:nodoc:
         :authorization => 'DEFERRED',
         :capture => 'RELEASE',
         :void => 'VOID',
-        :abort => 'ABORT'
+        :abort => 'ABORT',
+        :store => 'TOKEN',
+        :unstore => 'REMOVETOKEN',
+        :repeat => 'REPEAT'
       }
 
       CREDIT_CARDS = {
@@ -34,17 +37,42 @@ module ActiveMerchant #:nodoc:
         :jcb => "JCB"
       }
 
-      ELECTRON = /^(424519|42496[23]|450875|48440[6-8]|4844[1-5][1-5]|4917[3-5][0-9]|491880)\d{10}(\d{3})?$/
-
-      AVS_CVV_CODE = {
+      AVS_CODE = {
         "NOTPROVIDED" => nil,
         "NOTCHECKED" => 'X',
         "MATCHED" => 'Y',
         "NOTMATCHED" => 'N'
       }
 
+      CVV_CODE = {
+        "NOTPROVIDED" => 'S',
+        "NOTCHECKED" => 'X',
+        "MATCHED" => 'M',
+        "NOTMATCHED" => 'N'
+      }
+
+      OPTIONAL_REQUEST_FIELDS = {
+        paypal_callback_url: :PayPalCallbackURL,
+        basket: :Basket,
+        gift_aid_payment: :GiftAidPayment ,
+        apply_avscv2: :ApplyAVSCV2 ,
+        apply_3d_secure: :Apply3DSecure,
+        account_type: :AccountType,
+        billing_agreement: :BillingAgreement,
+        basket_xml: :BasketXML,
+        customer_xml: :CustomerXML,
+        surcharge_xml: :SurchargeXML,
+        vendor_data: :VendorData,
+        language: :Language,
+        website: :Website,
+        recipient_account_number: :FIRecipientAcctNumber ,
+        recipient_surname: :FIRecipientSurname ,
+        recipient_postcode: :FIRecipientPostcode ,
+        recipient_dob: :FIRecipientDoB
+      }
+
       self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :switch, :solo, :maestro, :diners_club]
-      self.supported_countries = ['GB']
+      self.supported_countries = ['GB', 'IE']
       self.default_currency = 'GBP'
 
       self.homepage_url = 'http://www.sagepay.com'
@@ -55,29 +83,29 @@ module ActiveMerchant #:nodoc:
         super
       end
 
-      def purchase(money, credit_card, options = {})
+      def purchase(money, payment_method, options = {})
         requires!(options, :order_id)
 
         post = {}
 
         add_amount(post, money, options)
         add_invoice(post, options)
-        add_credit_card(post, credit_card)
+        add_payment_method(post, payment_method, options)
         add_address(post, options)
         add_customer_data(post, options)
         add_optional_data(post, options)
 
-        commit(:purchase, post)
+        commit((past_purchase_reference?(payment_method) ? :repeat : :purchase), post)
       end
 
-      def authorize(money, credit_card, options = {})
+      def authorize(money, payment_method, options = {})
         requires!(options, :order_id)
 
         post = {}
 
         add_amount(post, money, options)
         add_invoice(post, options)
-        add_credit_card(post, credit_card)
+        add_payment_method(post, payment_method, options)
         add_address(post, options)
         add_customer_data(post, options)
         add_optional_data(post, options)
@@ -110,7 +138,7 @@ module ActiveMerchant #:nodoc:
 
         post = {}
 
-        add_credit_reference(post, identification)
+        add_related_reference(post, identification)
         add_amount(post, money, options)
         add_invoice(post, options)
 
@@ -118,11 +146,54 @@ module ActiveMerchant #:nodoc:
       end
 
       def credit(money, identification, options = {})
-        deprecated CREDIT_DEPRECATION_MESSAGE
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options)
       end
 
+      def store(credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_currency(post, 0, options)
+
+        commit(:store, post)
+      end
+
+      def unstore(token, options = {})
+        post = {}
+        add_token(post, token)
+        commit(:unstore, post)
+      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 supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(%r((&?CardNumber=)\d+(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?CV2=)\d+(&?)), '\1[FILTERED]\2')
+      end
+
       private
+      def truncate(value, max_size)
+        return nil unless value
+        return value.to_s if CGI.escape(value.to_s).length <= max_size
+
+        if value.size > max_size
+          truncate(super(value, max_size), max_size)
+        else
+          truncate(value.to_s.chop, max_size)
+        end
+      end
+
       def add_reference(post, identification)
         order_id, transaction_id, authorization, security_key = identification.split(';')
 
@@ -132,7 +203,7 @@ module ActiveMerchant #:nodoc:
         add_pair(post, :SecurityKey, security_key)
       end
 
-      def add_credit_reference(post, identification)
+      def add_related_reference(post, identification)
         order_id, transaction_id, authorization, security_key = identification.split(';')
 
         add_pair(post, :RelatedVendorTxCode, order_id)
@@ -147,55 +218,76 @@ module ActiveMerchant #:nodoc:
         add_pair(post, :Currency, currency, :required => true)
       end
 
+      def add_currency(post, money, options)
+        currency = options[:currency] || currency(money)
+        add_pair(post, :Currency, currency, :required => true)
+      end
+
       # doesn't actually use the currency -- dodgy!
       def add_release_amount(post, money, options)
         add_pair(post, :ReleaseAmount, amount(money), :required => true)
       end
 
       def add_customer_data(post, options)
-        add_pair(post, :CustomerEMail, options[:email][0,255]) unless options[:email].blank?
-        add_pair(post, :BillingPhone, options[:phone].gsub(/[^0-9+]/, '')[0,20]) unless options[:phone].blank?
+        add_pair(post, :CustomerEMail, truncate(options[:email], 255)) unless options[:email].blank?
         add_pair(post, :ClientIPAddress, options[:ip])
       end
 
       def add_optional_data(post, options)
-        add_pair(post, :GiftAidPayment, options[:gift_aid_payment]) unless options[:gift_aid_payment].blank?
-        add_pair(post, :Apply3DSecure, options[:apply_3d_secure]) unless options[:apply_3d_secure].blank?
+        add_pair(post, :CreateToken, 1) unless options[:store].blank?
+
+        OPTIONAL_REQUEST_FIELDS.each do |gateway_option, sagepay_field|
+          add_pair(post, sagepay_field, options[gateway_option])
+        end
       end
 
       def add_address(post, options)
         if billing_address = options[:billing_address] || options[:address]
-          first_name, last_name = parse_first_and_last_name(billing_address[:name])
-          add_pair(post, :BillingSurname, last_name)
-          add_pair(post, :BillingFirstnames, first_name)
-          add_pair(post, :BillingAddress1, billing_address[:address1])
-          add_pair(post, :BillingAddress2, billing_address[:address2])
-          add_pair(post, :BillingCity, billing_address[:city])
-          add_pair(post, :BillingState, billing_address[:state]) if billing_address[:country] == 'US'
-          add_pair(post, :BillingCountry, billing_address[:country])
-          add_pair(post, :BillingPostCode, billing_address[:zip])
+          first_name, last_name = split_names(billing_address[:name])
+          add_pair(post, :BillingSurname, truncate(last_name, 20))
+          add_pair(post, :BillingFirstnames, truncate(first_name, 20))
+          add_pair(post, :BillingAddress1, truncate(billing_address[:address1], 100))
+          add_pair(post, :BillingAddress2, truncate(billing_address[:address2], 100))
+          add_pair(post, :BillingCity, truncate(billing_address[:city], 40))
+          add_pair(post, :BillingState, truncate(billing_address[:state], 2)) if is_usa(billing_address[:country])
+          add_pair(post, :BillingCountry, truncate(billing_address[:country], 2))
+          add_pair(post, :BillingPhone, sanitize_phone(billing_address[:phone]))
+          add_pair(post, :BillingPostCode, truncate(billing_address[:zip], 10))
         end
 
         if shipping_address = options[:shipping_address] || billing_address
-          first_name, last_name = parse_first_and_last_name(shipping_address[:name])
-          add_pair(post, :DeliverySurname, last_name)
-          add_pair(post, :DeliveryFirstnames, first_name)
-          add_pair(post, :DeliveryAddress1, shipping_address[:address1])
-          add_pair(post, :DeliveryAddress2, shipping_address[:address2])
-          add_pair(post, :DeliveryCity, shipping_address[:city])
-          add_pair(post, :DeliveryState, shipping_address[:state]) if shipping_address[:country] == 'US'
-          add_pair(post, :DeliveryCountry, shipping_address[:country])
-          add_pair(post, :DeliveryPostCode, shipping_address[:zip])
+          first_name, last_name = split_names(shipping_address[:name])
+          add_pair(post, :DeliverySurname, truncate(last_name, 20))
+          add_pair(post, :DeliveryFirstnames, truncate(first_name, 20))
+          add_pair(post, :DeliveryAddress1, truncate(shipping_address[:address1], 100))
+          add_pair(post, :DeliveryAddress2, truncate(shipping_address[:address2], 100))
+          add_pair(post, :DeliveryCity, truncate(shipping_address[:city], 40))
+          add_pair(post, :DeliveryState, truncate(shipping_address[:state], 2)) if is_usa(shipping_address[:country])
+          add_pair(post, :DeliveryCountry, truncate(shipping_address[:country], 2))
+          add_pair(post, :DeliveryPhone, sanitize_phone(shipping_address[:phone]))
+          add_pair(post, :DeliveryPostCode, truncate(shipping_address[:zip], 10))
         end
       end
 
       def add_invoice(post, options)
         add_pair(post, :VendorTxCode, sanitize_order_id(options[:order_id]), :required => true)
-        add_pair(post, :Description, options[:description] || options[:order_id])
+        add_pair(post, :Description, truncate(options[:description] || options[:order_id], 100))
+      end
+
+      def add_payment_method(post, payment_method, options)
+        if payment_method.is_a?(String)
+          if past_purchase_reference?(payment_method)
+            add_related_reference(post, payment_method)
+          else
+            add_token_details(post, payment_method, options)
+          end
+        else
+          add_credit_card(post, payment_method)
+        end
       end
 
       def add_credit_card(post, credit_card)
-        add_pair(post, :CardHolder, credit_card.name, :required => true)
+        add_pair(post, :CardHolder, truncate(credit_card.name, 50), :required => true)
         add_pair(post, :CardNumber, credit_card.number, :required => true)
 
         add_pair(post, :ExpiryDate, format_date(credit_card.month, credit_card.year), :required => true)
@@ -209,8 +301,29 @@ module ActiveMerchant #:nodoc:
         add_pair(post, :CV2, credit_card.verification_value)
       end
 
+      def add_token_details(post, token, options)
+        add_token(post, token)
+        add_pair(post, :StoreToken, options[:customer])
+        add_pair(post, :CV2, options[:verification_value])
+      end
+
+      def add_token(post, token)
+        add_pair(post, :Token, token)
+      end
+
       def sanitize_order_id(order_id)
-        order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
+        cleansed = order_id.to_s.gsub(/[^-a-zA-Z0-9._]/, '')
+        truncate(cleansed, 40)
+      end
+
+      def sanitize_phone(phone)
+        return nil unless phone
+        cleansed = phone.to_s.gsub(/[^0-9+]/, '')
+        truncate(cleansed, 20)
+      end
+
+      def is_usa(country)
+        truncate(country, 2) == 'US'
       end
 
       def map_card_type(credit_card)
@@ -218,8 +331,7 @@ module ActiveMerchant #:nodoc:
 
         card_type = card_brand(credit_card).to_sym
 
-        # Check if it is an electron card
-        if card_type == :visa && credit_card.number =~ ELECTRON
+        if card_type == :visa && credit_card.electron?
           CREDIT_CARDS[:electron]
         else
           CREDIT_CARDS[card_type]
@@ -243,19 +355,24 @@ module ActiveMerchant #:nodoc:
           :test => test?,
           :authorization => authorization_from(response, parameters, action),
           :avs_result => {
-            :street_match => AVS_CVV_CODE[ response["AddressResult"] ],
-            :postal_match => AVS_CVV_CODE[ response["PostCodeResult"] ],
+            :street_match => AVS_CODE[ response["AddressResult"] ],
+            :postal_match => AVS_CODE[ response["PostCodeResult"] ],
           },
-          :cvv_result => AVS_CVV_CODE[ response["CV2Result"] ]
+          :cvv_result => CVV_CODE[ response["CV2Result"] ]
         )
       end
 
       def authorization_from(response, params, action)
+        case action
+        when :store
+          response['Token']
+        else
          [ params[:VendorTxCode],
-           response["VPSTxId"],
+           response["VPSTxId"] || params[:VPSTxId],
            response["TxAuthNo"],
-           response["SecurityKey"],
+           response["SecurityKey"] || params[:SecurityKey],
            action ].join(";")
+        end
       end
 
       def abort_or_void_from(identification)
@@ -268,7 +385,11 @@ module ActiveMerchant #:nodoc:
       end
 
       def build_url(action)
-        endpoint = [ :purchase, :authorization ].include?(action) ? "vspdirect-register" : TRANSACTIONS[action].downcase
+        endpoint = case action
+          when :purchase, :authorization then "vspdirect-register"
+          when :store then 'directtoken'
+          else TRANSACTIONS[action].downcase
+        end
         "#{test? ? self.test_url : self.live_url}/#{endpoint}.vsp"
       end
 
@@ -285,9 +406,13 @@ module ActiveMerchant #:nodoc:
         parameters.update(
           :Vendor => @options[:login],
           :TxType => TRANSACTIONS[action],
-          :VPSProtocol => "2.23"
+          :VPSProtocol => @options.fetch(:protocol_version, '3.00')
         )
 
+        if(application_id && (application_id != Gateway.application_id))
+          parameters.update(:ReferrerID => application_id)
+        end
+
         parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
       end
 
@@ -306,19 +431,11 @@ module ActiveMerchant #:nodoc:
         post[key] = value if !value.blank? || options[:required]
       end
 
-      def parse_first_and_last_name(value)
-        name = value.to_s.split(' ')
-
-        last_name = name.pop || ''
-        first_name = name.join(' ')
-        [ first_name[0,20], last_name[0,20] ]
-      end
-
-      def localized_amount(money, currency)
-        amount = amount(money)
-        CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s) ? amount.split('.').first : amount
+      def past_purchase_reference?(payment_method)
+        return false unless payment_method.is_a?(String)
+        payment_method.split(';').last == 'purchase'
       end
     end
+
   end
 end
-

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

@@ -57,12 +57,23 @@ module ActiveMerchant #:nodoc:
       end
 
       def credit(money, authorization, options = {})
-        deprecated CREDIT_DEPRECATION_MESSAGE
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((<CARDNUMBER>)\d+(</CARDNUMBER>))i, '\1[FILTERED]\2').
+          gsub(%r((<CARDCODE>)\d+(</CARDCODE>))i, '\1[FILTERED]\2').
+          gsub(%r((<SECUREKEY>).+(</SECUREKEY>))i, '\1[FILTERED]\2')
+      end
 
       private
+
       def commit(request)
         xml = build_request(request)
         url = test? ? self.test_url : self.live_url
@@ -93,9 +104,7 @@ module ActiveMerchant #:nodoc:
 
         xml.tag! 'AMOUNT', amount(money)
         add_credit_card(xml, creditcard)
-        add_required_params(xml, action, options)
-        add_address(xml, creditcard, options)
-        add_invoice(xml, options)
+        add_params_in_required_order(xml, action, creditcard, options)
         add_more_required_params(xml, options)
 
         xml.target!
@@ -111,7 +120,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'CARDNUMBER', last_four
         end
 
-        add_required_params(xml, action, options)
+        add_params_in_required_order(xml, action, nil, options)
         xml.tag! 'REF_TRANSID', transaction_id
         add_more_required_params(xml, options)
 
@@ -126,13 +135,6 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def expdate(creditcard)
-        year  = sprintf("%.4i", creditcard.year)
-        month = sprintf("%.2i", creditcard.month)
-
-        "#{month}#{year[-2..-1]}"
-      end
-
       def add_customer_data(xml, options)
         if options.has_key? :customer
           xml.tag! 'CUSTOMERID', options[:customer]
@@ -144,6 +146,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_address(xml, creditcard, options)
+        return unless creditcard
 
         if address = options[:billing_address] || options[:address]
           xml.tag!("CUSTOMER_BILL") do
@@ -169,8 +172,16 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'CITY', address[:city].to_s
             xml.tag! 'COMPANY', address[:company].to_s
             xml.tag! 'COUNTRY', address[:country].to_s
-            xml.tag! 'FIRSTNAME', address[:first_name].to_s
-            xml.tag! 'LASTNAME', address[:last_name].to_s
+
+            if address[:name]
+              first_name, last_name = split_names(address[:name])
+              xml.tag! 'FIRSTNAME', first_name
+              xml.tag! 'LASTNAME', last_name
+            else
+              xml.tag! 'FIRSTNAME', address[:first_name].to_s
+              xml.tag! 'LASTNAME', address[:last_name].to_s
+            end
+
             xml.tag! 'STATE', address[:state].blank?  ? 'n/a' : address[:state]
             xml.tag! 'ZIP', address[:zip].to_s
           end
@@ -181,12 +192,6 @@ module ActiveMerchant #:nodoc:
 
       end
 
-      def add_invoice(xml, options)
-        xml.tag! 'NOTE', options[:description] if options[:description]
-        xml.tag! 'INVOICEDESC', options[:invoice_description] if options[:invoice_description]
-        xml.tag! 'INVOICENUM', options[:invoice_number] if options[:invoice_number]
-      end
-
       def add_merchant_key(xml, options)
         xml.tag!("MERCHANT_KEY") do
           xml.tag! 'GROUPID', 0
@@ -195,22 +200,29 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def add_required_params(xml, action, options)
+      # SecureNet requires some of the xml params to be in a certain order.  http://cl.ly/image/3K260E0p0a0n/content.png
+      def add_params_in_required_order(xml, action, creditcard, options)
         xml.tag! 'CODE', TRANSACTIONS[action]
         add_customer_data(xml, options)
+        add_address(xml, creditcard, options)
         xml.tag! 'DCI', 0 # No duplicate checking will be done, except for ORDERID
         xml.tag! 'INSTALLMENT_SEQUENCENUM', 1
+        xml.tag! 'INVOICEDESC', options[:invoice_description] if options[:invoice_description]
+        xml.tag! 'INVOICENUM', options[:invoice_number] if options[:invoice_number]
         add_merchant_key(xml, options)
         xml.tag! 'METHOD', 'CC'
-        xml.tag! 'ORDERID', options[:order_id]
+        xml.tag! 'NOTE', options[:description] if options[:description]
+        xml.tag! 'ORDERID', truncate(options[:order_id], 25)
         xml.tag! 'OVERRIDE_FROM', 0 # Docs say not required, but doesn't work without it
       end
 
       def add_more_required_params(xml, options)
+        test_mode = options[:test_mode].nil? ? test? : options[:test_mode]
         xml.tag! 'RETAIL_LANENUM', '0'
-        xml.tag! 'TEST', 'TRUE' if test?
+        xml.tag! 'TEST', test_mode ? 'TRUE' : 'FALSE'
         xml.tag! 'TOTAL_INSTALLMENTCOUNT', 0
         xml.tag! 'TRANSACTION_SERVICE', 0
+        xml.tag! 'DEVELOPERID', options[:developer_id] if options[:developer_id]
       end
 
       def success?(response)
@@ -218,11 +230,6 @@ module ActiveMerchant #:nodoc:
       end
 
       def message_from(response)
-        if response[:response_code].to_i == DECLINED
-          return CVVResult.messages[ response[:card_code_response_code] ] if CARD_CODE_ERRORS.include?(response[:card_code_response_code])
-          return AVSResult.messages[ response[:avs_result_code] ] if AVS_ERRORS.include?(response[:avs_result_code])
-        end
-
         return response[:response_reason_text].nil? ? '' : response[:response_reason_text][0..-1]
       end
 
@@ -259,4 +266,3 @@ module ActiveMerchant #:nodoc:
     end
   end
 end
-