bitfluent-activemerchant 1.5.1.1 → 1.15.1

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

@@ -0,0 +1,282 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # ActiveMerchant Implementation for Quantum Gateway XML Requester Service
+    # Based on API Doc from 8/6/2009
+    #
+    # Important Notes
+    # * Support is included for a customer id via the :customer option, invoice number via :invoice option, invoice description via :merchant option and memo via :description option
+    # * You can force email of receipt with :email_receipt => true
+    # * You can force email of merchant receipt with :merchant_receipt => true
+    # * You can exclude CVV with :ignore_cvv => true
+    # * All transactions use dollar values.
+    class QuantumGateway < Gateway
+      LIVE_URL = 'https://secure.quantumgateway.com/cgi/xml_requester.php'
+
+      # visa, master, american_express, discover
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_countries = ['US']
+      self.default_currency = 'USD'
+      self.money_format = :dollars
+      self.homepage_url = 'http://www.quantumgateway.com'
+      self.display_name = 'Quantum Gateway'
+
+      # These are the options that can be used when creating a new Quantum Gateway object.
+      #
+      # :login =>  Your Quantum Gateway Gateway ID
+      #
+      # :password =>  Your Quantum Gateway Vault Key or Restrict Key
+      #
+      # NOTE: For testing supply your test GatewayLogin and GatewayKey
+      #
+      # :email_receipt => true   if you want a receipt sent to the customer (false be default)
+      #
+      # :merchant_receipt  => true if you want to override receiving the merchant receipt
+      #
+      # :ignore_avs => true   ignore both AVS and CVV verification
+      # :ignore_cvv => true   don't want to use CVV so continue processing even if CVV would have failed
+      #
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      # Should run against the test servers or not?
+      def test?
+        @options[:test] || Base.gateway_mode == :test
+      end
+
+      # Request an authorization for an amount from CyberSource
+      #
+      def authorize(money, creditcard, options = {})
+        setup_address_hash(options)
+        commit(build_auth_request(money, creditcard, options), options )
+      end
+
+      # Capture an authorization that has previously been requested
+      def capture(money, authorization, options = {})
+        setup_address_hash(options)
+        commit(build_capture_request(money, authorization, options), options)
+      end
+
+      # Purchase is an auth followed by a capture
+      # You must supply an order_id in the options hash
+      def purchase(money, creditcard, options = {})
+        setup_address_hash(options)
+        commit(build_purchase_request(money, creditcard, options), options)
+      end
+
+      def void(identification, options = {})
+        commit(build_void_request(identification, options), options)
+      end
+
+      def refund(money, identification, options = {})
+        commit(build_credit_request(money, identification, options), options)
+      end
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
+      private
+
+      def setup_address_hash(options)
+        options[:billing_address] = options[:billing_address] || options[:address] || {}
+      end
+
+      def build_auth_request(money, creditcard, options)
+        xml = Builder::XmlMarkup.new
+        add_common_credit_card_info(xml,'AUTH_ONLY')
+        add_purchase_data(xml, money)
+        add_creditcard(xml, creditcard)
+        add_address(xml, creditcard, options[:billing_address], options)
+        add_invoice_details(xml, options)
+        add_customer_details(xml, options)
+        add_memo(xml, options)
+        add_business_rules_data(xml)
+        xml.target!
+      end
+
+      def build_capture_request(money, authorization, options)
+        xml = Builder::XmlMarkup.new
+        add_common_credit_card_info(xml,'PREVIOUS_SALE')
+        transaction_id, _ = authorization_parts_from(authorization)
+        add_transaction_id(xml, transaction_id)
+        xml.target!
+      end
+
+      def build_purchase_request(money, creditcard, options)
+        xml = Builder::XmlMarkup.new
+        add_common_credit_card_info(xml, @options[:ignore_avs] ||  @options[:ignore_cvv] ? 'SALES' : 'AUTH_CAPTURE')
+        add_address(xml, creditcard, options[:billing_address], options)
+        add_purchase_data(xml, money)
+        add_creditcard(xml, creditcard)
+        add_invoice_details(xml, options)
+        add_customer_details(xml, options)
+        add_memo(xml, options)
+        add_business_rules_data(xml)
+        xml.target!
+      end
+
+      def build_void_request(authorization, options)
+        xml = Builder::XmlMarkup.new
+        add_common_credit_card_info(xml,'VOID')
+        transaction_id, _ = authorization_parts_from(authorization)
+        add_transaction_id(xml, transaction_id)
+        xml.target!
+      end
+
+      def build_credit_request(money, authorization, options)
+        xml = Builder::XmlMarkup.new
+        add_common_credit_card_info(xml,'RETURN')
+        add_purchase_data(xml, money)
+        transaction_id, cc = authorization_parts_from(authorization)
+        add_transaction_id(xml, transaction_id)
+        xml.tag! 'CreditCardNumber', cc
+        xml.target!
+      end
+
+      def add_common_credit_card_info(xml, process_type)
+        xml.tag! 'RequestType', 'ProcessSingleTransaction'
+        xml.tag! 'TransactionType', 'CREDIT'
+        xml.tag! 'PaymentType', 'CC'
+        xml.tag! 'ProcessType', process_type
+      end
+
+      def add_business_rules_data(xml)
+        xml.tag!('CustomerEmail', @options[:email_receipt] ? 'Y' : 'N')
+        xml.tag!('MerchantEmail', @options[:merchant_receipt] ? 'Y' : 'N')
+      end
+
+      def add_invoice_details(xml, options)
+        xml.tag! 'InvoiceNumber', options[:invoice]
+        xml.tag! 'InvoiceDescription', options[:merchant]
+      end
+
+      def add_customer_details(xml, options)
+        xml.tag! 'CustomerID', options[:customer]
+      end
+
+      def add_transaction_id(xml, transaction_id)
+        xml.tag! 'TransactionID', transaction_id
+      end
+
+      def add_memo(xml, options)
+        xml.tag! 'Memo', options[:description]
+      end
+
+      def add_purchase_data(xml, money = 0)
+        xml.tag! 'Amount', amount(money)
+        xml.tag! 'TransactionDate', Time.now
+      end
+
+      def add_address(xml, creditcard, address, options, shipTo = false)
+        xml.tag! 'FirstName', creditcard.first_name
+        xml.tag! 'LastName', creditcard.last_name
+        xml.tag! 'Address', address[:address1] # => there is no support for address2 in quantum
+        xml.tag! 'City', address[:city]
+        xml.tag! 'State', address[:state]
+        xml.tag! 'ZipCode', address[:zip]
+        xml.tag! 'Country', address[:country]
+        xml.tag! 'EmailAddress', options[:email]
+        xml.tag! 'IPAddress', options[:ip]
+      end
+
+      def add_creditcard(xml, creditcard)
+        xml.tag! 'PaymentType', 'CC'
+        xml.tag! 'CreditCardNumber', creditcard.number
+        xml.tag! 'ExpireMonth', format(creditcard.month, :two_digits)
+        xml.tag! 'ExpireYear', format(creditcard.year, :four_digits)
+        xml.tag!('CVV2', creditcard.verification_value) unless (@options[:ignore_cvv] || creditcard.verification_value.blank? )
+      end
+
+      # Where we actually build the full SOAP request using builder
+      def build_request(body, options)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.tag! 'QGWRequest' do
+          xml.tag! 'Authentication' do
+            xml.tag! 'GatewayLogin', @options[:login]
+            xml.tag! 'GatewayKey', @options[:password]
+          end
+          xml.tag! 'Request' do
+            xml << body
+          end
+        end
+        xml.target!
+      end
+
+      # Contact CyberSource, make the SOAP request, and parse the reply into a Response object
+      def commit(request, options)
+        headers = { 'Content-Type' => 'text/xml' }
+        response = parse(ssl_post(LIVE_URL, build_request(request, options), headers))
+
+        success = response[:request_status] == "Success"
+        message = response[:request_message]
+
+        if success # => checking for connectivity success first
+          success = %w(APPROVED FORCED VOIDED).include?(response[:Status])
+          message = response[:StatusDescription]
+          authorization = success ? authorization_for(response) : nil
+        end
+
+        Response.new(success, message, response,
+        :test => test?,
+        :authorization => authorization,
+        :avs_result => { :code => response[:AVSResponseCode] },
+        :cvv_result => response[:CVV2ResponseCode]
+        )
+      end
+
+      # Parse the SOAP response
+      # Technique inspired by the Paypal Gateway
+      def parse(xml)
+        reply = {}
+
+        begin
+          xml = REXML::Document.new(xml)
+
+          root = REXML::XPath.first(xml, "//QGWRequest/ResponseSummary")
+          parse_element(reply, root)
+          reply[:request_status] = reply[:Status]
+          reply[:request_message] = "#{reply[:Status]}: #{reply[:StatusDescription]}"
+
+          if root = REXML::XPath.first(xml, "//QGWRequest/Result")
+            root.elements.to_a.each do |node|
+              parse_element(reply, node)
+            end
+          end
+        rescue Exception => e
+          reply[:request_status] = 'Failure'
+          reply[:request_message] = "Failure: There was a problem parsing the response XML"
+        end
+
+        return reply
+      end
+
+      def parse_element(reply, node)
+        if node.has_elements?
+          node.elements.each{|e| parse_element(reply, e) }
+        else
+          if node.parent.name =~ /item/
+            parent = node.parent.name + (node.parent.attributes["id"] ? "_" + node.parent.attributes["id"] : '')
+            reply[(parent + '_' + node.name).to_sym] = node.text
+          else
+            reply[node.name.to_sym] = node.text
+          end
+        end
+        return reply
+      end
+      
+      def authorization_for(reply)
+        "#{reply[:TransactionID]};#{reply[:CreditCardNumber]}"
+      end
+      
+      def authorization_parts_from(authorization)
+        authorization.split(/;/)
+      end
+
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module ActiveMerchant #:nodoc:
       self.default_currency = 'DKK'  
       self.money_format = :cents
       self.supported_cardtypes = [ :dankort, :forbrugsforeningen, :visa, :master, :american_express, :diners_club, :jcb, :maestro ]
-      self.supported_countries = ['DK']
+      self.supported_countries = ['DK', 'SE']
       self.homepage_url = 'http://quickpay.dk/'
       self.display_name = 'Quickpay'
       
@@ -75,7 +75,7 @@ module ActiveMerchant #:nodoc:
         commit(:cancel, post)
       end
       
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         post = {}
 
         add_amount_without_currency(post, money)
@@ -83,6 +83,11 @@ module ActiveMerchant #:nodoc:
 
         commit(:refund, post)
       end
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)      
+      end
       
       def store(creditcard, options = {})                       
         post = {}

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

@@ -3,11 +3,11 @@ require 'digest/sha1'
 
 module ActiveMerchant
   module Billing
-    # Realex us the leading CC gateway in Ireland
+    # Realex is the leading CC gateway in Ireland
     # see http://www.realexpayments.com
     # Contributed by John Ward (john@ward.name)
     # see http://thinedgeofthewedge.blogspot.com
-    # 
+    #
     # Realex works using the following
     # login - The unique id of the merchant
     # password - The secret is used to digitally sign the request
@@ -15,12 +15,12 @@ module ActiveMerchant
     # and is used if the merchant wishes do distuinguish cc traffic from the different sources
     # by using a different account. This must be created in advance
     #
-    # the Realex team decided to make the orderid unique per request, 
-    # so if validation fails you can not correct and resend using the 
+    # the Realex team decided to make the orderid unique per request,
+    # so if validation fails you can not correct and resend using the
     # same order id
     class RealexGateway < Gateway
       URL = 'https://epage.payandshop.com/epage-remote.cgi'
-                  
+
       CARD_MAPPING = {
         'master'            => 'MC',
         'visa'              => 'VISA',
@@ -30,46 +30,78 @@ module ActiveMerchant
         'solo'              => 'SWITCH',
         'laser'             => 'LASER'
       }
-      
+
       self.money_format = :cents
       self.default_currency = 'EUR'
       self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :switch, :solo, :laser ]
       self.supported_countries = [ 'IE', 'GB' ]
       self.homepage_url = 'http://www.realexpayments.com/'
       self.display_name = 'Realex'
-           
+
       SUCCESS, DECLINED          = "Successful", "Declined"
       BANK_ERROR = REALEX_ERROR  = "Gateway is in maintenance. Please try again later."
       ERROR = CLIENT_DEACTIVATED = "Gateway Error"
-      
+
       def initialize(options = {})
         requires!(options, :login, :password)
+        options[:refund_hash] = Digest::SHA1.hexdigest(options[:rebate_secret]) if options.has_key?(:rebate_secret)
         @options = options
         super
-      end  
-  
+      end
+
       def purchase(money, credit_card, options = {})
         requires!(options, :order_id)
-        
-        request = build_purchase_or_authorization_request(:purchase, money, credit_card, options) 
+
+        request = build_purchase_or_authorization_request(:purchase, money, credit_card, options)
+        commit(request)
+      end
+
+      def authorize(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        request = build_purchase_or_authorization_request(:authorization, money, creditcard, options)
+        commit(request)
+      end
+
+      def capture(money, authorization, options = {})
+        request = build_capture_request(authorization, options)
+        commit(request)
+      end
+
+      def refund(money, authorization, options = {})
+        request = build_refund_request(money, authorization, options)
+        commit(request)
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def void(authorization, options = {})
+        request = build_void_request(authorization, options)
         commit(request)
-      end     
-      
-      private           
-      def commit(request)        
+      end
+
+      private
+      def commit(request)
         response = parse(ssl_post(URL, request))
 
         Response.new(response[:result] == "00", message_from(response), response,
           :test => response[:message] =~ /\[ test system \]/,
-          :authorization => response[:authcode],
-          :cvv_result => response[:cvnresult]
-        )      
+          :authorization => authorization_from(response),
+          :cvv_result => response[:cvnresult],
+          :avs_result => {
+            :street_match => response[:avspostcoderesponse],
+            :postal_match => response[:avspostcoderesponse]
+          }
+        )
       end
 
       def parse(xml)
         response = {}
-        
-        xml = REXML::Document.new(xml)          
+
+        xml = REXML::Document.new(xml)
         xml.elements.each('//response/*') do |node|
 
           if (node.elements.size == 0)
@@ -78,88 +110,165 @@ module ActiveMerchant
             node.elements.each do |childnode|
               name = "#{node.name.downcase}_#{childnode.name.downcase}"
               response[name.to_sym] = normalize(childnode.text)
-            end              
+            end
           end
 
         end unless xml.root.nil?
 
         response
       end
-      
-      def parse_credit_card_number(request)
-        xml = REXML::Document.new(request)
-        card_number = REXML::XPath.first(xml, '/request/card/number')
-        card_number && card_number.text
+
+      def authorization_from(parsed)
+        [parsed[:orderid], parsed[:pasref], parsed[:authcode]].join(';')
       end
 
       def build_purchase_or_authorization_request(action, money, credit_card, options)
-        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-        
+        timestamp = new_timestamp
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'auth' do
-      
-          xml.tag! 'merchantid', @options[:login] 
-          xml.tag! 'account', @options[:account]
-      
+          add_merchant_details(xml, options)
           xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+          add_amount(xml, money, options)
+          add_card(xml, credit_card)
+          xml.tag! 'autosettle', 'flag' => auto_settle_flag(action)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), amount(money), (options[:currency] || currency(money)), credit_card.number)
+          add_comments(xml, options)
+          add_address_and_customer_info(xml, options)
+        end
+        xml.target!
+      end
+
+      def build_capture_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'settle' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), nil, nil, nil)
+        end
+        xml.target!
+      end
+
+      def build_refund_request(money, authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'rebate' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
           xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
+          xml.tag! 'refundhash', @options[:refund_hash] if @options[:refund_hash]
+          xml.tag! 'autosettle', 'flag' => 1
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), amount(money), (options[:currency] || currency(money)), nil)
+        end
+        xml.target!
+      end
 
-          xml.tag! 'card' do
-            xml.tag! 'number', credit_card.number
-            xml.tag! 'expdate', expiry_date(credit_card)
-            xml.tag! 'type', CARD_MAPPING[card_brand(credit_card).to_s]
-            xml.tag! 'chname', credit_card.name
-            xml.tag! 'issueno', credit_card.issue_number
-            
-            xml.tag! 'cvn' do
-              xml.tag! 'number', credit_card.verification_value
-              xml.tag! 'presind', credit_card.verification_value? ? 1 : nil
-            end
-          end
-          
-          xml.tag! 'autosettle', 'flag' => auto_settle_flag(action)
-          xml.tag! 'sha1hash', sha1from("#{timestamp}.#{@options[:login]}.#{sanitize_order_id(options[:order_id])}.#{amount(money)}.#{options[:currency] || currency(money)}.#{credit_card.number}")
-          xml.tag! 'comments' do
-            xml.tag! 'comment', options[:description], 'id' => 1 
-            xml.tag! 'comment', 'id' => 2
-          end
-          
-          billing_address = options[:billing_address] || options[:address] || {}
-          shipping_address = options[:shipping_address] || {}
-          
-          xml.tag! 'tssinfo' do
+      def build_void_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'void' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), nil, nil, nil)
+        end
+        xml.target!
+      end
+
+      def add_address_and_customer_info(xml, options)
+        billing_address = options[:billing_address] || options[:address]
+        shipping_address = options[:shipping_address]
+
+        return unless billing_address || shipping_address || options[:customer] || options[:invoice] || options[:ip]
+
+        xml.tag! 'tssinfo' do
+          xml.tag! 'custnum', options[:customer] if options[:customer]
+          xml.tag! 'prodid', options[:invoice] if options[:invoice]
+          xml.tag! 'custipaddress', options[:ip] if options[:ip]
+
+          if billing_address
             xml.tag! 'address', 'type' => 'billing' do
-              xml.tag! 'code', billing_address[:zip]
+              xml.tag! 'code', avs_input_code( billing_address )
               xml.tag! 'country', billing_address[:country]
             end
+          end
 
+          if shipping_address
             xml.tag! 'address', 'type' => 'shipping' do
               xml.tag! 'code', shipping_address[:zip]
               xml.tag! 'country', shipping_address[:country]
             end
-            
-            xml.tag! 'custnum', options[:customer]
-            
-            xml.tag! 'prodid', options[:invoice]
-            xml.tag! 'varref'
           end
         end
+      end
 
-        xml.target!
+      def add_merchant_details(xml, options)
+        xml.tag! 'merchantid', @options[:login]
+        if options[:account] || @options[:account]
+          xml.tag! 'account', (options[:account] || @options[:account])
+        end
+      end
+
+      def add_transaction_identifiers(xml, authorization, options)
+        options[:order_id], pasref, authcode = authorization.split(';')
+        xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+        xml.tag! 'pasref', pasref
+        xml.tag! 'authcode', authcode
+      end
+
+      def add_comments(xml, options)
+        return unless options[:description]
+        xml.tag! 'comments' do
+          xml.tag! 'comment', options[:description], 'id' => 1
+        end
+      end
+
+      def add_amount(xml, money, options)
+        xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
       end
-      
+
+      def add_card(xml, credit_card)
+        xml.tag! 'card' do
+          xml.tag! 'number', credit_card.number
+          xml.tag! 'expdate', expiry_date(credit_card)
+          xml.tag! 'chname', credit_card.name
+          xml.tag! 'type', CARD_MAPPING[card_brand(credit_card).to_s]
+          xml.tag! 'issueno', credit_card.issue_number
+          xml.tag! 'cvn' do
+            xml.tag! 'number', credit_card.verification_value
+            xml.tag! 'presind', (options['presind'] || (credit_card.verification_value? ? 1 : nil))
+          end
+        end
+      end
+
+      def avs_input_code(address)
+        address.values_at(:zip, :address1).map{ |v| extract_digits(v) }.join('|')
+      end
+
+      def extract_digits(string)
+        return "" if string.nil?
+        string.gsub(/[\D]/,'')
+      end
+
+      def new_timestamp
+        Time.now.strftime('%Y%m%d%H%M%S')
+      end
+
+      def add_signed_digest(xml, *values)
+        string = Digest::SHA1.hexdigest(values.join("."))
+        xml.tag! 'sha1hash', Digest::SHA1.hexdigest([string, @options[:password]].join("."))
+      end
+
       def auto_settle_flag(action)
         action == :authorization ? '0' : '1'
       end
-      
+
       def expiry_date(credit_card)
         "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
       end
-      
-      def sha1from(string)
-        Digest::SHA1.hexdigest("#{Digest::SHA1.hexdigest(string)}.#{@options[:password]}")
-      end
-      
+
       def normalize(field)
         case field
         when "true"   then true
@@ -167,12 +276,12 @@ module ActiveMerchant
         when ""       then nil
         when "null"   then nil
         else field
-        end        
+        end
       end
-      
+
       def message_from(response)
         message = nil
-        case response[:result]                
+        case response[:result]
         when "00"
           message = SUCCESS
         when "101"
@@ -184,14 +293,16 @@ module ActiveMerchant
         when /^3[0-9][0-9]/
           message = REALEX_ERROR
         when /^5[0-9][0-9]/
+          message = response[:message]
+        when "600", "601", "603"
           message = ERROR
         when "666"
           message = CLIENT_DEACTIVATED
         else
           message = DECLINED
-        end  
+        end
       end
-      
+
       def sanitize_order_id(order_id)
         order_id.to_s.gsub(/[^a-zA-Z0-9\-_]/, '')
       end