activemerchant 1.42.6 → 1.90.0

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

@@ -18,32 +18,58 @@ module ActiveMerchant #:nodoc:
         :authorization => 'DEFERRED',
         :capture => 'RELEASE',
         :void => 'VOID',
-        :abort => 'ABORT'
+        :abort => 'ABORT',
+        :store => 'TOKEN',
+        :unstore => 'REMOVETOKEN',
+        :repeat => 'REPEAT'
       }
 
       CREDIT_CARDS = {
-        :visa => "VISA",
-        :master => "MC",
-        :delta => "DELTA",
-        :solo => "SOLO",
-        :switch => "MAESTRO",
-        :maestro => "MAESTRO",
-        :american_express => "AMEX",
-        :electron => "UKE",
-        :diners_club => "DC",
-        :jcb => "JCB"
+        :visa => 'VISA',
+        :master => 'MC',
+        :delta => 'DELTA',
+        :maestro => 'MAESTRO',
+        :american_express => 'AMEX',
+        :electron => 'UKE',
+        :diners_club => 'DC',
+        :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_CODE = {
+        'NOTPROVIDED' => nil,
+        'NOTCHECKED' => 'X',
+        'MATCHED' => 'Y',
+        'NOTMATCHED' => 'N'
+      }
+
+      CVV_CODE = {
+        'NOTPROVIDED' => 'S',
+        'NOTCHECKED' => 'X',
+        'MATCHED' => 'M',
+        'NOTMATCHED' => 'N'
+      }
 
-      AVS_CVV_CODE = {
-        "NOTPROVIDED" => nil,
-        "NOTCHECKED" => 'X',
-        "MATCHED" => 'Y',
-        "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_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :maestro, :diners_club]
       self.supported_countries = ['GB', 'IE']
       self.default_currency = 'GBP'
 
@@ -55,29 +81,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 +136,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 +144,55 @@ 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 +202,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,84 +217,115 @@ 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, truncate_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)
-
-        if requires_start_date_or_issue_number?(credit_card)
-          add_pair(post, :StartDate, format_date(credit_card.start_month, credit_card.start_year))
-          add_pair(post, :IssueNumber, credit_card.issue_number)
-        end
         add_pair(post, :CardType, map_card_type(credit_card))
 
         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 truncate_description(description)
-        return nil unless description
-        description[0, 100]
+      def is_usa(country)
+        truncate(country, 2) == 'US'
       end
 
       def map_card_type(credit_card)
-        raise ArgumentError, "The credit card type must be provided" if card_brand(credit_card).blank?
+        raise ArgumentError, 'The credit card type must be provided' if card_brand(credit_card).blank?
 
         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]
@@ -235,32 +336,37 @@ module ActiveMerchant #:nodoc:
       def format_date(month, year)
         return nil if year.blank? || month.blank?
 
-        year  = sprintf("%.4i", year)
-        month = sprintf("%.2i", month)
+        year  = sprintf('%.4i', year)
+        month = sprintf('%.2i', month)
 
         "#{month}#{year[-2..-1]}"
       end
 
       def commit(action, parameters)
-        response = parse( ssl_post(url_for(action), post_data(action, parameters)) )
+        response = parse(ssl_post(url_for(action), post_data(action, parameters)))
 
-        Response.new(response["Status"] == APPROVED, message_from(response), response,
+        Response.new(response['Status'] == APPROVED, message_from(response), response,
           :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)
-         [ params[:VendorTxCode],
-           response["VPSTxId"],
-           response["TxAuthNo"],
-           response["SecurityKey"],
-           action ].join(";")
+        case action
+        when :store
+          response['Token']
+        else
+          [ params[:VendorTxCode],
+            response['VPSTxId'] || params[:VPSTxId],
+            response['TxAuthNo'],
+            response['SecurityKey'] || params[:SecurityKey],
+            action ].join(';')
+        end
       end
 
       def abort_or_void_from(identification)
@@ -273,12 +379,16 @@ 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
 
       def build_simulator_url(action)
-        endpoint = [ :purchase, :authorization ].include?(action) ? "VSPDirectGateway.asp" : "VSPServerGateway.asp?Service=Vendor#{TRANSACTIONS[action].capitalize}Tx"
+        endpoint = [ :purchase, :authorization ].include?(action) ? 'VSPDirectGateway.asp' : "VSPServerGateway.asp?Service=Vendor#{TRANSACTIONS[action].capitalize}Tx"
         "#{self.simulator_url}/#{endpoint}"
       end
 
@@ -290,10 +400,14 @@ module ActiveMerchant #:nodoc:
         parameters.update(
           :Vendor => @options[:login],
           :TxType => TRANSACTIONS[action],
-          :VPSProtocol => "2.23"
+          :VPSProtocol => @options.fetch(:protocol_version, '3.00')
         )
 
-        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        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
 
       # SagePay returns data in the following format
@@ -311,19 +425,10 @@ 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/sallie_mae.rb

@@ -21,7 +21,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def test?
-        @options[:login] == "TEST0"
+        @options[:login] == 'TEST0'
       end
 
       def authorize(money, creditcard, options = {})
@@ -94,11 +94,11 @@ module ActiveMerchant #:nodoc:
 
       def parse(body)
         h = {}
-        body.gsub!("<html><body><plaintext>", "")
+        body.gsub!('<html><body><plaintext>', '')
         body.
           split("\r\n").
           map do |i|
-            a = i.split("=")
+            a = i.split('=')
             h[a.first] = a.last unless a.first.nil?
           end
         h
@@ -111,33 +111,32 @@ module ActiveMerchant #:nodoc:
 
         case action
         when :sale
-          parameters[:action] = "ns_quicksale_cc"
+          parameters[:action] = 'ns_quicksale_cc'
         when :authonly
-          parameters[:action] = "ns_quicksale_cc"
+          parameters[:action] = 'ns_quicksale_cc'
           parameters[:authonly] = 1
         when :capture
-          parameters[:action] = "ns_quicksale_cc"
+          parameters[:action] = 'ns_quicksale_cc'
         end
 
-        response = parse(ssl_post(self.live_url, parameters.to_post_data) || "")
+        response = parse(ssl_post(self.live_url, parameters.to_post_data) || '')
         Response.new(successful?(response), message_from(response), response,
           :test => test?,
-          :authorization => response["refcode"]
+          :authorization => response['refcode']
         )
       end
 
       def successful?(response)
-        response["Status"] == "Accepted"
+        response['Status'] == 'Accepted'
       end
 
       def message_from(response)
         if successful?(response)
-          "Accepted"
+          'Accepted'
         else
-          response["Reason"].split(":")[2].capitalize unless response["Reason"].nil?
+          response['Reason'].split(':')[2].capitalize unless response['Reason'].nil?
         end
       end
     end
   end
 end
-