quickbooks 0.0.2 → 0.0.3

data/README

@@ -1,10 +1,10 @@
 == Welcome to QuickBooks for Ruby
 
-QuickBooks is a module that allows you to connect to QuickBooks and QuickBooks Merchant
-Services via the QuickBooks SDK (QBXML).  You need to configure the QuickBooks Remote Data 
-Sharing Server (RDS) in order to connect.  The RDS server allows you to use the SDK over
-https webservice.  This means that you can communicate with QuickBooks from non-Windows 
-operating systems.
+The purpose of this gem is to perform connectivity and communication with Quickbooks, providing the user with access to quickbooks data as everyday ruby objects. This could be understood to be somewhat like an ORM, but it is different in that its models are predefined by the Quickbooks API.
+
+In releases prior to 1.0, some knowledge of the Quickbooks API will be required. In releases beyond 1.0, the Quickbooks API should be fully hidden from your view.
+
+Enjoy and PLEASE contribute either by suggestion or by submitting patches, etc. Or if development seems slow, please feel free to join! My work on this project has been solely for my own use of the gem, while opening up its achievements for others to use as well. Development may slow down considerably when I find it is at a stable and usable point for my needs. You've been warned! ;)
 
 == Download
 
@@ -13,38 +13,28 @@ operating systems.
 
 == Status
 
-This library is a work in progress and has very limited capabilities right now.  There is
-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.
+This library is a work in progress and has limited capabilities right now. As of version 0.0.3, the Customer model is the only one proven
+to be in working condition, and that even with some bugs. It is stable in the capabilities that are defined, but there are some points
+where the usability needs improvement. I have attempted to make the Quickbooks family of models to work much like DataMapper models, with their finder methods and such.
 
 == Usage
 
-You can use the QuickBooks::Connection class to talk to the RDS server:
-
-      connection = QuickBooks::Connection.new('admin', 'pass123', 'My Test App')
-      connection.open
-      xml = <<EOL
-	<?xml version="1.0"?>
-	<?qbxml version="3.0"?>
-	<QBXML>
-	  <QBXMLMsgsRq onError="continueOnError">
-	    <InvoiceQueryRq requestID="1">
-	      <RefNumber>81</RefNumber>
-	      <IncludeLineItems>true</IncludeLineItems>
-	    </InvoiceQueryRq>
-	  </QBXMLMsgsRq>
-	</QBXML>
-	EOL
-      connection.send(xml)
-      connection.close 
+Simply include this gem in your project:
+  require 'rubygems'
+  gem 'quickbooks'
+
+Without any configuration, you should be able to talk to Quickbooks immediately if it and a company file is open on the same computer:
+  c = Quickbooks::Customer.first
+  c.phone = '(123) 456-7890'
+  c.save
 
 == Authors
   
 * Chris Bruce (mailto:chrisabruce@yahoo.com)
+* Daniel Parker (mailto:gems@behindlogic.com)
 
 This library is released under the terms of the MIT License.
 
 == Changes
 
-I renamed QuickBooks::Session to QuickBooks::Connection as it seems more intuitive.
+* Initial import of a new rewrite at version 0.0.3

data/Rakefile

@@ -5,22 +5,18 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "0.0.2"
+PKG_NAME = 'quickbooks'
+PKG_VERSION = "0.0.3"
 
 PKG_FILES = FileList[
-    "lib/**/*", "test/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
+    "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
 ]
 
 desc "Default Task"
-task :default => [ :test ]
-
-# Run the unit tests
-desc "Run all unit tests"
-Rake::TestTask.new("test") { |t|
-  t.libs << "lib"
-  t.pattern = 'test/*/*_test.rb'
-  t.verbose = true
-}
+task :default => [ :test ] do
+  # Run the unit tests
+  desc "Run all rspec tests (rake task not yet implemented!)"
+end
 
 # Make a console, useful when working on tests
 desc "Generate a test console"
@@ -38,38 +34,30 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 }
 
-# Genereate the package
+# Generate the package
 spec = Gem::Specification.new do |s|
-
   #### Basic information.
-
-  s.name = 'quickbooks'
+  s.name = PKG_NAME
   s.version = PKG_VERSION
-  s.summary = <<-EOF
-   A module to connect to QuickBooks through the QuickBooks SDK.
-  EOF
-  s.description = <<-EOF
-   A module to connect to QuickBooks and QuickBooks Merchant Services through the QuickBooks SDK.
-  EOF
+  s.platform = Gem::Platform::RUBY
+  s.description = s.summary = "A module to connect to QuickBooks through the QuickBooks SDK using WIN32OLE (other connection types to come)."
 
   #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
-
   s.files = PKG_FILES
 
   #### Load-time details: library and application (you will need one or both).
-
   s.require_path = 'lib'
   s.autorequire = 'quickbooks'
 
   #### Documentation and testing.
-
   s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
 
   #### Author and project details.
-
-  s.author = "Chris Bruce"
-  s.email = "chrisabruce@yahoo.com"
+  s.author = "Chris Bruce & Daniel Parker"
+  s.email = "gems@behindlogic.com"
   s.homepage = "http://quickbooks.rubyforge.org"
+  s.rubyforge_project = 'quickbooks'
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -81,12 +69,11 @@ desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
   require 'code_statistics'
   CodeStatistics.new(
-    ["Library", "lib"],
-    ["Units", "test"]
+    ["Library", "lib"]
   ).to_s
 end
 
 desc "Publish new documentation"
 task :publish => [:doc] do
-   `pscp -r doc/* rubyforge:/var/www/gforge-projects/quickbooks/`
+  `scp -r doc/* dcparker@rubyforge.org:/var/www/gforge-projects/quickbooks`
 end

data/doc/classes/{QuickBooks/Models/DataExt.html → Class.html}

@@ -1,141 +1,152 @@
-<?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>Class: QuickBooks::Models::DataExt</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="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">QuickBooks::Models::DataExt</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/quickbooks/models/base_rb.html">
-                lib/quickbooks/models/base.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                <a href="Base.html">
-                Base
-               </a>
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">data_ext_name</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">data_ext_type</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">data_ext_value</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">owner_id</td>
-          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        </table>
-      </div>
-    </div>
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
+<?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>Class: Class</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Class</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/quickbooks/ruby_magic_rb.html">
+                lib/quickbooks/ruby_magic.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000003">class_leaf_name</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="Class.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('Class.src/M000003.html');return false;">
+          <span class="method-name">class_leaf_name</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the class name without the module names that precede it. I&#8216;m
+sure there&#8216;s a builtin way to do this, but I couldn&#8216;t find it
+and this works just as reliably! Examples:
+</p>
+<ul>
+<li>Quickbooks::Qbxml::Request.class_leaf_name # =&gt; &#8216;Request&#8216;
+
+</li>
+<li>Quickbooks::Customer.class_leaf_name # =&gt; &#8216;Customer&#8216;
+
+</li>
+</ul>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
 </html>