quickbooks 0.4.0 → 0.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. data.tar.gz.sig +0 -0
  2. data/History.txt +23 -0
  3. data/License.txt +54 -0
  4. data/Manifest.txt +73 -0
  5. data/README.txt +79 -0
  6. data/Rakefile +17 -78
  7. data/lib/quickbooks.rb +153 -7
  8. data/lib/quickbooks/adaptability.rb +67 -0
  9. data/lib/quickbooks/adapters/http_adapter.rb +94 -0
  10. data/lib/quickbooks/adapters/https_adapter.rb +57 -0
  11. data/lib/quickbooks/adapters/ole_adapter.rb +141 -110
  12. data/lib/quickbooks/adapters/spew_adapter.rb +39 -0
  13. data/lib/quickbooks/adapters/tcp_adapter.rb +71 -0
  14. data/lib/quickbooks/adapters/test_adapter.rb +62 -0
  15. data/lib/quickbooks/element.rb +385 -0
  16. data/lib/quickbooks/element_collection.rb +105 -0
  17. data/lib/quickbooks/extlib.rb +8 -0
  18. data/lib/quickbooks/extlib/assertions.rb +8 -0
  19. data/lib/quickbooks/extlib/class.rb +98 -0
  20. data/lib/quickbooks/extlib/days_and_times.rb +10 -0
  21. data/lib/quickbooks/extlib/days_and_times/duration.rb +362 -0
  22. data/lib/quickbooks/extlib/days_and_times/numeric.rb +48 -0
  23. data/lib/quickbooks/extlib/days_and_times/object.rb +19 -0
  24. data/lib/quickbooks/extlib/days_and_times/time.rb +137 -0
  25. data/lib/quickbooks/extlib/hash.rb +327 -0
  26. data/lib/quickbooks/extlib/hook.rb +366 -0
  27. data/lib/quickbooks/extlib/inflection.rb +436 -0
  28. data/lib/quickbooks/extlib/logger.rb +202 -0
  29. data/lib/quickbooks/extlib/object.rb +162 -0
  30. data/lib/quickbooks/extlib/pathname.rb +15 -0
  31. data/lib/quickbooks/extlib/rubygems.rb +38 -0
  32. data/lib/quickbooks/extlib/string.rb +32 -0
  33. data/lib/quickbooks/extlib/time.rb +41 -0
  34. data/lib/quickbooks/model.rb +503 -121
  35. data/lib/quickbooks/option.rb +95 -0
  36. data/lib/quickbooks/property.rb +69 -0
  37. data/lib/quickbooks/ruby_ext.rb +251 -0
  38. data/lib/quickbooks/type.rb +75 -0
  39. data/lib/quickbooks/types.rb +58 -0
  40. data/lib/quickbooks/version.rb +10 -0
  41. data/lib/quickbooks/xsd.rb +243 -0
  42. data/lib/quickbooks/xsd/attribute.rb +57 -0
  43. data/lib/quickbooks/xsd/choice.rb +94 -0
  44. data/lib/quickbooks/xsd/complex_type.rb +77 -0
  45. data/lib/quickbooks/xsd/element.rb +214 -0
  46. data/lib/quickbooks/xsd/group.rb +94 -0
  47. data/lib/quickbooks/xsd/restriction.rb +51 -0
  48. data/lib/quickbooks/xsd/sequence.rb +85 -0
  49. data/lib/quickbooks/xsd/simple_type.rb +87 -0
  50. data/lib/quickbooks/xsd/union.rb +70 -0
  51. data/lib/quickbooks/xsd/validation.rb +89 -0
  52. data/lib/quickbooks/xsd/xml_parse.rb +80 -0
  53. data/quickbooks.gemspec +36 -0
  54. data/source/qbxml21_demo.xsd +2223 -0
  55. data/source/qbxmlops_demo.xsd +483 -0
  56. data/source/qbxmltypes.xsd +160 -0
  57. data/spec/association_spec.rb +5 -0
  58. data/spec/element_collection_spec.rb +8 -0
  59. data/spec/find_spec.rb +30 -0
  60. data/spec/lib/quickbooks/element_spec.rb +83 -0
  61. data/spec/lib/quickbooks/elements/sales_order_add_spec.rb +14 -0
  62. data/spec/lib/quickbooks/elements/vendor_add_spec.rb +78 -0
  63. data/spec/lib/quickbooks/model_spec.rb +89 -0
  64. data/spec/lib/quickbooks/models/customer_spec.rb +52 -0
  65. data/spec/lib/quickbooks/models/invoice_spec.rb +12 -0
  66. data/spec/lib/quickbooks/models/sales_order_line_spec.rb +0 -0
  67. data/spec/lib/quickbooks/models/sales_order_spec.rb +145 -0
  68. data/spec/lib/quickbooks/xsd/choice_spec.rb +18 -0
  69. data/spec/pending_spec.rb +11 -0
  70. data/spec/quickbooks_spec.rb +38 -0
  71. data/spec/repeatable_spec.rb +20 -0
  72. data/spec/requires_spec.rb +10 -0
  73. data/spec/spec_helper.rb +5 -0
  74. data/spec/validation_spec.rb +24 -0
  75. metadata +133 -285
  76. metadata.gz.sig +0 -0
  77. data/LICENSE +0 -16
  78. data/README +0 -49
  79. data/doc/classes/Array.html +0 -368
  80. data/doc/classes/Array.src/M000026.html +0 -18
  81. data/doc/classes/Array.src/M000027.html +0 -21
  82. data/doc/classes/Array.src/M000028.html +0 -18
  83. data/doc/classes/Array.src/M000029.html +0 -19
  84. data/doc/classes/Array.src/M000030.html +0 -18
  85. data/doc/classes/Array.src/M000031.html +0 -23
  86. data/doc/classes/Array.src/M000032.html +0 -18
  87. data/doc/classes/Array.src/M000033.html +0 -18
  88. data/doc/classes/Array.src/M000034.html +0 -18
  89. data/doc/classes/Array.src/M000035.html +0 -19
  90. data/doc/classes/Array.src/M000036.html +0 -18
  91. data/doc/classes/Array.src/M000037.html +0 -23
  92. data/doc/classes/Array.src/M000038.html +0 -18
  93. data/doc/classes/Array.src/M000039.html +0 -21
  94. data/doc/classes/Array.src/M000040.html +0 -18
  95. data/doc/classes/Array.src/M000041.html +0 -18
  96. data/doc/classes/Class.html +0 -171
  97. data/doc/classes/Class.src/M000042.html +0 -18
  98. data/doc/classes/Class.src/M000043.html +0 -18
  99. data/doc/classes/Hash.html +0 -516
  100. data/doc/classes/Hash.src/M000001.html +0 -18
  101. data/doc/classes/Hash.src/M000002.html +0 -21
  102. data/doc/classes/Hash.src/M000003.html +0 -18
  103. data/doc/classes/Hash.src/M000004.html +0 -21
  104. data/doc/classes/Hash.src/M000005.html +0 -18
  105. data/doc/classes/Hash.src/M000006.html +0 -20
  106. data/doc/classes/Hash.src/M000007.html +0 -18
  107. data/doc/classes/Hash.src/M000008.html +0 -22
  108. data/doc/classes/Hash.src/M000009.html +0 -18
  109. data/doc/classes/Hash.src/M000010.html +0 -21
  110. data/doc/classes/Hash.src/M000011.html +0 -24
  111. data/doc/classes/Hash.src/M000012.html +0 -18
  112. data/doc/classes/Hash.src/M000013.html +0 -21
  113. data/doc/classes/Hash.src/M000014.html +0 -18
  114. data/doc/classes/Hash.src/M000015.html +0 -21
  115. data/doc/classes/Hash.src/M000016.html +0 -18
  116. data/doc/classes/Hash.src/M000017.html +0 -21
  117. data/doc/classes/Hash.src/M000018.html +0 -27
  118. data/doc/classes/Hash.src/M000019.html +0 -20
  119. data/doc/classes/Hash.src/M000020.html +0 -18
  120. data/doc/classes/Hash.src/M000021.html +0 -18
  121. data/doc/classes/Hash.src/M000022.html +0 -18
  122. data/doc/classes/Hash.src/M000023.html +0 -18
  123. data/doc/classes/Hash.src/M000024.html +0 -18
  124. data/doc/classes/Hash.src/M000025.html +0 -28
  125. data/doc/classes/Object.html +0 -278
  126. data/doc/classes/Object.src/M000044.html +0 -24
  127. data/doc/classes/Object.src/M000045.html +0 -19
  128. data/doc/classes/Object.src/M000046.html +0 -24
  129. data/doc/classes/Object.src/M000047.html +0 -18
  130. data/doc/classes/Object.src/M000048.html +0 -19
  131. data/doc/classes/Object.src/M000049.html +0 -18
  132. data/doc/classes/Object.src/M000050.html +0 -18
  133. data/doc/classes/Object.src/M000051.html +0 -18
  134. data/doc/classes/Qbxml.html +0 -131
  135. data/doc/classes/Qbxml/Request.html +0 -224
  136. data/doc/classes/Qbxml/Request.src/M000132.html +0 -66
  137. data/doc/classes/Qbxml/Request.src/M000133.html +0 -19
  138. data/doc/classes/Qbxml/Request.src/M000134.html +0 -83
  139. data/doc/classes/Qbxml/RequestSet.html +0 -199
  140. data/doc/classes/Qbxml/RequestSet.src/M000135.html +0 -22
  141. data/doc/classes/Qbxml/RequestSet.src/M000136.html +0 -26
  142. data/doc/classes/Qbxml/RequestSet.src/M000137.html +0 -18
  143. data/doc/classes/Qbxml/RequestSet.src/M000138.html +0 -22
  144. data/doc/classes/Qbxml/Response.html +0 -302
  145. data/doc/classes/Qbxml/Response.src/M000123.html +0 -24
  146. data/doc/classes/Qbxml/Response.src/M000124.html +0 -19
  147. data/doc/classes/Qbxml/Response.src/M000125.html +0 -55
  148. data/doc/classes/Qbxml/Response.src/M000126.html +0 -18
  149. data/doc/classes/Qbxml/Response.src/M000127.html +0 -18
  150. data/doc/classes/Qbxml/Response.src/M000128.html +0 -18
  151. data/doc/classes/Qbxml/Response.src/M000129.html +0 -18
  152. data/doc/classes/Qbxml/Response.src/M000130.html +0 -18
  153. data/doc/classes/Qbxml/Response.src/M000131.html +0 -63
  154. data/doc/classes/Qbxml/ResponseSet.html +0 -244
  155. data/doc/classes/Qbxml/ResponseSet.src/M000116.html +0 -22
  156. data/doc/classes/Qbxml/ResponseSet.src/M000117.html +0 -26
  157. data/doc/classes/Qbxml/ResponseSet.src/M000118.html +0 -24
  158. data/doc/classes/Qbxml/ResponseSet.src/M000119.html +0 -20
  159. data/doc/classes/Qbxml/ResponseSet.src/M000120.html +0 -27
  160. data/doc/classes/Qbxml/ResponseSet.src/M000121.html +0 -18
  161. data/doc/classes/Qbxml/ResponseSet.src/M000122.html +0 -18
  162. data/doc/classes/Quickbooks.html +0 -196
  163. data/doc/classes/Quickbooks/Address.html +0 -139
  164. data/doc/classes/Quickbooks/Address.src/M000115.html +0 -19
  165. data/doc/classes/Quickbooks/Base.html +0 -567
  166. data/doc/classes/Quickbooks/Base.src/M000095.html +0 -18
  167. data/doc/classes/Quickbooks/Base.src/M000096.html +0 -20
  168. data/doc/classes/Quickbooks/Base.src/M000097.html +0 -19
  169. data/doc/classes/Quickbooks/Base.src/M000098.html +0 -18
  170. data/doc/classes/Quickbooks/Base.src/M000099.html +0 -19
  171. data/doc/classes/Quickbooks/Base.src/M000100.html +0 -30
  172. data/doc/classes/Quickbooks/Base.src/M000101.html +0 -22
  173. data/doc/classes/Quickbooks/Base.src/M000102.html +0 -30
  174. data/doc/classes/Quickbooks/Base.src/M000103.html +0 -19
  175. data/doc/classes/Quickbooks/Base.src/M000104.html +0 -19
  176. data/doc/classes/Quickbooks/Base.src/M000105.html +0 -18
  177. data/doc/classes/Quickbooks/Base.src/M000106.html +0 -18
  178. data/doc/classes/Quickbooks/Base.src/M000107.html +0 -19
  179. data/doc/classes/Quickbooks/Base.src/M000108.html +0 -18
  180. data/doc/classes/Quickbooks/Base.src/M000109.html +0 -45
  181. data/doc/classes/Quickbooks/Base.src/M000110.html +0 -18
  182. data/doc/classes/Quickbooks/Base.src/M000111.html +0 -18
  183. data/doc/classes/Quickbooks/Base.src/M000112.html +0 -20
  184. data/doc/classes/Quickbooks/BillAddress.html +0 -113
  185. data/doc/classes/Quickbooks/CreditCardInfo.html +0 -113
  186. data/doc/classes/Quickbooks/Customer.html +0 -113
  187. data/doc/classes/Quickbooks/CustomerTypeRef.html +0 -113
  188. data/doc/classes/Quickbooks/Deleted.html +0 -113
  189. data/doc/classes/Quickbooks/ItemSalesTaxRef.html +0 -113
  190. data/doc/classes/Quickbooks/JobTypeRef.html +0 -113
  191. data/doc/classes/Quickbooks/ListDeleted.html +0 -139
  192. data/doc/classes/Quickbooks/ListDeleted.src/M000114.html +0 -18
  193. data/doc/classes/Quickbooks/ListItem.html +0 -170
  194. data/doc/classes/Quickbooks/ListItem.src/M000093.html +0 -20
  195. data/doc/classes/Quickbooks/ListItem.src/M000094.html +0 -18
  196. data/doc/classes/Quickbooks/Model.html +0 -462
  197. data/doc/classes/Quickbooks/Model.src/M000073.html +0 -24
  198. data/doc/classes/Quickbooks/Model.src/M000074.html +0 -19
  199. data/doc/classes/Quickbooks/Model.src/M000075.html +0 -18
  200. data/doc/classes/Quickbooks/Model.src/M000076.html +0 -18
  201. data/doc/classes/Quickbooks/Model.src/M000077.html +0 -18
  202. data/doc/classes/Quickbooks/Model.src/M000078.html +0 -22
  203. data/doc/classes/Quickbooks/Model.src/M000079.html +0 -32
  204. data/doc/classes/Quickbooks/Model.src/M000080.html +0 -32
  205. data/doc/classes/Quickbooks/Model.src/M000081.html +0 -18
  206. data/doc/classes/Quickbooks/Model.src/M000082.html +0 -18
  207. data/doc/classes/Quickbooks/Model.src/M000083.html +0 -22
  208. data/doc/classes/Quickbooks/Model.src/M000084.html +0 -23
  209. data/doc/classes/Quickbooks/Model.src/M000085.html +0 -18
  210. data/doc/classes/Quickbooks/Model.src/M000086.html +0 -21
  211. data/doc/classes/Quickbooks/Model.src/M000087.html +0 -26
  212. data/doc/classes/Quickbooks/Model.src/M000088.html +0 -26
  213. data/doc/classes/Quickbooks/Model.src/M000089.html +0 -26
  214. data/doc/classes/Quickbooks/Model.src/M000090.html +0 -21
  215. data/doc/classes/Quickbooks/Model.src/M000091.html +0 -23
  216. data/doc/classes/Quickbooks/OleAdapter.html +0 -129
  217. data/doc/classes/Quickbooks/OleAdapter/Connection.html +0 -343
  218. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000058.html +0 -18
  219. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000059.html +0 -19
  220. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000060.html +0 -24
  221. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000061.html +0 -18
  222. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000062.html +0 -18
  223. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000063.html +0 -21
  224. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000064.html +0 -24
  225. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000065.html +0 -20
  226. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000066.html +0 -24
  227. data/doc/classes/Quickbooks/OleAdapter/Connection.src/M000067.html +0 -24
  228. data/doc/classes/Quickbooks/OleAdapter/Ole.html +0 -209
  229. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000068.html +0 -21
  230. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000069.html +0 -22
  231. data/doc/classes/Quickbooks/OleAdapter/Ole.src/M000070.html +0 -18
  232. data/doc/classes/Quickbooks/ParentRef.html +0 -113
  233. data/doc/classes/Quickbooks/PreferredPaymentMethodRef.html +0 -113
  234. data/doc/classes/Quickbooks/PriceLevelRef.html +0 -113
  235. data/doc/classes/Quickbooks/QbxmlDebugAdapter.html +0 -111
  236. data/doc/classes/Quickbooks/QbxmlDebugAdapter/Connection.html +0 -139
  237. data/doc/classes/Quickbooks/QbxmlDebugAdapter/Connection.src/M000057.html +0 -18
  238. data/doc/classes/Quickbooks/Ref.html +0 -146
  239. data/doc/classes/Quickbooks/Ref.src/M000113.html +0 -18
  240. data/doc/classes/Quickbooks/SalesRepRef.html +0 -113
  241. data/doc/classes/Quickbooks/SalesTaxCodeRef.html +0 -113
  242. data/doc/classes/Quickbooks/ShipAddress.html +0 -113
  243. data/doc/classes/Quickbooks/TermsRef.html +0 -113
  244. data/doc/classes/Quickbooks/Transaction.html +0 -154
  245. data/doc/classes/Quickbooks/Transaction.src/M000071.html +0 -19
  246. data/doc/classes/Quickbooks/Transaction.src/M000072.html +0 -18
  247. data/doc/classes/Quickbooks/TxnDeleted.html +0 -139
  248. data/doc/classes/Quickbooks/TxnDeleted.src/M000092.html +0 -18
  249. data/doc/classes/String.html +0 -203
  250. data/doc/classes/String.src/M000052.html +0 -18
  251. data/doc/classes/String.src/M000053.html +0 -18
  252. data/doc/classes/String.src/M000054.html +0 -18
  253. data/doc/classes/String.src/M000055.html +0 -18
  254. data/doc/classes/String.src/M000056.html +0 -18
  255. data/doc/created.rid +0 -1
  256. data/doc/files/LICENSE.html +0 -129
  257. data/doc/files/README.html +0 -225
  258. data/doc/files/lib/qbxml/request_rb.html +0 -110
  259. data/doc/files/lib/qbxml/response_rb.html +0 -109
  260. data/doc/files/lib/qbxml/support_rb.html +0 -101
  261. data/doc/files/lib/qbxml_rb.html +0 -122
  262. data/doc/files/lib/quickbooks/adapters/ole_adapter_rb.html +0 -108
  263. data/doc/files/lib/quickbooks/adapters/qbxml_debug_adapter_rb.html +0 -108
  264. data/doc/files/lib/quickbooks/base_rb.html +0 -327
  265. data/doc/files/lib/quickbooks/model_rb.html +0 -108
  266. data/doc/files/lib/quickbooks/models/common/address_rb.html +0 -101
  267. data/doc/files/lib/quickbooks/models/common/all_refs_rb.html +0 -101
  268. data/doc/files/lib/quickbooks/models/customer/credit_card_info_rb.html +0 -101
  269. data/doc/files/lib/quickbooks/models/customer_rb.html +0 -110
  270. data/doc/files/lib/quickbooks/models/deleted_rb.html +0 -101
  271. data/doc/files/lib/quickbooks/models/list_item_rb.html +0 -101
  272. data/doc/files/lib/quickbooks/models/transaction_rb.html +0 -101
  273. data/doc/files/lib/quickbooks/ruby_magic_rb.html +0 -120
  274. data/doc/files/lib/quickbooks_rb.html +0 -125
  275. data/doc/fr_class_index.html +0 -64
  276. data/doc/fr_file_index.html +0 -45
  277. data/doc/fr_method_index.html +0 -164
  278. data/doc/index.html +0 -24
  279. data/doc/rdoc-style.css +0 -208
  280. data/lib/qbxml.rb +0 -3
  281. data/lib/qbxml/request.rb +0 -207
  282. data/lib/qbxml/response.rb +0 -197
  283. data/lib/qbxml/support.rb +0 -130
  284. data/lib/quickbooks/adapters/qbxml_debug_adapter.rb +0 -10
  285. data/lib/quickbooks/base.rb +0 -277
  286. data/lib/quickbooks/models/common/address.rb +0 -14
  287. data/lib/quickbooks/models/common/all_refs.rb +0 -37
  288. data/lib/quickbooks/models/customer.rb +0 -70
  289. data/lib/quickbooks/models/customer/credit_card_info.rb +0 -5
  290. data/lib/quickbooks/models/deleted.rb +0 -22
  291. data/lib/quickbooks/models/list_item.rb +0 -41
  292. data/lib/quickbooks/models/transaction.rb +0 -49
  293. data/lib/quickbooks/ruby_magic.rb +0 -213
data/doc/classes/Quickbooks/Address.src/M000115.html DELETED
@@ -1,19 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>inherited (Quickbooks::Address)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/quickbooks/models/common/address.rb, line 3</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
15
- <span class="ruby-keyword kw">super</span>
16
- <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">read_write</span> <span class="ruby-identifier">:addr1</span>, <span class="ruby-identifier">:addr2</span>, <span class="ruby-identifier">:addr3</span>, <span class="ruby-identifier">:addr4</span>, <span class="ruby-identifier">:addr5</span>, <span class="ruby-identifier">:city</span>, <span class="ruby-identifier">:state</span>, <span class="ruby-identifier">:postal_code</span>, <span class="ruby-identifier">:country</span>, <span class="ruby-identifier">:note</span>
17
- <span class="ruby-keyword kw">end</span></pre>
18
- </body>
19
- </html>
data/doc/classes/Quickbooks/Base.html DELETED
@@ -1,567 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: Quickbooks::Base</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">Quickbooks::Base</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../files/lib/quickbooks/base_rb.html">
59
- lib/quickbooks/base.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- <a href="Model.html">
69
- Model
70
- </a>
71
- </td>
72
- </tr>
73
- </table>
74
- </div>
75
- <!-- banner header -->
76
-
77
- <div id="bodyContent">
78
-
79
-
80
-
81
- <div id="contextContent">
82
-
83
- <div id="description">
84
- <p>
85
- <a href="Base.html">Base</a> is just base for <a
86
- href="ListItem.html">ListItem</a> and <a
87
- href="Transaction.html">Transaction</a>. It inherits from <a
88
- href="Model.html">Model</a>, just as <a href="Ref.html">Ref</a> does.
89
- </p>
90
- <p>
91
- Some <a href="../Qbxml.html">Qbxml</a> specifications require certain
92
- finder-options to be placed inside a containing entity, such as:
93
- </p>
94
- <pre>
95
- ...
96
- &lt;DeletedDateRangeFilter&gt;
97
- &lt;FromDeletedDate&gt;#{(Time.now - 5*60*60).xmlschema}&lt;/FromDeletedDate&gt;
98
- &lt;ToDeletedDate&gt;#{(Time.now - 3*60*60).xmlschema}&lt;/ToDeletedDate&gt;
99
- &lt;/DeletedDateRangeFilter&gt;
100
- ...
101
- </pre>
102
- <p>
103
- The <a href="../Quickbooks.html">Quickbooks</a> Models define aliases to
104
- these &quot;inside&quot; options. The equivalent to the above [partial] <a
105
- href="Base.html#M000101">request</a>:
106
- </p>
107
- <pre>
108
- Quickbooks::Deleted.all(:deleted_after =&gt; (Time.now - 5*60*60).xmlschema, :deleted_before =&gt; (Time.now - 3*60*60).xmlschema)
109
- </pre>
110
- <p>
111
- (Type-casting hasn&#8216;t made it in yet.)
112
- </p>
113
- <p>
114
- <a href="../Qbxml.html">Qbxml</a> makes a special allowance for <a
115
- href="Deleted.html">Deleted</a> items. Much of the time, we&#8216;d rather
116
- access a model&#8216;s <a href="Base.html#M000105">deleted</a> items
117
- through that model class instead of through the <a
118
- href="Base.html#M000105">deleted</a> class. So <a
119
- href="../Qbxml.html">Qbxml</a> allows any class to ask for its <a
120
- href="Base.html#M000105">deleted</a> items through a call like this:
121
- </p>
122
- <pre>
123
- Quickbooks::Customer.deleted(:deleted_after =&gt; Time.now - 3*60*60)
124
- </pre>
125
-
126
- </div>
127
-
128
-
129
- </div>
130
-
131
- <div id="method-list">
132
- <h3 class="section-bar">Methods</h3>
133
-
134
- <div class="name-list">
135
- <a href="#M000112">==</a>&nbsp;&nbsp;
136
- <a href="#M000103">all</a>&nbsp;&nbsp;
137
- <a href="#M000098">connection</a>&nbsp;&nbsp;
138
- <a href="#M000099">connection=</a>&nbsp;&nbsp;
139
- <a href="#M000106">create</a>&nbsp;&nbsp;
140
- <a href="#M000105">deleted</a>&nbsp;&nbsp;
141
- <a href="#M000111">destroy</a>&nbsp;&nbsp;
142
- <a href="#M000097">establish_connection</a>&nbsp;&nbsp;
143
- <a href="#M000104">first</a>&nbsp;&nbsp;
144
- <a href="#M000102">instantiate</a>&nbsp;&nbsp;
145
- <a href="#M000107">new</a>&nbsp;&nbsp;
146
- <a href="#M000108">new_record?</a>&nbsp;&nbsp;
147
- <a href="#M000100">query</a>&nbsp;&nbsp;
148
- <a href="#M000110">reload</a>&nbsp;&nbsp;
149
- <a href="#M000101">request</a>&nbsp;&nbsp;
150
- <a href="#M000109">save</a>&nbsp;&nbsp;
151
- <a href="#M000095">success?</a>&nbsp;&nbsp;
152
- <a href="#M000096">use_adapter</a>&nbsp;&nbsp;
153
- </div>
154
- </div>
155
-
156
- </div>
157
-
158
-
159
- <!-- if includes -->
160
-
161
- <div id="section">
162
-
163
-
164
-
165
-
166
-
167
- <div id="attribute-list">
168
- <h3 class="section-bar">Attributes</h3>
169
-
170
- <div class="name-list">
171
- <table>
172
- <tr class="top-aligned-row context-row">
173
- <td class="context-item-name">response_log</td>
174
- <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
175
- <td class="context-item-desc">
176
- Stores a log of <a href="../Qbxml/Response.html">Qbxml::Response</a>
177
- objects that were a result of methods performed on this object.
178
-
179
- </td>
180
- </tr>
181
- </table>
182
- </div>
183
- </div>
184
-
185
-
186
-
187
- <!-- if method_list -->
188
- <div id="methods">
189
- <h3 class="section-bar">Public Class methods</h3>
190
-
191
- <div id="method-M000103" class="method-detail">
192
- <a name="M000103"></a>
193
-
194
- <div class="method-heading">
195
- <a href="Base.src/M000103.html" target="Code" class="method-signature"
196
- onclick="popupCode('Base.src/M000103.html');return false;">
197
- <span class="method-name">all</span><span class="method-args">(filters={})</span>
198
- </a>
199
- </div>
200
-
201
- <div class="method-description">
202
- <p>
203
- Queries <a href="../Quickbooks.html">Quickbooks</a> for <a
204
- href="Base.html#M000103">all</a> of the objects of the current
205
- class&#8216;s type. For example, Quickbooks::Customer.all will return an
206
- array of <a href="Customer.html">Quickbooks::Customer</a> objects
207
- representing <a href="Base.html#M000103">all</a> customers.
208
- </p>
209
- </div>
210
- </div>
211
-
212
- <div id="method-M000098" class="method-detail">
213
- <a name="M000098"></a>
214
-
215
- <div class="method-heading">
216
- <a href="Base.src/M000098.html" target="Code" class="method-signature"
217
- onclick="popupCode('Base.src/M000098.html');return false;">
218
- <span class="method-name">connection</span><span class="method-args">()</span>
219
- </a>
220
- </div>
221
-
222
- <div class="method-description">
223
- <p>
224
- Returns the current Connection
225
- </p>
226
- </div>
227
- </div>
228
-
229
- <div id="method-M000099" class="method-detail">
230
- <a name="M000099"></a>
231
-
232
- <div class="method-heading">
233
- <a href="Base.src/M000099.html" target="Code" class="method-signature"
234
- onclick="popupCode('Base.src/M000099.html');return false;">
235
- <span class="method-name">connection=</span><span class="method-args">(conn)</span>
236
- </a>
237
- </div>
238
-
239
- <div class="method-description">
240
- <p>
241
- Sets the current Connection.
242
- </p>
243
- <p>
244
- This is normally not needed, but in the case that you may want to connect a
245
- separate <a href="Base.html#M000098">connection</a> to <a
246
- href="../Quickbooks.html">Quickbooks</a>, you can use this method to
247
- explicitly set the <a href="Base.html#M000098">connection</a> in a class
248
- that inherits from <a href="Base.html">Quickbooks::Base</a>.
249
- </p>
250
- <pre>
251
- Quickbooks::Models::Base.connection = Quickbooks::Connection.new('My Test App', 'C:\\Some File.QBW', 'user', 'pass')
252
- </pre>
253
- </div>
254
- </div>
255
-
256
- <div id="method-M000106" class="method-detail">
257
- <a name="M000106"></a>
258
-
259
- <div class="method-heading">
260
- <a href="Base.src/M000106.html" target="Code" class="method-signature"
261
- onclick="popupCode('Base.src/M000106.html');return false;">
262
- <span class="method-name">create</span><span class="method-args">(*args)</span>
263
- </a>
264
- </div>
265
-
266
- <div class="method-description">
267
- <p>
268
- Creates a <a href="Base.html#M000107">new</a> object of the current
269
- class&#8216;s type. For example, Quickbooks::Customer.create(:name =&gt;
270
- &#8216;Tommy&#8217;) will <a href="Base.html#M000106">create</a> a customer
271
- object with a Name of Tommy.
272
- </p>
273
- </div>
274
- </div>
275
-
276
- <div id="method-M000105" class="method-detail">
277
- <a name="M000105"></a>
278
-
279
- <div class="method-heading">
280
- <a href="Base.src/M000105.html" target="Code" class="method-signature"
281
- onclick="popupCode('Base.src/M000105.html');return false;">
282
- <span class="method-name">deleted</span><span class="method-args">(filters={})</span>
283
- </a>
284
- </div>
285
-
286
- <div class="method-description">
287
- <p>
288
- Still in testing&#8230; these should be equivalent:
289
- </p>
290
- <pre>
291
- Quickbooks::Customer.deleted(:deleted_before =&gt; Time.now) == Quickbooks::Deleted.all(:type =&gt; 'Customer', :deleted_before =&gt; Time.now)
292
- </pre>
293
- </div>
294
- </div>
295
-
296
- <div id="method-M000097" class="method-detail">
297
- <a name="M000097"></a>
298
-
299
- <div class="method-heading">
300
- <a href="Base.src/M000097.html" target="Code" class="method-signature"
301
- onclick="popupCode('Base.src/M000097.html');return false;">
302
- <span class="method-name">establish_connection</span><span class="method-args">(*args)</span>
303
- </a>
304
- </div>
305
-
306
- <div class="method-description">
307
- <p>
308
- Establishes a <a href="Base.html#M000098">connection</a> to the <a
309
- href="../Quickbooks.html">Quickbooks</a> RDS Server for <a
310
- href="Base.html#M000103">all</a> <a href="Model.html">Model</a> Classes
311
- </p>
312
- </div>
313
- </div>
314
-
315
- <div id="method-M000104" class="method-detail">
316
- <a name="M000104"></a>
317
-
318
- <div class="method-heading">
319
- <a href="Base.src/M000104.html" target="Code" class="method-signature"
320
- onclick="popupCode('Base.src/M000104.html');return false;">
321
- <span class="method-name">first</span><span class="method-args">(filters={})</span>
322
- </a>
323
- </div>
324
-
325
- <div class="method-description">
326
- <p>
327
- Queries <a href="../Quickbooks.html">Quickbooks</a> for the <a
328
- href="Base.html#M000104">first</a> object of the current class&#8216;s
329
- type. For example, Quickbooks::Customer.first will return a <a
330
- href="Customer.html">Quickbooks::Customer</a> object representing the <a
331
- href="Base.html#M000104">first</a> customer.
332
- </p>
333
- </div>
334
- </div>
335
-
336
- <div id="method-M000102" class="method-detail">
337
- <a name="M000102"></a>
338
-
339
- <div class="method-heading">
340
- <a href="Base.src/M000102.html" target="Code" class="method-signature"
341
- onclick="popupCode('Base.src/M000102.html');return false;">
342
- <span class="method-name">instantiate</span><span class="method-args">(obj_or_attrs={},attrs={})</span>
343
- </a>
344
- </div>
345
-
346
- <div class="method-description">
347
- <p>
348
- Instantiate a <a href="Base.html#M000107">new</a> object with just
349
- attributes, or an existing object replacing the attributes
350
- </p>
351
- </div>
352
- </div>
353
-
354
- <div id="method-M000107" class="method-detail">
355
- <a name="M000107"></a>
356
-
357
- <div class="method-heading">
358
- <a href="Base.src/M000107.html" target="Code" class="method-signature"
359
- onclick="popupCode('Base.src/M000107.html');return false;">
360
- <span class="method-name">new</span><span class="method-args">(*args)</span>
361
- </a>
362
- </div>
363
-
364
- <div class="method-description">
365
- <p>
366
- Generates a <a href="Base.html#M000107">new</a> object that can be saved
367
- into <a href="../Quickbooks.html">Quickbooks</a> once the required
368
- attributes are set.
369
- </p>
370
- </div>
371
- </div>
372
-
373
- <div id="method-M000100" class="method-detail">
374
- <a name="M000100"></a>
375
-
376
- <div class="method-heading">
377
- <a href="Base.src/M000100.html" target="Code" class="method-signature"
378
- onclick="popupCode('Base.src/M000100.html');return false;">
379
- <span class="method-name">query</span><span class="method-args">(obj_or_args,*args)</span>
380
- </a>
381
- </div>
382
-
383
- <div class="method-description">
384
- <p>
385
- Generates a <a href="Base.html#M000101">request</a> by sending *args to
386
- Qbxml::Request.new, sends the <a href="Base.html#M000101">request</a> over
387
- the current <a href="Base.html#M000098">connection</a>, and interprets the
388
- response using <a href="../Qbxml/ResponseSet.html">Qbxml::ResponseSet</a>.
389
- The response is then instantiated into an object or an array of objects.
390
- </p>
391
- <p>
392
- This method is used mostly internally, but it is the yoke of this library -
393
- use it to perform custom requests.
394
- </p>
395
- </div>
396
- </div>
397
-
398
- <div id="method-M000101" class="method-detail">
399
- <a name="M000101"></a>
400
-
401
- <div class="method-heading">
402
- <a href="Base.src/M000101.html" target="Code" class="method-signature"
403
- onclick="popupCode('Base.src/M000101.html');return false;">
404
- <span class="method-name">request</span><span class="method-args">(*args)</span>
405
- </a>
406
- </div>
407
-
408
- <div class="method-description">
409
- <p>
410
- Generates a <a href="Base.html#M000101">request</a> using <a
411
- href="../Qbxml/Request.html">Qbxml::Request</a>, sends it, and returns a <a
412
- href="../Qbxml/ResponseSet.html">Qbxml::ResponseSet</a> object containing
413
- the response(s).
414
- </p>
415
- </div>
416
- </div>
417
-
418
- <div id="method-M000096" class="method-detail">
419
- <a name="M000096"></a>
420
-
421
- <div class="method-heading">
422
- <a href="Base.src/M000096.html" target="Code" class="method-signature"
423
- onclick="popupCode('Base.src/M000096.html');return false;">
424
- <span class="method-name">use_adapter</span><span class="method-args">(adapter)</span>
425
- </a>
426
- </div>
427
-
428
- <div class="method-description">
429
- </div>
430
- </div>
431
-
432
- <h3 class="section-bar">Public Instance methods</h3>
433
-
434
- <div id="method-M000112" class="method-detail">
435
- <a name="M000112"></a>
436
-
437
- <div class="method-heading">
438
- <a href="Base.src/M000112.html" target="Code" class="method-signature"
439
- onclick="popupCode('Base.src/M000112.html');return false;">
440
- <span class="method-name">==</span><span class="method-args">(other)</span>
441
- </a>
442
- </div>
443
-
444
- <div class="method-description">
445
- <p>
446
- Usual comparison (super), but add in false if either is a <a
447
- href="Base.html#M000107">new</a> record.
448
- </p>
449
- </div>
450
- </div>
451
-
452
- <div id="method-M000111" class="method-detail">
453
- <a name="M000111"></a>
454
-
455
- <div class="method-heading">
456
- <a href="Base.src/M000111.html" target="Code" class="method-signature"
457
- onclick="popupCode('Base.src/M000111.html');return false;">
458
- <span class="method-name">destroy</span><span class="method-args">()</span>
459
- </a>
460
- </div>
461
-
462
- <div class="method-description">
463
- <p>
464
- Destroys a record in <a href="../Quickbooks.html">Quickbooks</a>. Note that
465
- even though <a href="../Quickbooks.html">Quickbooks</a> will <a
466
- href="Base.html#M000111">destroy</a> the record, the record&#8216;s ListID
467
- and DeletedTime can be accessed by doing a <a
468
- href="Base.html#M000100">query</a> for <a
469
- href="Base.html#M000105">deleted</a> objects of the appropriate type.
470
- </p>
471
- </div>
472
- </div>
473
-
474
- <div id="method-M000108" class="method-detail">
475
- <a name="M000108"></a>
476
-
477
- <div class="method-heading">
478
- <a href="Base.src/M000108.html" target="Code" class="method-signature"
479
- onclick="popupCode('Base.src/M000108.html');return false;">
480
- <span class="method-name">new_record?</span><span class="method-args">()</span>
481
- </a>
482
- </div>
483
-
484
- <div class="method-description">
485
- <p>
486
- Returns true if the object is a <a href="Base.html#M000107">new</a> object
487
- (that doesn&#8216;t represent an existing object in <a
488
- href="../Quickbooks.html">Quickbooks</a>).
489
- </p>
490
- </div>
491
- </div>
492
-
493
- <div id="method-M000110" class="method-detail">
494
- <a name="M000110"></a>
495
-
496
- <div class="method-heading">
497
- <a href="Base.src/M000110.html" target="Code" class="method-signature"
498
- onclick="popupCode('Base.src/M000110.html');return false;">
499
- <span class="method-name">reload</span><span class="method-args">()</span>
500
- </a>
501
- </div>
502
-
503
- <div class="method-description">
504
- <p>
505
- Reloads the record from <a href="../Quickbooks.html">Quickbooks</a>,
506
- discarding any changes that have been made to it.
507
- </p>
508
- </div>
509
- </div>
510
-
511
- <div id="method-M000109" class="method-detail">
512
- <a name="M000109"></a>
513
-
514
- <div class="method-heading">
515
- <a href="Base.src/M000109.html" target="Code" class="method-signature"
516
- onclick="popupCode('Base.src/M000109.html');return false;">
517
- <span class="method-name">save</span><span class="method-args">()</span>
518
- </a>
519
- </div>
520
-
521
- <div class="method-description">
522
- <p>
523
- Saves the attributes that have changed.
524
- </p>
525
- <p>
526
- If the EditSequence is out of date but none of the changes conflict, the
527
- object will be saved to <a href="../Quickbooks.html">Quickbooks</a>. But if
528
- there are conflicts, the updated values from <a
529
- href="../Quickbooks.html">Quickbooks</a> will be written to the
530
- original_values, and false is returned. This way you can deal with the
531
- differences (conflicts), if you so desire, and simply call <a
532
- href="Base.html#M000109">save</a> again to commit your changes.
533
- </p>
534
- </div>
535
- </div>
536
-
537
- <div id="method-M000095" class="method-detail">
538
- <a name="M000095"></a>
539
-
540
- <div class="method-heading">
541
- <a href="Base.src/M000095.html" target="Code" class="method-signature"
542
- onclick="popupCode('Base.src/M000095.html');return false;">
543
- <span class="method-name">success?</span><span class="method-args">()</span>
544
- </a>
545
- </div>
546
-
547
- <div class="method-description">
548
- <p>
549
- Returns success (true/false) status of the last quickbooks communication
550
- called from this object.
551
- </p>
552
- </div>
553
- </div>
554
-
555
-
556
- </div>
557
-
558
-
559
- </div>
560
-
561
-
562
- <div id="validator-badges">
563
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
564
- </div>
565
-
566
- </body>
567
- </html>