quickbooks 0.4.0 → 0.9.9

data/History.txt

@@ -0,0 +1,23 @@
+=== 0.9.0 / 2008-10-08
+
+* First Release
+
+=== 0.9.2 / 2009-01-08
+
+* Patches and updates
+
+=== 0.9.5 / 2009-02-20
+
+* Restructured gem to generate from XSD dynamically instead of from DTD statically.
+
+=== 0.9.6 / 2009-03-10
+
+* Fixed a couple bugs related to collection elements in responses.
+
+=== 0.9.7 / 2009-04-15
+
+* Fixed conflicts with Rails / ActiveRecord / ActiveSupport.
+
+=== 0.9.8 / 2009-05-06
+
+* A few minor enhancements; Made the :spew adapter default for ease of use in irb.

data/License.txt

@@ -0,0 +1,54 @@
+Copyright (c) 2008 BehindLogic <gems@behindlogic.com>
+
+* THIS IS NOT FREE SOFTWARE!
+  Although I'd love for it to be free, the truth is it just took
+  SO MUCH WORK that I absolutely must get something out of it.
+  Please understand that in my opinion, to try to integrate with
+  QuickBooks from scratch would be nothing short of proposterous
+  with this ready-made gem looking you straight in the eye. I'll
+  just leave it at that. :)
+
+* Use of the Trial Version
+  This is a trial version. For the most part, this is a working
+  copy that is restricted to working with a small set of QuickBooks
+  objects.
+  
+  Use of the full version of this QuickBooks Rubygem is subject to a
+  fee. BehindLogic has developed this QuickBooks Rubygem out of its
+  own necessity and the necessity of others; and because of the large
+  number of hours required to complete such a task, BehindLogic has
+  decided to provide it to others for use at a decent fee. For the
+  current fee, visit behindlogic.com or contact gems@behindlogic.com.
+
+* Extent of permission
+  This QuickBooks Rubygem shall only be used for its packaged
+  capabilities. It is provided as-is. You MAY NOT redistribute any
+  code contained within this library. You MAY NOT include any code
+  contained within this library within an open source project, when
+  in doing so effectively releases the code to the public. Remember,
+  the purpose of this License is to allow you to fully use this gem,
+  after you have paid your due. BehindLogic has spent countless
+  hours on this work, and seeks to be compensated over time for its
+  work.
+
+* Support, Upgrades and Bugfixes
+  Agreement for Support will be discussed elsewhere, such as when you
+  communicate your purchase of a license from BehindLogic. Upgrades
+  are to be granted upon request at a fraction of the initial fee
+  paid. Upgrades are not guaranteed to be created for new versions of
+  QuickBooks, and the timeliness of this service is not guaranteed
+  since newer versions of QuickBooks aren't guaranteed by Intuit to
+  follow patterns of their predecessors. Incentive monies, to a
+  certain point, help to speed up the work when necessary. Bugfixes
+  will be treated with care and will be worked on for free; however,
+  again, timeliness is not guaranteed, but incentive monies can be
+  offered to expedite the bug squashing.
+
+* PROVIDED AS IS!
+  THE SOFTWARE IS PROVIDED "AS IS", 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.

data/Manifest.txt

@@ -0,0 +1,73 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/quickbooks.rb
+lib/quickbooks/adaptability.rb
+lib/quickbooks/adapters/http_adapter.rb
+lib/quickbooks/adapters/https_adapter.rb
+lib/quickbooks/adapters/ole_adapter.rb
+lib/quickbooks/adapters/spew_adapter.rb
+lib/quickbooks/adapters/tcp_adapter.rb
+lib/quickbooks/adapters/test_adapter.rb
+lib/quickbooks/element.rb
+lib/quickbooks/element_collection.rb
+lib/quickbooks/extlib.rb
+lib/quickbooks/extlib/assertions.rb
+lib/quickbooks/extlib/class.rb
+lib/quickbooks/extlib/days_and_times.rb
+lib/quickbooks/extlib/days_and_times/duration.rb
+lib/quickbooks/extlib/days_and_times/numeric.rb
+lib/quickbooks/extlib/days_and_times/object.rb
+lib/quickbooks/extlib/days_and_times/time.rb
+lib/quickbooks/extlib/hash.rb
+lib/quickbooks/extlib/hook.rb
+lib/quickbooks/extlib/inflection.rb
+lib/quickbooks/extlib/logger.rb
+lib/quickbooks/extlib/object.rb
+lib/quickbooks/extlib/pathname.rb
+lib/quickbooks/extlib/rubygems.rb
+lib/quickbooks/extlib/string.rb
+lib/quickbooks/extlib/time.rb
+lib/quickbooks/model.rb
+lib/quickbooks/option.rb
+lib/quickbooks/property.rb
+lib/quickbooks/ruby_ext.rb
+lib/quickbooks/type.rb
+lib/quickbooks/types.rb
+lib/quickbooks/version.rb
+lib/quickbooks/xsd.rb
+lib/quickbooks/xsd/attribute.rb
+lib/quickbooks/xsd/choice.rb
+lib/quickbooks/xsd/complex_type.rb
+lib/quickbooks/xsd/element.rb
+lib/quickbooks/xsd/group.rb
+lib/quickbooks/xsd/restriction.rb
+lib/quickbooks/xsd/sequence.rb
+lib/quickbooks/xsd/simple_type.rb
+lib/quickbooks/xsd/union.rb
+lib/quickbooks/xsd/validation.rb
+lib/quickbooks/xsd/xml_parse.rb
+quickbooks.gemspec
+source/qbxml21_demo.xsd
+source/qbxmlops_demo.xsd
+source/qbxmltypes.xsd
+spec/association_spec.rb
+spec/element_collection_spec.rb
+spec/find_spec.rb
+spec/lib/quickbooks/element_spec.rb
+spec/lib/quickbooks/elements/sales_order_add_spec.rb
+spec/lib/quickbooks/elements/vendor_add_spec.rb
+spec/lib/quickbooks/model_spec.rb
+spec/lib/quickbooks/models/customer_spec.rb
+spec/lib/quickbooks/models/invoice_spec.rb
+spec/lib/quickbooks/models/sales_order_line_spec.rb
+spec/lib/quickbooks/models/sales_order_spec.rb
+spec/lib/quickbooks/xsd/choice_spec.rb
+spec/pending_spec.rb
+spec/quickbooks_spec.rb
+spec/repeatable_spec.rb
+spec/requires_spec.rb
+spec/spec_helper.rb
+spec/validation_spec.rb

data/README.txt

@@ -0,0 +1,79 @@
+= quickbooks
+
+* http://behindlogic.com
+* http://behindlogic.lighthouseapp.com/projects/32776
+
+== DESCRIPTION:
+
+The only comprehensive Ruby interface to Quickbooks. THIS IS A DEMO VERSION. Visit behindlogic.com for the full version, which works with all versions of QuickBooks.
+
+== SYNOPSIS:
+
+  jim = QB::Customer.first(:fullname => ["Jim Stout"])
+  jim.destroy # Note that you cannot delete items in QuickBooks
+              # but you CAN delete them using the API.
+
+== REQUIREMENTS:
+
+  NONE
+
+== INSTALL:
+
+  gem install quickbooks
+
+== LICENSE:
+
+Copyright (c) 2008 BehindLogic <gems@behindlogic.com>
+
+* THIS IS NOT FREE SOFTWARE!
+  Although I'd love for it to be free, the truth is it just took
+  SO MUCH WORK that I absolutely must get something out of it.
+  Please understand that in my opinion, to try to integrate with
+  QuickBooks from scratch would be nothing short of proposterous
+  with this ready-made gem looking you straight in the eye. I'll
+  just leave it at that. :)
+
+* Use of the Trial Version
+  This is a trial version. For the most part, this is a working
+  copy that is restricted to working with a small set of QuickBooks
+  objects.
+  
+  Use of the full version of this QuickBooks Rubygem is subject to a
+  fee. BehindLogic has developed this QuickBooks Rubygem out of its
+  own necessity and the necessity of others; and because of the large
+  number of hours required to complete such a task, BehindLogic has
+  decided to provide it to others for use at a decent fee. For the
+  current fee, visit behindlogic.com or contact gems@behindlogic.com.
+
+* Extent of permission
+  This QuickBooks Rubygem shall only be used for its packaged
+  capabilities. It is provided as-is. You MAY NOT redistribute any
+  code contained within this library. You MAY NOT include any code
+  contained within this library within an open source project, when
+  in doing so effectively releases the code to the public. Remember,
+  the purpose of this License is to allow you to fully use this gem,
+  after you have paid your due. BehindLogic has spent countless
+  hours on this work, and seeks to be compensated over time for its
+  work.
+
+* Support, Upgrades and Bugfixes
+  Agreement for Support will be discussed elsewhere, such as when you
+  communicate your purchase of a license from BehindLogic. Upgrades
+  are to be granted upon request at a fraction of the initial fee
+  paid. Upgrades are not guaranteed to be created for new versions of
+  QuickBooks, and the timeliness of this service is not guaranteed
+  since newer versions of QuickBooks aren't guaranteed by Intuit to
+  follow patterns of their predecessors. Incentive monies, to a
+  certain point, help to speed up the work when necessary. Bugfixes
+  will be treated with care and will be worked on for free; however,
+  again, timeliness is not guaranteed, but incentive monies can be
+  offered to expedite the bug squashing.
+
+* PROVIDED AS IS!
+  THE SOFTWARE IS PROVIDED "AS IS", 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.

data/Rakefile

@@ -1,82 +1,21 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-
-PKG_NAME = 'quickbooks'
-PKG_VERSION = "0.4.0"
-
-PKG_FILES = FileList[
-    "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
-]
-
-desc "Default Task"
-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"
-task :console do
-   verbose( false ) { sh "irb -I lib -r 'quickbooks'" }
-end
-
-# Genereate the RDoc documentation
-desc "Create documentation"
-Rake::RDocTask.new("doc") { |rdoc|
-  rdoc.title = "QuickBooks for Ruby"
-  rdoc.rdoc_dir = 'doc'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('LICENSE')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-}
+# -*- ruby -*-
 
-# Generate the package
-spec = Gem::Specification.new do |s|
-  #### Basic information.
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  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)."
-
-  #### Dependencies.
-  s.add_dependency('formattedstring', '>= 0.1.0')
-  s.add_dependency('hash_magic', '>= 0.1.0')
-  
-  #### 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'
-
-  #### Documentation and testing.
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE"]
-
-  #### Author and project details.
-  s.author = "Daniel Parker"
-  s.email = "gems@behindlogic.com"
-  s.homepage = "http://quickbooks.rubyforge.org"
-  s.rubyforge_project = 'quickbooks'
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = false
+require 'rubygems'
+gem 'hoe', '1.8.3'
+require 'hoe'
+require './lib/quickbooks.rb'
+require './lib/quickbooks/version.rb'
+
+hoe = Hoe.new('quickbooks', Quickbooks::VERSION::STRING) do |p|
+  p.developer('BehindLogic', 'gems@behindlogic.com')
+  p.test_globs = ["test/**/test_*.rb", "spec/**/*_spec.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # p.extra_deps << ['extlib', '>= 0.9.6']
 end
 
-desc "Report code statistics (KLOCs, etc) from the application"
-task :stats do
-  require 'code_statistics'
-  CodeStatistics.new(
-    ["Library", "lib"]
-  ).to_s
+# vim: syntax=Ruby
+task :cultivate do
+  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
+  system "rake debug_gem | grep -v \"(in \" > #{hoe.name}.gemspec"
 end
-
-desc "Publish new documentation"
-task :publish => [:doc] do
-  `scp -r doc/* dcparker@rubyforge.org:/var/www/gforge-projects/quickbooks`
-end

data/lib/quickbooks.rb

@@ -1,7 +1,153 @@
-QUICKBOOKS_VERSION = '0.1.0'
-require 'quickbooks/base'
-require 'quickbooks/models/list_item'
-require 'quickbooks/models/transaction'
-
-require 'quickbooks/models/customer'
-require 'quickbooks/models/deleted'
+require 'time'
+gem_path = File.dirname(__FILE__)
+$:.unshift(File.expand_path(gem_path)) unless $:.include?(gem_path) || $:.include?(File.expand_path(gem_path))
+
+require 'quickbooks/extlib'
+require 'quickbooks/ruby_ext'
+require 'quickbooks/xsd'
+require 'quickbooks/element_collection'
+require 'quickbooks/element'
+require 'quickbooks/model'
+require 'quickbooks/adaptability'
+
+# Use the QB constant to access any model or element class. QB::Customer will get the Customer model class,
+# autogenerating it from the parsed specs if necessary. You can also access a class constant using the
+# accessor method: QB['Customer']. Use QB.xsd if you want to browse the XSD data structure parsed from the
+# specs at the current Quickbooks.qbxml_version.
+module QB
+  class << self
+    def const_missing(const)
+      Quickbooks.get_constant(const)
+    end
+    alias :[] :const_missing
+
+    # Returns the XSD data structure parsed from the specs at the current Quickbooks.qbxml_version.
+    def xsd
+      Quickbooks.xsd(true)
+    end
+  end
+end
+
+module Quickbooks
+  # Just a placeholder for all Model classes.
+  module Models
+  end
+  # Just a placeholder for all Element classes.
+  module Elements
+  end
+  # Just a placeholder for all Property classes.
+  module Properties
+  end
+
+  ValidationError           = Class.new(RuntimeError)
+  AttributeAssignmentError  = Class.new(RuntimeError)
+    InvalidAttributeError   = Class.new(AttributeAssignmentError)
+  QuickbooksAPIError        = Class.new(RuntimeError)
+  HTTPConnectorError        = Class.new(RuntimeError)
+
+  extend Adaptability
+
+  class << self
+
+    # Set or retrieve the current qbxml_version the gem is running at. If autoload is true, it will ask Quickbooks
+    # (via the current connection) for the qbxml versions it supports, then choose the latest that the gem also supports.
+    def qbxml_version(autoload=false)
+      @qbxml_version ||= if autoload
+        '2.1'
+      else
+        nil
+      end
+    end
+    def qbxml_version=(version)
+      warn "Only a subset of QBXML Version 2.1 is available in the demo."
+      @qbxml_version = '2.1'
+      # Load xsd right away?
+      # Also, could run a separate thread for loading this,
+      # then join it when needed and harvest the xsd from it.
+      # xsd(true)
+    end
+
+    # Returns the XSD data structure parsed from the current qbxml_version. If autoload is true, it will go ahead and parse the XSD for
+    # the current version if it is not already parsed and cached.
+    def xsd(autoload=false)
+      @xsd ||= {}
+      @xsd[qbxml_version(true)] || begin
+        @xsd[qbxml_version] = (autoload ? Quickbooks::XSD.parse_file("qbxmlops_demo.xsd", File.dirname(__FILE__) + "/../source/") : nil)
+        connector_error_xsd = <<ENDXSD
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+<xsd:element name="ErrorMessage">
+	<xsd:simpleType>
+		<xsd:restriction base="STRTYPE" />
+	</xsd:simpleType>
+</xsd:element>
+
+<xsd:element name="ConnectorError">
+	<xsd:complexType>
+		<xsd:sequence>
+			<xsd:element ref="ErrorMessage" />
+		</xsd:sequence>
+	</xsd:complexType>
+</xsd:element>
+ENDXSD
+        @xsd[qbxml_version].parse(connector_error_xsd)
+      end
+      @xsd[qbxml_version]
+    end
+
+    # Quickbooks.get_constant. See QB.
+    def get_constant(const)
+      const = const.to_s
+      return loaded_classes[const] if loaded_classes.has_key?(const)
+      # TODO: Need to auto-generate Models too!
+      # If const+'Ret' exists, generate a Model class for const.
+      if const_xsd = xsd(true)[const] || xsd(true)[const+'Ret'] || xsd(true)[const+'Add'] || xsd(true)[const+'Mod']
+        loaded_classes[const] = const_xsd.to_class(const)
+      else
+        raise RuntimeError, "The Quickbooks class '#{const}' could not be found (called from #{caller[1]}) in QBXML Version #{qbxml_version}. Please report to gems@behindlogic.com if you think this is a BUG! (#{xsd.inspect} : #{const.inspect} => #{xsd[const]})"
+      end
+    end
+
+    def send_qbxml(qbxml)
+      @last_response_xml = connection.send_xml("<?xml version=\"1.0\" ?>\n<?qbxml version=\"#{qbxml_version(true)}\" ?>\n#{qbxml}")
+    end
+
+    def send_request(request)
+      Quickbooks::Support.parse_xml(send_qbxml(request.to_xml))
+    end
+
+    def requestify(requestish)
+      QB::QBXMLMsgsRq.options[:onError].default = 'stopOnError'
+      request = requestish.class.name =~ /Rq$/ ? QB::QBXML.new(:QBXMLMsgsRq => [requestish]) : requestish
+      raise ValidationError, request.to_xml + "\n" + request.errors.join(', ') if !request.valid?
+      return request
+    end
+
+    def qbxml(&block)
+      raise ArgumentError unless block_given?
+      yield
+    end
+
+    # Execute a Request to Quickbooks and parse the answer back into QB gem objects.
+    def execute(requestish)
+      request = requestify(requestish)
+      response_klass_name = request[:QBXMLMsgsRq].attributes[0].class.short_name.gsub(/Rq/, 'Rs')
+      @last_response = send_request(request)
+      raise RuntimeError, "Response invalid!" unless @last_response.respond_to?(:[])
+      # Here, if the response we got was an error (<ConnectorError><ErrorMessage>...</ErrorMessage></ConnectorError>), deal with it now.
+      raise HTTPConnectorError, @last_response[:ConnectorError][:ErrorMessage] if @last_response[:ConnectorError]
+      raise RuntimeError, "Response did not include QBXMLMsgsRs." unless @last_response[:QBXMLMsgsRs]
+      raise RuntimeError, "Response not the right type (#{response_klass_name})." unless @last_response[:QBXMLMsgsRs][response_klass_name]
+      # raise RuntimeError, "Response has no results." unless @last_response[:QBXMLMsgsRs][response_klass_name][0].nil?
+      rs = @last_response[:QBXMLMsgsRs][response_klass_name][0]
+      if rs && rs['statusSeverity'] == 'Error'
+        raise QuickbooksAPIError, "##{rs['statusCode']}: #{rs['statusMessage']}"
+      end
+      @last_response
+    end
+
+    def loaded_classes
+      @loaded_classes ||= {}
+      @loaded_classes[qbxml_version(true)] ||= {}
+    end
+  end
+end