exact4r 0.9.1 → 0.9.2

data/doc/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:10:27 -0700 2008</td>
+      <td>Tue Sep 15 16:09:38 +1000 2009</td>
     </tr>
     </table>
   </div>
@@ -71,34 +71,45 @@
     <div id="description">
       <h1>exact4r</h1>
 <p>
-Provides access to E-xact Web Services API, which allows the submission via
-REST, JSON or SOAP.
+A gem which provides access to E-xact&#8216;s Web Services API, allowing
+the submission of financial transactions via REST, JSON or SOAP.
 </p>
 <h2>Getting Started</h2>
+<p>
+To submit requests to our transaction processing service, you must first
+have a Gateway ID, and a password. Test logins are as follows:
+</p>
+<pre>
+  Account 1:  :gateway_id =&gt; &quot;A00049-01&quot;, :password =&gt; &quot;test1&quot;
+  Account 2:  :gateway_id =&gt; &quot;A00427-01&quot;, :password =&gt; &quot;testus&quot;
+</pre>
 <h1>1. Submit a transaction</h1>
 <pre>
+  require 'rubygems'
+  require 'exact4r'
+
   # build a purchase request
   request = EWS::Transaction::Request.new({
     :transaction_type =&gt; :purchase,
     :amount =&gt; 10.50,
     :cardholder_name =&gt; &quot;Simon Brown&quot;,
     :cc_number =&gt; &quot;4111111111111111&quot;,
-    :cc_expiry =&gt; &quot;1005&quot;,             # MUST be YYMM format
+    :cc_expiry =&gt; &quot;1012&quot;,             # MUST be MMYY format
     :gateway_id =&gt; &quot;XXXXXXX&quot;,         # which gateway to submit the request to
     :password =&gt; &quot;YYYYYY&quot;             # your password for that gateway
   })
 
-  transporter = EWS::Transaction::Transporter.new
-  response = transporter.send(request)  # submits using REST (XML) by default
+  transporter = EWS::Transporter.new
+  response = transporter.submit(request)  # submits using REST (XML) by default
 
   # submit using JSON, or
-  response = transporter.send(request, :json)
+  response = transporter.submit(request, :json)
 
   # submit using SOAP, or
-  response = transporter.send(request, :soap)
+  response = transporter.submit(request, :soap)
 
   # submit explicitly via REST
-  response = transporter.send(request, :rest)
+  response = transporter.submit(request, :rest)
 
   # The response object is independent of type of transport chosen.
   # We decode the payload into a regular object
@@ -110,19 +121,22 @@ REST, JSON or SOAP.
 </pre>
 <h1>2. Find information on an existing transaction</h1>
 <pre>
+  require 'rubygems'
+  require 'exact4r'
+
   # build a purchase request
   request = EWS::Transaction::Request.new({
     :transaction_type =&gt; :purchase,
     :amount =&gt; 10.50,
     :cardholder_name =&gt; &quot;Simon Brown&quot;,
     :cc_number =&gt; &quot;4111111111111111&quot;,
-    :cc_expiry =&gt; &quot;1005&quot;,             # MUST be YYMM format
+    :cc_expiry =&gt; &quot;1012&quot;,             # MUST be MMYY format
     :gateway_id =&gt; &quot;XXXXXXX&quot;,         # which gateway to submit the request to
     :password =&gt; &quot;YYYYYY&quot;             # your password for that gateway
   })
 
-  transporter = EWS::Transaction::Transporter.new
-  response = transporter.send(request)  # submits using REST (XML) by default
+  transporter = EWS::Transporter.new
+  response = transporter.submit(request)  # submits using REST (XML) by default
 
   # you need to know the transaction tag of the transaction you are looking for
   find_request = EWS::Transaction::Request.new({
@@ -132,15 +146,20 @@ REST, JSON or SOAP.
     :password =&gt; &quot;YYYYYY&quot;
   })
 
-  find_response = transporter.send(find_request, :json)  # again, can choose your transport type as before
+  find_response = transporter.submit(find_request, :json)  # again, can choose your transport type as before
   find_response.cc_number          # 4111111111111111
   find_response.amount             # 10.50
 </pre>
 <h1>3. Re-using a Transporter</h1>
 <pre>
+  require 'rubygems'
+  require 'exact4r'
+
   # The transporter object can be re-used across multiple transactions, so set it up once
   # and forget about it.
-  transporter = EWS::Transaction::Transporter.new
+  # In this example, we will continue to use E-xact's default web-service URL, but we
+  # will specify a default transport_type of :soap
+  transporter = EWS::Transporter.new(&quot;https://api.e-xact.com/&quot;, {:transaction_type =&gt; :soap})
 
   # now let's submit do a recurring seed purchase...
   rsp_req = EWS::Transaction::Request.new({
@@ -148,12 +167,12 @@ REST, JSON or SOAP.
     :amount =&gt; 12.00,
     :cardholder_name =&gt; &quot;Simon Brown&quot;,
     :cc_number =&gt; &quot;4111111111111111&quot;,
-    :cc_expiry =&gt; &quot;1005&quot;,
+    :cc_expiry =&gt; &quot;1012&quot;,
     :gateway_id =&gt; &quot;XXXXXX&quot;,
     :password =&gt; &quot;YYYYYY&quot;
   })
 
-  rsp_resp = transporter.send(rsp_req, :json)
+  rsp_resp = transporter.submit(rsp_req)
   raise &quot;Seed Purchase failed&quot; unless rsp_resp.approved?
 
   # ...then do multiple refunds against it
@@ -161,27 +180,149 @@ REST, JSON or SOAP.
     rf_req = EWS::Transaction::Request.new({
       :transaction_type =&gt; :tagged_refund,
       :transaction_tag =&gt; rsp_resp.transaction_tag,   # need to know which transaction we're refunding against...
-      :auth_number =&gt; rsp_resp.auth_number,           # and its auth_number
+      :authorization_num =&gt; rsp_resp.authorization_num,           # and its authorization_num
       :amount =&gt; 1.00,                                # refund a dollar at a time
       :gateway_id =&gt; &quot;XXXXXX&quot;,
       :password =&gt; &quot;YYYYYY&quot;
     })
-    rf_resp = transporter.send(rf_req, :json)
+    rf_resp = transporter.submit(rf_req)
     raise &quot;Refund failed: #{rf_resp.exact_resp_code}, #{rf_resp.exact_message}&quot; unless rf_resp.approved?
   end
 </pre>
-<h2>Rake tasks</h2>
+<h1>4. Using the AVS API</h1>
+<p>
+Allowable AVS params are:
+</p>
+<ul>
+<li>:avs_street_address =&gt; &quot;7501ELMST.&quot;
+
+</li>
+<li>:avs_unit_no =&gt; &quot;801&quot;
+
+</li>
+<li>:avs_po_box =&gt; nil # P.O. Box or street address may be specified, but
+not both
+
+</li>
+<li>:avs_postal_code =&gt; &quot;90210&quot;
+
+</li>
+<li>:avs_test_flag =&gt; &quot;X&quot; # AVS test flag (optional)
+
+</li>
+</ul>
+<h3>Test Flags</h3>
 <p>
-spec
+In order to simulate an AVS response in the test environment, set the
+:<tt>avs_test_flag</tt> to the AVS result code you would like returned. The
+AVS result is a one-character response that indicates the degree of match
+for the provided address. The following AVS responses are currently
+supported:
 </p>
+<h3>North American Response Codes</h3>
+<pre>
+  AVS Code - ABS Definition - Explanation
+</pre>
+<ul>
+<li>X - Exact match, 9 digit zip - Street Address, and 9 digit ZIP Code match
+
+</li>
+<li>Y - Exact match, 5 digit zip - Street Address, and 5 digit ZIP Code match
+
+</li>
+<li>A - Partial match - Street Address matches, ZIP Code does not
+
+</li>
+<li>W - Partial match - ZIP Code matches, Street Address does not
+
+</li>
+<li>Z - Partial match - 5 digit ZIP Code match only
+
+</li>
+<li>N - No match - No Address or ZIP Code match
+
+</li>
+<li>U - Unavailable - Address information is unavailable for that account
+number, or the card issuer does not support
+
+</li>
+<li>G - Service Not supported, non-US Issuer does not participate
+
+</li>
+<li>R - Retry - Issuer system unavailable, retry later
+
+</li>
+<li>E - Not a mail or phone order
+
+</li>
+<li>S - Service not supported
+
+</li>
+</ul>
+<h3>International Response Codes</h3>
+<pre>
+  AVS Code - ABS Definition and Explanation
+</pre>
+<ul>
+<li>G - Global non-AVS participant
+
+</li>
+<li>B - Address matches only
+
+</li>
+<li>C - Address and Postal Code do not match
+
+</li>
+<li>D - Address and Postal Code match
+
+</li>
+<li>F - Address and Postal Code match (UK only)
+
+</li>
+<li>I - Address information not verified for international transaction
+
+</li>
+<li>M - Address and Postal Code match
+
+</li>
+<li>P - Postal Code matches only
+
+</li>
+</ul>
+<h3>Code Sample</h3>
 <pre>
-  Run all test in spec/ folder (default)
+  avs_params = {
+    :avs_test_flag =&gt; 'N',
+    :avs_street_address =&gt; '123BROWNSTREET',
+    :avs_unit_no =&gt; '4,
+    :avs_po_box =&gt; nil,
+    :avs_postal_code =&gt; '902101234'
+  }
+
+  tx_params = {
+    :transaction_type =&gt; :purchase,
+    :amount =&gt; 10.50,
+    :cardholder_name =&gt; &quot;Simon Brown&quot;,
+    :cc_number =&gt; &quot;4111111111111111&quot;,
+    :cc_expiry =&gt; &quot;1012&quot;,
+    :gateway_id =&gt; &quot;XXXXXXX&quot;,
+    :password =&gt; &quot;YYYYYY&quot;
+  }.merge(avs_params)
+
+  request = EWS::Transaction::Request.new(tx_params)
+
+  transporter = EWS::Transporter.new(&quot;https://api.e-xact.com/&quot;)
+  response = transporter.submit(request)
+
+  response.cc_verification_str1.should == &quot;N123BROWNSTREET4902101234&quot;
+  response.avs.should == N
 </pre>
+<h1>Rake tasks</h1>
 <p>
-rcov
+test
 </p>
 <pre>
-  Run all test and generate coverage report in coverage/
+  Run all tests (default)
 </pre>
 <p>
 rdoc

data/doc/files/VERSION.html

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: VERSION</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>VERSION</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>VERSION
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Sep 15 16:05:10 +1000 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+0.9.2
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/files/lib/ews/transaction/fake_response_rb.html

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: fake_response.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>fake_response.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/ews/transaction/fake_response.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Sep 15 15:52:11 +1000 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/files/lib/ews/transaction/mapping_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:10:27 -0700 2008</td>
+      <td>Tue Sep 15 15:54:32 +1000 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/ews/transaction/request_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:10:27 -0700 2008</td>
+      <td>Tue Sep 15 15:54:32 +1000 2009</td>
     </tr>
     </table>
   </div>
@@ -69,6 +69,13 @@
   <div id="contextContent">
 
 
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+
+      <div class="name-list">
+      ews/transaction/validator&nbsp;&nbsp;
+      </div>
+    </div>
 
    </div>
 

data/doc/files/lib/ews/transaction/response_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:10:27 -0700 2008</td>
+      <td>Tue Sep 15 15:54:31 +1000 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/ews/transaction/validator_rb.html

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: validator.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>validator.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/ews/transaction/validator.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Sep 15 15:54:32 +1000 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/files/lib/ews/{transaction/transporter_rb.html → transporter_rb.html}

@@ -8,7 +8,7 @@
   <title>File: transporter.rb</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/ews/transaction/transporter.rb
+      <td>lib/ews/transporter.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:35:29 -0700 2008</td>
+      <td>Tue Sep 15 15:54:32 +1000 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/exact4r_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu May 29 14:10:27 -0700 2008</td>
+      <td>Tue Sep 15 16:00:02 +1000 2009</td>
     </tr>
     </table>
   </div>
@@ -78,7 +78,11 @@
       ews/transaction/mapping&nbsp;&nbsp;
       ews/transaction/request&nbsp;&nbsp;
       ews/transaction/response&nbsp;&nbsp;
-      ews/transaction/transporter&nbsp;&nbsp;
+      ews/transaction/validator&nbsp;&nbsp;
+      ews/transporter&nbsp;&nbsp;
+      ews/transaction/fake_response&nbsp;&nbsp;
+      rexml/document&nbsp;&nbsp;
+      rexml/entity&nbsp;&nbsp;
       </div>
     </div>