jelaniharris-activemerchant 1.24.1

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

@@ -0,0 +1,211 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module PayflowCommonAPI
+      def self.included(base)
+        base.default_currency = 'USD'
+          
+        base.class_attribute :partner
+        
+        # Set the default partner to PayPal
+        base.partner = 'PayPal'
+        
+        base.supported_countries = ['US', 'CA', 'SG', 'AU']
+        
+        base.class_attribute :timeout
+        base.timeout = 60
+        
+        # Enable safe retry of failed connections
+        # Payflow is safe to retry because retried transactions use the same
+        # X-VPS-Request-ID header. If a transaction is detected as a duplicate
+        # only the original transaction data will be used by Payflow, and the
+        # subsequent Responses will have a :duplicate parameter set in the params
+        # hash.
+        base.retry_safe = true
+      end
+      
+      XMLNS = 'http://www.paypal.com/XMLPay'
+      TEST_URL = 'https://pilot-payflowpro.paypal.com'
+      LIVE_URL = 'https://payflowpro.paypal.com'
+      
+      CARD_MAPPING = {
+        :visa => 'Visa',
+        :master => 'MasterCard',
+        :discover => 'Discover',
+        :american_express => 'Amex',
+        :jcb => 'JCB',
+        :diners_club => 'DinersClub',
+        :switch => 'Switch',
+        :solo => 'Solo'
+      }
+      
+      TRANSACTIONS = { 
+        :purchase       => "Sale",
+        :authorization  => "Authorization",
+        :capture        => "Capture",
+        :void           => "Void",
+        :credit         => "Credit" 
+      }
+      
+      CVV_CODE = {
+        'Match' => 'M',
+        'No Match' => 'N',
+        'Service Not Available' => 'U', 
+        'Service not Requested' => 'P'
+      }
+          
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        
+        @options = options
+        @options[:partner] = partner if @options[:partner].blank?
+        super
+      end  
+      
+      def test?
+        @options[:test] || super
+      end
+      
+      def capture(money, authorization, options = {})
+        request = build_reference_request(:capture, money, authorization, options)
+        commit(request, options)
+      end
+      
+      def void(authorization, options = {})
+        request = build_reference_request(:void, nil, authorization, options)
+        commit(request, options)
+      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! 'RequestData' do
+            xml.tag! 'Vendor', @options[:login]
+            xml.tag! 'Partner', @options[:partner]
+            if options[:request_type] == :recurring
+              xml << body
+            else
+              xml.tag! 'Transactions' do
+                xml.tag! 'Transaction', 'CustRef' => options[:customer] do
+                  xml.tag! 'Verbosity', 'MEDIUM'
+                  xml << body
+                end
+              end
+            end
+          end
+          xml.tag! 'RequestAuth' do
+            xml.tag! 'UserPass' do
+              xml.tag! 'User', !@options[:user].blank? ? @options[:user] : @options[:login]
+              xml.tag! 'Password', @options[:password]
+            end
+          end
+        end
+        xml.target!
+      end
+      
+      def build_reference_request(action, money, authorization, options)
+        xml = Builder::XmlMarkup.new
+        xml.tag! TRANSACTIONS[action] do
+          xml.tag! 'PNRef', authorization
+        
+          unless money.nil?
+            xml.tag! 'Invoice' do
+              xml.tag!('TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money))
+              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?
+            end
+          end
+        end
+        
+        xml.target!
+      end
+
+      def add_address(xml, tag, address, options)  
+        return if address.nil?
+        xml.tag! tag do
+          xml.tag! 'Name', address[:name] unless address[:name].blank?
+          xml.tag! 'EMail', options[:email] unless options[:email].blank?
+          xml.tag! 'Phone', address[:phone] unless address[:phone].blank?
+          xml.tag! 'CustCode', options[:customer] if !options[:customer].blank? && tag == 'BillTo'
+          xml.tag! 'PONum', options[:po_number] if !options[:po_number].blank? && tag == 'BillTo'
+          
+          xml.tag! 'Address' do
+            xml.tag! 'Street', address[:address1] unless address[:address1].blank?
+            xml.tag! 'City', address[:city] unless address[:city].blank?
+            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
+        end
+      end
+          
+      def parse(data)
+        response = {}
+        xml = REXML::Document.new(data)
+        root = REXML::XPath.first(xml, "//ResponseData")
+        
+        # REXML::XPath in Ruby 1.8.6 is now unable to match nodes based on their attributes
+        tx_result = REXML::XPath.first(root, "//TransactionResult")
+        
+        if tx_result && tx_result.attributes['Duplicate'] == "true"
+          response[:duplicate] = true 
+        end
+        
+        root.elements.to_a.each do |node|
+          parse_element(response, node)
+        end
+
+        response
+      end
+      
+      def parse_element(response, node)
+        node_name = node.name.underscore.to_sym
+        case
+        when node_name == :rp_payment_result
+          # Since we'll have multiple history items, we can't just flatten everything
+          # 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.elements.each{ |e| parse_element(payment_result_response, e) }
+        when node.has_elements?
+          node.elements.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']
+        when node_name == :ext_data
+          response[node.attributes['Name'].underscore.to_sym] = node.attributes['Value']
+        else
+          response[node_name] = node.text
+        end
+      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  = {})
+        request = build_request(request_body, options)
+        headers = build_headers(request.size)
+        
+    	  response = parse(ssl_post(test? ? TEST_URL : 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] }
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayflowExpressResponse < Response
+      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 address
+        {  'name'       => full_name,
+           'company'    => nil,
+           'address1'   => @params['street'],
+           'address2'   => @params['shiptostreet2'] || @params['street2'],
+           'city'       => @params['city'],
+           'state'      => @params['state'],
+           'country'    => @params['country'],
+           'zip'        => @params['zip'],
+           'phone'      => nil
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayflowResponse < Response
+      def profile_id
+        @params['profile_id']
+      end
+      
+      def payment_history
+        @payment_history ||= @params['rp_payment_result'].collect{ |result| result.stringify_keys } rescue []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,224 @@
+require File.dirname(__FILE__) + '/payflow/payflow_common_api'
+require File.dirname(__FILE__) + '/payflow/payflow_express_response'
+require File.dirname(__FILE__) + '/paypal_express_common'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+      # ==General Parameters
+      # The following parameters are supported for #setup_authorization, #setup_purchase, #authorize and #purchase transactions. I've read
+      # in the docs that they recommend you pass the exact same parameters to both setup and authorize/purchase.
+      #
+      # This information was gleaned from a mix of:
+      # * PayFlow documentation
+      #   * for key value pairs: {Express Checkout for Payflow Pro (PDF)}[https://cms.paypal.com/cms_content/US/en_US/files/developer/PFP_ExpressCheckout_PP.pdf]
+      #   * XMLPay: {Payflow Pro XMLPay Developer's Guide (PDF)}[https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_PayflowPro_XMLPay_Guide.pdf]
+      # * previous ActiveMerchant code
+      # * trial & error
+      #
+      # The following parameters are currently supported.
+      # [<tt>:ip</tt>] (opt) Customer IP Address
+      # [<tt>:order_id</tt>] (opt) An order or invoice number. This will be passed through to the Payflow backend at manager.paypal.com, and show up as "Supplier Reference #"
+      # [<tt>:description</tt>] (opt) Order description, shown to buyer (after redirected to PayPal). If Order Line Items are used (see below), then the description is suppressed. This will not be passed through to the Payflow backend.
+      # [<tt>:billing_address</tt>] (opt) See ActiveMerchant::Billing::Gateway for details
+      # [<tt>:shipping_address</tt>] (opt) See ActiveMerchant::Billing::Gateway for details
+      # [<tt>:currency</tt>] (req) Currency of transaction, will be set to USD by default for PayFlow Express if not specified
+      # [<tt>:email</tt>] (opt) Email of buyer; used to pre-fill PayPal login screen
+      # [<tt>:payer_id</tt>] (opt) Unique PayPal buyer account identification number, as returned by details_for request
+      # [<tt>:token</tt>] (req for #authorize & #purchase) Token returned by setup transaction
+      # [<tt>:no_shipping</tt>] (opt) Boolean for whether or not to display shipping address to buyer
+      # [<tt>:address_override</tt>] (opt) Boolean. If true, display shipping address passed by parameters, rather than shipping address on file with PayPal
+      # [<tt>:allow_note</tt>] (opt) Boolean for permitting buyer to add note during checkout. Note contents can be retrieved with details_for transaction
+      # [<tt>:return_url</tt>] (req) URL to which the buyer’s browser is returned after choosing to pay.
+      # [<tt>:cancel_return_url</tt>] (req) URL to which the buyer is returned if the buyer cancels the order.
+      # [<tt>:notify_url</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+      # [<tt>:comment</tt>] (opt) Comment field which will be reported to Payflow backend (at manager.paypal.com) as Comment1
+      # [<tt>:comment2</tt>] (opt) Comment field which will be reported to Payflow backend (at manager.paypal.com) as Comment2
+      # [<tt>:discount</tt>] (opt) Total discounts in cents
+      #
+      # ==Line Items
+      # Support for order line items is available, but has to be enabled on the PayFlow backend. This is what I was told by Todd Sieber at Technical Support:
+      #
+      # <em>You will need to call Payflow Support at 1-888-883-9770, choose option #2.  Request that they update your account in "Pandora" under Product Settings >> PayPal Mark and update the Features Bitmap to 1111111111111112.  This is 15 ones and a two.</em>
+      #
+      # See here[https://www.x.com/message/206214#206214] for the forum discussion (requires login to {x.com}[https://x.com]
+      #     
+      # [<tt>:items</tt>] (opt) Array of Order Line Items hashes. These are shown to the buyer after redirect to PayPal.
+      #
+      #
+      #
+      #                   The following keys are supported for line items:
+      #                   [<tt>:name</tt>] Name of line item
+      #                   [<tt>:description</tt>] Description of line item
+      #                   [<tt>:amount</tt>] Line Item Amount in Cents (as Integer)
+      #                   [<tt>:quantity</tt>] Line Item Quantity (default to 1 if left blank)
+      #
+      # ====Customization of Payment Page
+      # [<tt>:page_style</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+      # [<tt>:header_image</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+      # [<tt>:background_color</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+      # ====Additional options for old Checkout Experience, being phased out in 2010 and 2011
+      # [<tt>:header_background_color</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+      # [<tt>:header_border_color</tt>] (opt) Your URL for receiving Instant Payment Notification (IPN) about this transaction.
+
+
+    class PayflowExpressGateway < Gateway
+      include PayflowCommonAPI
+      include PaypalExpressCommon
+      
+      self.test_redirect_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside'
+      self.display_name = 'PayPal Express Checkout'
+
+      def authorize(money, options = {})
+        requires!(options, :token, :payer_id)
+        request = build_sale_or_authorization_request('Authorization', money, options)
+        commit(request, options)
+      end
+      
+      def purchase(money, options = {})        
+        requires!(options, :token, :payer_id)
+        request = build_sale_or_authorization_request('Sale', money, options)
+        commit(request, options)
+      end
+      
+      def refund(money, identification, options = {})
+        request = build_reference_request(:credit, money, identification, options)
+        commit(request, options)
+      end        
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
+      def setup_authorization(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+        
+        request = build_setup_express_sale_or_authorization_request('Authorization', money, options)
+        commit(request, options)
+      end
+      
+      def setup_purchase(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+        
+        request = build_setup_express_sale_or_authorization_request('Sale', money, options)
+        commit(request, options)
+      end
+      
+      def details_for(token)
+        request = build_get_express_details_request(token)
+        commit(request, options)
+      end
+      
+      private
+      def build_get_express_details_request(token)
+        xml = Builder::XmlMarkup.new :indent => 2  
+        xml.tag! 'GetExpressCheckout' do
+          xml.tag! 'Authorization' do
+            xml.tag! 'PayData' do  
+              xml.tag! 'Tender' do
+                xml.tag! 'PayPal' do
+                  xml.tag! 'Token', token
+                end
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_setup_express_sale_or_authorization_request(action, money, options = {})
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'SetExpressCheckout' do
+          xml.tag! action do
+            add_pay_data xml, money, options
+          end
+        end
+        xml.target!
+      end
+      
+      def build_sale_or_authorization_request(action, money, options) 
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'DoExpressCheckout' do
+          xml.tag! action do
+            add_pay_data xml, money, options
+          end
+        end
+        xml.target!
+      end
+
+      def add_pay_data(xml, money, options)
+        xml.tag! 'PayData' do
+          xml.tag! 'Invoice' do
+            xml.tag! 'CustIP', options[:ip] unless options[:ip].blank?
+            xml.tag! 'InvNum', options[:order_id] unless options[:order_id].blank?
+            # Description field will be shown to buyer, unless line items are also being supplied (then only line items are shown).
+            xml.tag! 'Description', options[:description] unless options[:description].blank?
+            # Comment, Comment2 should make it to the backend at manager.paypal.com, as with Payflow credit card transactions
+            # but that doesn't seem to work (yet?). See: https://www.x.com/thread/51908?tstart=0
+            xml.tag! 'Comment', options[:comment] unless options[:comment].nil?
+            xml.tag!('ExtData', 'Name'=> 'COMMENT2', 'Value'=> options[:comment2]) unless options[:comment2].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]
+
+            # Note: To get order line-items to show up with Payflow Express, this feature has to be enabled on the backend.
+            # Call Support at 888 883 9770, press 2. Then request that they update your account in "Pandora" under Product Settings >> PayPal
+            # Mark and update the Features Bitmap to 1111111111111112.  This is 15 ones and a two.
+            # See here for the forum discussion: https://www.x.com/message/206214#206214
+            items = options[:items] || []
+            items.each_with_index do |item, index|
+              xml.tag! 'ExtData', 'Name' => "L_DESC#{index}", 'Value' => item[:description]
+              xml.tag! 'ExtData', 'Name' => "L_COST#{index}", 'Value' => amount(item[:amount])
+              xml.tag! 'ExtData', 'Name' => "L_QTY#{index}", 'Value' => item[:quantity] || '1'
+              xml.tag! 'ExtData', 'Name' => "L_NAME#{index}", 'Value' => item[:name]
+              # Note: An ItemURL is supported in Paypal Express (different API), but not PayFlow Express, as far as I can tell.
+              # L_URLn nor L_ITEMURLn seem to work
+            end
+            if items.any?
+              xml.tag! 'ExtData', 'Name' => 'CURRENCY', 'Value' => options[:currency] || currency(money)
+              xml.tag! 'ExtData', 'Name' => "ITEMAMT", 'Value' => amount(options[:subtotal] || money)
+            end
+            xml.tag! 'DiscountAmt', amount(options[:discount]) if options[:discount]
+            xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
+
+          end
+
+          xml.tag! 'Tender' do
+            add_paypal_details(xml, options)
+          end
+        end
+      end
+
+      def add_paypal_details(xml, options)
+         xml.tag! 'PayPal' do
+          xml.tag! 'EMail', options[:email] unless options[:email].blank?
+          xml.tag! 'ReturnURL', options[:return_url] unless options[:return_url].blank?
+          xml.tag! 'CancelURL', options[:cancel_return_url] unless options[:cancel_return_url].blank?
+          xml.tag! 'NotifyURL', options[:notify_url] unless options[:notify_url].blank?
+          xml.tag! 'PayerID', options[:payer_id] unless options[:payer_id].blank?
+          xml.tag! 'Token', options[:token] unless options[:token].blank?
+          xml.tag! 'NoShipping', options[:no_shipping] ? '1' : '0'
+          xml.tag! 'AddressOverride', options[:address_override] ? '1' : '0'
+          xml.tag! 'ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank? 
+          
+          # Customization of the payment page
+          xml.tag! 'PageStyle', options[:page_style] unless options[:page_style].blank?
+          xml.tag! 'HeaderImage', options[:header_image] unless options[:header_image].blank?
+          xml.tag! 'PayflowColor', options[:background_color] unless options[:background_color].blank?
+          # Note: HeaderImage and PayflowColor apply to both the new (as of 2010) and the old checkout experience
+          # HeaderBackColor and HeaderBorderColor apply only to the old checkout experience which is being phased out.
+          xml.tag! 'HeaderBackColor', options[:header_background_color] unless options[:header_background_color].blank?
+          xml.tag! 'HeaderBorderColor', options[:header_border_color] unless options[:header_border_color].blank?
+          xml.tag! 'ExtData', 'Name' => 'ALLOWNOTE', 'Value' => options[:allow_note]
+        end
+      end
+      
+      def build_response(success, message, response, options = {})
+        PayflowExpressResponse.new(success, message, response, options)
+      end
+    end
+  end
+end
+