n8_activemerchant 1.9.3

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

@@ -0,0 +1,277 @@
+require 'rexml/document'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # First, make sure you have everything setup correctly and all of your dependencies in place with:
+    # 
+    #   require 'rubygems'
+    #   require 'active_merchant'
+    #
+    # ActiveMerchant expects the amounts to be given as an Integer in cents. In this case, $10 US becomes 1000.
+    #
+    #   tendollar = 1000
+    #
+    # Next, create a credit card object using a TC approved test card.
+    #
+    #   creditcard = ActiveMerchant::Billing::CreditCard.new(
+    #	    :number => '4111111111111111',
+    #	    :month => 8,
+    #	    :year => 2006,
+    #	    :first_name => 'Longbob',
+    #     :last_name => 'Longsen'
+    #   )
+    #   options = {
+    #     :order_id => '1230123',
+    #     :email => 'bob@testbob.com',
+    #     :address => { :address1 => '47 Bobway',
+    #                   :city => 'Bobville', 
+    #                   :state => 'WA',
+    #                   :country => 'Australia',
+    #                   :zip => '2000'
+    #                 }
+    #     :description => 'purchased items'
+    #   }
+    #
+    # To finish setting up, create the active_merchant object you will be using, with the eWay gateway. If you have a
+    # functional eWay account, replace :login with your account info. 
+    #
+    #   gateway = ActiveMerchant::Billing::Base.gateway(:eway).new(:login => '87654321')
+    #
+    # Now we are ready to process our transaction
+    #
+    #   response = gateway.purchase(tendollar, creditcard, options)
+    #
+    # Sending a transaction to TrustCommerce with active_merchant returns a Response object, which consistently allows you to:
+    #
+    # 1) Check whether the transaction was successful
+    #
+    #   response.success?
+    #
+    # 2) Retrieve any message returned by eWay, either a "transaction was successful" note or an explanation of why the
+    # transaction was rejected.
+    #
+    #   response.message
+    #
+    # 3) Retrieve and store the unique transaction ID returned by eWway, for use in referencing the transaction in the future.
+    #
+    #   response.authorization
+    #
+    # This should be enough to get you started with eWay and active_merchant. For further information, review the methods
+    # below and the rest of active_merchant's documentation.
+
+    class EwayGateway < Gateway 
+      TEST_URL     = 'https://www.eway.com.au/gateway/xmltest/testpage.asp'
+      LIVE_URL     = 'https://www.eway.com.au/gateway/xmlpayment.asp'
+      
+      TEST_CVN_URL = 'https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp'
+      LIVE_CVN_URL = 'https://www.eway.com.au/gateway_cvn/xmlpayment.asp'
+      
+      MESSAGES = {
+        "00" => "Transaction Approved",
+        "01" => "Refer to Issuer",
+        "02" => "Refer to Issuer, special",	
+        "03" => "No Merchant",
+        "04" => "Pick Up Card",	
+        "05" => "Do Not Honour",	
+        "06" => "Error",
+        "07" => "Pick Up Card, Special",	
+        "08" => "Honour With Identification",	
+        "09" => "Request In Progress",
+        "10" => "Approved For Partial Amount",	
+        "11" => "Approved, VIP",	
+        "12" => "Invalid Transaction",	
+        "13" => "Invalid Amount",
+        "14" => "Invalid Card Number",	
+        "15" => "No Issuer",	
+        "16" => "Approved, Update Track 3",	
+        "19" => "Re-enter Last Transaction",	
+        "21" => "No Action Taken",	
+        "22" => "Suspected Malfunction",	
+        "23" => "Unacceptable Transaction Fee",	
+        "25" => "Unable to Locate Record On File",	
+        "30" => "Format Error",	
+        "31" => "Bank Not Supported By Switch",	
+        "33" => "Expired Card, Capture",	
+        "34" => "Suspected Fraud, Retain Card",	
+        "35" => "Card Acceptor, Contact Acquirer, Retain Card",	
+        "36" => "Restricted Card, Retain Card",	
+        "37" => "Contact Acquirer Security Department, Retain Card",	
+        "38" => "PIN Tries Exceeded, Capture",	
+        "39" => "No Credit Account",	
+        "40" => "Function Not Supported",	
+        "41" => "Lost Card",	
+        "42" => "No Universal Account",	
+        "43" => "Stolen Card",	
+        "44" => "No Investment Account",	
+        "51" => "Insufficient Funds",	
+        "52" => "No Cheque Account",	
+        "53" => "No Savings Account",	
+        "54" => "Expired Card",	
+        "55" => "Incorrect PIN",	
+        "56" => "No Card Record",	
+        "57" => "Function Not Permitted to Cardholder",	
+        "58" => "Function Not Permitted to Terminal",	
+        "59" => "Suspected Fraud",	
+        "60" => "Acceptor Contact Acquirer",	
+        "61" => "Exceeds Withdrawal Limit",	
+        "62" => "Restricted Card",	
+        "63" => "Security Violation",	
+        "64" => "Original Amount Incorrect",	
+        "66" => "Acceptor Contact Acquirer, Security",	
+        "67" => "Capture Card",	
+        "75" => "PIN Tries Exceeded",	
+        "82" => "CVV Validation Error",	
+        "90" => "Cutoff In Progress",	
+        "91" => "Card Issuer Unavailable",	
+        "92" => "Unable To Route Transaction",	
+        "93" => "Cannot Complete, Violation Of The Law",	
+        "94" => "Duplicate Transaction",	
+        "96" => "System Error"
+      }
+      
+	    self.money_format = :cents
+      self.supported_countries = ['AU']
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'http://www.eway.com.au/'
+      self.display_name = 'eWAY'
+	    
+    	def initialize(options = {})
+        requires!(options, :login)
+        @options = options
+        super
+    	end
+
+      # ewayCustomerEmail, ewayCustomerAddress, ewayCustomerPostcode
+      def purchase(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        post = {}
+        add_creditcard(post, creditcard)
+        add_address(post, options)  
+        add_customer_data(post, options)
+        add_invoice_data(post, options)
+        # The request fails if all of the fields aren't present
+        add_optional_data(post)
+    
+        commit(money, post)
+      end
+      
+      def test?
+        @options[:test] || super
+      end
+      
+      private                       
+      def add_creditcard(post, creditcard)
+        post[:CardNumber]  = creditcard.number
+        post[:CardExpiryMonth]  = sprintf("%.2i", creditcard.month)
+        post[:CardExpiryYear] = sprintf("%.4i", creditcard.year)[-2..-1]
+        post[:CustomerFirstName] = creditcard.first_name
+        post[:CustomerLastName]  = creditcard.last_name
+        post[:CardHoldersName] = creditcard.name
+              
+        post[:CVN] = creditcard.verification_value if creditcard.verification_value?
+      end 
+
+      def add_address(post, options)
+        if address = options[:billing_address] || options[:address]
+          post[:CustomerAddress]    = [ address[:address1], address[:address2], address[:city], address[:state], address[:country] ].compact.join(', ')
+          post[:CustomerPostcode]   = address[:zip]
+        end
+      end
+
+      def add_customer_data(post, options)
+        post[:CustomerEmail] = options[:email]
+      end
+      
+      def add_invoice_data(post, options)
+        post[:CustomerInvoiceRef] = options[:order_id]
+        post[:CustomerInvoiceDescription] = options[:description]
+      end
+
+      def add_optional_data(post)
+        post[:TrxnNumber] = nil
+        post[:Option1] = nil
+        post[:Option2] = nil
+        post[:Option3] = nil     
+      end
+
+      def commit(money, parameters)       
+        parameters[:TotalAmount] = amount(money)
+
+        response = parse( ssl_post(gateway_url(parameters[:CVN], test?), post_data(parameters)) )
+
+        Response.new(success?(response), message_from(response[:ewaytrxnerror]), response,
+          :authorization => response[:ewayauthcode],
+          :test => /\(Test( CVN)? Gateway\)/ === response[:ewaytrxnerror]
+        )      
+      end
+      
+      def success?(response)
+        response[:ewaytrxnstatus] == "True"
+      end
+                                             
+      # Parse eway response xml into a convinient hash
+      def parse(xml)
+        #  "<?xml version=\"1.0\"?>".
+        #  <ewayResponse>
+        #  <ewayTrxnError></ewayTrxnError>
+        #  <ewayTrxnStatus>True</ewayTrxnStatus>
+        #  <ewayTrxnNumber>10002</ewayTrxnNumber>
+        #  <ewayTrxnOption1></ewayTrxnOption1>
+        #  <ewayTrxnOption2></ewayTrxnOption2>
+        #  <ewayTrxnOption3></ewayTrxnOption3>
+        #  <ewayReturnAmount>10</ewayReturnAmount>
+        #  <ewayAuthCode>123456</ewayAuthCode>
+        #  <ewayTrxnReference>987654321</ewayTrxnReference>
+        #  </ewayResponse>     
+
+        response = {}
+        xml = REXML::Document.new(xml)          
+        xml.elements.each('//ewayResponse/*') do |node|
+
+          response[node.name.downcase.to_sym] = normalize(node.text)
+
+        end unless xml.root.nil?
+
+        response
+      end   
+
+      def post_data(parameters = {})
+        parameters[:CustomerID] = @options[:login]
+        
+        xml   = REXML::Document.new
+        root  = xml.add_element("ewaygateway")
+        
+        parameters.each do |key, value|
+          root.add_element("eway#{key}").text = value
+        end    
+        xml.to_s
+      end
+    
+      def message_from(message)
+        return '' if message.blank?
+        MESSAGES[message[0,2]] || message
+      end
+
+      # Make a ruby type out of the response string
+      def normalize(field)
+        case field
+        when "true"   then true
+        when "false"  then false
+        when ""       then nil
+        when "null"   then nil
+        else field
+        end        
+      end
+      
+      def gateway_url(cvn, test)
+        if cvn
+          test ? TEST_CVN_URL : LIVE_CVN_URL
+        else
+          test ? TEST_URL : LIVE_URL
+        end
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,222 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ExactGateway < Gateway
+      URL = 'https://secure2.e-xact.com/vplug-in/transaction/rpc-enc/service.asmx'
+      
+      API_VERSION = "8.5"
+      
+      TEST_LOGINS = [ {:login => "A00049-01", :password => "test1"},
+                      {:login => "A00427-01", :password => "testus"} ]
+      
+      TRANSACTIONS = { :sale          => "00",
+                       :authorization => "01",
+                       :capture       => "32",
+                       :credit        => "34" }
+      
+
+      ENVELOPE_NAMESPACES = { 'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                              'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+                              'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+                            }
+                            
+      SEND_AND_COMMIT_ATTRIBUTES = { 'xmlns:n1' => "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/Request",
+                                     'env:encodingStyle' => 'http://schemas.xmlsoap.org/soap/encoding/'
+                                   }
+                                   
+      SEND_AND_COMMIT_SOURCE_ATTRIBUTES = { 'xmlns:n2' => 'http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/encodedTypes',
+                                            'xsi:type' => 'n2:Transaction'
+                                          }
+      
+      POST_HEADERS = { 'soapAction' => "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/SendAndCommit",
+                       'Content-Type' => 'text/xml' 
+                     }
+                     
+      SUCCESS = "true"
+      
+      SENSITIVE_FIELDS = [ :verification_str2, :expiry_date, :card_number ]
+      
+      self.supported_cardtypes = [:visa, :master, :american_express, :jcb, :discover]
+      self.supported_countries = ['CA', 'US']
+      self.homepage_url = 'http://www.e-xact.com'
+      self.display_name = 'E-xact'
+  
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        
+        if TEST_LOGINS.include?( { :login => options[:login], :password => options[:password] } )
+          @test_mode = true
+        end
+      
+        super
+      end
+      
+      def test?
+        @test_mode || Base.gateway_mode == :test
+      end
+      
+      def authorize(money, credit_card, options = {})
+        commit(:authorization, build_sale_or_authorization_request(money, credit_card, options))
+      end
+      
+      def purchase(money, credit_card, options = {})
+        commit(:sale, build_sale_or_authorization_request(money, credit_card, options))
+      end
+    
+      def capture(money, authorization, options = {})
+        commit(:capture, build_capture_or_credit_request(money, authorization, options))
+      end
+
+      def credit(money, authorization, options = {})
+        commit(:credit, build_capture_or_credit_request(money, authorization, options))
+      end
+         
+      private                       
+      def build_request(action, body)
+        xml = Builder::XmlMarkup.new
+        
+        xml.instruct!
+        xml.tag! 'env:Envelope', ENVELOPE_NAMESPACES do
+          xml.tag! 'env:Body' do
+            xml.tag! 'n1:SendAndCommit', SEND_AND_COMMIT_ATTRIBUTES do
+              xml.tag! 'SendAndCommitSource', SEND_AND_COMMIT_SOURCE_ATTRIBUTES do
+                add_credentials(xml)
+                add_transaction_type(xml, action)
+                xml << body
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+                
+      def build_sale_or_authorization_request(money, credit_card, options)
+        xml = Builder::XmlMarkup.new
+ 
+        add_amount(xml, money)
+        add_credit_card(xml, credit_card)
+        add_customer_data(xml, options)
+        add_invoice(xml, options)
+        
+        xml.target!        
+      end
+      
+      def build_capture_or_credit_request(money, identification, options)
+        xml = Builder::XmlMarkup.new
+  
+        add_identification(xml, identification)
+        add_amount(xml, money)
+        add_customer_data(xml, options)
+    
+        xml.target!
+      end
+      
+      def add_credentials(xml)
+        xml.tag! 'ExactID', @options[:login]
+        xml.tag! 'Password', @options[:password]
+      end
+      
+      def add_transaction_type(xml, action)
+        xml.tag! 'Transaction_Type', TRANSACTIONS[action]
+      end
+      
+      def add_identification(xml, identification)
+        authorization_num, transaction_tag = identification.split(';')
+ 
+        xml.tag! 'Authorization_Num', authorization_num
+        xml.tag! 'Transaction_Tag', transaction_tag
+      end
+      
+      def add_amount(xml, money)
+        xml.tag! 'DollarAmount', amount(money)
+      end
+      
+      def add_credit_card(xml, credit_card)
+        xml.tag! 'Card_Number', credit_card.number
+        xml.tag! 'Expiry_Date', expdate(credit_card)
+        xml.tag! 'CardHoldersName', credit_card.name
+        
+        if credit_card.verification_value?
+          xml.tag! 'CVD_Presence_Ind', '1'
+          xml.tag! 'VerificationStr2', credit_card.verification_value
+        end
+      end
+      
+      def add_customer_data(xml, options)
+        xml.tag! 'Customer_Ref', options[:customer]
+        xml.tag! 'Client_IP', options[:ip]
+        xml.tag! 'Client_Email', options[:email]
+      end
+
+      def add_address(xml, options)
+        if address = options[:billing_address] || options[:address]
+          xml.tag! 'ZipCode', address[:zip]       
+        end    
+      end
+
+      def add_invoice(xml, options)
+        xml.tag! 'Reference_No', options[:order_id]
+        xml.tag! 'Reference_3',  options[:description]
+      end
+      
+      def expdate(credit_card)
+        "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
+      end
+      
+      def commit(action, request)
+         response = parse(ssl_post(URL, build_request(action, request), POST_HEADERS))
+      
+         Response.new(successful?(response), message_from(response), response,
+           :test => test?,
+           :authorization => authorization_from(response),
+           :avs_result => { :code => response[:avs] },
+           :cvv_result => response[:cvv2]
+         )
+      end
+      
+      def successful?(response)
+        response[:transaction_approved] == SUCCESS
+      end
+      
+      def authorization_from(response)
+        if response[:authorization_num] && response[:transaction_tag]
+           "#{response[:authorization_num]};#{response[:transaction_tag]}"        
+        else
+           ''
+        end
+      end
+      
+      def message_from(response)
+        if response[:faultcode] && response[:faultstring]
+          response[:faultstring]
+        elsif response[:error_number] != '0'
+          response[:error_description]
+        else
+          result = response[:exact_message] || ''
+          result << " - #{response[:bank_message]}" unless response[:bank_message].blank?
+          result
+        end
+      end
+      
+      def parse(xml)
+        response = {}
+        xml = REXML::Document.new(xml)
+        
+        if root = REXML::XPath.first(xml, "//types:TransactionResult")
+          parse_elements(response, root)
+        elsif root = REXML::XPath.first(xml, "//soap:Fault")
+          parse_elements(response, root)
+        end
+
+        response.delete_if{ |k,v| SENSITIVE_FIELDS.include?(k) }
+      end
+
+      def parse_elements(response, root)
+        root.elements.to_a.each do |node|
+          response[node.name.gsub(/EXact/, 'Exact').underscore.to_sym] = (node.text || '').strip
+        end
+      end
+    end
+  end
+end
+