@@ -42,21 +42,123 @@ module ActiveMerchant BANK_ERROR = REALEX_ERROR = "Gateway is in maintenance. Please try again later." ERROR = CLIENT_DEACTIVATED = "Gateway Error" + # Unique to the Realex gateway, it requires a separate secret password used to provide refunds/credits. + attr_accessor :refundhash + def initialize(options = {}) requires!(options, :login, :password) + self.refundhash = Digest::SHA1.hexdigest(options[:rebate_secret]) if options.has_key?(:rebate_secret) @options = options super end - + + # Performs an authorization, which reserves the funds on the customer's credit card, but does not + # charge the card. + # + # ==== Parameters + # + # * <tt>money</tt> -- The amount to be authorized. Either an Integer value in cents or a Money object. + # * <tt>creditcard</tt> -- The CreditCard details for the transaction. + # * <tt>options</tt> -- A hash of optional parameters. + # + # ==== Options + # + # * <tt>:order_id</tt> -- The application generated order identifier. (REQUIRED) + def authorize(money, creditcard, options = {}) + requires!(options, :order_id) + + request = build_purchase_or_authorization_request(:auth, money, credit_card, options) + commit(request) + end + + # Perform a purchase, which is essentially an authorization and capture in a single operation. + # + # ==== Parameters + # + # * <tt>money</tt> -- The amount to be purchased. Either an Integer value in cents or a Money object. + # * <tt>creditcard</tt> -- The CreditCard details for the transaction. + # * <tt>options</tt> -- A hash of optional parameters. + # + # ==== Options + # + # * <tt>:order_id</tt> -- The application generated order identifier. (REQUIRED) def purchase(money, credit_card, options = {}) requires!(options, :order_id) request = build_purchase_or_authorization_request(:purchase, money, credit_card, options) commit(request) - end + end + + # Captures the funds from an authorized transaction. + # + # ==== Parameters + # + # * <tt>money</tt> -- The amount to be captured. Either an Integer value in cents or a Money object. + # * <tt>authorization</tt> -- The authorization returned from the previous authorize request. + # + # ==== Options + # + # * <tt>:order_id</tt> -- The application generated order identifier. (REQUIRED) + # * <tt>:pasref</tt> -- The realex payments reference of the original transaction. (REQUIRED) + # * <tt>:authcode</tt> -- The authcode of the original transaction. (REQUIRED) + def capture(money, authorization, options = {}) + options.merge!(:authcode => authorization) + requires!(options, :authcode) + requires!(options, :pasref) + requires!(options, :order_id) + + request = build_settle_request(options) + commit(request) + end + + # Credit an account. + # + # This transaction is also referred to as a Refund (or Rebate) and indicates to the gateway that + # money should flow from the merchant to the customer. + # + # ==== Parameters + # + # * <tt>money</tt> -- The amount to be credited to the customer. Either an Integer value in cents or a Money object. + # * <tt>identification</tt> -- The ID of the original transaction against which the credit is being issued. + # * <tt>options</tt> -- A hash of parameters. + # + # ==== Options + # + # * <tt>:order_id</tt> -- The application generated order identifier. (REQUIRED) + # * <tt>:pasref</tt> -- The realex payments reference of the original transaction. (REQUIRED) + # * <tt>:authcode</tt> -- The authcode of the original transaction. (REQUIRED) + def credit(money, identification, options = {}) + options.merge!(:order_id => identification) + requires!(options, :pasref) + requires!(options, :authcode) + + request = build_rebate_request(money, options) + commit(request) + end - private - def commit(request) + # Void a previous transaction + # + # ==== Parameters + # + # * <tt>authorization</tt> - The authorization returned from the previous authorize request. + # + # ==== Options + # + # * <tt>:order_id</tt> -- The application generated order identifier. (REQUIRED) + # * <tt>:pasref</tt> -- The realex payments reference of the original transaction. (REQUIRED) + # * <tt>:authcode</tt> -- The authcode of the original transaction. (REQUIRED) + def void(identification, options = {}) + options.merge!(:order_id => identification) + requires!(options, :order_id) + requires!(options, :pasref) + requires!(options, :authcode) + + request = build_void_request(options) + commit(request) + end + + private + def commit(request) response = parse(ssl_post(URL, request)) Response.new(response[:result] == "00", message_from(response), response, @@ -148,6 +250,107 @@ module ActiveMerchant xml.target! end + # <request timestamp="20010427124312" type="rebate"> + # <merchantid>your merchant id</merchantid> + # <account>original account</account> + # <orderid>original order id</orderid> + # <pasref>original realex payments ref</pasref> + # <authcode>original authcode</authcode> + # <amount currency="EUR">3000</amount> + # <refundhash>738e83....3434ddae662a</refundhash> + # <autosettle flag="1" /> + # <comments> + # <comment id="1">comment 1</comment> + # <comment id="2">comment 2</comment> + # </comments> + # <sha1hash>748328aed83....34789ade7</sha1hash> + # <md5hash>738e83....34ae662a</md5hash> + # </request> + def build_rebate_request(money, options) + timestamp = Time.now.strftime('%Y%m%d%H%M%S') + + xml = Builder::XmlMarkup.new :indent => 2 + xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'rebate' do + xml.tag! 'merchantid', @options[:login] + xml.tag! 'account', @options[:account] + xml.tag! 'orderid', sanitize_order_id(options[:order_id]) + xml.tag! 'pasref', options[:pasref] + xml.tag! 'authcode', options[:authcode] + xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money) + xml.tag! 'refundhash', Digest::SHA1.hexdigest(@options[:rebate_secret]) + xml.tag! 'autosettle', 'flag' => 1 + xml.tag! 'comments' do + xml.tag! 'comment', options[:description], 'id' => 1 + xml.tag! 'comment', 'id' => 2 + end + xml.tag! 'sha1hash', sha1from("#{timestamp}.#{@options[:login]}.#{sanitize_order_id(options[:order_id])}.#{amount(money)}.#{options[:currency] || currency(money)}") + end + xml.target! + end + + # <request timestamp="20010427014523" type="void"> + # <merchantid>your merchant id</merchantid> + # <account>account to use</account> + # <orderid>original order id</orderid> + # <pasref>original realex payments reference</pasref> + # <authcode>original authcode</authcode> + # <comments> + # <comment id="1">comment 1</comment> + # <comment id="2">comment 2</comment> + # </comments> + # <sha1hash>7384ae67....ac7d7d</sha1hash> + # <md5hash>34e7....a77d</md5hash> + # </request> + def build_void_request(options) + timestamp = Time.now.strftime('%Y%m%d%H%M%S') + + xml = Builder::XmlMarkup.new :indent => 2 + xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'void' do + xml.tag! 'merchantid', @options[:login] + xml.tag! 'account', @options[:account] + xml.tag! 'orderid', sanitize_order_id(options[:order_id]) + xml.tag! 'pasref', options[:pasref] + xml.tag! 'authcode', options[:authcode] + xml.tag! 'comments' do + xml.tag! 'comment', options[:description], 'id' => 1 + xml.tag! 'comment', 'id' => 2 + end + xml.tag! 'sha1hash', sha1from("#{timestamp}.#{@options[:login]}.#{sanitize_order_id(options[:order_id])}") + end + xml.target! + end + + # <request timestamp="20010427014523" type="settle"> + # <merchantid>your merchant id</merchantid> + # <account>account to use</account> + # <orderid>original order id</orderid> + # <pasref>original realex payments reference</pasref> + # <authcode>original authcode</authcode> + # <comments> + # <comment id="1">comment 1</comment> + # <comment id="2">comment 2</comment> + # </comments> + # <sha1hash>7384ae67....ac7d7d</sha1hash> + # </request> + def build_settle_request(options) + timestamp = Time.now.strftime('%Y%m%d%H%M%S') + + xml = Builder::XmlMarkup.new :indent => 2 + xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'settle' do + xml.tag! 'merchantid', @options[:login] + xml.tag! 'account', @options[:account] + xml.tag! 'orderid', sanitize_order_id(options[:order_id]) + xml.tag! 'pasref', options[:pasref] + xml.tag! 'authcode', options[:authcode] + xml.tag! 'comments' do + xml.tag! 'comment', options[:description], 'id' => 1 + xml.tag! 'comment', 'id' => 2 + end + xml.tag! 'sha1hash', sha1from("#{timestamp}.#{@options[:login]}.#{sanitize_order_id(options[:order_id])}") + end + xml.target! + end + def auto_settle_flag(action) action == :authorization ? '0' : '1' end lib/active_merchant/billing/gateways/realex.rb @@ -1,4 +1,4 @@ -require 'test_helper' +require File.join(File.dirname(__FILE__) + '/../../test_helper') class RemoteRealexTest < Test::Unit::TestCase test/remote/gateways/remote_realex_test.rb @@ -1,4 +1,4 @@ -require 'test_helper' +require File.join(File.dirname(__FILE__) + '/../../test_helper') require 'digest/sha1' class RealexTest < Test::Unit::TestCase @@ -6,7 +6,7 @@ class RealexTest < Test::Unit::TestCase def setup @login = 'your_merchant_id' @password = 'your_secret' - + @gateway = RealexGateway.new( :login => @merchant_id, :password => @secret, @@ -67,6 +67,26 @@ class RealexTest < Test::Unit::TestCase assert response.test? end + def test_successful_credit + @gateway = RealexGateway.new(:login => @login, :password => @password, :rebate_secret => 'xyz') + @gateway.expects(:ssl_post).returns(successful_credit_response) + + response = @gateway.credit(@amount, '1234', {:order_id => '1234', :pasref => '1234', :authcode => '1234' }) + assert_instance_of Response, response + assert_success response + assert response.test? + end + + def test_unsuccessful_credit + @gateway = RealexGateway.new(:login => @login, :password => @password, :rebate_secret => 'xyz') + @gateway.expects(:ssl_post).returns(unsuccessful_credit_response) + + response = @gateway.credit(@amount, '1234', {:order_id => '1234', :pasref => '1234', :authcode => '1234' }) + assert_instance_of Response, response + assert_failure response + assert response.test? + end + def test_supported_countries assert_equal ['IE', 'GB'], RealexGateway.supported_countries end @@ -148,4 +168,40 @@ class RealexTest < Test::Unit::TestCase </response>" RESPONSE end + + def successful_credit_response + <<-RESPONSE +<response timestamp='20010427043422'> + <merchantid>your merchant id</merchantid> + <account>account to use</account> + <orderid>order id from request</orderid> + <authcode>authcode received</authcode> + <result>00</result> + <message>[ test system ] message returned from system</message> + <pasref> realex payments reference</pasref> + <cvnresult>M</cvnresult> + <batchid>batch id for this transaction (if any)</batchid> + <sha1hash>7384ae67....ac7d7d</sha1hash> + <md5hash>34e7....a77d</md5hash> +</response>" + RESPONSE + end + + def unsuccessful_credit_response + <<-RESPONSE +<response timestamp='20010427043422'> + <merchantid>your merchant id</merchantid> + <account>account to use</account> + <orderid>order id from request</orderid> + <authcode>authcode received</authcode> + <result>508</result> + <message>[ test system ] You may only rebate up to 115% of the original amount.</message> + <pasref> realex payments reference</pasref> + <cvnresult>M</cvnresult> + <batchid>batch id for this transaction (if any)</batchid> + <sha1hash>7384ae67....ac7d7d</sha1hash> + <md5hash>34e7....a77d</md5hash> +</response>" + RESPONSE + end end \ No newline at end of file test/unit/gateways/realex_test.rb f5f64a35b94480ee24afa3af38524ca4203adb15 David Rice davidjrice@gmail.com http://github.com/davidjrice/active_merchant/commit/1fb149614c55e98b1c594f8a1b308c9c7710e0ac 1fb149614c55e98b1c594f8a1b308c9c7710e0ac 2009-08-24T07:47:12-07:00 2009-08-24T07:47:12-07:00 Implement capture, authorize, credit and void API methods in the Realex gateway implementation 373c4e5601ed61b394dbb49034092bd25df28dfa David Rice davidjrice@gmail.com