quickbooks 0.4.0 → 0.9.9

data/source/qbxmltypes.xsd

@@ -0,0 +1,160 @@
+
+<!-- ============================================================================= -->
+<!-- qbXML version 3.0                                                             -->
+<!--                                                                               -->
+<!--                                                                               -->
+<!-- Unpublished work. INTUIT CONFIDENTIAL.                                        -->
+<!-- Copyright   2001 Intuit Inc. All rights reserved.                             -->
+<!--                                                                               -->
+<!-- Use is subject to a qbXML Developer Agreement available at:                   -->
+<!--          http://developer.intuit.com/legal/qbXML_021201.asp                   -->
+<!-- and the terms specified at:                                                   -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                   -->
+<!--                                                                               -->
+<!-- NOTICE: THE API IS A PRELIMINARY SPECIFICATION, AND IS SUBJECT TO CHANGE.     -->
+<!-- IT IS NOT FOR USE IN PRODUCTION.   ANY USE OF THE API                         -->
+<!-- IS AT YOUR OWN RISK.                                                          -->
+<!--                                                                               -->
+<!-- ============================================================================= -->
+<!--                                                                               -->
+<!-- qbxmltypes.xsd                                                                -->
+<!--                                                                               -->
+<!-- Unpublished work. INTUIT CONFIDENTIAL.                                        -->
+<!-- Copyright   2001 Intuit Inc. All rights reserved.                             -->
+<!-- Use is subject to the terms specified at:                                     -->
+<!--          http://developer.intuit.com/legal/devsite_tos.html                   -->
+<!--                                                                               -->
+<!-- ============================================================================= -->
+
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+
+<xsd:simpleType name="IDTYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:maxLength value="36"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="STRTYPE">
+  <xsd:restriction base="xsd:string">
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="BOOLTYPE">
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:boolean">
+      </xsd:restriction>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:token">
+        <xsd:enumeration value=""/>
+      </xsd:restriction>
+    </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+<xsd:simpleType name="DATETYPE">
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:date">
+      </xsd:restriction>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:token">
+        <xsd:enumeration value=""/>
+      </xsd:restriction>
+    </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+<xsd:simpleType name="DATETIMETYPE">
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:string">
+        <xsd:pattern value="([0-9]{4}\-[0-9]{1,2}\-[0-9]{1,2}(T[0-9]{1,2}(:[0-9]{1,2}(:[0-9]{1,2}([+\-]{1}[0-9]{1,2}:[0-9]{1,2})?)?)?)?)?" />
+      </xsd:restriction>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:token">
+        <xsd:enumeration value=""/>
+      </xsd:restriction>
+    </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+<xsd:simpleType name="TIMEINTERVALTYPE">
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:duration">
+        <xsd:pattern value="PT([0-9]+H)?([0-9]+M)?([0-9]+S)?" />
+      </xsd:restriction>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:token">
+        <xsd:enumeration value=""/>
+      </xsd:restriction>
+    </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+<xsd:simpleType name="AMTTYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:pattern value="([+\-]?[0-9]{1,8}\.[0-9]{2})?"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="PRICETYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:pattern value="([+\-]?[0-9]{1,7}\.[0-9]{1,5})?|([+\-]?[0-9]{1,8}\.[0-9]{1,2})?|([+\-]?[0-9]{1,8})?" />
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="QUANTYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:pattern value="([+\-]?[0-9]{1,7}(\.[0-9]{1,5})?)?"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="PERCENTTYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:pattern value="([+\-]?[0-9]{1,7}(\.[0-9]{1,5})?)?"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="ENUMTYPE">
+  <xsd:restriction base="xsd:string">
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="INTTYPE">
+  <xsd:restriction base="xsd:integer">
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="GUIDTYPE">
+  <xsd:restriction base="xsd:string">
+    <xsd:pattern value="0|(\{[0-9a-fA-F]{8}(\-([0-9a-fA-F]{4})){3}\-[0-9a-fA-F]{12}\})"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="MACROTYPE">
+  <xsd:restriction base="xsd:string">
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="FLOATTYPE">
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:decimal">
+      </xsd:restriction>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:token">
+        <xsd:enumeration value=""/>
+      </xsd:restriction>
+    </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+
+</xsd:schema>

data/spec/association_spec.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "associations" do
+  it "should ..."
+end

data/spec/element_collection_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "element collections" do
+  it "should assign an element collection to all repeatable elements" do
+    q = QB::SalesOrder.new(:SalesOrderLine => [{}])
+    q[:SalesOrderLine].should be_is_a(ElementCollection)
+  end
+end

data/spec/find_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "find elements" do
+  it "should find SalesOrderAdd/SalesOrderLineAdd" do
+    QB.xsd['SalesOrderAdd'].find('SalesOrderLineAdd').name.should eql('SalesOrderLineAdd')
+  end
+  it "should recognize DataEventSubscriptionAdd/ListEventSubscription" do
+    QB.xsd['DataEventSubscriptionAdd'].find('DeliverOwnEvents').name.should eql('DeliverOwnEvents')
+    QB.xsd['DataEventSubscriptionAdd'].find('ListEventSubscription').name.should eql('ListEventSubscription')
+  end
+  it "should recognize QBXMLMsgsRq/HostQueryRq" do
+    QB.xsd['QBXMLMsgsRq'].find('HostQueryRq').name.should eql('HostQueryRq')
+  end
+  it "should recognize TermsQueryRsType/DateDrivenTermsRet" do
+    QB.xsd.types['TermsQueryRsType'].find('DateDrivenTermsRet').name.should eql('DateDrivenTermsRet')
+  end
+  it "should still work after using gsub" do
+    QB.xsd['DataEventSubscriptionAdd'].find('DeliverOwnEvents').should_not be_nil
+    newstuff = QB.xsd['DataEventSubscriptionAdd'].gsub(/Events/,'Evans')
+    newstuff.find('DeliverOwnEvans').should_not be_nil
+    QB.xsd['DataEventSubscriptionAdd'].find('DeliverOwnEvents').should_not be_nil
+  end
+end
+
+describe "gsub test" do
+  it "should gsub all names" do
+    QB.xsd['CustomerRet'].gsub!(/Ret$/,'RRet').find('DataExtRRet').should_not be_nil
+    QB.xsd['CustomerRet'].gsub(/RRet$/,'').find('DataExt').should_not be_nil
+  end
+end

data/spec/lib/quickbooks/element_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Quickbooks::Element do
+  it 'should enumerate the associations properly' do
+    pending "associations"
+    QB::SalesOrderMod.associations.should include('Class')
+    QB::SalesOrderMod.associations.should include('CustomerMsg')
+    QB::SalesOrderMod.associations.should include('Customer')
+    QB::SalesOrderMod.associations.should include('CustomerSalesTaxCode')
+    QB::SalesOrderMod.associations.should include('ItemSalesTax')
+    QB::SalesOrderMod.associations.should include('SalesRep')
+    QB::SalesOrderMod.associations.should include('ShipMethod')
+    QB::SalesOrderMod.associations.should include('Template')
+    QB::SalesOrderMod.associations.should include('Terms')
+    QB::SalesOrderMod.associations.length.should eql(9)
+  end
+
+  it 'should define working association accessor methods' do
+    pending "associations"
+    # pending 'make the methods auto-generate: read will auto-load the associated object, if one not already attached; write will simply attach associated object.'
+    so = QB::SalesOrderMod.new
+    so[:Customer].should eql(nil)
+    so[:Customer] = QB::Customer.new
+    so[:Customer].should be_is_a(QB::Customer)
+  end
+
+  it 'should grab the associated member when the corresponding ref has a value' do
+    pending "associations"
+    so = QB::SalesOrderMod.new
+    so[:Customer].should eql(nil)
+    so[:CustomerRef] = {:FullName => 'Tom Jones'}
+    Quickbooks.use_adapter(:spew)
+    so[:Customer].should eql("<?xml version=\"1.0\" ?>\n<?qbxml version=\"6.0\" ?>\n<QBXML>\n  <QBXMLMsgsRq onError=\"stopOnError\">\n    <CustomerQueryRq>\n      <FullName>Tom Jones</FullName>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>")
+    Quickbooks.use_adapter(:test)
+  end
+
+  it 'should update the corresponding ref when the association attribute is updated' do
+    pending "associations"
+    so = QB::SalesOrderMod.new
+    # Should blank the ref if there is none
+    so[:Customer] = QB::Customer.new
+    so[:CustomerRef].should eql(nil)
+    # Should assign the ref if there is one
+    so[:Customer] = QB::Customer.instantiate(:ListID => '12345')
+    so[:CustomerRef].should be_is_a(QB::CustomerRef)
+    so[:CustomerRef][:ListID].to_s.should eql('12345')
+  end
+
+  it 'should create dependent associated records before saving current record, if possible' do
+    pending "associations"
+    so = QB::SalesOrderMod.new
+    so[:Customer] = QB::Customer.new(:Name => 'Joe Smith')
+    so[:SalesOrderLine] = [{:Item => QB::ItemInventory.new(
+      :Name => 'Some Item',
+      :IncomeAccountRef => {:FullName => 'Sales'},
+      :AssetAccountRef => {:FullName => 'Inventory Asset'},
+      :COGSAccountRef => {:FullName => 'Cost of Goods Sold'},
+      :SalesPrice => '25.00',
+      :Inactive => true
+    )}]
+    # Save the Customer
+    Quickbooks.connection.next_response("<QBXML>
+      <QBXMLMsgsRs>
+        <CustomerAddRs>
+          <CustomerRet>
+            <ListID>12479-02920</ListID>
+          </CustomerRet>
+        </CustomerAddRs>
+      </QBXMLMsgsRs>
+    </QBXML>")
+    # Save the ItemInventory
+    Quickbooks.connection.next_response("<QBXML>
+      <QBXMLMsgsRs>
+        <ItemInventoryAddRs>
+          <ItemInventoryRet>
+            <ListID>12479-02920</ListID>
+          </ItemInventoryRet>
+        </ItemInventoryAddRs>
+      </QBXMLMsgsRs>
+    </QBXML>")
+    so.save_associations # Should save Customer and Item
+  end
+end

data/spec/lib/quickbooks/elements/sales_order_add_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+describe QB::SalesOrderAdd do
+  it "should validate nicely" do
+    # Need to determine how to manage elements in models where something like SalesOrderLineAdd is required,
+    # but we should be using a SalesOrderLine.
+    s = QB::SalesOrderAdd.new(:CustomerRef => {:ListID => '12345'})
+    s.should_not be_valid
+    lambda { s[:SalesOrderLineAdd] = {} }.should raise_error(RuntimeError)
+    s.should_not be_valid
+    s.errors.should include("missing required element either of (SalesOrderLineAdd, SalesOrderLineGroupAdd)")
+    lambda { s[:SalesOrderLineAdd] = [{}] }.should_not raise_error
+  end
+end

data/spec/lib/quickbooks/elements/vendor_add_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module QB
+  describe VendorAdd do
+    after(:each) {$DEBUG = nil}
+
+    it "should instantiate a VendorAdd object and validate it" do
+      va = VendorAdd.new
+      va.valid?.should eql(false)
+      va = VendorAdd.new(:Name => 'Herman')
+      va.should be_valid
+    end
+
+    it "should be able to set attributes" do
+      va = VendorAdd.new
+      va[:Name] = 'Herman'
+      va[:Name].should eql('Herman')
+    end
+
+    it "should render attributes in the correct order" do
+      va = VendorAdd.new(:IsActive => true, :Name => 'Herman', :Salutation => 'Mr. Sir', :Phone => '(123) 456-7890')
+      va.attributes.collect {|a| a.class.short_name}.should eql(['Name', 'IsActive', 'Salutation', 'Phone'])
+    end
+
+    it "should be able to assign an attribute twice and retain only the new value" do
+      va = VendorAdd.new(:Name => 'Herman')
+      va[:Name] = 'Herbert'
+      va[:Name].should eql('Herbert')
+      va.attributes.select {|a| a.class == va[:Name].class}.length.should eql(1)
+    end
+
+    it "should initialize attributes as arrays also" do
+      va = VendorAdd.new([Quickbooks.get_constant('Name').new('Herman'), Quickbooks.get_constant('IsActive').new(true), Quickbooks.get_constant('Salutation').new('Mr. Sir'), Quickbooks.get_constant('Phone').new('(123) 456-7890')])
+      va[:Name].should eql('Herman')
+    end
+
+    it "should mark dirty attributes in the record attribute assignment" do
+      va = VendorAdd.send(:instantiate, :Name => 'Herman')
+      va[:Name].dirty?.should eql(false)
+      va[:Name].downcase!
+      va[:Name].should be_dirty
+    end
+
+    it "should notice attribute values as dirty when they are modified (mutable values)" do
+      va = VendorAdd.send(:instantiate, :Name => 'Herman')
+      va[:Name].dirty?.should eql(false)
+      va[:Name] = 'Herbert'
+      va[:Name].should be_dirty
+    end
+
+    it ":dirty_attributes should operate correctly" do
+      va = VendorAdd.send(:instantiate, :Name => 'Herman')
+      va[:Name] = 'Herbert'
+      va.dirty_attributes.inspect.should eql([va[:Name]].inspect)
+    end
+
+    it "should be able to serialize to_xml" do
+      va = VendorAdd.new(:Name => 'Herman', :IsActive => true, :Salutation => 'Mr. Sir', :Phone => '(123) 456-7890')
+      va.to_xml.should eql("<VendorAdd>\n  <Name>Herman</Name>\n  <IsActive>true</IsActive>\n  <Salutation>Mr. Sir</Salutation>\n  <Phone>(123) 456-7890</Phone>\n</VendorAdd>")
+    end
+
+    it "should be able to serialize to_dirty_xml" do
+      va = VendorAdd.new(:Name => 'Herman', :IsActive => true, :Salutation => 'Mr. Sir', :Phone => '(123) 456-7890')
+      va.to_dirty_xml.should eql("<VendorAdd>\n  <Name>Herman</Name>\n  <IsActive>true</IsActive>\n  <Salutation>Mr. Sir</Salutation>\n  <Phone>(123) 456-7890</Phone>\n</VendorAdd>")
+      va.send(:clean!) # inject to manually make it clean
+      va[:Name] += " Wonders"
+      va.to_dirty_xml.should eql("<VendorAdd>\n  <Name>Herman Wonders</Name>\n</VendorAdd>")
+    end
+
+    it "should include required elements with the dirty ones" do
+      va = VendorAdd.new(:Name => 'Herman', :IsActive => true, :Salutation => 'Mr. Sir', :Phone => '(123) 456-7890')
+      va.send(:clean!) # inject to manually make it clean
+      va[:IsActive] = false
+      # Name is included because it is a required element, and we passed true into to_dirty_xml
+      va.to_dirty_xml(true).should eql("<VendorAdd>\n  <Name>Herman</Name>\n  <IsActive>false</IsActive>\n</VendorAdd>")
+    end
+  end
+end

data/spec/lib/quickbooks/model_spec.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Quickbooks::Model do
+  it 'should enumerate the associations properly' do
+    QB::SalesOrder.associations.should include(:Class)
+    QB::SalesOrder.associations.should include(:CustomerMsg)
+    QB::SalesOrder.associations.should include(:Customer)
+    QB::SalesOrder.associations.should include(:CustomerSalesTaxCode)
+    QB::SalesOrder.associations.should include(:ItemSalesTax)
+    QB::SalesOrder.associations.should include(:SalesRep)
+    QB::SalesOrder.associations.should include(:ShipMethod)
+    QB::SalesOrder.associations.should include(:Template)
+    QB::SalesOrder.associations.should include(:Terms)
+    QB::SalesOrder.associations.reject {|k,p| !p.addable?}.length.should eql(9)
+  end
+
+  it 'should define working association accessor methods' do
+    # pending 'make the methods auto-generate: read will auto-load the associated object, if one not already attached; write will simply attach associated object.'
+    so = QB::SalesOrder.new
+    so[:Customer].should eql(nil)
+    so[:Customer] = QB::Customer.new
+    so[:Customer].should be_is_a(QB::Customer)
+  end
+
+  it 'should grab the associated member when the corresponding ref has a value' do
+    pending "associations"
+    so = QB::SalesOrder.new
+    so[:Customer].should eql(nil)
+    so[:CustomerRef] = {:FullName => 'Tom Jones'}
+    Quickbooks.use_adapter(:spew)
+    so[:Customer].should eql("<?xml version=\"1.0\" ?>\n<?qbxml version=\"6.0\" ?>\n<QBXML>\n  <QBXMLMsgsRq onError=\"stopOnError\">\n    <CustomerQueryRq>\n      <FullName>Tom Jones</FullName>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>")
+    Quickbooks.use_adapter(:test)
+  end
+
+  it 'should update the corresponding ref when the association attribute is updated' do
+    so = QB::SalesOrder.new
+    # Should blank the ref if there is none
+    so[:Customer] = QB::Customer.new
+    so[:CustomerRef].should eql(nil)
+    # Should assign the ref if there is one
+    so[:Customer] = QB::Customer.instantiate(:ListID => '12345')
+    so[:CustomerRef].should be_is_a(QB::CustomerRef)
+    so[:CustomerRef][:ListID].to_s.should eql('12345')
+  end
+
+  it 'should create dependent associated records before saving current record, if possible' do
+    so = QB::SalesOrder.new
+    so[:Customer] = QB::Customer.new(:Name => 'Joe Smith')
+    so[:SalesOrderLine] = [
+      {:Item => QB::ItemInventory.new(
+        :Name => 'Some Item',
+        :IncomeAccountRef => {:FullName => 'Sales'},
+        :AssetAccountRef => {:FullName => 'Inventory Asset'},
+        :COGSAccountRef => {:FullName => 'Cost of Goods Sold'},
+        :SalesPrice => '25.00',
+        :IsActive => false)}
+    ]
+    # Should save Customer, then Item, then SalesOrder
+    Quickbooks.use_adapter(:test)
+    Quickbooks.connection.next_response("<QBXML>
+      <QBXMLMsgsRs>
+        <CustomerAddRs>
+          <CustomerRet>
+            <ListID>12479-02920</ListID>
+          </CustomerRet>
+        </CustomerAddRs>
+      </QBXMLMsgsRs>
+    </QBXML>")
+    Quickbooks.connection.next_response("<QBXML>
+      <QBXMLMsgsRs>
+        <ItemInventoryAddRs>
+          <ItemInventoryRet>
+            <ListID>12479-02921</ListID>
+          </ItemInventoryRet>
+        </ItemInventoryAddRs>
+      </QBXMLMsgsRs>
+    </QBXML>")
+    Quickbooks.connection.next_response("<QBXML>
+      <QBXMLMsgsRs>
+        <SalesOrderAddRs>
+          <SalesOrderRet>
+            <TxnID>12479-02922</TxnID>
+          </SalesOrderRet>
+        </SalesOrderAddRs>
+      </QBXMLMsgsRs>
+    </QBXML>")
+    so.save
+  end
+end