activemerchant 1.42.6 → 1.90.0

data/lib/active_merchant/billing/gateways/payflow/payflow_common_api.rb

@@ -10,7 +10,7 @@ module ActiveMerchant #:nodoc:
         # Set the default partner to PayPal
         base.partner = 'PayPal'
 
-        base.supported_countries = ['US', 'CA', 'SG', 'AU']
+        base.supported_countries = ['US', 'CA', 'NZ', 'AU']
 
         base.class_attribute :timeout
         base.timeout = 60
@@ -25,6 +25,13 @@ module ActiveMerchant #:nodoc:
         # subsequent Responses will have a :duplicate parameter set in the params
         # hash.
         base.retry_safe = true
+
+        # Send Payflow requests to PayPal directly by activating the NVP protocol.
+        # Valid XMLPay documents may have issues being parsed correctly by
+        # Payflow but will be accepted by PayPal if a PAYPAL-NVP request header
+        # is declared.
+        base.class_attribute :use_paypal_nvp
+        base.use_paypal_nvp = false
       end
 
       XMLNS = 'http://www.paypal.com/XMLPay'
@@ -36,16 +43,14 @@ module ActiveMerchant #:nodoc:
         :american_express => 'Amex',
         :jcb => 'JCB',
         :diners_club => 'DinersClub',
-        :switch => 'Switch',
-        :solo => 'Solo'
       }
 
       TRANSACTIONS = {
-        :purchase       => "Sale",
-        :authorization  => "Authorization",
-        :capture        => "Capture",
-        :void           => "Void",
-        :credit         => "Credit"
+        :purchase       => 'Sale',
+        :authorization  => 'Authorization',
+        :capture        => 'Capture',
+        :void           => 'Void',
+        :credit         => 'Credit'
       }
 
       CVV_CODE = {
@@ -73,10 +78,11 @@ module ActiveMerchant #:nodoc:
       end
 
       private
+
       def build_request(body, options = {})
         xml = Builder::XmlMarkup.new
         xml.instruct!
-        xml.tag! 'XMLPayRequest', 'Timeout' => timeout.to_s, 'version' => "2.1", "xmlns" => XMLNS do
+        xml.tag! 'XMLPayRequest', 'Timeout' => timeout.to_s, 'version' => '2.1', 'xmlns' => XMLNS do
           xml.tag! 'RequestData' do
             xml.tag! 'Vendor', @options[:login]
             xml.tag! 'Partner', @options[:partner]
@@ -85,7 +91,7 @@ module ActiveMerchant #:nodoc:
             else
               xml.tag! 'Transactions' do
                 xml.tag! 'Transaction', 'CustRef' => options[:customer] do
-                  xml.tag! 'Verbosity', 'MEDIUM'
+                  xml.tag! 'Verbosity', @options[:verbosity] || 'MEDIUM'
                   xml << body
                 end
               end
@@ -112,6 +118,11 @@ module ActiveMerchant #:nodoc:
               xml.tag!('Description', options[:description]) unless options[:description].blank?
               xml.tag!('Comment', options[:comment]) unless options[:comment].blank?
               xml.tag!('ExtData', 'Name'=> 'COMMENT2', 'Value'=> options[:comment2]) unless options[:comment2].blank?
+              xml.tag!(
+                'ExtData',
+                'Name' => 'CAPTURECOMPLETE',
+                'Value' => options[:capture_complete]
+              ) unless options[:capture_complete].blank?
             end
           end
         end
@@ -130,8 +141,9 @@ module ActiveMerchant #:nodoc:
 
           xml.tag! 'Address' do
             xml.tag! 'Street', address[:address1] unless address[:address1].blank?
+            xml.tag! 'Street2', address[:address2] unless address[:address2].blank?
             xml.tag! 'City', address[:city] unless address[:city].blank?
-            xml.tag! 'State', address[:state].blank? ? "N/A" : address[:state]
+            xml.tag! 'State', address[:state].blank? ? 'N/A' : address[:state]
             xml.tag! 'Country', address[:country] unless address[:country].blank?
             xml.tag! 'Zip', address[:zip] unless address[:zip].blank?
           end
@@ -142,16 +154,16 @@ module ActiveMerchant #:nodoc:
         response = {}
         xml = Nokogiri::XML(data)
         xml.remove_namespaces!
-        root = xml.xpath("//ResponseData")
+        root = xml.xpath('//ResponseData')
 
         # REXML::XPath in Ruby 1.8.6 is now unable to match nodes based on their attributes
-        tx_result = root.xpath(".//TransactionResult").first
+        tx_result = root.xpath('.//TransactionResult').first
 
-        if tx_result && tx_result.attributes['Duplicate'].to_s == "true"
+        if tx_result && tx_result.attributes['Duplicate'].to_s == 'true'
           response[:duplicate] = true
         end
 
-        root.xpath(".//*").each do |node|
+        root.xpath('.//*').each do |node|
           parse_element(response, node)
         end
 
@@ -166,10 +178,10 @@ module ActiveMerchant #:nodoc:
           # down as we do everywhere else. RPPaymentResult elements are not contained
           # in an RPPaymentResults element so we'll come here multiple times
           response[node_name] ||= []
-          response[node_name] << ( payment_result_response = {} )
-          node.xpath(".//*").each{ |e| parse_element(payment_result_response, e) }
-        when node.xpath(".//*").to_a.any?
-          node.xpath(".//*").each{|e| parse_element(response, e) }
+          response[node_name] << (payment_result_response = {})
+          node.xpath('.//*').each { |e| parse_element(payment_result_response, e) }
+        when node.xpath('.//*').to_a.any?
+          node.xpath('.//*').each { |e| parse_element(response, e) }
         when node_name.to_s =~ /amt$/
           # *Amt elements don't put the value in the #text - instead they use a Currency attribute
           response[node_name] = node.attributes['Currency'].to_s
@@ -181,29 +193,43 @@ module ActiveMerchant #:nodoc:
       end
 
       def build_headers(content_length)
-        {
-          "Content-Type" => "text/xml",
-          "Content-Length" => content_length.to_s,
-      	  "X-VPS-Client-Timeout" => timeout.to_s,
-      	  "X-VPS-VIT-Integration-Product" => "ActiveMerchant",
-      	  "X-VPS-VIT-Runtime-Version" => RUBY_VERSION,
-      	  "X-VPS-Request-ID" => Utils.generate_unique_id
-    	  }
-    	end
-
-    	def commit(request_body, options  = {})
+        headers = {
+          'Content-Type' => 'text/xml',
+          'Content-Length' => content_length.to_s,
+          'X-VPS-Client-Timeout' => timeout.to_s,
+          'X-VPS-VIT-Integration-Product' => 'ActiveMerchant',
+          'X-VPS-VIT-Runtime-Version' => RUBY_VERSION,
+          'X-VPS-Request-ID' => SecureRandom.hex(16)
+        }
+
+        headers['PAYPAL-NVP'] = 'Y' if self.use_paypal_nvp
+        headers
+      end
+
+      def commit(request_body, options = {})
         request = build_request(request_body, options)
         headers = build_headers(request.size)
 
-    	  response = parse(ssl_post(test? ? self.test_url : self.live_url, request, headers))
+        response = parse(ssl_post(test? ? self.test_url : self.live_url, request, headers))
 
-    	  build_response(response[:result] == "0", response[:message], response,
-    	    :test => test?,
-    	    :authorization => response[:pn_ref] || response[:rp_ref],
-    	    :cvv_result => CVV_CODE[response[:cv_result]],
-    	    :avs_result => { :code => response[:avs_result] }
+        build_response(
+          success_for(response),
+          response[:message], response,
+          test: test?,
+          authorization: response[:pn_ref] || response[:rp_ref],
+          cvv_result: CVV_CODE[response[:cv_result]],
+          avs_result: { code: response[:avs_result] },
+          fraud_review: under_fraud_review?(response)
         )
       end
+
+      def success_for(response)
+        %w(0 126).include?(response[:result])
+      end
+
+      def under_fraud_review?(response)
+        (response[:result] == '126')
+      end
     end
   end
 end

data/lib/active_merchant/billing/gateways/payflow/payflow_express_response.rb

@@ -4,26 +4,30 @@ module ActiveMerchant #:nodoc:
       def email
         @params['e_mail']
       end
-      
+
       def full_name
         "#{@params['name']} #{@params['lastname']}"
       end
-      
+
       def token
         @params['token']
       end
-      
+
       def payer_id
         @params['payer_id']
       end
-      
+
       # Really the shipping country, but it is all the information provided
       def payer_country
         address['country']
       end
-      
+
+      def phone
+        @params['phone']
+      end
+
       def address
-        {  'name'       => full_name,
+        {  'name'       => @params['shiptoname'] || full_name,
            'company'    => nil,
            'address1'   => @params['street'],
            'address2'   => @params['shiptostreet2'] || @params['street2'],
@@ -31,7 +35,7 @@ module ActiveMerchant #:nodoc:
            'state'      => @params['state'],
            'country'    => @params['country'],
            'zip'        => @params['zip'],
-           'phone'      => nil
+           'phone'      => phone,
         }
       end
     end

data/lib/active_merchant/billing/gateways/payflow/payflow_response.rb

@@ -4,10 +4,10 @@ module ActiveMerchant #:nodoc:
       def profile_id
         @params['profile_id']
       end
-      
+
       def payment_history
-        @payment_history ||= @params['rp_payment_result'].collect{ |result| result.stringify_keys } rescue []
+        @payment_history ||= @params['rp_payment_result'].collect(&:stringify_keys) rescue []
       end
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/payflow/payflow_common_api'
-require File.dirname(__FILE__) + '/payflow/payflow_response'
-require File.dirname(__FILE__) + '/payflow_express'
+require 'active_merchant/billing/gateways/payflow/payflow_common_api'
+require 'active_merchant/billing/gateways/payflow/payflow_response'
+require 'active_merchant/billing/gateways/payflow_express'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
@@ -27,7 +27,7 @@ module ActiveMerchant #:nodoc:
 
       def credit(money, funding_source, options = {})
         if funding_source.is_a?(String)
-          deprecated CREDIT_DEPRECATION_MESSAGE
+          ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
           # Perform referenced credit
           refund(money, funding_source, options)
         elsif card_brand(funding_source) == 'check'
@@ -44,6 +44,22 @@ module ActiveMerchant #:nodoc:
         commit(build_reference_request(:credit, money, reference, options), options)
       end
 
+      def verify(payment, options={})
+        if credit_card_type(payment) == 'Amex'
+          MultiResponse.run(:use_first_response) do |r|
+            r.process { authorize(100, payment, options) }
+            r.process(:ignore_result) { void(r.authorization, options) }
+          end
+        else
+          authorize(0, payment, options)
+        end
+      end
+
+      def verify_credentials
+        response = void('0')
+        response.params['result'] != '26'
+      end
+
       # Adds or modifies a recurring Payflow profile.  See the Payflow Pro Recurring Billing Guide for more details:
       # https://www.paypal.com/en_US/pdf/PayflowPro_RecurringBilling_Guide.pdf
       #
@@ -57,20 +73,26 @@ module ActiveMerchant #:nodoc:
       # * <tt>payments</tt> - The term, or number of payments that will be made
       # * <tt>comment</tt> - A comment associated with the profile
       def recurring(money, credit_card, options = {})
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
         options[:name] = credit_card.name if options[:name].blank? && credit_card
         request = build_recurring_request(options[:profile_id] ? :modify : :add, money, options) do |xml|
-          add_credit_card(xml, credit_card) if credit_card
+          add_credit_card(xml, credit_card, options) if credit_card
         end
         commit(request, options.merge(:request_type => :recurring))
       end
 
       def cancel_recurring(profile_id)
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
         request = build_recurring_request(:cancel, 0, :profile_id => profile_id)
         commit(request, options.merge(:request_type => :recurring))
       end
 
       def recurring_inquiry(profile_id, options = {})
-        request = build_recurring_request(:inquiry, nil, options.update( :profile_id => profile_id ))
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
+        request = build_recurring_request(:inquiry, nil, options.update(:profile_id => profile_id))
         commit(request, options.merge(:request_type => :recurring))
       end
 
@@ -78,7 +100,20 @@ module ActiveMerchant #:nodoc:
         @express ||= PayflowExpressGateway.new(@options)
       end
 
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((<CardNum>)[^<]*(</CardNum>)), '\1[FILTERED]\2').
+          gsub(%r((<CVNum>)[^<]*(</CVNum>)), '\1[FILTERED]\2').
+          gsub(%r((<AcctNum>)[^<]*(</AcctNum>)), '\1[FILTERED]\2').
+          gsub(%r((<Password>)[^<]*(</Password>)), '\1[FILTERED]\2')
+      end
+
       private
+
       def build_sale_or_authorization_request(action, money, funding_source, options)
         if funding_source.is_a?(String)
           build_reference_sale_or_authorization_request(action, money, funding_source, options)
@@ -98,6 +133,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'CustIP', options[:ip] unless options[:ip].blank?
               xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank?
               xml.tag! 'Description', options[:description] unless options[:description].blank?
+              xml.tag! 'OrderDesc', options[:order_desc] unless options[:order_desc].blank?
               xml.tag! 'Comment', options[:comment] unless options[:comment].blank?
               xml.tag!('ExtData', 'Name'=> 'COMMENT2', 'Value'=> options[:comment2]) unless options[:comment2].blank?
               xml.tag! 'TaxAmt', options[:taxamt] unless options[:taxamt].blank?
@@ -107,7 +143,7 @@ module ActiveMerchant #:nodoc:
 
               billing_address = options[:billing_address] || options[:address]
               add_address(xml, 'BillTo', billing_address, options) if billing_address
-              add_address(xml, 'ShipTo', options[:shipping_address],options) if options[:shipping_address]
+              add_address(xml, 'ShipTo', options[:shipping_address], options) if options[:shipping_address]
 
               xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
             end
@@ -129,6 +165,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'CustIP', options[:ip] unless options[:ip].blank?
               xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank?
               xml.tag! 'Description', options[:description] unless options[:description].blank?
+              xml.tag! 'OrderDesc', options[:order_desc] unless options[:order_desc].blank?
               # Comment and Comment2 will show up in manager.paypal.com as Comment1 and Comment2
               xml.tag! 'Comment', options[:comment] unless options[:comment].blank?
               xml.tag!('ExtData', 'Name'=> 'COMMENT2', 'Value'=> options[:comment2]) unless options[:comment2].blank?
@@ -136,6 +173,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'FreightAmt', options[:freightamt] unless options[:freightamt].blank?
               xml.tag! 'DutyAmt', options[:dutyamt] unless options[:dutyamt].blank?
               xml.tag! 'DiscountAmt', options[:discountamt] unless options[:discountamt].blank?
+              xml.tag! 'EMail', options[:email] unless options[:email].nil?
 
               billing_address = options[:billing_address] || options[:address]
               add_address(xml, 'BillTo', billing_address, options) if billing_address
@@ -145,7 +183,7 @@ module ActiveMerchant #:nodoc:
             end
 
             xml.tag! 'Tender' do
-              add_credit_card(xml, credit_card)
+              add_credit_card(xml, credit_card, options)
             end
           end
         end
@@ -160,6 +198,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'CustIP', options[:ip] unless options[:ip].blank?
               xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank?
               xml.tag! 'Description', options[:description] unless options[:description].blank?
+              xml.tag! 'OrderDesc', options[:order_desc] unless options[:order_desc].blank?
               xml.tag! 'BillTo' do
                 xml.tag! 'Name', check.name
               end
@@ -177,7 +216,7 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
-      def add_credit_card(xml, credit_card)
+      def add_credit_card(xml, credit_card, options = {})
         xml.tag! 'Card' do
           xml.tag! 'CardType', credit_card_type(credit_card)
           xml.tag! 'CardNum', credit_card.number
@@ -185,10 +224,19 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'NameOnCard', credit_card.first_name
           xml.tag! 'CVNum', credit_card.verification_value if credit_card.verification_value?
 
-          if requires_start_date_or_issue_number?(credit_card)
-            xml.tag!('ExtData', 'Name' => 'CardStart', 'Value' => startdate(credit_card)) unless credit_card.start_month.blank? || credit_card.start_year.blank?
-            xml.tag!('ExtData', 'Name' => 'CardIssue', 'Value' => format(credit_card.issue_number, :two_digits)) unless credit_card.issue_number.blank?
+          if options[:three_d_secure]
+            three_d_secure = options[:three_d_secure]
+            xml.tag! 'BuyerAuthResult' do
+              xml.tag! 'Status', three_d_secure[:status] unless three_d_secure[:status].blank?
+              xml.tag! 'AuthenticationId', three_d_secure[:authentication_id] unless three_d_secure[:authentication_id].blank?
+              xml.tag! 'PAReq', three_d_secure[:pareq] unless three_d_secure[:pareq].blank?
+              xml.tag! 'ACSUrl', three_d_secure[:acs_url] unless three_d_secure[:acs_url].blank?
+              xml.tag! 'ECI', three_d_secure[:eci] unless three_d_secure[:eci].blank?
+              xml.tag! 'CAVV', three_d_secure[:cavv] unless three_d_secure[:cavv].blank?
+              xml.tag! 'XID', three_d_secure[:xid] unless three_d_secure[:xid].blank?
+            end
           end
+
           xml.tag! 'ExtData', 'Name' => 'LASTNAME', 'Value' =>  credit_card.last_name
         end
       end
@@ -200,8 +248,8 @@ module ActiveMerchant #:nodoc:
       end
 
       def expdate(creditcard)
-        year  = sprintf("%.4i", creditcard.year.to_s.sub(/^0+/, ''))
-        month = sprintf("%.2i", creditcard.month.to_s.sub(/^0+/, ''))
+        year  = sprintf('%.4i', creditcard.year.to_s.sub(/^0+/, ''))
+        month = sprintf('%.2i', creditcard.month.to_s.sub(/^0+/, ''))
 
         "#{year}#{month}"
       end
@@ -241,7 +289,7 @@ module ActiveMerchant #:nodoc:
                   end
 
                   if action == :add
-                    xml.tag! 'Start', format_rp_date(options[:starting_at] || Date.today + 1 )
+                    xml.tag! 'Start', format_rp_date(options[:starting_at] || Date.today + 1)
                   else
                     xml.tag! 'Start', format_rp_date(options[:starting_at]) unless options[:starting_at].nil?
                   end
@@ -257,10 +305,10 @@ module ActiveMerchant #:nodoc:
                 end
               end
               if action != :add
-                xml.tag! "ProfileID", options[:profile_id]
+                xml.tag! 'ProfileID', options[:profile_id]
               end
               if action == :inquiry
-                xml.tag! "PaymentHistory", ( options[:history] ? 'Y' : 'N' )
+                xml.tag! 'PaymentHistory', (options[:history] ? 'Y' : 'N')
               end
             end
           end
@@ -270,20 +318,20 @@ module ActiveMerchant #:nodoc:
       def get_pay_period(options)
         requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily, :semimonthly, :quadweekly, :quarterly, :semiyearly])
         case options[:periodicity]
-          when :weekly then 'Weekly'
-          when :biweekly then 'Bi-weekly'
-          when :semimonthly then 'Semi-monthly'
-          when :quadweekly then 'Every four weeks'
-          when :monthly then 'Monthly'
-          when :quarterly then 'Quarterly'
-          when :semiyearly then 'Semi-yearly'
-          when :yearly then 'Yearly'
+        when :weekly then 'Weekly'
+        when :biweekly then 'Bi-weekly'
+        when :semimonthly then 'Semi-monthly'
+        when :quadweekly then 'Every four weeks'
+        when :monthly then 'Monthly'
+        when :quarterly then 'Quarterly'
+        when :semiyearly then 'Semi-yearly'
+        when :yearly then 'Yearly'
         end
       end
 
       def format_rp_date(time)
         case time
-          when Time, Date then time.strftime("%m%d%Y")
+        when Time, Date then time.strftime('%m%d%Y')
         else
           time.to_s
         end
@@ -295,4 +343,3 @@ module ActiveMerchant #:nodoc:
     end
   end
 end
-