tlconnor-activemerchant 1.20.4

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

@@ -0,0 +1,315 @@
+require 'rexml/document'
+require 'digest/sha1'
+
+module ActiveMerchant
+  module Billing
+    # Realex is the leading CC gateway in Ireland
+    # see http://www.realexpayments.com
+    # Contributed by John Ward (john@ward.name)
+    # see http://thinedgeofthewedge.blogspot.com
+    #
+    # Realex works using the following
+    # login - The unique id of the merchant
+    # password - The secret is used to digitally sign the request
+    # account - This is an optional third part of the authentication process
+    # and is used if the merchant wishes do distuinguish cc traffic from the different sources
+    # by using a different account. This must be created in advance
+    #
+    # the Realex team decided to make the orderid unique per request,
+    # so if validation fails you can not correct and resend using the
+    # same order id
+    class RealexGateway < Gateway
+      URL = 'https://epage.payandshop.com/epage-remote.cgi'
+
+      CARD_MAPPING = {
+        'master'            => 'MC',
+        'visa'              => 'VISA',
+        'american_express'  => 'AMEX',
+        'diners_club'       => 'DINERS',
+        'switch'            => 'SWITCH',
+        'solo'              => 'SWITCH',
+        'laser'             => 'LASER'
+      }
+
+      self.money_format = :cents
+      self.default_currency = 'EUR'
+      self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :switch, :solo, :laser ]
+      self.supported_countries = [ 'IE', 'GB' ]
+      self.homepage_url = 'http://www.realexpayments.com/'
+      self.display_name = 'Realex'
+
+      SUCCESS, DECLINED          = "Successful", "Declined"
+      BANK_ERROR = REALEX_ERROR  = "Gateway is in maintenance. Please try again later."
+      ERROR = CLIENT_DEACTIVATED = "Gateway Error"
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        options[:refund_hash] = Digest::SHA1.hexdigest(options[:rebate_secret]) if options.has_key?(:rebate_secret)
+        @options = options
+        super
+      end
+
+      def purchase(money, credit_card, options = {})
+        requires!(options, :order_id)
+
+        request = build_purchase_or_authorization_request(:purchase, money, credit_card, options)
+        commit(request)
+      end
+
+      def authorize(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        request = build_purchase_or_authorization_request(:authorization, money, creditcard, options)
+        commit(request)
+      end
+
+      def capture(money, authorization, options = {})
+        request = build_capture_request(authorization, options)
+        commit(request)
+      end
+
+      def refund(money, authorization, options = {})
+        request = build_refund_request(money, authorization, options)
+        commit(request)
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def void(authorization, options = {})
+        request = build_void_request(authorization, options)
+        commit(request)
+      end
+
+      private
+      def commit(request)
+        response = parse(ssl_post(URL, request))
+
+        Response.new(response[:result] == "00", message_from(response), response,
+          :test => response[:message] =~ /\[ test system \]/,
+          :authorization => authorization_from(response),
+          :cvv_result => response[:cvnresult],
+          :avs_result => {
+            :street_match => response[:avspostcoderesponse],
+            :postal_match => response[:avspostcoderesponse]
+          }
+        )
+      end
+
+      def parse(xml)
+        response = {}
+
+        xml = REXML::Document.new(xml)
+        xml.elements.each('//response/*') do |node|
+
+          if (node.elements.size == 0)
+            response[node.name.downcase.to_sym] = normalize(node.text)
+          else
+            node.elements.each do |childnode|
+              name = "#{node.name.downcase}_#{childnode.name.downcase}"
+              response[name.to_sym] = normalize(childnode.text)
+            end
+          end
+
+        end unless xml.root.nil?
+
+        response
+      end
+
+      def authorization_from(parsed)
+        [parsed[:orderid], parsed[:pasref], parsed[:authcode]].join(';')
+      end
+
+      def build_purchase_or_authorization_request(action, money, credit_card, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'auth' do
+          add_merchant_details(xml, options)
+          xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+          add_amount(xml, money, options)
+          add_card(xml, credit_card)
+          xml.tag! 'autosettle', 'flag' => auto_settle_flag(action)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), amount(money), (options[:currency] || currency(money)), credit_card.number)
+          add_comments(xml, options)
+          add_address_and_customer_info(xml, options)
+        end
+        xml.target!
+      end
+
+      def build_capture_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'settle' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), nil, nil, nil)
+        end
+        xml.target!
+      end
+
+      def build_refund_request(money, authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'rebate' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
+          xml.tag! 'refundhash', @options[:refund_hash] if @options[:refund_hash]
+          xml.tag! 'autosettle', 'flag' => 1
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), amount(money), (options[:currency] || currency(money)), nil)
+        end
+        xml.target!
+      end
+
+      def build_void_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'void' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], sanitize_order_id(options[:order_id]), nil, nil, nil)
+        end
+        xml.target!
+      end
+
+      def add_address_and_customer_info(xml, options)
+        billing_address = options[:billing_address] || options[:address]
+        shipping_address = options[:shipping_address]
+
+        return unless billing_address || shipping_address || options[:customer] || options[:invoice] || options[:ip]
+
+        xml.tag! 'tssinfo' do
+          xml.tag! 'custnum', options[:customer] if options[:customer]
+          xml.tag! 'prodid', options[:invoice] if options[:invoice]
+          xml.tag! 'custipaddress', options[:ip] if options[:ip]
+
+          if billing_address
+            xml.tag! 'address', 'type' => 'billing' do
+              xml.tag! 'code', avs_input_code( billing_address )
+              xml.tag! 'country', billing_address[:country]
+            end
+          end
+
+          if shipping_address
+            xml.tag! 'address', 'type' => 'shipping' do
+              xml.tag! 'code', format_shipping_zip_code(shipping_address[:zip])
+              xml.tag! 'country', shipping_address[:country]
+            end
+          end
+        end
+      end
+
+      def add_merchant_details(xml, options)
+        xml.tag! 'merchantid', @options[:login]
+        if options[:account] || @options[:account]
+          xml.tag! 'account', (options[:account] || @options[:account])
+        end
+      end
+
+      def add_transaction_identifiers(xml, authorization, options)
+        options[:order_id], pasref, authcode = authorization.split(';')
+        xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+        xml.tag! 'pasref', pasref
+        xml.tag! 'authcode', authcode
+      end
+
+      def add_comments(xml, options)
+        return unless options[:description]
+        xml.tag! 'comments' do
+          xml.tag! 'comment', options[:description], 'id' => 1
+        end
+      end
+
+      def add_amount(xml, money, options)
+        xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
+      end
+
+      def add_card(xml, credit_card)
+        xml.tag! 'card' do
+          xml.tag! 'number', credit_card.number
+          xml.tag! 'expdate', expiry_date(credit_card)
+          xml.tag! 'chname', credit_card.name
+          xml.tag! 'type', CARD_MAPPING[card_brand(credit_card).to_s]
+          xml.tag! 'issueno', credit_card.issue_number
+          xml.tag! 'cvn' do
+            xml.tag! 'number', credit_card.verification_value
+            xml.tag! 'presind', (options['presind'] || (credit_card.verification_value? ? 1 : nil))
+          end
+        end
+      end
+
+      def avs_input_code(address)
+        address.values_at(:zip, :address1).map{ |v| extract_digits(v) }.join('|')
+      end
+
+      def format_shipping_zip_code(zip)
+        zip.to_s.gsub(/\W/, '')
+      end
+
+      def extract_digits(string)
+        return "" if string.nil?
+        string.gsub(/[\D]/,'')
+      end
+
+      def new_timestamp
+        Time.now.strftime('%Y%m%d%H%M%S')
+      end
+
+      def add_signed_digest(xml, *values)
+        string = Digest::SHA1.hexdigest(values.join("."))
+        xml.tag! 'sha1hash', Digest::SHA1.hexdigest([string, @options[:password]].join("."))
+      end
+
+      def auto_settle_flag(action)
+        action == :authorization ? '0' : '1'
+      end
+
+      def expiry_date(credit_card)
+        "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
+      end
+
+      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 message_from(response)
+        message = nil
+        case response[:result]
+        when "00"
+          message = SUCCESS
+        when "101"
+          message = response[:message]
+        when "102", "103"
+          message = DECLINED
+        when /^2[0-9][0-9]/
+          message = BANK_ERROR
+        when /^3[0-9][0-9]/
+          message = REALEX_ERROR
+        when /^5[0-9][0-9]/
+          message = response[:message]
+        when "600", "601", "603"
+          message = ERROR
+        when "666"
+          message = CLIENT_DEACTIVATED
+        else
+          message = DECLINED
+        end
+      end
+
+      def sanitize_order_id(order_id)
+        order_id.to_s.gsub(/[^a-zA-Z0-9\-_]/, '')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/sage/sage_bankcard'
+require File.dirname(__FILE__) + '/sage/sage_virtual_check'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageGateway < Gateway
+      self.supported_countries = SageBankcardGateway.supported_countries
+      self.supported_cardtypes = SageBankcardGateway.supported_cardtypes
+
+      # Creates a new SageGateway
+      # 
+      # The gateway requires that a valid login and password be passed
+      # in the +options+ hash.
+      # 
+      # ==== Options
+      #
+      # * <tt>:login</tt> - The Sage Payment Solutions Merchant ID Number.
+      # * <tt>:password</tt> - The Sage Payment Solutions Merchant Key Number.
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      # Performs an authorization transaction
+      # 
+      # ==== Parameters
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>credit_card</tt> - The CreditCard object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_shipping</tt>.      
+      def authorize(money, credit_card, options = {})
+        bankcard.authorize(money, credit_card, options)
+      end
+      
+      # Performs a purchase, which is essentially an authorization and capture in a single operation.
+      # 
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>source</tt> - The CreditCard or Check object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an integer value in cents. Maps to Sage <tt>T_shipping</tt>.
+      #
+      # ==== Additional options in the +options+ hash for when using a Check as the funding source
+      # * <tt>:originator_id</tt> - 10 digit originator. If not provided, Sage will use the default Originator ID for the specific customer type.
+      # * <tt>:addenda</tt> - Transaction addenda.
+      # * <tt>:ssn</tt> - The customer's Social Security Number.
+      # * <tt>:drivers_license_state</tt> - The customer's drivers license state code.
+      # * <tt>:drivers_license_number</tt> - The customer's drivers license number.
+      # * <tt>:date_of_birth</tt> - The customer's date of birth as a Time or Date object or a string in the format <tt>mm/dd/yyyy</tt>.
+      def purchase(money, source, options = {})
+        if card_brand(source) == "check"
+          virtual_check.purchase(money, source, options)
+        else
+          bankcard.purchase(money, source, options)
+        end
+      end                       
+    
+      # Captures authorized funds.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents. Sage doesn't support changing the capture amount, so the full amount of the initial transaction will be captured.
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def capture(money, reference, options = {})
+        bankcard.capture(money, reference, options)
+      end
+      
+      # Voids a prior transaction. Works for both CreditCard and Check transactions.
+      #
+      # ==== Parameters
+      #
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def void(reference, options = {})
+        if reference.split(";").last == "virtual_check"
+          virtual_check.void(reference, options)
+        else
+          bankcard.void(reference, options)
+        end
+      end
+
+      # Performs a credit transaction. (Sage +Credit+ transaction).
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>source</tt> - The CreditCard or Check object to be used as the target for the credit.
+      def credit(money, source, options = {})
+        if card_brand(source) == "check"
+          virtual_check.credit(money, source, options)
+        else
+          bankcard.credit(money, source, options)
+        end
+      end
+          
+      private
+      def bankcard
+        @bankcard ||= SageBankcardGateway.new(@options)
+      end
+      
+      def virtual_check
+        @virtual_check ||= SageVirtualCheckGateway.new(@options)
+      end 
+    end
+  end
+end
+