quickbooks 0.0.1 → 0.0.2

data/README

@@ -14,16 +14,16 @@ operating systems.
 == Status
 
 This library is a work in progress and has very limited capabilities right now.  There is
-a Session class that will let you connect to QuickBooks and send QBXML directly.  I am in 
+a Connection class that will let you connect to QuickBooks and send QBXML directly.  I am in 
 the process of implementing all the messages that you can send and recieve in an easy to 
 use class structure.
 
 == Usage
 
-You can use the QuickBooks::Session class to talk to the RDS server:
+You can use the QuickBooks::Connection class to talk to the RDS server:
 
-      session = QuickBooks::Session.new('admin', 'pass123', 'My Test App')
-      session.open
+      connection = QuickBooks::Connection.new('admin', 'pass123', 'My Test App')
+      connection.open
       xml = <<EOL
 	<?xml version="1.0"?>
 	<?qbxml version="3.0"?>
@@ -36,11 +36,15 @@ You can use the QuickBooks::Session class to talk to the RDS server:
 	  </QBXMLMsgsRq>
 	</QBXML>
 	EOL
-      session.send(xml)
-      session.close 
+      connection.send(xml)
+      connection.close 
 
 == Authors
   
 * Chris Bruce (mailto:chrisabruce@yahoo.com)
 
-This library is released under the terms of the MIT License.
+This library is released under the terms of the MIT License.
+
+== Changes
+
+I renamed QuickBooks::Session to QuickBooks::Connection as it seems more intuitive.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "0.0.1"
+PKG_VERSION = "0.0.2"
 
 PKG_FILES = FileList[
     "lib/**/*", "test/**/*", "[A-Z]*", "Rakefile", "doc/**/*"

data/doc/classes/QuickBooks.html

@@ -55,16 +55,16 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../files/lib/quickbooks/session_rb.html">
-                lib/quickbooks/session.rb
+                <a href="../files/lib/quickbooks/connection_rb.html">
+                lib/quickbooks/connection.rb
                 </a>
         <br />
                 <a href="../files/lib/quickbooks/models/base_rb.html">
                 lib/quickbooks/models/base.rb
                 </a>
         <br />
-                <a href="../files/lib/quickbooks/models/customer_rb.html">
-                lib/quickbooks/models/customer.rb
+                <a href="../files/lib/quickbooks/models/models_rb.html">
+                lib/quickbooks/models/models.rb
                 </a>
         <br />
             </td>
@@ -80,34 +80,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-Copyright &#169; 2006 Chris Bruce
-</p>
-<p>
-Permission is hereby granted, free of charge, to any person obtaining a
-copy of this software and associated documentation files (the
-&quot;Software&quot;), to deal in the Software without restriction,
-including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to the
-following conditions:
-</p>
-<p>
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-</p>
-<p>
-THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
-NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
-USE OR OTHER DEALINGS IN THE SOFTWARE.
-</p>
-
-    </div>
 
 
    </div>
@@ -124,7 +96,7 @@ USE OR OTHER DEALINGS IN THE SOFTWARE.
       <h3 class="section-bar">Classes and Modules</h3>
 
       Module <a href="QuickBooks/Models.html" class="link">QuickBooks::Models</a><br />
-Class <a href="QuickBooks/Session.html" class="link">QuickBooks::Session</a><br />
+Class <a href="QuickBooks/Connection.html" class="link">QuickBooks::Connection</a><br />
 
     </div>
 

data/doc/classes/QuickBooks/{Session.html → Connection.html}

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Class: QuickBooks::Session</title>
+  <title>Class: QuickBooks::Connection</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" />
@@ -50,13 +50,13 @@
         <table class="header-table">
         <tr class="top-aligned-row">
           <td><strong>Class</strong></td>
-          <td class="class-name-in-header">QuickBooks::Session</td>
+          <td class="class-name-in-header">QuickBooks::Connection</td>
         </tr>
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../files/lib/quickbooks/session_rb.html">
-                lib/quickbooks/session.rb
+                <a href="../../files/lib/quickbooks/connection_rb.html">
+                lib/quickbooks/connection.rb
                 </a>
         <br />
             </td>
@@ -80,16 +80,16 @@
 
     <div id="description">
       <p>
-<a href="Session.html">Session</a> used to communicate with <a
+<a href="Connection.html">Connection</a> is used to communicate with <a
 href="../QuickBooks.html">QuickBooks</a> RDS Server. You need to configure
 your <a href="../QuickBooks.html">QuickBooks</a> software to allow RDS
-connection from application. &lt;code&gt;
+connection from your application. &lt;code&gt;
 </p>
 <pre>
   require 'quickbooks'
 
-  session = QuickBooks::Session.new('admin', 'pass', 'My Test App')
-  session.open
+  connection = QuickBooks::Connection.new('admin', 'pass', 'My Test App')
+  connection.open
   xml = &lt;&lt;END
   &lt;?xml version=&quot;1.0&quot;?&gt;
   &lt;?qbxml version=&quot;3.0&quot;?&gt;
@@ -102,8 +102,8 @@ connection from application. &lt;code&gt;
   &lt;/QBXMLMsgsRq&gt;
   &lt;/QBXML&gt;
   &lt;&lt;END
-  session.send(xml)
-  session.close
+  connection.send(xml)
+  connection.close
 </pre>
 
     </div>
@@ -115,11 +115,11 @@ connection from application. &lt;code&gt;
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000015">close</a>&nbsp;&nbsp;
-      <a href="#M000012">connected?</a>&nbsp;&nbsp;
-      <a href="#M000011">new</a>&nbsp;&nbsp;
-      <a href="#M000013">open</a>&nbsp;&nbsp;
-      <a href="#M000014">send</a>&nbsp;&nbsp;
+      <a href="#M000019">close</a>&nbsp;&nbsp;
+      <a href="#M000016">connected?</a>&nbsp;&nbsp;
+      <a href="#M000015">new</a>&nbsp;&nbsp;
+      <a href="#M000017">open</a>&nbsp;&nbsp;
+      <a href="#M000018">send</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -174,31 +174,31 @@ connection from application. &lt;code&gt;
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="Session.src/M000011.html" target="Code" class="method-signature"
-            onclick="popupCode('Session.src/M000011.html');return false;">
+          <a href="Connection.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('Connection.src/M000015.html');return false;">
           <span class="method-name">new</span><span class="method-args">(user, password, application_name, host=&quot;localhost&quot;, port=3790, mode='multiUser')</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Initializes an instance of <a href="Session.html">QuickBooks::Session</a>
+Initializes an instance of QuickBooks::Session
 </p>
         </div>
       </div>
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000015" class="method-detail">
-        <a name="M000015"></a>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
 
         <div class="method-heading">
-          <a href="Session.src/M000015.html" target="Code" class="method-signature"
-            onclick="popupCode('Session.src/M000015.html');return false;">
+          <a href="Connection.src/M000019.html" target="Code" class="method-signature"
+            onclick="popupCode('Connection.src/M000019.html');return false;">
           <span class="method-name">close</span><span class="method-args">()</span>
           </a>
         </div>
@@ -210,30 +210,30 @@ Close the session to <a href="../QuickBooks.html">QuickBooks</a> RDS Server
         </div>
       </div>
 
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
 
         <div class="method-heading">
-          <a href="Session.src/M000012.html" target="Code" class="method-signature"
-            onclick="popupCode('Session.src/M000012.html');return false;">
+          <a href="Connection.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('Connection.src/M000016.html');return false;">
           <span class="method-name">connected?</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Determines if the <a href="Session.html">Session</a> is connected to a <a
+Determines if the Session is connected to a <a
 href="../QuickBooks.html">QuickBooks</a> RDS Server
 </p>
         </div>
       </div>
 
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
 
         <div class="method-heading">
-          <a href="Session.src/M000013.html" target="Code" class="method-signature"
-            onclick="popupCode('Session.src/M000013.html');return false;">
+          <a href="Connection.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('Connection.src/M000017.html');return false;">
           <span class="method-name">open</span><span class="method-args">()</span>
           </a>
         </div>
@@ -246,12 +246,12 @@ Server
         </div>
       </div>
 
-      <div id="method-M000014" class="method-detail">
-        <a name="M000014"></a>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
 
         <div class="method-heading">
-          <a href="Session.src/M000014.html" target="Code" class="method-signature"
-            onclick="popupCode('Session.src/M000014.html');return false;">
+          <a href="Connection.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('Connection.src/M000018.html');return false;">
           <span class="method-name">send</span><span class="method-args">(xml)</span>
           </a>
         </div>

data/doc/classes/QuickBooks/{Session.src/M000011.html → Connection.src/M000015.html}

@@ -5,12 +5,12 @@
 
 <html>
 <head>
-  <title>new (QuickBooks::Session)</title>
+  <title>new (QuickBooks::Connection)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/quickbooks/session.rb, line 49</span>
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/connection.rb, line 31</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">application_name</span>, <span class="ruby-identifier">host</span>=<span class="ruby-value str">&quot;localhost&quot;</span>, <span class="ruby-identifier">port</span>=<span class="ruby-value">3790</span>, <span class="ruby-identifier">mode</span>=<span class="ruby-value str">'multiUser'</span>)
       <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">user</span>
       <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>

data/doc/classes/QuickBooks/{Session.src/M000012.html → Connection.src/M000016.html}

@@ -5,12 +5,12 @@
 
 <html>
 <head>
-  <title>connected? (QuickBooks::Session)</title>
+  <title>connected? (QuickBooks::Connection)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/quickbooks/session.rb, line 61</span>
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/connection.rb, line 43</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connected?</span>
       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@ticket</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@soap_client</span>
         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>

data/doc/classes/QuickBooks/{Session.src/M000013.html → Connection.src/M000017.html}

@@ -5,12 +5,12 @@
 
 <html>
 <head>
-  <title>open (QuickBooks::Session)</title>
+  <title>open (QuickBooks::Connection)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/quickbooks/session.rb, line 69</span>
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/connection.rb, line 51</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open</span>
       <span class="ruby-ivar">@soap_client</span> = <span class="ruby-constant">SOAP</span><span class="ruby-operator">::</span><span class="ruby-constant">WSDLDriverFactory</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;https://#{@host}:#{@port}/QBXMLRemote?wsdl&quot;</span>).<span class="ruby-identifier">create_rpc_driver</span>
       <span class="ruby-ivar">@ticket</span> = <span class="ruby-ivar">@soap_client</span>.<span class="ruby-constant">OpenConnectionAndBeginSession</span>(<span class="ruby-ivar">@user</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-value str">''</span>, <span class="ruby-ivar">@application_name</span>, <span class="ruby-value str">''</span>, <span class="ruby-ivar">@mode</span>)

data/doc/classes/QuickBooks/{Session.src/M000014.html → Connection.src/M000018.html}

@@ -5,12 +5,12 @@
 
 <html>
 <head>
-  <title>send (QuickBooks::Session)</title>
+  <title>send (QuickBooks::Connection)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/quickbooks/session.rb, line 76</span>
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/connection.rb, line 58</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send</span>(<span class="ruby-identifier">xml</span>)
       <span class="ruby-ivar">@soap_client</span>.<span class="ruby-constant">ProcessRequest</span>(<span class="ruby-ivar">@ticket</span>, <span class="ruby-identifier">xml</span>)      
     <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/QuickBooks/{Session.src/M000015.html → Connection.src/M000019.html}

@@ -5,12 +5,12 @@
 
 <html>
 <head>
-  <title>close (QuickBooks::Session)</title>
+  <title>close (QuickBooks::Connection)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/quickbooks/session.rb, line 81</span>
+  <pre><span class="ruby-comment cmt"># File lib/quickbooks/connection.rb, line 63</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">connected?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@soap_client</span>
         <span class="ruby-ivar">@soap_client</span>.<span class="ruby-constant">CloseConnection</span>(<span class="ruby-ivar">@ticket</span>)

data/doc/classes/QuickBooks/Models.html

@@ -59,8 +59,8 @@
                 lib/quickbooks/models/base.rb
                 </a>
         <br />
-                <a href="../../files/lib/quickbooks/models/customer_rb.html">
-                lib/quickbooks/models/customer.rb
+                <a href="../../files/lib/quickbooks/models/models_rb.html">
+                lib/quickbooks/models/models.rb
                 </a>
         <br />
             </td>

data/doc/classes/QuickBooks/Models/Base.html

@@ -86,8 +86,11 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000009">add_xml</a>&nbsp;&nbsp;
-      <a href="#M000010">mod_xml</a>&nbsp;&nbsp;
+      <a href="#M000013">add_xml</a>&nbsp;&nbsp;
+      <a href="#M000011">connection</a>&nbsp;&nbsp;
+      <a href="#M000012">connection=</a>&nbsp;&nbsp;
+      <a href="#M000010">establish_connection</a>&nbsp;&nbsp;
+      <a href="#M000014">mod_xml</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -107,19 +110,43 @@
 
     <!-- if method_list -->
     <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
+      <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000009.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000009.html');return false;">
-          <span class="method-name">add_xml</span><span class="method-args">()</span>
+          <a href="Base.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000011.html');return false;">
+          <span class="method-name">connection</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the current <a href="../Connection.html">Connection</a>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000012.html');return false;">
+          <span class="method-name">connection=</span><span class="method-args">(connection)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+Sets the current <a href="../Connection.html">Connection</a>
+</p>
+<pre>
+  connection = QuickBooks::Connection.new('user', 'pass', 'My Test App')
+  QuickBooks::Models::Base.connection = connection
+</pre>
         </div>
       </div>
 
@@ -129,6 +156,41 @@
         <div class="method-heading">
           <a href="Base.src/M000010.html" target="Code" class="method-signature"
             onclick="popupCode('Base.src/M000010.html');return false;">
+          <span class="method-name">establish_connection</span><span class="method-args">(user, password, application_name, host=&quot;localhost&quot;, port=3790, mode='multiUser')</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Establishes a connection to the <a
+href="../../QuickBooks.html">QuickBooks</a> RDS Server for all Model
+Classes
+</p>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000013.html');return false;">
+          <span class="method-name">add_xml</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000014.html');return false;">
           <span class="method-name">mod_xml</span><span class="method-args">()</span>
           </a>
         </div>