RubyGems - quickbooks - Versions diffs - 0.0.3 → 0.0.5 - Mend

quickbooks 0.0.3 → 0.0.5

Files changed (186) hide show

data/README CHANGED

@@ -2,7 +2,7 @@
 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.
+In releases prior to 1.0, some knowledge of the Quickbooks API may 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! ;)
@@ -13,9 +13,8 @@ Enjoy and PLEASE contribute either by suggestion or by submitting patches, etc.
 == Status
-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.
+This library is a work in progress and has limited capabilities right now. As of version 0.0.5, the Customer model is the only model fleshed out and 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
@@ -26,8 +25,12 @@ Simply include this gem in your project:
 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.first_name = 'Joey'
+  c.last_name = 'Smith'
   c.save
+Again, until a later version, you will need to be running Quickbooks on the same computer _and have quickbooks open_ to the company file you need.
 == Authors
 * Chris Bruce (mailto:chrisabruce@yahoo.com)
@@ -37,4 +40,5 @@ This library is released under the terms of the MIT License.
 == Changes
-* Initial import of a new rewrite at version 0.0.3
+* Initial import of a new rewrite at version 0.0.3
+* 0.0.5 includes support for ordered qbxml attributes, as well as better error-handling and smarter saving.

data/Rakefile CHANGED

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 PKG_NAME = 'quickbooks'
-PKG_VERSION = "0.0.3"
+PKG_VERSION = "0.0.5"
 PKG_FILES = FileList[
     "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
@@ -21,7 +21,7 @@ end
 # Make a console, useful when working on tests
 desc "Generate a test console"
 task :console do
-   verbose( false ) { sh "irb -I lib/ -r 'quickbooks'" }
+   verbose( false ) { sh "irb -I lib -r 'quickbooks'" }
 end
 # Genereate the RDoc documentation

data/doc/classes/Array.html ADDED

@@ -0,0 +1,244 @@
+<?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: Array</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">Array</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="#M000005">camelize_values</a>&nbsp;&nbsp;
+      <a href="#M000006">camelize_values!</a>&nbsp;&nbsp;
+      <a href="#M000003">only</a>&nbsp;&nbsp;
+      <a href="#M000004">only!</a>&nbsp;&nbsp;
+      <a href="#M000007">order</a>&nbsp;&nbsp;
+      <a href="#M000008">order!</a>&nbsp;&nbsp;
+      <a href="#M000001">stringify_values</a>&nbsp;&nbsp;
+      <a href="#M000002">stringify_values!</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-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000005.html');return false;">
+          <span class="method-name">camelize_values</span><span class="method-args">(specials={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000006.html');return false;">
+          <span class="method-name">camelize_values!</span><span class="method-args">(specials={})</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000003.html');return false;">
+          <span class="method-name">only</span><span class="method-args">(*values)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000004.html');return false;">
+          <span class="method-name">only!</span><span class="method-args">(*values)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000007.html');return false;">
+          <span class="method-name">order</span><span class="method-args">(*ordered)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000008.html');return false;">
+          <span class="method-name">order!</span><span class="method-args">(*ordered)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000001.html');return false;">
+          <span class="method-name">stringify_values</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+        <div class="method-heading">
+          <a href="Array.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('Array.src/M000002.html');return false;">
+          <span class="method-name">stringify_values!</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </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>

data/doc/classes/Array.src/M000001.html ADDED

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>stringify_values (Array)</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/ruby_magic.rb, line 158</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stringify_values</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">stringify_values!</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000002.html ADDED

@@ -0,0 +1,19 @@
+<?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>
+<head>
+  <title>stringify_values! (Array)</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/ruby_magic.rb, line 161</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stringify_values!</span>
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each_with_index</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span> }
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000003.html ADDED

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>only (Array)</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/ruby_magic.rb, line 166</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">only</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">only!</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000004.html ADDED

@@ -0,0 +1,23 @@
+<?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>
+<head>
+  <title>only! (Array)</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/ruby_magic.rb, line 169</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">only!</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>)
+    <span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten!</span>
+    <span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
+    <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-identifier">length</span><span class="ruby-operator">-</span><span class="ruby-value">1</span> <span class="ruby-keyword kw">do</span>
+      <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">is_one_of?</span>(<span class="ruby-identifier">values</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-identifier">i</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000005.html ADDED

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>camelize_values (Array)</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/ruby_magic.rb, line 178</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">camelize_values</span>(<span class="ruby-identifier">specials</span>={})
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">camelize_values!</span>(<span class="ruby-identifier">specials</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000006.html ADDED

@@ -0,0 +1,21 @@
+<?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>
+<head>
+  <title>camelize_values! (Array)</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/ruby_magic.rb, line 181</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">camelize_values!</span>(<span class="ruby-identifier">specials</span>={})
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">specials</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">v</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">specials</span>[<span class="ruby-identifier">v</span>] <span class="ruby-operator">:</span> (<span class="ruby-identifier">v</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">camelcase</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">camelcase</span>)
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">self</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Array.src/M000007.html ADDED

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>order (Array)</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/ruby_magic.rb, line 188</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">order</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">ordered</span>)
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">order!</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">ordered</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>