jelaniharris-activemerchant 1.24.1

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

@@ -0,0 +1,255 @@
+require 'rexml/document'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # The National Australia Bank provide a payment gateway that seems to
+    # be a rebadged Securepay Australia service, though some differences exist.
+    class NabTransactGateway < Gateway
+      API_VERSION = 'xml-4.2'
+      PERIODIC_API_VERSION = "spxml-4.2"
+
+      TEST_URL = 'https://transact.nab.com.au/test/xmlapi/payment'
+      LIVE_URL = 'https://transact.nab.com.au/live/xmlapi/payment'
+      TEST_PERIODIC_URL = "https://transact.nab.com.au/xmlapidemo/periodic"
+      LIVE_PERIODIC_URL = "https://transact.nab.com.au/xmlapi/periodic"
+
+      self.supported_countries = ['AU']
+
+      # The card types supported by the payment gateway
+      # Note that support for Diners, Amex, and JCB require extra
+      # steps in setting up your account, as detailed in the NAB Transact API
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club, :jcb]
+
+      self.homepage_url = 'http://transact.nab.com.au'
+      self.display_name = 'NAB Transact'
+
+      cattr_accessor :request_timeout
+      self.request_timeout = 60
+
+      self.money_format = :cents
+      self.default_currency = 'AUD'
+
+      #Transactions currently accepted by NAB Transact XML API
+      TRANSACTIONS = {
+        :purchase => 0,         #Standard Payment
+        :credit => 4,           #Refund
+        :void => 6,             #Client Reversal (Void)
+        :authorization => 10,   #Preauthorise
+        :capture => 11          #Preauthorise Complete (Advice)
+      }
+
+      PERIODIC_TYPES = {
+        :addcrn    => 5,
+        :editcrn   => 5,
+        :deletecrn => 5,
+        :trigger   => 8
+      }
+
+      SUCCESS_CODES = [ '00', '08', '11', '16', '77' ]
+
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      def test?
+        @options[:test] || super
+      end
+
+      def purchase(money, credit_card_or_stored_id, options = {})
+        if credit_card_or_stored_id.respond_to?(:number)
+          #Credit card for instant payment
+          commit :purchase, build_purchase_request(money, credit_card_or_stored_id, options)
+        else
+          #Triggered payment for an existing stored credit card
+          options[:billing_id] = credit_card_or_stored_id.to_s
+          commit_periodic build_periodic_item(:trigger, money, nil, options)
+        end
+      end
+
+      def store(creditcard, options = {})
+        requires!(options, :billing_id, :amount)
+        commit_periodic(build_periodic_item(:addcrn, options[:amount], creditcard, options))
+      end
+
+      def unstore(identification, options = {})
+        options[:billing_id] = identification
+        commit_periodic(build_periodic_item(:deletecrn, options[:amount], nil, options))
+      end
+
+      private
+
+      def add_metadata(xml, options)
+        if options[:merchant_name] || options[:merchant_location]
+          xml.tag! 'metadata' do
+            xml.tag! 'meta', :name => 'ca_name', :value => options[:merchant_name] if options[:merchant_name]
+            xml.tag! 'meta', :name => 'ca_location', :value => options[:merchant_location] if options[:merchant_location]
+          end
+        end
+      end
+
+      def build_purchase_request(money, credit_card, options)
+        xml = Builder::XmlMarkup.new
+        xml.tag! 'amount', amount(money)
+        xml.tag! 'currency', options[:currency] || currency(money)
+        xml.tag! 'purchaseOrderNo', options[:order_id].to_s.gsub(/[ ']/, '')
+
+        xml.tag! 'CreditCardInfo' do
+          xml.tag! 'cardNumber', credit_card.number
+          xml.tag! 'expiryDate', expdate(credit_card)
+          xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
+        end
+
+        add_metadata(xml, options)
+
+        xml.target!
+      end
+
+      #Generate payment request XML
+      # - API is set to allow multiple Txn's but currentlu only allows one
+      # - txnSource = 23 - (XML)
+
+      def build_request(action, body)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.tag! 'NABTransactMessage' do
+          xml.tag! 'MessageInfo' do
+            xml.tag! 'messageID', Utils.generate_unique_id.slice(0, 30)
+            xml.tag! 'messageTimestamp', generate_timestamp
+            xml.tag! 'timeoutValue', request_timeout
+            xml.tag! 'apiVersion', API_VERSION
+          end
+
+          xml.tag! 'MerchantInfo' do
+            xml.tag! 'merchantID', @options[:login]
+            xml.tag! 'password', @options[:password]
+          end
+
+          xml.tag! 'RequestType', 'Payment'
+          xml.tag! 'Payment' do
+            xml.tag! 'TxnList', "count" => 1 do
+              xml.tag! 'Txn', "ID" => 1 do
+                xml.tag! 'txnType', TRANSACTIONS[action]
+                xml.tag! 'txnSource', 23
+                xml << body
+              end
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_periodic_item(action, money, credit_card, options)
+        xml = Builder::XmlMarkup.new
+
+        xml.tag! 'actionType', action.to_s
+        xml.tag! 'periodicType', PERIODIC_TYPES[action] if PERIODIC_TYPES[action]
+        xml.tag! 'currency', options[:currency] || currency(money)
+        xml.tag! 'crn', options[:billing_id]
+
+        if credit_card
+          xml.tag! 'CreditCardInfo' do
+            xml.tag! 'cardNumber', credit_card.number
+            xml.tag! 'expiryDate', expdate(credit_card)
+            xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
+          end
+        end
+        xml.tag! 'amount', amount(money)
+
+        xml.target!
+      end
+
+      def build_periodic_request(body)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.tag! 'NABTransactMessage' do
+          xml.tag! 'MessageInfo' do
+            xml.tag! 'messageID', ActiveMerchant::Utils.generate_unique_id.slice(0, 30)
+            xml.tag! 'messageTimestamp', generate_timestamp
+            xml.tag! 'timeoutValue', request_timeout
+            xml.tag! 'apiVersion', PERIODIC_API_VERSION
+          end
+
+          xml.tag! 'MerchantInfo' do
+            xml.tag! 'merchantID', @options[:login]
+            xml.tag! 'password', @options[:password]
+          end
+
+          xml.tag! 'RequestType', 'Periodic'
+          xml.tag! 'Periodic' do
+            xml.tag! 'PeriodicList', "count" => 1 do
+              xml.tag! 'PeriodicItem', "ID" => 1 do
+                xml << body
+              end
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def commit(action, request)
+        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, build_request(action, request)))
+
+        Response.new(success?(response), message_from(response), response,
+          :test => test?,
+          :authorization => authorization_from(response)
+        )
+      end
+
+      def commit_periodic(request)
+        response = parse(ssl_post(test? ? TEST_PERIODIC_URL : LIVE_PERIODIC_URL, build_periodic_request(request)))
+        Response.new(success?(response), message_from(response), response,
+          :test => test?,
+          :authorization => authorization_from(response)
+        )
+      end
+
+      def success?(response)
+        SUCCESS_CODES.include?(response[:response_code])
+      end
+
+      def authorization_from(response)
+        response[:txn_id]
+      end
+
+      def message_from(response)
+        response[:response_text] || response[:status_description]
+      end
+
+      def expdate(credit_card)
+        "#{format(credit_card.month, :two_digits)}/#{format(credit_card.year, :two_digits)}"
+      end
+
+      def parse(body)
+        xml = REXML::Document.new(body)
+
+        response = {}
+
+        xml.root.elements.to_a.each do |node|
+          parse_element(response, node)
+        end
+
+        response
+      end
+
+      def parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|element| parse_element(response, element) }
+        else
+          response[node.name.underscore.to_sym] = node.text
+        end
+      end
+
+      # YYYYDDMMHHNNSSKKK000sOOO
+      def generate_timestamp
+        time = Time.now.utc
+        time.strftime("%Y%d%m%H%M%S#{time.usec}+000")
+      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

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

@@ -0,0 +1,239 @@
+require 'digest/md5'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class NetaxeptGateway < Gateway
+      TEST_URL = 'https://epayment-test.bbs.no/'
+      LIVE_URL = 'https://epayment.bbs.no/'
+      
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['NO', 'DK', 'SE', 'FI']
+      
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.betalingsterminal.no/Netthandel-forside/'
+      
+      # The name of the gateway
+      self.display_name = 'BBS Netaxept'
+      
+      self.money_format = :cents
+      
+      self.default_currency = 'NOK'
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end  
+      
+      def purchase(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        post = {}
+        add_credentials(post, options)
+        add_transaction(post, options)
+        add_order(post, money, options)
+        add_creditcard(post, creditcard)
+        commit('Sale', post)
+      end                       
+
+      def authorize(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        post = {}
+        add_credentials(post, options)
+        add_transaction(post, options)
+        add_order(post, money, options)
+        add_creditcard(post, creditcard)
+        commit('Auth', post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_credentials(post, options)
+        add_authorization(post, authorization, money)
+        commit('Capture', post, false)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        add_credentials(post, options)
+        add_authorization(post, authorization, money)
+        commit('Credit', post, false)
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_credentials(post, options)
+        add_authorization(post, authorization)
+        commit('Annul', post, false)
+      end
+
+      def test?
+        @options[:test] || Base.gateway_mode == :test
+      end
+
+    
+      private
+      
+      def add_credentials(post, options)
+        post[:merchantId] = @options[:login]
+        post[:token] = @options[:password]
+      end
+      
+      def add_authorization(post, authorization, money=nil)
+        post[:transactionId] = authorization
+        post[:transactionAmount] = amount(money) if money
+      end
+      
+      def add_transaction(post, options)
+        post[:transactionId] = generate_transaction_id(options)
+        post[:serviceType] = 'M'
+        post[:redirectUrl] = 'http://example.com'
+      end
+      
+      def add_order(post, money, options)
+        post[:orderNumber] = options[:order_id]
+        post[:amount] = amount(money)
+        post[:currencyCode] = (options[:currency] || currency(money))
+      end
+      
+      CARD_TYPE_PREFIXES = {
+        'visa' => 'v',
+        'master' => 'm',
+        'american_express' => 'a',
+      }
+      def add_creditcard(post, creditcard)
+        brand = Gateway.card_brand(creditcard)
+        prefix = CARD_TYPE_PREFIXES[brand]
+        unless prefix
+          raise ArgumentError.new("Card type #{brand} not supported.")
+        end
+
+        post[:creditcard] = {}
+        post[:creditcard][:"#{prefix}a"] = creditcard.number
+        post[:creditcard][:"#{prefix}m"] = format(creditcard.month, :two_digits)
+        post[:creditcard][:"#{prefix}y"] = format(creditcard.year, :two_digits)
+        post[:creditcard][:"#{prefix}c"] = creditcard.verification_value
+      end
+      
+      def commit(action, parameters, setup=true)
+        parameters[:action] = action
+
+        response = {:success => false}
+
+        catch(:exception) do
+          if setup
+            commit_transaction_setup(response, parameters)
+            commit_payment_details(response, parameters)
+            commit_process_setup(response, parameters)
+          end
+          commit_transaction(response, parameters)
+          response[:success] = true
+        end
+        
+        Response.new(response[:success], response[:message], response, :test => test?, :authorization => response[:authorization])
+      end
+      
+      def commit_transaction_setup(response, parameters)
+        response[:setup] = parse(ssl_get(build_url("REST/Setup.aspx", pick(parameters, :merchantId, :token, :serviceType, :amount, :currencyCode, :redirectUrl, :orderNumber, :transactionId))))
+        process(response, :setup)
+      end
+      
+      def commit_payment_details(response, parameters)
+        data = encode(parameters[:creditcard].merge(:BBSePay_transaction => response[:setup]['SetupString']))
+        response[:paymentDetails] = parse(ssl_post(build_url("terminal/default.aspx"), data), false)
+        process(response, :paymentDetails)
+      end
+      
+      def commit_process_setup(response, parameters)
+        result = ssl_get(build_url("REST/ProcessSetup.aspx", pick(parameters, :merchantId, :token, :transactionId).merge(:transactionString => response[:paymentDetails][:result])))
+        response[:processSetup] = parse(result)
+        process(response, :processSetup)
+      end
+      
+      def commit_transaction(response, parameters)
+        result = ssl_get(build_url("REST/#{parameters[:action]}.aspx", pick(parameters, :merchantId, :token, :transactionId, :transactionAmount)))
+        response[:action] = parse(result)
+        process(response, :action)
+      end
+
+      def process(response, step)
+        if response[step][:container] =~ /Exception|Error/
+          response[:message] = response[step]['Message']
+          throw :exception
+        else
+          message = (response[step]['ResponseText'] || response[step]['ResponseCode'])
+          response[:message] = (message || response[:message])
+          
+          response[:authorization] = response[step]['TransactionId']
+        end
+      end
+      
+      def parse(result, expects_xml=true)
+        if expects_xml || /^</ =~ result
+          doc = REXML::Document.new(result)
+          extract_xml(doc.root).merge(:container => doc.root.name)
+        else
+          {:result => result}
+        end
+      end
+      
+      def extract_xml(element)
+        if element.has_elements?
+          hash = {}
+          element.elements.each do |e|
+            hash[e.name] = extract_xml(e)
+          end
+          hash
+        else
+          element.text
+        end
+      end
+      
+      def url
+        (test? ? TEST_URL : LIVE_URL)
+      end
+      
+      def generate_transaction_id(options)
+        Digest::MD5.hexdigest("#{options.inspect}+#{Time.now}+#{rand}")
+      end
+      
+      def pick(hash, *keys)
+        keys.inject({}){|h,key| h[key] = hash[key] if hash[key]; h}
+      end
+      
+      def build_url(base, parameters=nil)
+        url = "#{test? ? TEST_URL : LIVE_URL}"
+        url << base
+        if parameters
+          url << '?'
+          url << encode(parameters)
+        end
+        url
+      end
+      
+      def encode(hash)
+        hash.collect{|(k,v)| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join('&')
+      end
+      
+      class Response < Billing::Response
+        attr_reader :error_detail
+        def initialize(success, message, raw, options)
+          super
+          unless success
+            @error_detail = raw[:processSetup]['Result']['ResponseText'] if raw[:processSetup] && raw[:processSetup]['Result']
+          end
+        end
+      end
+    end
+  end
+end
+