activemerchant 1.11.0 → 1.12.0

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

@@ -78,6 +78,8 @@ module ActiveMerchant #:nodoc:
                 
                 xml.tag! 'n2:NotifyURL', options[:notify_url]
                 xml.tag! 'n2:ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank?
+                xml.tag! 'n2:InvoiceID', options[:order_id]
+                xml.tag! 'n2:OrderDescription', options[:description]
               end
             end
           end
@@ -94,20 +96,50 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'SetExpressCheckoutRequest', 'xmlns:n2' => EBAY_NAMESPACE do
             xml.tag! 'n2:Version', API_VERSION
             xml.tag! 'n2:SetExpressCheckoutRequestDetails' do
-              xml.tag! 'n2:PaymentAction', action
-              xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), 'currencyID' => currency_code
               if options[:max_amount]
                 xml.tag! 'n2:MaxAmount', localized_amount(options[:max_amount], currency_code), 'currencyID' => currency_code
               end
+              if !options[:allow_note].nil?
+                xml.tag! 'n2:AllowNote', options[:allow_note] ? '1' : '0'
+              end
+              xml.tag! 'n2:PaymentDetails' do
+                xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), 'currencyID' => currency_code
+                # All of the values must be included together and add up to the order total
+                if [:subtotal, :shipping, :handling, :tax].all? { |o| options.has_key?(o) }
+                  xml.tag! 'n2:ItemTotal', localized_amount(options[:subtotal], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:ShippingTotal', localized_amount(options[:shipping], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:HandlingTotal', localized_amount(options[:handling], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:TaxTotal', localized_amount(options[:tax], currency_code), 'currencyID' => currency_code
+                end
+
+                xml.tag! 'n2:OrderDescription', options[:description]
+                xml.tag! 'n2:InvoiceID', options[:order_id]
+
+                if options[:items]
+                  options[:items].each do |item|
+                    xml.tag! 'n2:PaymentDetailsItem' do
+                      xml.tag! 'n2:Name', item[:name]
+                      xml.tag! 'n2:Number', item[:number]
+                      xml.tag! 'n2:Quantity', item[:quantity]
+                      if item[:amount]
+                        xml.tag! 'n2:Amount', localized_amount(item[:amount], currency_code), 'currencyID' => currency_code
+                      end
+                      xml.tag! 'n2:Description', item[:description]
+                      xml.tag! 'n2:ItemURL', item[:url]
+                    end
+                  end
+                end
+
+                xml.tag! 'n2:PaymentAction', action
+              end
+
               add_address(xml, 'n2:Address', options[:shipping_address] || options[:address])
               xml.tag! 'n2:AddressOverride', options[:address_override] ? '1' : '0'
               xml.tag! 'n2:NoShipping', options[:no_shipping] ? '1' : '0'
               xml.tag! 'n2:ReturnURL', options[:return_url]
               xml.tag! 'n2:CancelURL', options[:cancel_return_url]
               xml.tag! 'n2:IPAddress', options[:ip] unless options[:ip].blank?
-              xml.tag! 'n2:OrderDescription', options[:description]
               xml.tag! 'n2:BuyerEmail', options[:email] unless options[:email].blank?
-              xml.tag! 'n2:InvoiceID', options[:order_id]
               
               if options[:billing_agreement]
                 xml.tag! 'n2:BillingAgreementDetails' do
@@ -119,7 +151,7 @@ module ActiveMerchant #:nodoc:
         
               # Customization of the payment page
               xml.tag! 'n2:PageStyle', options[:page_style] unless options[:page_style].blank?
-              xml.tag! 'n2:cpp-image-header', options[:header_image] unless options[:header_image].blank?
+              xml.tag! 'n2:cpp-header-image', options[:header_image] unless options[:header_image].blank?
               xml.tag! 'n2:cpp-header-back-color', options[:header_background_color] unless options[:header_background_color].blank?
               xml.tag! 'n2:cpp-header-border-color', options[:header_border_color] unless options[:header_border_color].blank?
               xml.tag! 'n2:cpp-payflow-color', options[:background_color] unless options[:background_color].blank?

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

@@ -0,0 +1,290 @@
+require 'securerandom'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class QbmsGateway < Gateway
+      API_VERSION = '4.0'
+
+      class_inheritable_accessor :test_url, :live_url
+
+      self.test_url = "https://webmerchantaccount.ptc.quickbooks.com/j/AppGateway"
+      self.live_url = "https://webmerchantaccount.quickbooks.com/j/AppGateway"
+
+      self.homepage_url = 'http://payments.intuit.com/'
+      self.display_name = 'QuickBooks Merchant Services'
+      self.default_currency = 'USD'
+      self.supported_cardtypes = [ :visa, :master, :discover, :american_express, :diners_club, :jcb ]
+      self.supported_countries = [ 'US' ]
+
+      TYPES = {
+        :authorize => 'CustomerCreditCardAuth',
+        :capture   => 'CustomerCreditCardCapture',
+        :purchase  => 'CustomerCreditCardCharge',
+        :refund    => 'CustomerCreditCardTxnVoidOrRefund',
+        :void      => 'CustomerCreditCardTxnVoid',
+        :query     => 'MerchantAccountQuery',
+      }
+
+      # Creates a new QbmsGateway
+      #
+      # The gateway requires that a valid app id, app login, and ticket be passed
+      # in the +options+ hash.
+      #
+      # ==== Options
+      #
+      # * <tt>:login</tt> -- The App Login (REQUIRED)
+      # * <tt>:ticket</tt> -- The Connection Ticket. (REQUIRED)
+      # * <tt>:pem</tt> -- The PEM-encoded SSL client key and certificate. (REQUIRED)
+      # * <tt>:test</tt> -- +true+ or +false+. If true, perform transactions against the test server.
+      #   Otherwise, perform transactions against the production server.
+      #
+      def initialize(options = {})
+        requires!(options, :login, :ticket)
+        test_mode = options[:test] || false
+        @options = options
+        super
+      end
+
+      # Performs an authorization, which reserves the funds on the customer's credit card, but does not
+      # charge the card.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be authorized as an Integer value in cents.
+      # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
+      # * <tt>options</tt> -- A hash of optional parameters.
+      #
+      def authorize(money, creditcard, options = {})
+        commit(:authorize, money, options.merge(:credit_card => creditcard))
+      end
+
+      # Perform a purchase, which is essentially an authorization and capture in a single operation.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be purchased as an Integer value in cents.
+      # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
+      # * <tt>options</tt> -- A hash of optional parameters.
+      #
+      def purchase(money, creditcard, options = {})
+        commit(:purchase, money, options.merge(:credit_card => creditcard))
+      end
+
+      # Captures the funds from an authorized transaction.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be captured as an Integer value in cents.
+      # * <tt>authorization</tt> -- The authorization returned from the previous authorize request.
+      #
+      def capture(money, authorization, options = {})
+        commit(:capture, money, options.merge(:transaction_id => authorization))
+      end
+
+      # Void a previous transaction
+      #
+      # ==== Parameters
+      #
+      # * <tt>authorization</tt> - The authorization returned from the previous authorize request.
+      #
+      def void(authorization, options = {})
+        commit(:void, nil, options.merge(:transaction_id => authorization))
+      end
+
+      # Credit an account.
+      #
+      # This transaction is also referred to as a Refund and indicates to the gateway that
+      # money should flow from the merchant to the customer.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be credited to the customer as an Integer value in cents.
+      # * <tt>identification</tt> -- The ID of the original transaction against which the credit is being issued.
+      # * <tt>options</tt> -- A hash of parameters.
+      #
+      #
+      def credit(money, identification, options = {})
+        commit(:refund, money, options.merge(:transaction_id => identification))
+      end
+
+      # Query the merchant account status
+      def query
+        commit(:query, nil, {})
+      end
+
+      private
+      
+      def hosted?
+        @options[:pem]
+      end
+
+      def commit(action, money, parameters)
+        url = test? ? self.test_url : self.live_url
+
+        type = TYPES[action]
+        parameters[:trans_request_id] ||= SecureRandom.hex(10)
+
+        req = build_request(type, money, parameters)
+        data = ssl_post(url, req, "Content-Type" => "application/x-qbmsxml")
+        response = parse(type, data)
+        message = (response[:status_message] || '').strip
+
+        Response.new(success?(response), message, response,
+          :test          => test?,
+          :authorization => response[:credit_card_trans_id],
+          :fraud_review  => fraud_review?(response),
+          :avs_result    => { :code => avs_result(response) },
+          :cvv_result    => cvv_result(response)
+        )
+      end
+
+      def success?(response)
+        response[:status_code] == 0
+      end
+
+      def fraud_review?(response)
+        [10100, 10101].member? response[:status_code]
+      end
+
+      def parse(type, body)
+        xml = REXML::Document.new(body)
+
+        signon = REXML::XPath.first(xml, "//SignonMsgsRs/#{hosted? ? 'SignonAppCertRs' : 'SignonDesktopRs'}")
+        status_code = signon.attributes["statusCode"].to_i
+
+        if status_code != 0
+          return {
+            :status_code    => status_code,
+            :status_message => signon.attributes["statusMessage"],
+          }
+        end
+
+        response = REXML::XPath.first(xml, "//QBMSXMLMsgsRs/#{type}Rs")
+
+        results = {
+          :status_code    => response.attributes["statusCode"].to_i,
+          :status_message => response.attributes["statusMessage"],
+        }
+
+        response.elements.each do |e|
+          name  = e.name.underscore.to_sym
+          value = e.text()
+
+          if old_value = results[name]
+            results[name] = [old_value] if !old_value.kind_of?(Array)
+            results[name] << value
+          else
+            results[name] = value
+          end
+        end
+
+        results
+      end
+
+      def build_request(type, money, parameters = {})
+        xml = Builder::XmlMarkup.new(:indent => 0)
+
+        xml.instruct!(:xml, :version => '1.0', :encoding => 'utf-8')
+        xml.instruct!(:qbmsxml, :version => API_VERSION)
+
+        xml.tag!("QBMSXML") do
+          xml.tag!("SignonMsgsRq") do
+            xml.tag!(hosted? ? "SignonAppCertRq" : "SignonDesktopRq") do
+              xml.tag!("ClientDateTime", Time.now.xmlschema)
+              xml.tag!("ApplicationLogin", @options[:login])
+              xml.tag!("ConnectionTicket", @options[:ticket])
+            end
+          end
+
+          xml.tag!("QBMSXMLMsgsRq") do
+            xml.tag!("#{type}Rq") do
+              method("build_#{type}").call(xml, money, parameters)
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_CustomerCreditCardAuth(xml, money, parameters)
+        cc = parameters[:credit_card]
+        name = "#{cc.first_name} #{cc.last_name}"[0...30]
+
+        xml.tag!("TransRequestID", parameters[:trans_request_id])
+        xml.tag!("CreditCardNumber", cc.number)
+        xml.tag!("ExpirationMonth", cc.month)
+        xml.tag!("ExpirationYear", cc.year)
+        xml.tag!("IsECommerce", "true")
+        xml.tag!("Amount", amount(money))
+        xml.tag!("NameOnCard", name)
+        add_address(xml, parameters)
+        xml.tag!("CardSecurityCode", cc.verification_value) if cc.verification_value?
+      end
+
+      def build_CustomerCreditCardCapture(xml, money, parameters)
+        xml.tag!("TransRequestID", parameters[:trans_request_id])
+        xml.tag!("CreditCardTransID", parameters[:transaction_id])
+        xml.tag!("Amount", amount(money))
+      end
+
+      def build_CustomerCreditCardCharge(xml, money, parameters)
+        cc = parameters[:credit_card]
+        name = "#{cc.first_name} #{cc.last_name}"[0...30]
+
+        xml.tag!("TransRequestID", parameters[:trans_request_id])
+        xml.tag!("CreditCardNumber", cc.number)
+        xml.tag!("ExpirationMonth", cc.month)
+        xml.tag!("ExpirationYear", cc.year)
+        xml.tag!("IsECommerce", "true")
+        xml.tag!("Amount", amount(money))
+        xml.tag!("NameOnCard", name)
+        add_address(xml, parameters)
+        xml.tag!("CardSecurityCode", cc.verification_value) if cc.verification_value?
+      end
+
+      def build_CustomerCreditCardTxnVoidOrRefund(xml, money, parameters)
+        xml.tag!("TransRequestID", parameters[:trans_request_id])
+        xml.tag!("CreditCardTransID", parameters[:transaction_id])
+        xml.tag!("Amount", amount(money))
+      end
+
+      def build_CustomerCreditCardTxnVoid(xml, money, parameters)
+        xml.tag!("TransRequestID", parameters[:trans_request_id])
+        xml.tag!("CreditCardTransID", parameters[:transaction_id])
+      end
+
+      # Called reflectively by build_request
+      def build_MerchantAccountQuery(xml, money, parameters)
+      end
+
+      def add_address(xml, parameters)
+        if address = parameters[:billing_address] || parameters[:address]
+          xml.tag!("CreditCardAddress", address[:address1][0...30])
+          xml.tag!("CreditCardPostalCode", address[:zip][0...9])
+        end
+      end
+
+      def cvv_result(response)
+        case response[:card_security_code_match]
+        when "Pass"         then 'M'
+        when "Fail"         then 'N'
+        when "NotAvailable" then 'P'
+        end
+      end
+
+      def avs_result(response)
+        case "#{response[:avs_street]}|#{response[:avs_zip]}"
+        when "Pass|Pass"                 then "D"
+        when "Pass|Fail"                 then "A"
+        when "Pass|NotAvailable"         then "B"
+        when "Fail|Pass"                 then "Z"
+        when "Fail|Fail"                 then "C"
+        when "Fail|NotAvailable"         then "N"
+        when "NotAvailable|Pass"         then "P"
+        when "NotAvailable|Fail"         then "N"
+        when "NotAvailable|NotAvailable" then "U"
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/direc_pay/helper.rb

@@ -14,7 +14,7 @@ module ActiveMerchant #:nodoc:
                                      :state    => 'custState',
                                      :zip      => 'custPinCode',
                                      :country  => 'custCountry',
-                                     :phone2   => 'custMobileNo'
+                                     :phone    => 'custMobileNo'
 
           mapping :shipping_address, :name     => 'deliveryName',
                                      :city     => 'deliveryCity',
@@ -22,7 +22,7 @@ module ActiveMerchant #:nodoc:
                                      :state    => 'deliveryState',
                                      :zip      => 'deliveryPinCode',
                                      :country  => 'deliveryCountry',
-                                     :phone2   => 'deliveryMobileNo'
+                                     :phone    => 'deliveryMobileNo'
 
           mapping :customer, :name  => 'custName',
                              :email => 'custEmailId'
@@ -79,16 +79,13 @@ module ActiveMerchant #:nodoc:
           end
           
           def shipping_address(params = {})
-            add_street_address!(params)
+            update_address(:shipping_address, params)
             super(params.dup)
-            add_field(mappings[:shipping_address][:name], fields[mappings[:customer][:name]]) if fields[mappings[:shipping_address][:name]].blank?
-            add_phone_for!(:shipping_address, params)
           end
           
           def billing_address(params = {})
-            add_street_address!(params)
+            update_address(:billing_address, params)
             super(params.dup)
-            add_phone_for!(:billing_address, params)
           end
           
           def form_fields
@@ -123,24 +120,27 @@ module ActiveMerchant #:nodoc:
             end
           end
           
-          def add_street_address!(params)
+          def update_address(address_type, params)
             address = params[:address1]
             address << " #{params[:address2]}" if params[:address2]
-            params.merge!(:address1 => address)
+            params[:address1] = address
+            params[:phone] = normalize_phone_number(params[:phone])
+            add_land_line_phone_for(address_type, params)
+            
+            if address_type == :shipping_address && params[:name].blank?
+              add_field(mappings[:shipping_address][:name], fields[mappings[:customer][:name]])
+            end
           end
-                    
-          def add_phone_for!(address_type, params)
+          
+          # Split a single phone number into the country code, area code and local number as best as possible
+          def add_land_line_phone_for(address_type, params)
             address_field = address_type == :billing_address ? 'custPhoneNo' : 'deliveryPhNo'
             
-            if params.has_key?(:phone)
-              country = fields[mappings[address_type][:country]]
-              phone = params[:phone].to_s
-              # Remove all non digits
-              phone.gsub!(/[^\d ]+/, '')
-              
+            if params.has_key?(:phone2)
+              phone = normalize_phone_number(params[:phone2])
               phone_country_code, phone_area_code, phone_number = nil
-
-              if country == 'IN' && phone =~ /(91)? *(\d{3}) *(\d{4,})$/
+              
+              if params[:country] == 'IN' && phone =~ /(91)? *(\d{3}) *(\d{4,})$/
                 phone_country_code, phone_area_code, phone_number = $1, $2, $3
               else
                 numbers = phone.split(' ')
@@ -154,13 +154,17 @@ module ActiveMerchant #:nodoc:
                   phone_area_code, phone_number = $1, $2
                 end
               end
-
-              add_field("#{address_field}1", phone_country_code || phone_code_for_country(country) || '91')
+              
+              add_field("#{address_field}1", phone_country_code || phone_code_for_country(params[:country]) || '91')
               add_field("#{address_field}2", phone_area_code)
               add_field("#{address_field}3", phone_number)
             end
           end
           
+          def normalize_phone_number(phone)
+            phone.gsub(/[^\d ]+/, '') if phone
+          end
+          
           # Special characters are NOT allowed while posting transaction parameters on DirecPay system
           def remove_special_characters(string)
             string.gsub(/[~"'&#%]/, '-')