activemerchant-nsp 1.27.0

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
+      self.live_url = self.test_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(self.live_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
+      self.test_url = 'https://epayment-test.bbs.no/'
+      self.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? ? self.test_url : self.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? ? self.test_url : self.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
+

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

@@ -0,0 +1,196 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class NetbillingGateway < Gateway
+      self.live_url = self.test_url = 'https://secure.netbilling.com:1402/gw/sas/direct3.1'
+
+      TRANSACTIONS = {
+        :authorization => 'A',
+        :purchase      => 'S',
+        :refund        => 'R',
+        :credit        => 'C',
+        :capture       => 'D',
+        :void          => 'U'
+      }
+
+      SUCCESS_CODES = [ '1', 'T' ]
+      SUCCESS_MESSAGE = 'The transaction was approved'
+      FAILURE_MESSAGE = 'The transaction failed'
+      TEST_LOGIN = '104901072025'
+
+      self.display_name = 'NETbilling'
+      self.homepage_url = 'http://www.netbilling.com'
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :diners_club]
+
+      def initialize(options = {})
+        requires!(options, :login)
+        @options = options
+        super
+      end
+
+      def authorize(money, credit_card, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, credit_card, options)
+        add_customer_data(post, options)
+
+        commit(:authorization, post)
+      end
+
+      def purchase(money, credit_card, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, credit_card, options)
+        add_customer_data(post, options)
+
+        commit(:purchase, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_reference(post, authorization)
+        commit(:capture, post)
+      end
+
+      def refund(money, source, options = {})
+        post = {}
+        add_amount(post, money)
+        add_reference(post, source)
+        commit(:refund, post)
+      end
+
+      def credit(money, credit_card, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        add_address(post, credit_card, options)
+        add_customer_data(post, options)
+
+        commit(:credit, post)
+      end
+
+      def void(source, options = {})
+        post = {}
+        add_reference(post, source)
+        commit(:void, post)
+      end
+
+      def test?
+        @options[:login] == TEST_LOGIN || super
+      end
+
+      private
+      def add_amount(post, money)
+        post[:amount] = amount(money)
+      end
+
+      def add_reference(post, reference)
+        post[:orig_id] = reference
+      end
+
+      def add_customer_data(post, options)
+        post[:cust_email] = options[:email]
+        post[:cust_ip] = options[:ip]
+      end
+
+      def add_address(post, credit_card, options)
+        if billing_address = options[:billing_address] || options[:address]
+          post[:bill_street]     = billing_address[:address1]
+          post[:cust_phone]      = billing_address[:phone]
+          post[:bill_zip]        = billing_address[:zip]
+          post[:bill_city]       = billing_address[:city]
+          post[:bill_country]    = billing_address[:country]
+          post[:bill_state]      = billing_address[:state]
+        end
+
+       if shipping_address = options[:shipping_address]
+         first_name, last_name = parse_first_and_last_name(shipping_address[:name])
+
+         post[:ship_name1]      = first_name
+         post[:ship_name2]      = last_name
+         post[:ship_street]     = shipping_address[:address1]
+         post[:ship_zip]        = shipping_address[:zip]
+         post[:ship_city]       = shipping_address[:city]
+         post[:ship_country]    = shipping_address[:country]
+         post[:ship_state]      = shipping_address[:state]
+       end
+      end
+
+      def add_invoice(post, options)
+        post[:description] = options[:description]
+      end
+
+      def add_credit_card(post, credit_card)
+        post[:bill_name1] = credit_card.first_name
+        post[:bill_name2] = credit_card.last_name
+        post[:card_number] = credit_card.number
+        post[:card_expire] = expdate(credit_card)
+        post[:card_cvv2] = credit_card.verification_value
+      end
+
+      def parse(body)
+        results = {}
+        body.split(/&/).each do |pair|
+          key,val = pair.split(/\=/)
+          results[key.to_sym] = CGI.unescape(val)
+        end
+        results
+      end
+
+      def commit(action, parameters)
+        response = parse(ssl_post(self.live_url, post_data(action, parameters)))
+
+        Response.new(success?(response), message_from(response), response,
+          :test => test_response?(response),
+          :authorization => response[:trans_id],
+          :avs_result => { :code => response[:avs_code]},
+          :cvv_result => response[:cvv2_code]
+        )
+      rescue ActiveMerchant::ResponseError => e
+        raise unless(e.response.code =~ /^[67]\d\d$/)
+        return Response.new(false, e.response.message, {:status_code => e.response.code}, :test => test?)
+      end
+
+      def test_response?(response)
+        !!(test? || response[:auth_msg] =~ /TEST/)
+      end
+
+      def success?(response)
+        SUCCESS_CODES.include?(response[:status_code])
+      end
+
+      def message_from(response)
+        success?(response) ? SUCCESS_MESSAGE : (response[:auth_msg] || FAILURE_MESSAGE)
+      end
+
+      def expdate(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+
+      def post_data(action, parameters = {})
+        parameters[:account_id] = @options[:login]
+        parameters[:pay_type] = 'C'
+        parameters[:tran_type] = TRANSACTIONS[action]
+
+        parameters.reject{|k,v| v.blank?}.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      def parse_first_and_last_name(value)
+        name = value.to_s.split(' ')
+
+        last_name = name.pop || ''
+        first_name = name.join(' ')
+        [ first_name, last_name ]
+      end
+    end
+  end
+end
+