exact4r 0.9.3 → 1.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+== v1.0
+  Added support for Batch Query and Batch Close transactions.
+
 == v0.9.3
   Reinstated Tagged Void support.
 

data/README

@@ -184,14 +184,3 @@ The following AVS responses are currently supported:
   
   response.cc_verification_str1.should == "N123BROWNSTREET4902101234"
   response.avs.should == N
-    
-= Rake tasks
-
-test
-  Run all tests (default)
-
-rdoc
-  Generate rdoc html in doc/
-
-gem
-  Build gem

data/Rakefile

@@ -3,13 +3,45 @@ require 'rake/testtask'
 require "rubygems"
 require "rake/gempackagetask"
 
-task :default => :test
+task :default => :'test:chase'
 
-desc 'Run all the tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+namespace :test do
+
+  desc 'Run all tests against all processors. Use LOCATION to specify web service URL.'
+  task :all do
+    %w(chase tsys emergis moneris).each do |processor|
+      3.times { puts }
+      puts "#-----------------------"
+      puts "# Testing: " + processor
+      puts "#-----------------------"
+
+      ENV['PROCESSOR'] = processor
+      begin
+        Rake::Task[:'test:processor'].execute
+      rescue
+        # don't care, just run it again. can examine output later
+      end
+    end
+  end
+  
+  desc 'Run all tests against Chase processor and Production web service. Use LOCATION to specify web service URL.'
+  task :chase do
+    ENV['PROCESSOR'] = 'chase'
+    ENV['LOCATION'] = 'PROD'
+    begin
+      Rake::Task[:'test:processor'].execute
+    rescue
+      # don't care, just run it again. can examine output later
+    end
+  end
+  
+  desc 'Run all the tests against a specific processor. Use LOCATION to specify web service URL.'
+  Rake::TestTask.new(:processor) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = true
+  end
+  
 end
 
 desc "Build the RDoc"

data/VERSION

@@ -1 +1 @@
-0.9.3
+1.0

data/lib/ews/transaction/request.rb

@@ -43,6 +43,8 @@ module EWS # :nodoc:
     #  :idebit_refund
     #  :secure_storage
     #  :secure_storage_eft
+    #  :batch_query
+    #  :batch_close
     #  :transaction_details
     class Request
       include Validator
@@ -117,6 +119,8 @@ METHOD_EOS
         :idebit_refund => '54',
         :secure_storage => '60',
         :secure_storage_eft => '61',
+        :batch_query => '80',
+        :batch_close => '81',
         :transaction_details => 'CR'
       }.freeze unless defined?(@@transaction_codes)
       

data/lib/ews/transaction/validator.rb

@@ -40,6 +40,8 @@ module EWS  # :nodoc:
         
         if self.transaction_type == "CR"
           append_error(:transaction_tag, "transaction_tag must be supplied") if self.transaction_tag.to_i < 1
+        elsif %w(80 81).include?(self.transaction_type)
+          # do nothing, no validation required
         elsif %w(50 54).include?(self.transaction_type)
           validate_for_pan
         elsif !self.transaction_tag.blank?

data/lib/ews/transporter.rb

@@ -15,7 +15,7 @@ module EWS # :nodoc:
   # Once configured to connect to a particular service, it can be used repeatedly
   # to send as many transactions as required.
   class Transporter
-
+    
     # Initialize a Transporter.
     #
     # You can specify the URL you would like the Transporter to connect to, although it defaults
@@ -30,6 +30,8 @@ module EWS # :nodoc:
     def initialize(url = "https://api.e-xact.com", options = {})
       @url = URI.parse(url.gsub(/\/$/,''))
       @transport_type = options[:transport_type] || :rest
+      
+      debugger
 
       @@issuer_cert ||= File.dirname(__FILE__)+"/../../certs/equifax_ca.cer"
       @@server_cert ||= File.new(File.dirname(__FILE__)+"/../../certs/exact.cer").read
@@ -52,7 +54,7 @@ module EWS # :nodoc:
       request = build_http_request(transaction, transport_type, transport_details[:suffix])
       request.basic_auth(transaction.gateway_id, transaction.password)
       request.add_field "Accept", transport_details[:content_type]
-      request.add_field "User-Agent", "exact4r v0.9.1"
+      request.add_field "User-Agent", "exact4r v1.0"
       request.add_field "Content-type", "#{transport_details[:content_type]}; charset=UTF-8"
 
       response = get_connection.request(request)

data/test/credentials.rb

@@ -0,0 +1,62 @@
+module Exact
+  class Credentials
+
+    attr_accessor :config
+    
+    def initialize
+      load_configuration(ENV['LOCATION'])
+    end
+    
+    # obtain the credentials for the processor specified by
+    # ENV['PROCESSOR'], defaulting to 'emergis'
+    def current_gateway
+      processor = ENV['PROCESSOR'] || 'emergis'
+      self.config[processor]
+    end
+    
+    def chase
+      self.config['chase']
+    end
+    def chase_batch
+      self.config['chase_batch']
+    end
+    def chase?
+      [self.chase[:gateway_id], self.chase_batch[:gateway_id]].include?(current_gateway[:gateway_id])
+    end
+    
+    def tsys
+      self.config['tsys']
+    end
+    def tsys?
+      current_gateway[:gateway_id] == self.tsys[:gateway_id]
+    end
+    
+    def emergis
+      self.config['emergis']
+    end
+    def emergis?
+      current_gateway[:gateway_id] == self.emergis[:gateway_id]
+    end
+    
+    def moneris
+      self.config['moneris']
+    end
+    def moneris?
+      current_gateway[:gateway_id] == self.moneris[:gateway_id]
+    end
+    
+    def load_configuration(environment)
+      config_file = File.dirname(__FILE__) + '/credentials.yml'
+      yaml = YAML::load(IO.read(config_file))
+      environment ||= 'DEV'
+
+      self.config = yaml[environment]
+    
+      if self.config.nil?
+        abort "No credentials configured. Please create a properly-formatted credentials.yml file in #{File.dirname(__FILE__)}."
+      end
+    end
+    private :load_configuration
+    
+  end
+end

data/test/credentials.yml

@@ -0,0 +1,53 @@
+DEV:
+  location: http://ws.local/
+  tsys:
+    :gateway_id: AD0007-01
+    :password: 3uLi726f
+  emergis:
+    :gateway_id: AD0009-01
+    :password: 8L588rmd
+  moneris:
+    :gateway_id: AD0154-01
+    :password: 77hgy56y
+  chase:
+    :gateway_id: AD0008-01
+    :password: 7nfcpc7n
+  chase_batch:
+    :gateway_id: AD0021-02
+    :password: 22ra7k69
+
+QA:
+  location: http://api.qa.e-xact.com/
+  tsys:
+    :gateway_id: A04766-01
+    :password: 4apitest
+  emergis:
+    :gateway_id: A04763-01
+    :password: 4apitest
+  moneris:
+    :gateway_id: A04760-01
+    :password: 4apitest
+  chase:
+    :gateway_id: A04757-02
+    :password: 4apitest
+  chase_batch:
+    :gateway_id: A04757-01
+    :password: 4apitest
+
+PROD:
+  location: https://api.e-xact.com/
+  tsys:
+    :gateway_id: A08741-01
+    :password: 4apitest
+  emergis:
+    :gateway_id: A08738-01
+    :password: 4apitest
+  moneris:
+    :gateway_id: A08735-01
+    :password: 4apitest
+  chase:
+    :gateway_id: A08732-02
+    :password: 4apitest
+  chase_batch:
+    :gateway_id: A08732-01
+    :password: 4apitest

data/test/exhaustive/batch_query_close_test.rb

@@ -0,0 +1,193 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class BatchQueryCloseTest < Test::Unit::TestCase
+  
+  # NOTE: DO NOT submit an amount with a cents value of LESS THAN 25 to this host as it will
+  # reply with a bank_resp_code == 200 + cents
+  
+  def setup
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
+  end
+  
+  def test_mandatory
+    request = EWS::Transaction::Request.new(:transaction_type => :batch_query)
+    assert !request.valid?
+    assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
+    
+    request.gateway_id = @@credentials.chase_batch[:gateway_id]
+    assert !request.valid?
+    assert_equal "password must be supplied", request.errors[:password]
+    
+    request.password = @@credentials.chase_batch[:password]
+    assert request.valid?
+    
+    # yep, that's it. only gateway_id and password are required
+
+    request = EWS::Transaction::Request.new(:transaction_type => :batch_close)
+    assert !request.valid?
+    assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
+    
+    request.gateway_id = @@credentials.chase_batch[:gateway_id]
+    assert !request.valid?
+    assert_equal "password must be supplied", request.errors[:password]
+    
+    request.password = @@credentials.chase_batch[:password]
+    assert request.valid?
+  end
+  
+  def test_query
+    return unless @@credentials.chase?
+    
+    # send a transaction to ensure there is a batch in progress
+    submit_purchase
+
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_query))
+
+    response = @transporter.submit(request, :json)
+    assert_response_approved response
+    assert_equal "BATINQ", response.authorization_num
+
+    response = @transporter.submit(request, :rest)
+    assert_response_approved response
+    assert_equal "BATINQ", response.authorization_num
+
+    response = @transporter.submit(request, :soap)
+    assert_response_approved response
+    assert_equal "BATINQ", response.authorization_num
+  end
+
+  def test_close_json
+    return unless @@credentials.chase?
+
+    # send a transaction to ensure there is a batch in progress
+    submit_purchase
+
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_close))
+    
+    response = @transporter.submit(request, :json)
+    assert_response_approved response
+    assert_equal "BATCLS", response.authorization_num
+  end
+
+  def test_close_rest
+    return unless @@credentials.chase?
+
+    # send a transaction to ensure there is a batch in progress
+    submit_purchase
+
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_close))
+
+    response = @transporter.submit(request, :rest)
+    assert_response_approved response
+    assert_equal "BATCLS", response.authorization_num
+  end
+
+  def test_close_soap
+    return unless @@credentials.chase?
+
+    # send a transaction to ensure there is a batch in progress
+    submit_purchase
+
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_close))
+
+    response = @transporter.submit(request, :soap)
+    assert_response_approved response
+    assert_equal "BATCLS", response.authorization_num
+  end
+
+  def test_cant_close_already_closed_batch
+    return unless @@credentials.chase?
+
+    # ensure any existing batch is closed
+    submit_batch_close
+
+    response = submit_batch_close
+    assert !response.approved?
+    assert_nil response.bank_resp_code
+    assert_equal "BAT ALREADY RELS", response.bank_message
+  end
+
+  # test cards
+  # Visa: 4111111111111111
+  # MasterCard: 5500000000000004
+  # American Express: 340000000000009
+  def test_summation
+    return unless @@credentials.chase?
+
+    submit_batch_close  # ensure we're starting a new batch
+
+    submit_purchase(:amount => 10.00)
+    submit_purchase(:amount => 15.29)
+    submit_purchase(:amount => 122.75)
+    # 3 transactions, total of 148.04 on VISA
+
+    submit_purchase({:cc_number => "5500000000000004", :amount => 1754.60})
+    submit_purchase({:cc_number => "5500000000000004", :amount => 1544.87})
+    # 2 transactions, total of 3299.47 on Mastercard
+
+    submit_purchase({:cc_number => "340000000000009", :amount => 43.26})
+    submit_purchase({:cc_number => "340000000000009", :amount => 185.75})
+    submit_purchase({:cc_number => "340000000000009", :amount => 877.53})
+    submit_purchase({:cc_number => "340000000000009", :amount => 7.45})
+    # 4 transactions, total of 1113.99 on Amex
+
+    response = submit_batch_query
+    assert_response_approved response
+    assert_equal "BATINQ", response.authorization_num
+    assert_equal "<CR|5|344751><AE|4|111399>", response.bank_message
+
+    # now close the batch
+    response = submit_batch_close
+    assert_response_approved response
+    assert_equal "BATCLS", response.authorization_num
+    assert_equal "<CR|5|344751><AE|4|111399>", response.bank_message
+  end
+
+  def test_large_summation
+    return unless @@credentials.chase?
+
+    submit_batch_close  # ensure we're starting a new batch
+
+    10.times { submit_purchase(:amount => 99999.0) }
+
+    response = submit_batch_query
+    assert_response_approved response
+    assert_equal "BATINQ", response.authorization_num
+    assert_equal "<CR|10|99999000>", response.bank_message
+
+    # now close the batch
+    response = submit_batch_close
+    assert_response_approved response
+    assert_equal "BATCLS", response.authorization_num
+    assert_equal "<CR|10|99999000>", response.bank_message
+  end
+
+private
+  def submit_batch_query
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_query))
+    @transporter.submit(request, :rest)
+  end
+
+  def submit_batch_close
+    request = EWS::Transaction::Request.new(@@credentials.chase_batch.merge(:transaction_type => :batch_close))
+    @transporter.submit(request, :json)
+  end
+
+  def submit_purchase(options = {:amount => 10.0})
+    params = cc_number_params.
+                merge(@@credentials.chase_batch).
+                merge(:transaction_type => :purchase).
+                merge(options)
+    request = EWS::Transaction::Request.new(params)
+    assert request.valid?, request.errors.inspect
+
+    # if this is failing, see note at top of page first!
+    assert @transporter.submit(request, :json).approved?
+  end
+
+  def assert_response_approved(response)
+    assert_not_nil response, "response should not be nil"
+    assert response.approved?, "#{response.error_number} / #{response.error_description} / #{response.exact_message} / #{response.bank_message}"
+    assert_equal "000", response.bank_resp_code
+  end
+end

data/test/exhaustive/forced_post_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/../test_helper"
 class ForcedPostTest < Test::Unit::TestCase
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -11,11 +11,11 @@ class ForcedPostTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = EMERGIS_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = EMERGIS_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "One of the following must be supplied: cc_number, track1, track2 or transaction_tag.", request.errors[:base]
     

data/test/exhaustive/online_debit_purchase_test.rb

@@ -5,7 +5,7 @@ class OnlineDebitPurchaseTest < Test::Unit::TestCase
   # NOTE: INTERAC Online Debit transactions are ONLY supported by Chase merchants
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -13,11 +13,11 @@ class OnlineDebitPurchaseTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = CHASE_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = CHASE_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "pan must be supplied", request.errors[:pan]
     
@@ -35,12 +35,14 @@ class OnlineDebitPurchaseTest < Test::Unit::TestCase
   
   # PAN may be specificed as a simple account number...
   def test_by_pan_as_cc_number
+    return unless @@credentials.chase?
+    
     request = EWS::Transaction::Request.new({
       :transaction_type => :idebit_purchase,
       :amount => 11.25,
       :pan => TEST_CARD_NUMBER,
       :cardholder_name => TEST_CARD_HOLDER
-    }.merge(CHASE_BASIC_AUTH))    
+    }.merge(@@credentials.current_gateway))    
     assert request.valid?, request.errors.inspect
     
     assert_details_correct request, @transporter.submit(request, :json)
@@ -50,12 +52,14 @@ class OnlineDebitPurchaseTest < Test::Unit::TestCase
   
   # ...or in track2 format
   def test_by_pan_as_cc_number
+    return unless @@credentials.chase?
+    
     request = EWS::Transaction::Request.new({
       :transaction_type => :idebit_purchase,
       :amount => 11.25,
       :pan => TEST_TRACK2,
       :cardholder_name => TEST_CARD_HOLDER
-    }.merge(CHASE_BASIC_AUTH))
+    }.merge(@@credentials.current_gateway))
     assert request.valid?, request.errors.inspect
     
     assert_details_correct request, @transporter.submit(request, :json)

data/test/exhaustive/online_debit_refund_test.rb

@@ -5,7 +5,7 @@ class OnlineDebitRefundTest < Test::Unit::TestCase
   # NOTE: INTERAC Online Debit transactions are ONLY supported by Chase merchants
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -13,11 +13,11 @@ class OnlineDebitRefundTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = CHASE_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = CHASE_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "pan must be supplied", request.errors[:pan]
     
@@ -35,12 +35,14 @@ class OnlineDebitRefundTest < Test::Unit::TestCase
   
   # PAN may be specificed as a simple account number...
   def test_by_pan_as_cc_number
+    return unless @@credentials.chase?
+    
     request = EWS::Transaction::Request.new({
       :transaction_type => :idebit_refund,
       :amount => 11.25,
       :pan => TEST_CARD_NUMBER,
       :cardholder_name => TEST_CARD_HOLDER
-    }.merge(CHASE_BASIC_AUTH))
+    }.merge(@@credentials.current_gateway))
     assert request.valid?, request.errors.inspect
     
     assert_details_correct request, @transporter.submit(request, :json)
@@ -50,12 +52,14 @@ class OnlineDebitRefundTest < Test::Unit::TestCase
   
   # ...or in track2 format
   def test_by_pan_as_cc_number
+    return unless @@credentials.chase?
+    
     request = EWS::Transaction::Request.new({
       :transaction_type => :idebit_refund,
       :amount => 11.25,
       :pan => TEST_TRACK2,
       :cardholder_name => TEST_CARD_HOLDER
-    }.merge(CHASE_BASIC_AUTH))
+    }.merge(@@credentials.current_gateway))
     assert request.valid?, request.errors.inspect
     
     assert_details_correct request, @transporter.submit(request, :json)

data/test/exhaustive/pre_auth_completion_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/../test_helper"
 class PreAuthCompletionTest < Test::Unit::TestCase
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -11,11 +11,11 @@ class PreAuthCompletionTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = EMERGIS_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = EMERGIS_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "One of the following must be supplied: cc_number, track1, track2 or transaction_tag.", request.errors[:base]
     

data/test/exhaustive/pre_auth_only_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/../test_helper"
 class PreAuthOnlyTest < Test::Unit::TestCase
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -11,11 +11,11 @@ class PreAuthOnlyTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = EMERGIS_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = EMERGIS_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "One of the following must be supplied: cc_number, track1, track2 or transaction_tag.", request.errors[:base]
     
@@ -36,6 +36,8 @@ class PreAuthOnlyTest < Test::Unit::TestCase
   end
   
   def test_by_credit_card
+    return unless @@credentials.chase? || @@credentials.emergis?
+    
     request = EWS::Transaction::Request.new(cc_number_params.merge(:transaction_type => :pre_auth_only))
     request.amount = 11.25
     assert request.valid?, request.errors.inspect
@@ -46,6 +48,8 @@ class PreAuthOnlyTest < Test::Unit::TestCase
   end
   
   def test_by_track1
+    return unless @@credentials.chase? || @@credentials.emergis?
+    
     request = EWS::Transaction::Request.new(track1_params.merge(:transaction_type => :pre_auth_only))
     request.amount = 11.25
     assert request.valid?, request.errors.inspect
@@ -56,6 +60,8 @@ class PreAuthOnlyTest < Test::Unit::TestCase
   end
   
   def test_by_track2
+    return unless @@credentials.chase? || @@credentials.emergis?
+    
     request = EWS::Transaction::Request.new(track2_params.merge(:transaction_type => :pre_auth_only))
     request.amount = 11.25
     assert request.valid?, request.errors.inspect

data/test/exhaustive/pre_auth_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/../test_helper"
 class PreAuthTest < Test::Unit::TestCase
   
   def setup
-    @transporter = EWS::Transporter.new(LOCATION)
+    @transporter = EWS::Transporter.new(@@credentials.config['location'])
   end
   
   def test_mandatory
@@ -11,11 +11,11 @@ class PreAuthTest < Test::Unit::TestCase
     assert !request.valid?
     assert_equal "gateway_id must be supplied", request.errors[:gateway_id]
     
-    request.gateway_id = EMERGIS_BASIC_AUTH[:gateway_id]
+    request.gateway_id = @@credentials.current_gateway[:gateway_id]
     assert !request.valid?
     assert_equal "password must be supplied", request.errors[:password]
     
-    request.password = EMERGIS_BASIC_AUTH[:password]
+    request.password = @@credentials.current_gateway[:password]
     assert !request.valid?
     assert_equal "One of the following must be supplied: cc_number, track1, track2 or transaction_tag.", request.errors[:base]