exact4r 0.5.2 → 0.6

data/lib/ews/transaction/transporter.rb

@@ -1,120 +0,0 @@
-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
-    #   :rest     REST with XML payload (default)
-    #   :soap     SOAP
-    #
-    # The Transporter will connect to the service, using SSL if required, and will
-    # encode Reqests to send to the service, and decode Responses received from the
-    # service.
-    #
-    # 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
-      # to https://api.e-xact.com, the location of our transaction processing web service.
-      #
-      # You can also specify a hash of options as follows:
-      #   :server_cert      the path to the server's certificate
-      #   :issuer_cert      the path to the certificate of the issuer of the server certificate
-      #   :transport_type   the default transport_type for this transporter (defaults to :rest)
-      #
-      # The default certificates are those required to connect to https://api.e-xact.com and the
-      # default <tt>transport_type</tt> is <tt>:rest</tt>. The default <tt>transport_type</tt> can be overridden on a per-transaction
-      # 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.gsub(/\/$/,''))
-        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[:transport_type] || :rest
-      end
-
-      # Send a transaction request to the server
-      #
-      # <tt>transaction</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 is not specified, the Transporter's transport type will be used
-      def submit(transaction, transport_type = nil)
-        raise "Request not supplied" if transaction.nil?
-        return false unless transaction.valid?
-
-        transport_type ||= @transport_type
-
-        raise "Transport type #{transport_type} is not supported" unless @@transport_types.include? transport_type
-
-        transport_details = @@transport_types[transport_type]
-        
-        request = build_http_request(transaction, transport_type, transport_details[:suffix])
-        request.basic_auth(transaction.gateway_id, transaction.password)
-        request["User-Agent"] = "Ruby"
-        request.content_type = "#{transport_details[:content_type]}; charset=UTF-8"
-
-        response = get_connection.request(request)
-
-        case response
-        when Net::HTTPSuccess then EWS::Transaction::Mapping.send "#{transport_type}_to_response", response.body
-        else
-          response.error!
-        end
-
-      end
-
-  private
-
-      def build_http_request(transaction, transport_type, request_suffix)
-        req = nil
-        if !transaction.is_find_transaction? or transport_type == :soap
-          req = Net::HTTP::Post.new(@url.path + "/transaction.#{request_suffix}")
-          if transport_type == :soap
-            # add the SOAPAction header
-            soapaction = (transaction.is_find_transaction?) ? "TransactionInfo" : "SendAndCommit"
-            req.add_field "soapaction", "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/#{soapaction}"
-          end
-          req.body = EWS::Transaction::Mapping.send "request_to_#{transport_type.to_s}", transaction
-        else
-          req = Net::HTTP::Get.new(@url.path + "/transaction/#{transaction.transaction_tag}.#{request_suffix}")
-        end
-        req
-      end
-      
-      def get_connection
-        # re-use the connection if it's available
-        return @connection unless @connection.nil?
-        
-        @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
-          @connection.ca_file = @issuer_cert
-          @connection.verify_callback = method(:validate_certificate)
-        end
-        @connection
-      end
-
-      def validate_certificate(is_ok, ctx)
-        # Don't check the root CA cert
-        unless (ctx.current_cert.subject.to_s == ctx.current_cert.issuer.to_s)
-          is_ok &&= File.open(@server_cert).read == ctx.current_cert.to_pem
-        end
-        is_ok
-      end
-
-      # what transport types we support, and their corresponding suffixes
-      @@transport_types = {
-        :rest => {:suffix => "xml", :content_type => "application/xml"},
-        :json => {:suffix => "json", :content_type => "application/json"},
-        :soap => {:suffix => "xmlsoap", :content_type => "application/xml"}
-      }
-
-    end
-  end
-end

data/output.log

@@ -1,368 +0,0 @@
-Index: VERSION
-===================================================================
---- VERSION	(revision 6047)
-+++ VERSION	(working copy)
-@@ -1 +1 @@
--0.5.1
-
-+0.5.2
-
-Index: lib/ews/transaction/response.rb
-===================================================================
---- lib/ews/transaction/response.rb	(revision 6043)
-+++ lib/ews/transaction/response.rb	(working copy)
-@@ -2,13 +2,17 @@
-   module Transaction # :nodoc:
- 
-     # This class encapsulates all the data returned from the E-xact Web Service.
--    class Response < EWS::Transaction::Request
-+    class Response
- 
-       attr_accessor :logon_message, :error_number, :error_description, :transaction_error, :transaction_approved
-       attr_accessor :exact_resp_code, :exact_message, :bank_resp_code, :bank_message, :bank_resp_code_2
-       attr_accessor :sequence_no, :avs, :cvv2, :retrieval_ref_no, :cavv_response
-       attr_accessor :merchant_name, :merchant_address, :merchant_city, :merchant_province, :merchant_country, :merchant_postal, :merchant_url, :CTR
- 
-+      attr_accessor :gateway_id, :password, :transaction_type, :amount, :surcharge_amount, :cc_number, :transaction_tag, :track1, :track2, :pan, :auth_number, :cc_expiry, :cardholder_name
-+      attr_accessor :cc_verification_str1, :cc_verification_str2, :cvd_presence_ind, :tax1_amount, :tax1_number, :tax2_amount, :tax2_number, :secure_auth_required, :secure_auth_result
-+      attr_accessor :ecommerce_flag, :xid, :cavv, :cavv_algorithm, :reference_no, :customer_ref, :reference_3, :language, :client_ip, :client_email, :user_name 
-+
-       # Indicates whether or not the transaction was approved
-       def approved?
-         self.transaction_approved == 1
-Index: lib/ews/transaction/transporter.rb
-===================================================================
---- lib/ews/transaction/transporter.rb	(revision 6047)
-+++ lib/ews/transaction/transporter.rb	(working copy)
-@@ -6,7 +6,7 @@
-     # 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
--    #   :rest     REST with XML payload
-+    #   :rest     REST with XML payload (default)
-     #   :soap     SOAP
-     #
-     # The Transporter will connect to the service, using SSL if required, and will
-@@ -19,95 +19,85 @@
- 
-       # Initialize a Transporter.
-       #
--      # You can specify the URL you would like the Transporter to connect to,
--      # although it defaults to https://api.e-xact.com, the location of our web
--      # service.
-+      # You can specify the URL you would like the Transporter to connect to, although it defaults
-+      # to https://api.e-xact.com, the location of our transaction processing web service.
-       #
-       # You can also specify a hash of options as follows:
-       #   :server_cert      the path to the server's certificate
-       #   :issuer_cert      the path to the certificate of the issuer of the server certificate
--      #   :transport_type   the default transport_type for this transporter
-+      #   :transport_type   the default transport_type for this transporter (defaults to :rest)
-       #
-       # The default certificates are those required to connect to https://api.e-xact.com and the
-       # default <tt>transport_type</tt> is <tt>:rest</tt>. The default <tt>transport_type</tt> can be overridden on a per-transaction
-       # 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)
-+        @url = URI.parse(url.gsub(/\/$/,''))
-         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
-+        @transport_type = options[:transport_type] || :rest
-       end
- 
-       # Send a transaction request 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 submit(request, transport_type = nil)
--        raise "Request not supplied" if request.nil?
--        return false unless request.valid?
-+      # <tt>transaction</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 is not specified, the Transporter's transport type will be used
-+      def submit(transaction, transport_type = nil)
-+        raise "Request not supplied" if transaction.nil?
-+        return false unless transaction.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
-+        transport_details = @@transport_types[transport_type]
-+        
-+        request = build_http_request(transaction, transport_type, transport_details[:suffix])
-+        request.basic_auth(transaction.gateway_id, transaction.password)
-+        request["User-Agent"] = "Ruby"
-+        request.content_type = "#{transport_details[:content_type]}; charset=UTF-8"
- 
--        EWS::Transaction::Mapping.send "#{transport_type}_to_response", content
--      end
-+        response = get_connection.request(request)
- 
--  private
--
--      def post(request, transport_type)
--        # build the request
--        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
--          soapaction = (request.is_find_transaction?) ? "TransactionInfo" : "SendAndCommit"
--          req.add_field "soapaction", "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/#{soapaction}"
--        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
--        when Net::HTTPSuccess then response.body
-+        when Net::HTTPSuccess then EWS::Transaction::Mapping.send "#{transport_type}_to_response", response.body
-         else
-           response.error!
-         end
-+
-       end
- 
--      def get(request, transport_type)
--        # build the request
--        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"
-+  private
- 
--        response = get_connection.request(req)
--
--        case response
--        when Net::HTTPSuccess then response.body
-+      def build_http_request(transaction, transport_type, request_suffix)
-+        req = nil
-+        if !transaction.is_find_transaction? or transport_type == :soap
-+          req = Net::HTTP::Post.new(@url.path + "/transaction.#{request_suffix}")
-+          if transport_type == :soap
-+            # add the SOAPAction header
-+            soapaction = (transaction.is_find_transaction?) ? "TransactionInfo" : "SendAndCommit"
-+            req.add_field "soapaction", "http://secure2.e-xact.com/vplug-in/transaction/rpc-enc/#{soapaction}"
-+          end
-+          req.body = EWS::Transaction::Mapping.send "request_to_#{transport_type.to_s}", transaction
-         else
--          response.error!
-+          req = Net::HTTP::Get.new(@url.path + "/transaction/#{transaction.transaction_tag}.#{request_suffix}")
-         end
-+        req
-       end
--
-+      
-       def get_connection
--        connection = Net::HTTP.new(@url.host, @url.port)
--        connection.set_debug_output $stdout if $DEBUG
-+        # re-use the connection if it's available
-+        return @connection unless @connection.nil?
-+        
-+        @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
--          connection.ca_file = @issuer_cert
--          connection.verify_callback = method(:validate_certificate)
-+          @connection.use_ssl = true
-+          @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-+          @connection.ca_file = @issuer_cert
-+          @connection.verify_callback = method(:validate_certificate)
-         end
--        connection
-+        @connection
-       end
- 
-       def validate_certificate(is_ok, ctx)
-@@ -120,9 +110,9 @@
- 
-       # what transport types we support, and their corresponding suffixes
-       @@transport_types = {
--        :rest => "xml",
--        :json => "json",
--        :soap => "xmlsoap"
-+        :rest => {:suffix => "xml", :content_type => "application/xml"},
-+        :json => {:suffix => "json", :content_type => "application/json"},
-+        :soap => {:suffix => "xmlsoap", :content_type => "application/xml"}
-       }
- 
-     end
-Index: CHANGELOG
-===================================================================
---- CHANGELOG	(revision 6047)
-+++ CHANGELOG	(working copy)
-@@ -1,3 +1,9 @@
-+== v0.5.2
-+  Updated Transporter to play nicely with mod_security
-+  Stripped trailing '/'s from URLs
-+  Now re-use same connection
-+  Updated RDoc with test login details
-+  
- == v0.5.1
-   Added CHANGELOG, LICENCE & VERSION
-   Ensured README etc. were included in gem and displayed as default in RDoc
-Index: spec/transporter_spec.rb
-===================================================================
---- spec/transporter_spec.rb	(revision 6047)
-+++ spec/transporter_spec.rb	(working copy)
-@@ -14,49 +14,8 @@
- 
-     lambda {
-       tr = ::EWS::Transaction::Transporter.new
--      tr.submit(txn, json)
-+      tr.submit(txn)
-     }.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
-
-Index: spec/request_spec.rb
-===================================================================
---- spec/request_spec.rb	(revision 6047)
-+++ spec/request_spec.rb	(working copy)
-@@ -70,7 +70,7 @@
- 
-     resp.exact_resp_code.should == "00"
-     resp.exact_message.should == "Transaction Normal"
--    resp.bank_message.should == "APPROVED"
-+    resp.bank_message.downcase.should match(/approved/)
-     resp.transaction_tag.should_not be_nil
-   end
-   
-@@ -81,7 +81,7 @@
- 
-       resp.exact_resp_code.should == "00"
-       resp.exact_message.should == "Transaction Normal"
--      resp.bank_message.should == "APPROVED"
-+      resp.bank_message.downcase.should match(/approved/)
-       resp.transaction_tag.should_not be_nil
-     end
-   end
-@@ -95,6 +95,9 @@
- 
-     txn = basic_new_transaction
-     @transaction_tag = @transporter.submit(txn, :json).transaction_tag
-+    puts "Sleeping for replication: #{REPLICATION_TIME}s"
-+    sleep(REPLICATION_TIME) # need time for replication to take place on the host
-+    puts "Awake"
-   end
-   
-   it "should work without a specified transport_type" do
-@@ -103,7 +106,7 @@
- 
-     resp.exact_resp_code.should == "00"
-     resp.exact_message.should == "Transaction Normal"
--    resp.bank_message.should == "APPROVED"
-+    resp.bank_message.downcase.should match(/approved/)
-     resp.transaction_tag.should_not be_nil
-   end
- 
-@@ -116,7 +119,7 @@
-       resp.cc_number == "4111111111111"
-       resp.exact_resp_code.should == "00"
-       resp.exact_message.should == "Transaction Normal"
--      resp.bank_message.should == "APPROVED"
-+      resp.bank_message.downcase.should match(/approved/)
-     end
-   end
- 
-Index: spec/spec_helper.rb
-===================================================================
---- spec/spec_helper.rb	(revision 6048)
-+++ spec/spec_helper.rb	(working copy)
-@@ -3,6 +3,8 @@
- require 'spec'
- require 'lib/exact4r'
- 
-+REPLICATION_TIME = 20
-+
- def basic_params(options = {})
-   {
-     :transaction_type => :purchase,
-@@ -18,8 +20,7 @@
- def basic_find_transaction(options = {})
-   params = {
-     :transaction_type => :transaction_details,
--    :gateway_id => "AD0008-01",
--    :password => "7nfcpc7n"
-+    :gateway_id => "A00049-01", :password => "test1"
-   }.merge(options)
-   
-   ::EWS::Transaction::Request.new(params)  
-@@ -33,8 +34,7 @@
-     :cc_number => "4111111111111111",
-     :cc_expiry => "1005",
-     :reference_no => "987987",
--    :gateway_id => "AD0008-01",
--    :password => "7nfcpc7n"
-+    :gateway_id => "A00049-01", :password => "test1"
-   }.merge(options)
-   
-   ::EWS::Transaction::Request.new(params)
-Index: README
-===================================================================
---- README	(revision 6047)
-+++ README	(working copy)
-@@ -4,6 +4,13 @@
- 
- == Getting Started
- 
-+To submit requests to our transaction processing service, you must first have a Gateway ID,
-+and a password. Test logins are as follows:
-+
-+  Account 1:  :gateway_id => "A00049-01", :password => "test1"
-+  Account 2:  :gateway_id => "A00427-01", :password => "testus"
-+
-+
- =1. Submit a transaction
- 
-   require 'rubygems'