patmaddox-activemerchant 1.4.2

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

@@ -0,0 +1,220 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class ModernPaymentsCimGateway < Gateway #:nodoc:
+      TEST_URL = "https://secure.modpay.com/netservices/test/ModpayTest.asmx"
+      LIVE_URL = 'https://secure.modpay.com/ws/modpay.asmx'
+      
+      LIVE_XMLNS = "https://secure.modpay.com/ws/"
+      TEST_XMLNS = "https://secure.modpay.com/netservices/test/"
+      
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.modpay.com'
+      self.display_name = 'Modern Payments'
+      
+      SUCCESS_MESSAGE = "Transaction accepted"
+      FAILURE_MESSAGE = "Transaction failed"
+      ERROR_MESSAGE   = "Transaction error"
+      
+      PAYMENT_METHOD = {
+        :check => 1,
+        :credit_card => 2
+      }
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end  
+      
+      def create_customer(options = {})
+        post = {}
+        add_customer_data(post, options)
+        add_address(post, options)
+        
+        commit('CreateCustomer', post)
+      end
+      
+      def modify_customer_credit_card(customer_id, credit_card)
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_credit_card(post, credit_card)
+        
+        commit('ModifyCustomerCreditCard', post)
+      end
+      
+      def authorize_credit_card_payment(customer_id, amount)
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_amount(post, amount)
+        
+        commit('AuthorizeCreditCardPayment', post)
+      end
+      
+      def create_payment(customer_id, amount, options = {})
+        raise ArgumentError, "The customer_id cannot be blank" if customer_id.blank?
+        
+        post = {}
+        add_customer_id(post, customer_id)
+        add_amount(post, amount)
+        add_payment_details(post, options)
+        
+        commit('CreatePayment', post)
+      end
+
+      private
+      def add_payment_details(post, options)
+        post[:pmtDate] = (options[:payment_date] || Time.now.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
+        post[:pmtType] = PAYMENT_METHOD[options[:payment_method] || :credit_card]
+      end
+      
+      def add_amount(post, money)
+        post[:pmtAmount] = amount(money)
+      end
+      
+      def add_customer_id(post, customer_id)
+        post[:custId] = customer_id
+      end
+      
+      def add_customer_data(post, options)
+        post[:acctNum]   = options[:customer]
+      end
+      
+      def add_address(post, options)
+        address = options[:billing_address] || options[:address] || {}
+        
+        if name = address[:name]
+          segments = name.split(' ')
+          post[:lastName] = segments.pop
+          post[:firstName] = segments.join(' ')
+        else
+          post[:firstName] = address[:first_name]
+          post[:lastName]  = address[:last_name]
+        end
+        
+        post[:address]   = address[:address1]
+        post[:city]      = address[:city]
+        post[:state]     = address[:state]
+        post[:zip]       = address[:zip]
+        post[:phone]     = address[:phone]
+        post[:fax]       = address[:fax]
+        post[:email]     = options[:email]
+      end
+      
+      def add_credit_card(post, credit_card)
+        post[:ccName] = credit_card.name
+        post[:ccNum]  = credit_card.number
+        post[:expMonth] = credit_card.month
+        post[:expYear]  = credit_card.year
+      end
+                
+      def build_request(action, params)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! 'env:Envelope',
+          { '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' } do
+
+          xml.tag! 'env:Body' do
+            xml.tag! action, { "xmlns" => xmlns(action) } do
+              xml.tag! "clientId", @options[:login]
+              xml.tag! "clientCode", @options[:password]
+              params.each {|key, value| xml.tag! key, value }
+            end
+          end
+        end
+        xml.target!
+      end
+      
+      def xmlns(action)
+        if test? && action == 'AuthorizeCreditCardPayment'
+          TEST_XMLNS
+        else
+          LIVE_XMLNS
+        end
+      end
+      
+      def url(action)
+        if test? && action == 'AuthorizeCreditCardPayment'
+          TEST_URL
+        else
+          LIVE_URL
+        end
+      end
+      
+      def commit(action, params)
+        data = ssl_post(url(action), build_request(action, params), 
+                 { 'Content-Type' =>'text/xml; charset=utf-8', 
+                   'SOAPAction' => "#{xmlns(action)}#{action}" }
+                )
+
+        response = parse(action, data)
+        Response.new(successful?(action, response), message_from(action, response), response, 
+          :test => test?, 
+          :authorization => authorization_from(action, response),
+          :avs_result => { :code => response[:avs_code] }
+        )
+      end
+      
+      def authorization_from(action, response)
+        response[authorization_key(action)]
+      end
+      
+      def authorization_key(action)
+        action == "AuthorizeCreditCardPayment" ? :trans_id : "#{action.underscore}_result".to_sym
+      end
+      
+      def successful?(action, response)
+        key = authorization_key(action)
+        
+        if key == :trans_id
+          response[:approved] == "true"
+        else
+          response[key].to_i > 0
+        end
+      end
+      
+      def message_from(action, response)
+        if response[:faultcode]
+          ERROR_MESSAGE
+        elsif successful?(action, response)
+          SUCCESS_MESSAGE
+        else
+          FAILURE_MESSAGE
+        end
+      end
+      
+      def parse(action, xml)
+        response = {}
+        response[:action] = action
+        
+        xml = REXML::Document.new(xml)
+        if root = REXML::XPath.first(xml, "//#{action}Response")
+          root.elements.to_a.each do |node|
+            parse_element(response, node)
+          end
+        elsif root = REXML::XPath.first(xml, "//soap:Fault")
+          root.elements.to_a.each do |node|
+            response[node.name.underscore.to_sym] = node.text
+          end
+        end
+
+        response
+      end
+      
+      def parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|e| parse_element(response, e) }
+        else
+          response[node.name.underscore.to_sym] = node.text.to_s.strip
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,205 @@
+require 'rexml/document'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+
+    # To learn more about the Moneris gateway, please contact 
+    # eselectplus@moneris.com for a copy of their integration guide. For 
+    # information on remote testing, please see "Test Environment Penny Value 
+    # Response Table", and "Test Environment eFraud (AVS and CVD) Penny 
+    # Response Values", available at Moneris' {eSelect Plus Documentation 
+    # Centre}[https://www3.moneris.com/connect/en/documents/index.html].
+    class MonerisGateway < Gateway
+      TEST_URL = 'https://esqa.moneris.com/gateway2/servlet/MpgRequest'
+      LIVE_URL = 'https://www3.moneris.com/gateway2/servlet/MpgRequest'
+      
+      self.supported_countries = ['CA']
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'http://www.moneris.com/'
+      self.display_name = 'Moneris'
+  
+      # login is your Store ID
+      # password is your API Token
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = { :crypt_type => 7 }.update(options)
+        super      
+      end      
+    
+      # Referred to as "PreAuth" in the Moneris integration guide, this action 
+      # verifies and locks funds on a customer's card, which then must be 
+      # captured at a later date.
+      # 
+      # Pass in +order_id+ and optionally a +customer+ parameter.
+      def authorize(money, creditcard, options = {})
+        debit_commit 'preauth', money, creditcard, options        
+      end
+      
+      # This action verifies funding on a customer's card, and readies them for 
+      # deposit in a merchant's account.
+      # 
+      # Pass in <tt>order_id</tt> and optionally a <tt>customer</tt> parameter
+      def purchase(money, creditcard, options = {})
+        debit_commit 'purchase', money, creditcard, options
+      end
+     
+      # This method retrieves locked funds from a customer's account (from a 
+      # PreAuth) and prepares them for deposit in a merchant's account.
+      # 
+      # Note: Moneris requires both the order_id and the transaction number of
+      # the original authorization.  To maintain the same interface as the other
+      # gateways the two numbers are concatenated together with a ; separator as
+      # the authorization number returned by authorization
+      def capture(money, authorization, options = {})
+        commit 'completion', crediting_params(authorization, :comp_amount => amount(money))
+      end
+
+      # Voiding requires the original transaction ID and order ID of some open 
+      # transaction. Closed transactions must be refunded. Note that the only 
+      # methods which may be voided are +capture+ and +purchase+.
+      # 
+      # Concatenate your transaction number and order_id by using a semicolon 
+      # (';'). This is to keep the Moneris interface consistent with other 
+      # gateways. (See +capture+ for details.)
+      def void(authorization, options = {})
+        commit 'purchasecorrection', crediting_params(authorization)
+      end
+      
+      # Performs a refund. This method requires that the original transaction 
+      # number and order number be included. Concatenate your transaction 
+      # number and order_id by using a semicolon (';'). This is to keep the 
+      # Moneris interface consistent with other gateways. (See +capture+ for 
+      # details.)
+      def credit(money, authorization, options = {})
+        commit 'refund', crediting_params(authorization, :amount => amount(money))
+      end
+   
+    private # :nodoc: all
+    
+      def expdate(creditcard)
+        sprintf("%.4i", creditcard.year)[-2..-1] + sprintf("%.2i", creditcard.month)
+      end
+      
+      def debit_commit(commit_type, money, creditcard, options)
+        requires!(options, :order_id)
+        commit(commit_type, debit_params(money, creditcard, options))
+      end
+      
+      # Common params used amongst the +purchase+ and +authorization+ methods
+      def debit_params(money, creditcard, options = {})
+        {
+          :order_id   => options[:order_id],
+          :cust_id    => options[:customer],
+          :amount     => amount(money),
+          :pan        => creditcard.number,
+          :expdate    => expdate(creditcard),
+          :crypt_type => options[:crypt_type] || @options[:crypt_type]
+        }
+      end
+      
+      # Common params used amongst the +credit+, +void+ and +capture+ methods
+      def crediting_params(authorization, options = {})
+        {
+          :txn_number => split_authorization(authorization).first, 
+          :order_id   => split_authorization(authorization).last, 
+          :crypt_type => options[:crypt_type] || @options[:crypt_type]
+        }.merge(options)
+      end
+      
+      # Splits an +authorization+ param and retrives the order id and 
+      # transaction number in that order.
+      def split_authorization(authorization)
+        if authorization.nil? || authorization.empty? || authorization !~ /;/
+          raise ArgumentError, 'You must include a valid authorization code (e.g. "1234;567")' 
+        else
+          authorization.split(';')
+        end
+      end
+  
+      def commit(action, parameters = {})
+        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, post_data(action, parameters)))
+
+        Response.new(successful?(response), message_from(response[:message]), response,
+          :test          => test?,
+          :authorization => authorization_from(response)
+        )
+      end
+      
+      # Generates a Moneris authorization string of the form 'trans_id;receipt_id'.
+      def authorization_from(response = {})
+        if response[:trans_id] && response[:receipt_id]
+          "#{response[:trans_id]};#{response[:receipt_id]}"
+        end
+      end
+      
+      # Tests for a successful response from Moneris' servers
+      def successful?(response)
+        response[:response_code] && 
+        response[:complete] && 
+        (0..49).include?(response[:response_code].to_i)
+      end
+                                               
+      def parse(xml)
+        response = { :message => "Global Error Receipt", :complete => false }
+        hashify_xml!(xml, response)
+        response
+      end
+      
+      def hashify_xml!(xml, response)
+        xml = REXML::Document.new(xml)
+        return if xml.root.nil?
+        xml.elements.each('//receipt/*') do |node|
+          response[node.name.underscore.to_sym] = normalize(node.text)
+        end
+      end
+
+      def post_data(action, parameters = {})
+        xml   = REXML::Document.new
+        root  = xml.add_element("request")
+        root.add_element("store_id").text  = options[:login]
+        root.add_element("api_token").text = options[:password]
+        transaction = root.add_element(action)
+
+        # Must add the elements in the correct order
+        actions[action].each do |key|
+          transaction.add_element(key.to_s).text = parameters[key] unless parameters[key].blank?
+        end
+        
+        xml.to_s
+      end
+    
+      def message_from(message)
+        return 'Unspecified error' if message.blank?
+        message.gsub(/[^\w]/, ' ').split.join(" ").capitalize
+      end
+
+      # Make a Ruby type out of the response string
+      def normalize(field)
+        case field
+          when "true"     then true
+          when "false"    then false
+          when '', "null" then nil
+          else field
+        end        
+      end
+      
+      def actions
+        {
+          "purchase"           => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+          "preauth"            => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+          "command"            => [:order_id],
+          "refund"             => [:order_id, :amount, :txn_number, :crypt_type],
+          "indrefund"          => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+          "completion"         => [:order_id, :comp_amount, :txn_number, :crypt_type],
+          "purchasecorrection" => [:order_id, :txn_number, :crypt_type],
+          "cavvpurcha"         => [:order_id, :cust_id, :amount, :pan, :expdate, :cav],
+          "cavvpreaut"         => [:order_id, :cust_id, :amount, :pan, :expdate, :cavv],
+          "transact"           => [:order_id, :cust_id, :amount, :pan, :expdate, :crypt_type],
+          "Batchcloseall"      => [],
+          "opentotals"         => [:ecr_number],
+          "batchclose"         => [:ecr_number]
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,189 @@
+module ActiveMerchant
+  module Billing
+    # Gateway for netregistry.com.au.
+    #
+    # Note that NetRegistry itself uses gateway service providers.  At the
+    # time of this writing, there are at least two (Quest and Ingenico).
+    # This module has only been tested with Quest.
+    #
+    # Also note that NetRegistry does not offer a test mode, nor does it
+    # have support for the authorize/capture/void functionality by default
+    # (you may arrange for this as described in "Programming for
+    # NetRegistry's E-commerce Gateway." [http://rubyurl.com/hNG]), and no
+    # #void functionality is documented.  As a result, the #authorize and
+    # #capture have not yet been tested through a live gateway, and #void
+    # will raise an error.
+    #
+    # If you have this functionality enabled, please consider contributing
+    # to ActiveMerchant by writing tests/code for these methods, and
+    # submitting a patch.
+    #
+    # In addition to the standard ActiveMerchant functionality, the
+    # response will contain a 'receipt' parameter
+    # (response.params['receipt']) if a receipt was issued by the gateway.
+    class NetRegistryGateway < Gateway
+      URL = 'https://4tknox.au.com/cgi-bin/themerchant.au.com/ecom/external2.pl'
+      
+      FILTERED_PARAMS = [ 'card_no', 'card_expiry', 'receipt_array' ]
+      
+      self.supported_countries = ['AU']
+      
+      # Note that support for Diners, Amex, and JCB require extra
+      # steps in setting up your account, as detailed in
+      # "Programming for NetRegistry's E-commerce Gateway."
+      # [http://rubyurl.com/hNG]
+      self.supported_cardtypes = [:visa, :master, :diners_club, :american_express, :jcb]
+      self.display_name = 'NetRegistry'
+      self.homepage_url = 'http://www.netregistry.com.au'
+      
+      TRANSACTIONS = {
+        :authorization => 'preauth',
+        :purchase => 'purchase',
+        :capture => 'completion',
+        :status => 'status',
+        :credit => 'refund'
+      }
+      
+      # Create a new NetRegistry gateway.
+      #
+      # Options :login and :password must be given.
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      # Note that #authorize and #capture only work if your account
+      # vendor is St George, and if your account has been setup as
+      # described in "Programming for NetRegistry's E-commerce
+      # Gateway." [http://rubyurl.com/hNG]
+      def authorize(money, credit_card, options = {})
+        params = {
+          'AMOUNT'  => amount(money),
+          'CCNUM'   => credit_card.number,
+          'CCEXP'   => expiry(credit_card)
+        }
+        add_request_details(params, options)
+        commit(:authorization, params)
+      end
+
+      # Note that #authorize and #capture only work if your account
+      # vendor is St George, and if your account has been setup as
+      # described in "Programming for NetRegistry's E-commerce
+      # Gateway." [http://rubyurl.com/hNG]
+      def capture(money, authorization, options = {})
+        requires!(options, :credit_card)
+        credit_card = options[:credit_card]
+
+        params = {
+          'PREAUTHNUM' => authorization,
+          'AMOUNT'     => amount(money),
+          'CCNUM'      => credit_card.number,
+          'CCEXP'      => expiry(credit_card)
+        }
+        add_request_details(params, options)
+        commit(:capture, params)
+      end
+
+      def purchase(money, credit_card, options = {})
+        params = {
+          'AMOUNT'  => amount(money),
+          'CCNUM'   => credit_card.number,
+          'CCEXP'   => expiry(credit_card)
+        }
+        add_request_details(params, options)
+        commit(:purchase, params)
+      end
+
+      def credit(money, identification, options = {})
+        params = {
+          'AMOUNT'  => amount(money),
+          'TXNREF'  => identification
+        }
+        add_request_details(params, options)
+        commit(:credit, params)
+      end
+      
+      # Specific to NetRegistry.
+      #
+      # Run a 'status' command.  This lets you view the status of a
+      # completed transaction.
+      #
+      def status(identification)
+        params = {
+          'TXNREF'  => identification
+        }
+        
+        commit(:status, params)
+      end
+
+      private
+      def add_request_details(params, options)
+        params['COMMENT'] = options[:description] unless options[:description].blank?
+      end
+      
+      # Return the expiry for the given creditcard in the required
+      # format for a command.
+      def expiry(credit_card)
+        month = format(credit_card.month, :two_digits)
+        year  = format(credit_card.year , :two_digits)
+        "#{month}/#{year}"
+      end
+
+      # Post the a request with the given parameters and return the
+      # response object.
+      #
+      # Login and password are added automatically, and the comment is
+      # omitted if nil.
+      def commit(action, params)
+        # get gateway response
+        response = parse( ssl_post(URL, post_data(action, params)) )
+        
+        Response.new(response['status'] == 'approved', message_from(response), response,          
+          :authorization => authorization_from(response, action)
+        )
+      end
+      
+      def post_data(action, params)
+        params['COMMAND'] = TRANSACTIONS[action]
+        params['LOGIN'] = "#{@options[:login]}/#{@options[:password]}"
+        URI.encode(params.map{|k,v| "#{k}=#{v}"}.join('&'))
+      end
+      
+      def parse(response)
+        params = {}
+        
+        lines = response.split("\n")
+        
+        # Just incase there is no real response returned
+        params['status'] = lines[0]
+        params['response_text'] = lines[1]
+        
+        started = false
+        lines.each do |line|          
+          if started
+            key, val = line.chomp.split(/=/, 2)
+            params[key] = val unless FILTERED_PARAMS.include?(key)
+          end
+          
+          started = line.chomp =~ /^\.$/ unless started
+        end
+        
+        params
+      end
+      
+      def message_from(response)
+        response['response_text']
+      end
+      
+      def authorization_from(response, command)
+        case command
+        when :purchase
+          response['txn_ref']
+        when :authorization
+          response['transaction_no']
+        end
+      end
+    end
+  end
+end