exact4r 0.5 → 0.5.1

data/lib/ews/transaction/transporter.rb

@@ -2,7 +2,7 @@ require 'net/https'
 
 module EWS # :nodoc:
   module Transaction # :nodoc:
-    
+
     # A Transporter is responsible for communicating with the E-xact Web Service in
     # whichever dialect is chosen by the user. The available options are:
     #   :json     REST with JSON payload
@@ -16,7 +16,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,
@@ -33,37 +33,38 @@ module EWS # :nodoc:
       # basis, if you choose to do so, by specifying it as a parameter to the <tt>send</tt> method.
       def initialize(url = "https://api.e-xact.com/", options = {})
         @url = URI.parse(url)
-        @server_cert = options[:server_cert] || "certs/exact.cer"
-        @issuer_cert = options[:issuer_cert] || "certs/equifax_ca.cer"
+        base = File.dirname(__FILE__)
+        @server_cert = options[:server_cert] || base+"/../../../certs/exact.cer"
+        @issuer_cert = options[:issuer_cert] || base+"/../../../certs/equifax_ca.cer"
         @transport_type = options[:issuer_cert] || :rest
       end
-      
+
       # Send a transaction request to the server
       #
-      # <tt>request</tt>::  the Request object to encode for transmission to the server 
+      # <tt>request</tt>::  the Request object to encode for transmission to the server
       # <tt>transport_type</tt>::  (optional) the transport type to use for this transaction only. If it not specified, the default transport type for this Transporter will be used
-      def send(request, transport_type = nil)
+      def submit(request, transport_type = nil)
         raise "Request not supplied" if request.nil?
         return false unless request.valid?
-      
+
         transport_type ||= @transport_type
-        
+
         raise "Transport type #{transport_type} is not supported" unless @@transport_types.include? transport_type
-      
+
         if !request.is_find_transaction? or transport_type == :soap
           content = post(request, transport_type)
         else
           content = get(request, transport_type)
         end
-        
+
         EWS::Transaction::Mapping.send "#{transport_type}_to_response", content
       end
-    
+
   private
 
       def post(request, transport_type)
         # build the request
-        req = Net::HTTP::Post.new(@url.path + "/transaction.#{@@transport_types[transport_type]}")
+        req = Net::HTTP::Post.new(@url.path + "transaction.#{@@transport_types[transport_type]}")
         req.basic_auth(request.gateway_id, request.password)
         if transport_type == :soap
           # add the SOAPAction header
@@ -72,7 +73,7 @@ module EWS # :nodoc:
         end
         req.content_type = (transport_type == :json) ? "application/json" : "application/xml"
         req.body = EWS::Transaction::Mapping.send "request_to_#{transport_type.to_s}", request
-      
+
         response = get_connection.request(req)
 
         case response
@@ -84,10 +85,10 @@ module EWS # :nodoc:
 
       def get(request, transport_type)
         # build the request
-        req = Net::HTTP::Get.new(@url.path + "/transaction/#{request.transaction_tag}.#{@@transport_types[transport_type]}")
+        req = Net::HTTP::Get.new(@url.path + "transaction/#{request.transaction_tag}.#{@@transport_types[transport_type]}")
         req.basic_auth(request.gateway_id, request.password)
         req.content_type = (transport_type == :json) ? "application/json" : "application/xml"
-      
+
         response = get_connection.request(req)
 
         case response
@@ -96,9 +97,10 @@ module EWS # :nodoc:
           response.error!
         end
       end
-    
+
       def get_connection
         connection = Net::HTTP.new(@url.host, @url.port)
+        connection.set_debug_output $stdout if $DEBUG
         if @url.scheme == 'https'
           connection.use_ssl = true
           connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -125,4 +127,4 @@ module EWS # :nodoc:
 
     end
   end
-end
+end

data/lib/exact4r.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'activesupport'
 
 require 'ews/transaction/mapping'
 require 'ews/transaction/request'

data/spec/donncha.rb

@@ -0,0 +1,46 @@
+# require File.dirname(__FILE__) + "/spec_helper"
+# 
+# describe "smaple" do
+#   it "should work" do
+#     r1 = {"requested_aci": 0, "trfid": 12715148, "sequence_no": "212", "auth_number": "ET3442", "abuff_length": 6, "currency_str": "USD", "trace_no": "028001", "bank_resp_code": "000", "returned_aci": 0, "tx_state": 0, "cc_number": "4111111111111111", "sys": 0, "cavv_response": 0, "txflag1": 0, "trans_no": "01", "bank_message": "APPROVED", "transaction_type": "00", "input_method": 0, "time_received": "2008/05/28 20:34:42 +0000", "retrieval_ref_no": "05283442", "cc_expiry": "1005", "transaction_id": 0, "credit_card_type": "Visa", "txflag2": 0, "gateway_id": "AD0008-01", "crc": 0, "ecommerce_flag": 0, "time_sent": "2008/05/28 20:34:42 +0000", "auth_source_code": "5", "cardholder_name": "Simon Brown", "transaction_tag": 2384, "enc": 2, "terminal_ptr": 16459632, "reversal_ind": "O", "exact_resp_code": "00", "amount": "1013", "terminal_id": "001", "cvd_presence_ind": 0, "transaction_approved": 1, "optional": "~uVisa", "transaction_tag2": 0,    "processing_centre": 1, "exact_message": "Transaction Normal",      "sub": 0, "cmd": 65418, "len": 493, "pid": 333}
+#     r2 = {"requested_aci": 0, "trfid": 0       , "sequence_no": "212", "auth_number": "ET3442", "abuff_length": 0,                                              "bank_resp_code": "000", "returned_aci": 0, "tx_state": 0, "cc_number": "4111111111111111", "sys": 0, "cavv_response": 0, "txflag1": 0,                   "bank_message": "APPROVED", "transaction_type": "00", "input_method": 0, "time_received": "2008/05/28 20:34:41 +0000",                                 "cc_expiry": "1005", "transaction_id": 0,                             "txflag2": 0, "gateway_id": "AD0008-01", "crc": 0, "ecommerce_flag": 0, "time_sent": "1899/12/30 00:00:00 +0000",                          "cardholder_name": "Simon Brown", "transaction_tag": 2384, "enc": 2, "terminal_ptr": 0,                             "exact_resp_code": "00", "amount": "1013", "terminal_id": "001", "cvd_presence_ind": 0, "transaction_approved": 1,                       "transaction_tag2": 2384, "processing_centre": 5, "exact_message": "Transaction Normalumber", "sub": 0, "cmd": 65418, "len": 487, "pid": 345}
+#   end
+# end
+
+require 'net/https'
+
+def validate_certificate(is_ok, ctx)
+  # Only check the server certificate, not the issuer.
+  unless (ctx.current_cert.subject.to_s == ctx.current_cert.issuer.to_s)
+    is_ok &&= File.open("certs/exact.cer").read == ctx.current_cert.to_pem
+  end
+  is_ok
+end
+
+# @url = URI.parse("https://olb.au.virginmoney.com/esis/Login/SrvPage")
+@url = URI.parse("https://pos.e-xact.com/")
+
+# https://olb.au.virginmoney.com/esis/Login/SrvPage
+begin
+  connection = Net::HTTP.new(@url.host, @url.port)
+  # 
+  if @url.scheme == 'https'
+    connection.use_ssl = true
+    connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    connection.ca_file = "certs/equifax_ca.cer"
+    connection.verify_callback = method(:validate_certificate)
+  end
+
+  req = Net::HTTP::Get.new(@url.path)
+
+  response = connection.request(req)
+rescue => e
+  puts e.message
+  puts e.backtrace
+end
+# puts response
+# case response
+# when Net::HTTPSuccess then response.body
+# else
+#   response.error!
+# end

data/spec/mapping_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "Mapping TO formats" do
+
+  it "should generate a JSON payload" do
+    r = EWS::Transaction::Request.new(basic_params)
+    
+    json = EWS::Transaction::Mapping.request_to_json(r)
+
+    res = ActiveSupport::JSON.decode(json)
+    res["amount"].should == "10.13"
+    res["cardholder_name"].should == "Simon Brown"
+    res["cc_number"].should == "4111111111111111"
+    res["cc_expiry"].should == "1005"
+  end
+
+  it "should generate a REST payload" do
+    r = EWS::Transaction::Request.new(basic_params)
+
+    rest = EWS::Transaction::Mapping.request_to_rest(r)
+    
+    xml = REXML::Document.new(rest)
+    txn = REXML::XPath.first(xml, "//Transaction")
+    REXML::XPath.first(txn, "Card_Number").text.should == "4111111111111111"
+    REXML::XPath.first(txn, "CardHoldersName").text.should == "Simon Brown"
+    REXML::XPath.first(txn, "Transaction_Type").text.should == "00"
+    REXML::XPath.first(txn, "Expiry_Date").text.should == "1005"
+    REXML::XPath.first(txn, "DollarAmount").text.should == "10.13"
+  end
+
+  it "should generate a SOAP payload" do
+    r = EWS::Transaction::Request.new(basic_params)
+
+    soap = EWS::Transaction::Mapping.request_to_soap(r)
+    
+    xml = REXML::Document.new(soap)
+    txn = REXML::XPath.first(xml, "//SendAndCommitSource")
+    REXML::XPath.first(txn, "Card_Number").text.should == "4111111111111111"
+    REXML::XPath.first(txn, "CardHoldersName").text.should == "Simon Brown"
+    REXML::XPath.first(txn, "Transaction_Type").text.should == "00"
+    REXML::XPath.first(txn, "Expiry_Date").text.should == "1005"
+    REXML::XPath.first(txn, "DollarAmount").text.should == "10.13"
+  end  
+end
+
+describe "Mapping FROM formats" do
+
+    it "should parse a JSON payload" do
+      payload = <<PAYLOAD
+      {"bank_message": "APPROVED", "transaction_type": "00", "transaction_tag": 2238, "exact_message": "Transaction Normal"}
+PAYLOAD
+
+      r = EWS::Transaction::Mapping.json_to_response(payload)
+
+      r.exact_message.should == "Transaction Normal"
+      r.error_description.should be_nil
+      r.bank_message.should == "APPROVED"
+      r.transaction_tag.should == 2238
+      r.transaction_type.should == "00"
+    end
+
+    it "should parse a REST payload" do
+      payload = <<PAYLOAD
+      <?xml version="1.0" encoding="UTF-8"?>
+      <TransactionResult>
+        <Error_Description></Error_Description>
+        <Bank_Message>APPROVED</Bank_Message>
+        <Transaction_Tag>2239</Transaction_Tag>
+        <EXact_Message>Transaction Normal</EXact_Message>
+        <Transaction_Type>00</Transaction_Type>
+      </TransactionResult>
+PAYLOAD
+
+      r = EWS::Transaction::Mapping.rest_to_response(payload)
+
+      r.exact_message.should == "Transaction Normal"
+      r.error_description.should be_nil
+      r.bank_message.should == "APPROVED"
+      r.transaction_tag.should == 2239
+      r.transaction_type.should == "00"
+    end
+
+    it "should parse a SOAP payload"
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,123 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "Request" do
+
+  it "should allow construction from empty hash" do
+    r = EWS::Transaction::Request.new
+  end
+  
+  it "should assign values" do
+    r = EWS::Transaction::Request.new(basic_params)
+    
+    r.amount.should == "10.13"
+    r.cardholder_name.should == "Simon Brown"
+    r.cc_number.should == "4111111111111111"
+    r.cc_expiry.should == "1005"
+  end
+  
+  it "should require gateway_id and password " do
+    EWS::Transaction::Request.new(basic_params).should be_valid
+
+    EWS::Transaction::Request.new(basic_params(:gateway_id => nil)).should_not be_valid
+    EWS::Transaction::Request.new(basic_params(:gateway_id => "")).should_not be_valid
+
+    EWS::Transaction::Request.new(basic_params(:password => nil)).should_not be_valid
+    EWS::Transaction::Request.new(basic_params(:password => "")).should_not be_valid
+  end
+  
+  it "should validate amount, cc_number and cc_expiry" do
+    # validation: amounts
+    [:amount, :surcharge_amount, :tax1_amount, :tax2_amount].each do |amount_attr|
+      EWS::Transaction::Request.new(basic_params(amount_attr => "10.13")).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => "10.")).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => "0.13")).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => 10.13)).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => 0.13)).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => 10)).should be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => "10.1s3")).should_not be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => "1s0.13")).should_not be_valid
+      EWS::Transaction::Request.new(basic_params(amount_attr => "dopey")).should_not be_valid
+    end
+
+    # validation: card number
+    EWS::Transaction::Request.new(basic_params(:cc_number => "4111111111111111")).should be_valid
+    EWS::Transaction::Request.new(basic_params(:cc_number => "4111111111111112")).should_not be_valid
+    
+    # validation: card expiry (should be in YYMM format)
+    EWS::Transaction::Request.new(basic_params(:cc_expiry => "1009")).should be_valid
+    EWS::Transaction::Request.new(basic_params(:cc_expiry => "0708")).should_not be_valid
+  end
+  
+  it "should be valid when symbol or value supplied for transaction_type" do
+    EWS::Transaction::Request.new(basic_params(:transaction_type => "00")).should be_valid
+    EWS::Transaction::Request.new(basic_params(:transaction_type => :purchase)).should be_valid
+
+    EWS::Transaction::Request.new(basic_params(:transaction_type => nil)).should_not be_valid
+    EWS::Transaction::Request.new(basic_params(:transaction_type => "")).should_not be_valid
+    EWS::Transaction::Request.new(basic_params(:transaction_type => "barry")).should_not be_valid
+  end
+end
+
+describe "Submitting New Requests" do
+
+  before :all do 
+    @transporter = EWS::Transaction::Transporter.new
+  end
+  
+  it "should work without a specified transport_type" do
+    txn = basic_new_transaction
+    resp = @transporter.submit(txn)
+
+    resp.exact_resp_code.should == "00"
+    resp.exact_message.should == "Transaction Normal"
+    resp.bank_message.should == "APPROVED"
+    resp.transaction_tag.should_not be_nil
+  end
+  
+  it "should support all transport types" do
+    [:json, :rest, :soap].each do |type|
+      txn = basic_new_transaction
+      resp = @transporter.submit(txn, type)
+
+      resp.exact_resp_code.should == "00"
+      resp.exact_message.should == "Transaction Normal"
+      resp.bank_message.should == "APPROVED"
+      resp.transaction_tag.should_not be_nil
+    end
+  end
+
+end
+
+describe "Submitting Find Requests" do
+
+  before :each do
+    @transporter = EWS::Transaction::Transporter.new
+
+    txn = basic_new_transaction
+    @transaction_tag = @transporter.submit(txn, :json).transaction_tag
+  end
+  
+  it "should work without a specified transport_type" do
+    txn = basic_find_transaction(:transaction_tag => @transaction_tag)
+    resp = @transporter.submit(txn)
+
+    resp.exact_resp_code.should == "00"
+    resp.exact_message.should == "Transaction Normal"
+    resp.bank_message.should == "APPROVED"
+    resp.transaction_tag.should_not be_nil
+  end
+
+  it "should support all transport types" do
+    [:json, :rest, :soap].each do |type|
+      txn = basic_find_transaction(:transaction_tag => @transaction_tag)
+      resp = @transporter.submit(txn, type)
+
+      resp.transaction_tag.should == @transaction_tag
+      resp.cc_number == "4111111111111"
+      resp.exact_resp_code.should == "00"
+      resp.exact_message.should == "Transaction Normal"
+      resp.bank_message.should == "APPROVED"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require 'spec'
+require 'lib/exact4r'
+
+def basic_params(options = {})
+  {
+    :transaction_type => :purchase,
+    :amount => "10.13",
+    :cardholder_name => "Simon Brown",
+    :cc_number => "4111111111111111",
+    :cc_expiry => "1005",
+    :gateway_id => "someone",
+    :password => "somehow"
+  }.merge(options)
+end
+
+def basic_find_transaction(options = {})
+  params = {
+    :transaction_type => :transaction_details,
+    :gateway_id => "AD0008-01",
+    :password => "7nfcpc7n"
+  }.merge(options)
+  
+  ::EWS::Transaction::Request.new(params)  
+end
+
+def basic_new_transaction(options = {})
+  params = {
+    :transaction_type => :purchase,
+    :amount => "10.13",
+    :cardholder_name => "Simon Brown",
+    :cc_number => "4111111111111111",
+    :cc_expiry => "1005",
+    :reference_no => "987987",
+    :gateway_id => "AD0008-01",
+    :password => "7nfcpc7n"
+  }.merge(options)
+  
+  ::EWS::Transaction::Request.new(params)
+end

data/spec/transporter_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "Transporter creating transactions" do
+  
+  it "should raise an exception when transport_type is not one of :json, :rest or :soap" do
+    lambda {
+      tr = ::EWS::Transaction::Transporter.new
+      tr.submit(basic_new_transaction, :banana)
+    }.should raise_error
+  end
+  
+  it "should not throw errors" do
+    txn = basic_new_transaction
+
+    lambda {
+      tr = ::EWS::Transaction::Transporter.new
+      tr.submit(txn, json)
+    }.should_not raise_error(RuntimeError)
+  end
+  
+  
+end
+
+describe "Transporter finding transactions" do
+  
+  before :each do
+    txn = basic_new_transaction
+    @tr = ::EWS::Transaction::Transporter.new
+    r = @tr.submit(txn, :json)
+    @transaction_tag = r.transaction_tag
+  end
+  
+  it "should support all transport types" do
+    [:json, :rest, :soap].each do |type|
+      txn = basic_find_transaction(:transaction_tag => @transaction_tag)
+      resp = @tr.submit(txn, type)
+
+      resp.transaction_tag.should == @transaction_tag
+      resp.cc_number == "4111111111111"
+      resp.exact_resp_code.should == "00"
+      resp.exact_message.should == "Transaction Normal"
+      resp.bank_message.should == "APPROVED"
+    end
+  end
+  
+end
+
+describe "Transporter creating and finding transactions" do
+  
+  it "should support all transport types" do
+    [:json, :rest, :soap].each do |type|
+      tr = ::EWS::Transaction::Transporter.new
+      new_txn = tr.submit(basic_new_transaction, type)
+      new_txn.transaction_tag.should_not be_nil
+
+      found_txn = tr.submit(basic_find_transaction(:transaction_tag => new_txn.transaction_tag), :json)
+      found_txn.should_not be_nil
+      found_txn.transaction_tag.should == new_txn.transaction_tag
+    end
+  end
+  
+end