payflow.rb in activemerchant-1.27.0

- old
+ new

@@ -4,29 +4,29 @@
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PayflowGateway < Gateway
       include PayflowCommonAPI
-      
+
       RECURRING_ACTIONS = Set.new([:add, :modify, :cancel, :inquiry, :reactivate, :payment])
-       
+
       self.supported_cardtypes = [:visa, :master, :american_express, :jcb, :discover, :diners_club]
       self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-pro-overview-outside'
       self.display_name = 'PayPal Payflow Pro'
-    
+
       def authorize(money, credit_card_or_reference, options = {})
         request = build_sale_or_authorization_request(:authorization, money, credit_card_or_reference, options)
-      
+
         commit(request, options)
       end
-      
+
       def purchase(money, credit_card_or_reference, options = {})
         request = build_sale_or_authorization_request(:purchase, money, credit_card_or_reference, options)
 
         commit(request, options)
       end
-      
+
       def credit(money, identification_or_credit_card, options = {})
         if identification_or_credit_card.is_a?(String)
           deprecated CREDIT_DEPRECATION_MESSAGE
           # Perform referenced credit
           refund(money, identification_or_credit_card, options)
@@ -34,57 +34,58 @@
           # Perform non-referenced credit
           request = build_credit_card_request(:credit, money, identification_or_credit_card, options)
           commit(request, options)
         end
       end
-      
+
       def refund(money, reference, options = {})
         commit(build_reference_request(:credit, money, reference, options), options)
       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
-      #    
+      #
       # Several options are available to customize the recurring profile:
       #
       # * <tt>profile_id</tt> - is only required for editing a recurring profile
       # * <tt>starting_at</tt> - takes a Date, Time, or string in mmddyyyy format. The date must be in the future.
       # * <tt>name</tt> - The name of the customer to be billed.  If not specified, the name from the credit card is used.
       # * <tt>periodicity</tt> - The frequency that the recurring payments will occur at.  Can be one of
       # :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily, :semimonthly, :quadweekly, :quarterly, :semiyearly
       # * <tt>payments</tt> - The term, or number of payments that will be made
-      # * <tt>comment</tt> - A comment associated with the profile            
+      # * <tt>comment</tt> - A comment associated with the profile
       def recurring(money, credit_card, options = {})
         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
         end
         commit(request, options.merge(:request_type => :recurring))
       end
-      
+
       def cancel_recurring(profile_id)
         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 ))
         commit(request, options.merge(:request_type => :recurring))
-      end   
-      
+      end
+
       def express
         @express ||= PayflowExpressGateway.new(@options)
       end
-      
+
       private
       def build_sale_or_authorization_request(action, money, credit_card_or_reference, options)
         if credit_card_or_reference.is_a?(String)
           build_reference_sale_or_authorization_request(action, money, credit_card_or_reference, options)
-        else  
+        else
           build_credit_card_request(action, money, credit_card_or_reference, options)
-        end  
+        end
       end
-      
+
       def build_reference_sale_or_authorization_request(action, money, reference, options)
         xml = Builder::XmlMarkup.new
         xml.tag! TRANSACTIONS[action] do
           xml.tag! 'PayData' do
             xml.tag! 'Invoice' do
@@ -112,13 +113,13 @@
             end
           end
         end
         xml.target!
       end
-      
+
       def build_credit_card_request(action, money, credit_card, options)
-        xml = Builder::XmlMarkup.new 
+        xml = Builder::XmlMarkup.new
         xml.tag! TRANSACTIONS[action] do
           xml.tag! 'PayData' do
             xml.tag! 'Invoice' do
               xml.tag! 'CustIP', options[:ip] unless options[:ip].blank?
               xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank?
@@ -132,64 +133,64 @@
               xml.tag! 'DiscountAmt', options[:discountamt] unless options[:discountamt].blank?
 
               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]
-              
+
               xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
             end
-            
+
             xml.tag! 'Tender' do
               add_credit_card(xml, credit_card)
             end
-          end 
+          end
         end
         xml.target!
       end
-    
+
       def add_credit_card(xml, credit_card)
         xml.tag! 'Card' do
           xml.tag! 'CardType', credit_card_type(credit_card)
           xml.tag! 'CardNum', credit_card.number
           xml.tag! 'ExpDate', expdate(credit_card)
           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?
           end
           xml.tag! 'ExtData', 'Name' => 'LASTNAME', 'Value' =>  credit_card.last_name
         end
       end
-      
+
       def credit_card_type(credit_card)
         return '' if card_brand(credit_card).blank?
-        
+
         CARD_MAPPING[card_brand(credit_card).to_sym]
       end
-      
+
       def expdate(creditcard)
         year  = sprintf("%.4i", creditcard.year.to_s.sub(/^0+/, ''))
         month = sprintf("%.2i", creditcard.month.to_s.sub(/^0+/, ''))
 
         "#{year}#{month}"
       end
-      
+
       def startdate(creditcard)
         year  = format(creditcard.start_year, :two_digits)
         month = format(creditcard.start_month, :two_digits)
 
         "#{month}#{year}"
       end
-      
+
       def build_recurring_request(action, money, options)
         unless RECURRING_ACTIONS.include?(action)
           raise StandardError, "Invalid Recurring Profile Action: #{action}"
         end
 
-        xml = Builder::XmlMarkup.new 
+        xml = Builder::XmlMarkup.new
         xml.tag! 'RecurringProfiles' do
           xml.tag! 'RecurringProfile' do
             xml.tag! action.to_s.capitalize do
               unless [:cancel, :inquiry].include?(action)
                 xml.tag! 'RPData' do
@@ -197,27 +198,28 @@
                   xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
                   xml.tag! 'PayPeriod', get_pay_period(options)
                   xml.tag! 'Term', options[:payments] unless options[:payments].nil?
                   xml.tag! 'Comment', options[:comment] unless options[:comment].nil?
                   xml.tag! 'RetryNumDays', options[:retry_num_days] unless options[:retry_num_days].nil?
-                
+                  xml.tag! 'MaxFailPayments', options[:max_fail_payments] unless options[:max_fail_payments].nil?
+
                   if initial_tx = options[:initial_transaction]
                     requires!(initial_tx, [:type, :authorization, :purchase])
                     requires!(initial_tx, :amount) if initial_tx[:type] == :purchase
-                      
+
                     xml.tag! 'OptionalTrans', TRANSACTIONS[initial_tx[:type]]
                     xml.tag! 'OptionalTransAmt', amount(initial_tx[:amount]) unless initial_tx[:amount].blank?
                   end
-                  
+
                   if action == :add
                     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
-                  
+
                   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
                   add_address(xml, 'ShipTo', options[:shipping_address], options) if options[:shipping_address]
                 end
                 xml.tag! 'Tender' do
@@ -254,11 +256,11 @@
           when Time, Date then time.strftime("%m%d%Y")
         else
           time.to_s
         end
       end
-      
-      def build_response(success, message, response, options = {}) 
+
+      def build_response(success, message, response, options = {})
         PayflowResponse.new(success, message, response, options)
       end
     end
   end
 end