activemerchant 1.2.1 → 1.3.0

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

@@ -10,24 +10,19 @@ module ActiveMerchant #:nodoc:
     # Response Values", available at Moneris' {eSelect Plus Documentation 
     # Centre}[https://www3.moneris.com/connect/en/documents/index.html].
     class MonerisGateway < Gateway
-      attr_reader :url 
-      attr_reader :response
-      attr_reader :options
+      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]
       self.homepage_url = 'http://www.moneris.com/'
       self.display_name = 'Moneris'
-
-      TEST_URL = 'https://esqa.moneris.com/gateway2/servlet/MpgRequest'
-      LIVE_URL = 'https://www3.moneris.com/gateway2/servlet/MpgRequest'
-        
+  
       # login is your Store ID
       # password is your API Token
       def initialize(options = {})
         requires!(options, :login, :password)
         @options = { :crypt_type => 7 }.update(options)
-        @url = test? ? TEST_URL : LIVE_URL      
         super      
       end      
     
@@ -122,53 +117,28 @@ module ActiveMerchant #:nodoc:
       end
   
       def commit(action, parameters = {})
-        # TODO This part still needs to be refactored
-        if result = test_result_from_cc_number(parameters[:pan])
-          return result
-        end
-        
-        @response = parse(ssl_post(@url, post_data(action, parameters)))
+        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, post_data(action, parameters)))
 
-        Response.new(successful_response?(response), message_form(response[:message]), @response,
+        Response.new(successful?(response), message_from(response[:message]), response,
           :test          => test?,
-          :authorization => authorization_string(response)
+          :authorization => authorization_from(response)
         )
       end
       
       # Generates a Moneris authorization string of the form 'trans_id;receipt_id'.
-      def authorization_string(response = {})
+      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 = {})
+      def successful?(response)
         response[:response_code] && 
         response[:complete] && 
         (0..49).include?(response[:response_code].to_i)
       end
                                                
-      # Parse Moneris' response XML into a convinient Hash.
-      # 
-      # Expected XML format:
-      # 
-      #   "<?xml version=\"1.0\"?><response><receipt>".
-      #   "<ReceiptId>Global Error Receipt</ReceiptId>".
-      #   "<ReferenceNum>null</ReferenceNum>
-      #   <ResponseCode>null</ResponseCode>".
-      #   "<ISO>null</ISO> 
-      #   <AuthCode>null</AuthCode>
-      #   <TransTime>null</TransTime>".
-      #   "<TransDate>null</TransDate>
-      #   <TransType>null</TransType>
-      #   <Complete>false</Complete>".
-      #   "<Message>null</Message>
-      #   <TransAmount>null</TransAmount>".
-      #   "<CardType>null</CardType>".
-      #   "<TransID>null</TransID>
-      #   <TimedOut>null</TimedOut>".
-      #   "</receipt></response>
       def parse(xml)
         response = { :message => "Global Error Receipt", :complete => false }
         hashify_xml!(xml, response)
@@ -198,7 +168,7 @@ module ActiveMerchant #:nodoc:
         xml.to_s
       end
     
-      def message_form(message)
+      def message_from(message)
         return 'Unspecified error' if message.blank?
         message.gsub(/[^\w]/, ' ').split.join(" ").capitalize
       end

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

@@ -1,33 +1,30 @@
-#
-# 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.
-# Also, a logger may be provided when instantiating the gateway to log
-# all data sent to/from the gateway (with sensitive information
-# hidden).
-#
 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
-      LIVE_URL = 'https://4tknox.au.com/cgi-bin/themerchant.au.com/ecom/external2.pl'
+      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']
       
@@ -39,66 +36,71 @@ module ActiveMerchant
       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)
-        @logger = options[:logger]
         @options = options
         super
       end
 
-      #
-      # A Logger object used to write extra debugging output to.  nil
-      # for none.
-      #
-      attr_accessor :logger
-
-      #
       # 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 = {})
-        post(options[:description],
-             'COMMAND' => 'preauth',
-             'AMOUNT'  => amount(money),
-             'CCNUM'   => credit_card.number,
-             'CCEXP'   => expiry(credit_card))
+        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 = {})
         credit_card = options[:credit_card]
-        post(options[:description],
-             'COMMAND'    => 'completion',
-             'PREAUTHNUM' => authorization,
-             'AMOUNT'     => amount(money),
-             'CCNUM'      => credit_card.number,
-             'CCEXP'      => expiry(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 = {})
-        post(options[:description],
-             'COMMAND' => 'purchase',
-             'AMOUNT'  => amount(money),
-             'CCNUM'   => credit_card.number,
-             'CCEXP'   => expiry(credit_card))
+        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 = {})
-        post(options[:description],
-             'COMMAND' => 'refund',
-             'AMOUNT'  => amount(money),
-             'TXNREF'  => identification)
+        params = {
+          'AMOUNT'  => amount(money),
+          'TXNREF'  => identification
+        }
+        add_request_details(params, options)
+        commit(:credit, params)
       end
       
       # Specific to NetRegistry.
@@ -107,150 +109,79 @@ module ActiveMerchant
       # completed transaction.
       #
       def status(identification)
-        post(options[:description],
-             'COMMAND' => 'status',
-             'TXNREF'  => identification)
+        params = {
+          'TXNREF'  => identification
+        }
+        
+        commit(:status, params)
       end
 
-      private  # -----------------------------------------------------
-
-      #
+      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 post(comment, keyvals)
-        if result = test_result_from_cc_number(keyvals['CCNUM'])
-          return result
-        end
-        
-        log "Executing #{keyvals['COMMAND']}:"
-        login    = @options[:login]
-        password = @options[:password]
-
-        # make query
-        keyvals['COMMENT'] = comment if comment
-        keyvals['LOGIN'] = "#{login}/#{password}"
-        str = URI.encode(keyvals.map{|k,v| "#{k}=#{v}"}.join('&'))
-        log "  ActiveMerchant/NetRegistry: sending: #{obscure_send_string(str)}"
-
+      def commit(action, params)
         # get gateway response
-        text = ssl_post(LIVE_URL, str)
-        log "  ActiveMerchant/NetRegistry: received:"
-        obscure_recv_string(text).each do |line|
-          log "    #{line}"
-        end
-
-        # make response object
-        response = parse_response(text, keyvals['COMMAND'])
-
-        return response
-      end
-
-      #
-      # Parse the text returned from the gateway into a Response object.
-      #
-      def parse_response(text, command)
-        params = {'original_text' => text}
-        sio = StringIO.new(text)
-        params['status'] = sio.gets.chomp
-        params['rrn'] = sio.gets.chomp
-
-        if sio.eof?
-          # some short errors have nothing else, e.g., "Invalid expiry
-          # format"
-          message = params.delete('rrn')
-          return Response.new(false, message, params)
-        end
-
-        # parse receipt
-        receipt = ''
-        while (line = sio.gets)
-          break if line.strip == '.'
-          receipt << line
-        end
-
-        # parse params
-        while (line = sio.gets)
-          line.chomp!
-          key, val = line.split(/=/, 2)
-          params[key] = val
-        end
-
-        params['receipt'] = receipt
-        authorization =
-          case command
-          when 'purchase'
-            params['txn_ref']
-          when 'preauth'
-            params['transaction_no']
-          else
-            nil
-          end
-
-        Response.new(params['status'] == 'approved',
-                     params['response_text'],
-                     params,
-                     :authorization => authorization)
+        response = parse( ssl_post(URL, post_data(action, params)) )
+        
+        Response.new(response['status'] == 'approved', message_from(response), response,          
+          :authorization => authorization_from(response, action)
+        )
       end
-
-      #
-      # Log a message if logging is enabled.
-      #
-      def log(msg)
-        logger.info(msg.chomp) unless logger.nil?
+      
+      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
-
-      #
-      # Return a copy of the given string (to be sent to the gateway),
-      # with sensitive information hidden.
-      #
-      def obscure_send_string(string)
-        string.gsub(/LOGIN=[^&]+/) do |keyval|
-          keyval.sub(/[^\/]+\z/){|pass| '*'*pass.size}
-        end.gsub(/CCNUM=[^&]+/) do |keyval|
-          keyval.sub(/[^=]+\z/){|num| obscure_card_number(num)}
-        end.gsub(/CCEXP=[^&]+/) do |keyval|
-          keyval.sub(/[^=]+\z/){|num| obscure_card_expiry(num)}
+      
+      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
-
-      #
-      # Return a copy of the given string (received from the gateway),
-      # with sensitive information hidden.
-      #
-      def obscure_recv_string(string)
-        string.
-          gsub(/(card_(?:no|number)=)(.*)$/){$1 << obscure_card_number($2)}.
-          gsub(/(card_expiry=)(.*)$/){$1 << obscure_card_expiry($2)}
-      end
-
-      #
-      # Obscure a credit card number.
-      #
-      def obscure_card_number(number)
-        return number if number.size < 4
-        number[0...-4] = '*'*(number.size-4)
-        return number
+      
+      def message_from(response)
+        response['response_text']
       end
-
-      #
-      # Obscure a credit card expiry.
-      #
-      def obscure_card_expiry(expiry)
-        expiry.gsub(/\d/, '*')
+      
+      def authorization_from(response, command)
+        case command
+        when :purchase
+          response['txn_ref']
+        when :authorization
+          response['transaction_no']
+        end
       end
     end
   end