mrglass-qbxml 1.0.0

data/spec/support/responses/receive_payment_query_rs.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+<QBXML>
+  <QBXMLMsgsRs>
+    <ReceivePaymentQueryRs requestID="UmVjZWl2ZVBheW1lbnRRdWVyeXwyNDg0LTEyNjM0OTkyMzE=" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
+      <ReceivePaymentRet>
+        <TxnID>2484-1263499231</TxnID>
+        <TimeCreated>2010-01-14T12:00:31-08:00</TimeCreated>
+        <TimeModified>2010-10-03T19:15:35-08:00</TimeModified>
+        <EditSequence>1286158535</EditSequence>
+        <TxnNumber>1664</TxnNumber>
+        <CustomerRef>
+          <ListID>800002FB-1263497272</ListID>
+          <FullName>Greg F</FullName>
+        </CustomerRef>
+        <ARAccountRef>
+          <ListID>80000068-1257362264</ListID>
+          <FullName>Accounts Receivable - USD</FullName>
+        </ARAccountRef>
+        <TxnDate>2009-10-02</TxnDate>
+        <RefNumber>101</RefNumber>
+        <TotalAmount>112.35</TotalAmount>
+        <PaymentMethodRef>
+          <ListID>80000005-1257354059</ListID>
+          <FullName>Visa</FullName>
+        </PaymentMethodRef>
+        <DepositToAccountRef>
+          <ListID>8000006A-1257362708</ListID>
+          <FullName>Undeposited Funds</FullName>
+        </DepositToAccountRef>
+        <CreditCardTxnInfo>
+          <CreditCardTxnInputInfo>
+            <CreditCardNumber>xxxxxxxxxxxx1234</CreditCardNumber>
+            <ExpirationMonth>1</ExpirationMonth>
+            <ExpirationYear>2011</ExpirationYear>
+            <TransactionMode>CardNotPresent</TransactionMode>
+          </CreditCardTxnInputInfo>
+        </CreditCardTxnInfo>
+        <UnusedPayment>0.00</UnusedPayment>
+        <UnusedCredits>0.00</UnusedCredits>
+        <AppliedToTxnRet>
+          <TxnID>244B-1263497335</TxnID>
+          <TxnType>Invoice</TxnType>
+          <TxnDate>2009-09-30</TxnDate>
+          <RefNumber>OP13988</RefNumber>
+          <BalanceRemaining>0.00</BalanceRemaining>
+          <Amount>112.35</Amount>
+        </AppliedToTxnRet>
+      </ReceivePaymentRet>
+    </ReceivePaymentQueryRs>
+  </QBXMLMsgsRs>
+</QBXML>

data/spec/support/responses/sales_receipt_add_rs.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" ?>
+<QBXML>
+  <QBXMLMsgsRs>
+    <SalesReceiptAddRs requestID="U2FsZXNSZWNlaXB0QWRkfDE2NDY2" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
+      <SalesReceiptRet>
+        <TxnID>141CA5-1231522949</TxnID>
+        <TimeCreated>2009-01-09T12:42:29-05:00</TimeCreated>
+        <TimeModified>2009-01-09T12:42:29-05:00</TimeModified>
+        <EditSequence>1231522949</EditSequence>
+        <TxnNumber>64951</TxnNumber>
+        <CustomerRef>
+          <ListID>80003579-1231522938</ListID>
+          <FullName>Test, Tom</FullName>
+        </CustomerRef>
+        <TemplateRef>
+          <ListID>E0000-1129903256</ListID>
+          <FullName>Custom Sales Receipt</FullName>
+        </TemplateRef>
+        <TxnDate>2009-01-09</TxnDate>
+        <RefNumber>16466</RefNumber>
+        <BillAddress>
+          <Addr1>Tom Test</Addr1>
+          <Addr2>123 Test St</Addr2>
+          <City>Concord</City>
+          <State>MA</State>
+          <PostalCode>01742</PostalCode>
+          <Country>USA</Country>
+        </BillAddress>
+        <BillAddressBlock>
+          <Addr1>Tom Test</Addr1>
+          <Addr3>123 Test St</Addr3>
+          <Addr4>Concord, Massachusetts 01742</Addr4>
+          <Addr5>United States</Addr5>
+        </BillAddressBlock>
+        <IsPending>true</IsPending>
+        <DueDate>2009-01-09</DueDate>
+        <ShipDate>2009-01-09</ShipDate>
+        <Subtotal>150.00</Subtotal>
+        <ItemSalesTaxRef>
+          <ListID>20C0000-1129494968</ListID>
+          <FullName>MA State Tax</FullName>
+        </ItemSalesTaxRef>
+        <SalesTaxPercentage>5.00</SalesTaxPercentage>
+        <SalesTaxTotal>0.00</SalesTaxTotal>
+        <TotalAmount>150.00</TotalAmount>
+        <IsToBePrinted>true</IsToBePrinted>
+        <IsToBeEmailed>false</IsToBeEmailed>
+        <CustomerSalesTaxCodeRef>
+          <ListID>10000-1128983215</ListID>
+          <FullName>Tax</FullName>
+        </CustomerSalesTaxCodeRef>
+        <DepositToAccountRef>
+          <ListID>960000-1129903123</ListID>
+          <FullName>*Undeposited Funds</FullName>
+        </DepositToAccountRef>
+        <SalesReceiptLineRet>
+          <TxnLineID>141CA7-1231522949</TxnLineID>
+          <ItemRef>
+            <ListID>200001-1143815300</ListID>
+            <FullName>gift certificate</FullName>
+          </ItemRef>
+          <Desc>$150.00 gift certificate</Desc>
+          <Quantity>1</Quantity>
+          <Rate>150.00</Rate>
+          <Amount>150.00</Amount>
+          <SalesTaxCodeRef>
+            <ListID>20000-1128983215</ListID>
+            <FullName>Non</FullName>
+          </SalesTaxCodeRef>
+        </SalesReceiptLineRet>
+        <SalesReceiptLineRet>
+          <TxnLineID>141CA9-1231522949</TxnLineID>
+          <ItemRef>
+            <ListID>80000857-1231503074</ListID>
+            <FullName>Handling Item - QuickBooks Inte</FullName>
+          </ItemRef>
+          <Desc>Handling Charge</Desc>
+          <Rate>0.00</Rate>
+          <Amount>0.00</Amount>
+          <SalesTaxCodeRef>
+            <ListID>20000-1128983215</ListID>
+            <FullName>Non</FullName>
+          </SalesTaxCodeRef>
+        </SalesReceiptLineRet>
+      </SalesReceiptRet>
+    </SalesReceiptAddRs>
+  </QBXMLMsgsRs>
+</QBXML>
+

data/test/unit/hash_to_xml_test.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class HashToXmlTest < Minitest::Test
+
+  def test_hash_to_xml_customer_query
+    qbxml = Qbxml.new
+    assert_equal "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <CustomerQueryRq>\n      <ListID>GUID-GOES-HERE</ListID>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n", qbxml.to_qbxml({:qbxml => {:qbxml_msgs_rq => {:customer_query_rq => {:list_id => 'GUID-GOES-HERE'}}}})
+  end
+
+  def test_hash_to_xml_invoice_mod
+    qbxml = Qbxml.new
+    xml = <<-EOF
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<?qbxml version="7.0"?>
+<QBXML>
+  <QBXMLMsgsRq>
+    <InvoiceModRq>
+      <InvoiceMod>
+        <TxnID>1929B9-1423150873</TxnID>
+        <EditSequence/>
+        <CustomerRef>
+          <ListID>4A50001-1013529664</ListID>
+        </CustomerRef>
+        <TxnDate>2015-01-28</TxnDate>
+        <RefNumber>12345678</RefNumber>
+        <Memo></Memo>
+        <InvoiceLineMod>
+          <TxnLineID>-1</TxnLineID>
+          <ItemRef>
+            <FullName>Sales</FullName>
+          </ItemRef>
+          <Desc>Contract 123</Desc>
+          <Quantity>23.44165</Quantity>
+          <Rate>515.0</Rate>
+          <SalesTaxCodeRef>
+            <FullName>E</FullName>
+          </SalesTaxCodeRef>
+        </InvoiceLineMod>
+      </InvoiceMod>
+    </InvoiceModRq>
+  </QBXMLMsgsRq>
+</QBXML>
+    EOF
+    assert_equal xml, qbxml.to_qbxml({:invoice_mod_rq=>{:invoice_mod=>{:txn_id=>"1929B9-1423150873", :edit_sequence=>nil, :customer_ref=>{:list_id=>"4A50001-1013529664"}, :txn_date=>"2015-01-28", :ref_number=>"12345678", :memo=>"", :invoice_line_mod=>[{:txn_line_id=>-1, :item_ref=>{:full_name=>"Sales"}, :desc=>"Contract 123", :quantity=>"23.44165", :rate=> 515.0, :sales_tax_code_ref=>{:full_name=>"E"}}]}}})
+  end
+
+  def test_hash_to_xml_customer_add
+    qbxml = Qbxml.new
+    xml = <<-EOF
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<?qbxml version="7.0"?>
+<QBXML>
+  <QBXMLMsgsRq>
+    <CustomerAddRq>
+      <CustomerAdd>
+        <Name>Joe Blow</Name>
+        <CompanyName>Joe Blow Inc.</CompanyName>
+        <BillAddress>
+          <Addr1>123 Fake Street</Addr1>
+          <City>Springfield</City>
+          <State>Texachussets</State>
+          <PostalCode>99999</PostalCode>
+          <Country>USA</Country>
+        </BillAddress>
+      </CustomerAdd>
+    </CustomerAddRq>
+  </QBXMLMsgsRq>
+</QBXML>
+    EOF
+    assert_equal xml, qbxml.to_qbxml({:customer_add_rq=>{:customer_add=>{:name=>"Joe Blow", :company_name=>"Joe Blow Inc.", :bill_address=>{:addr1=>"123 Fake Street", :city=>"Springfield", :state=>"Texachussets", :postal_code=>"99999", :country=>"USA"}}}})
+  end
+
+  def test_array_of_strings
+    assert_equal "<foo>\n  <bar>baz</bar>\n  <bar>guh</bar>\n</foo>\n", Qbxml::Hash.to_xml({:foo => {:bar => ['baz', 'guh']}}, {skip_instruct: true})
+  end
+
+end

data/test/unit/version_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class VersionTest < Minitest::Test
+
+  def test_string_version
+    Qbxml.new(:qb, '7.0')
+  end
+
+  def test_bad_version
+    assert_raises RuntimeError do
+      Qbxml.new(:qb, '3.14')
+    end
+  end
+
+  def test_float_version
+    Qbxml.new(:qb, 7.0)
+  end
+
+  def test_int_version
+    Qbxml.new(:qb, 7)
+  end
+
+end

data/test/unit/xml_to_hash_test.rb

@@ -0,0 +1,281 @@
+require 'minitest/autorun'
+require 'qbxml'
+
+class XmlToHashTest < Minitest::Test
+
+  def test_xml_to_hash
+    qbxml = Qbxml.new
+    h = {"qbxml"=>{"xml_attributes"=>{}, "qbxml_msgs_rq"=>{"xml_attributes"=>{}, "customer_query_rq"=>{"xml_attributes"=>{}, "list_id"=>"GUID-GOES-HERE"}}}}
+    assert_equal h, qbxml.from_qbxml("<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <CustomerQueryRq>\n      <ListID>GUID-GOES-HERE</ListID>\n    </CustomerQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n")
+  end
+
+  def test_array_of_strings
+    qbxml = Qbxml.new
+    h = {
+      "qbxml" => {
+        "xml_attributes" => {},
+        "qbxml_msgs_rq" => {
+          "xml_attributes" => {},
+          'invoice_query_rq' => {
+            "xml_attributes" => {},
+            'include_ret_element' => ['TxnID', 'RefNumber']
+          }
+        }
+      }
+    }
+    assert_equal h, qbxml.from_qbxml("<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRq>\n    <InvoiceQueryRq>\n      <IncludeRetElement>TxnID</IncludeRetElement>\n    <IncludeRetElement>RefNumber</IncludeRetElement>\n    </InvoiceQueryRq>\n  </QBXMLMsgsRq>\n</QBXML>\n")
+  end
+
+  def test_array_with_one_element
+    qbxml = Qbxml.new
+    h = {
+      "qbxml" => {
+        "xml_attributes" => {},
+        "qbxml_msgs_rs" => {
+          "xml_attributes" => {},
+          'customer_query_rs' => {
+            "xml_attributes" => {},
+            'customer_ret' => [{
+              "xml_attributes"=> {},
+              'list_id' => 'abc'
+            }]
+          }
+        }
+      }
+    }
+    assert_equal h, qbxml.from_qbxml("<?qbxml version=\"7.0\"?>\n<QBXML>\n  <QBXMLMsgsRs>\n    <CustomerQueryRs>\n      <CustomerRet><ListID>abc</ListID></CustomerRet>\n    </CustomerQueryRs>\n  </QBXMLMsgsRs>\n</QBXML>\n")
+  end
+
+  def test_float_percentage
+    qbxml = Qbxml.new
+    h = {
+      "qbxml" => {
+        "xml_attributes" => {},
+        "qbxml_msgs_rs" => {
+          "xml_attributes" => {},
+          "item_query_rs" => {
+            "xml_attributes" => {
+              "requestID" => "Retrieve items",
+              "statusCode" => "0",
+              "statusSeverity" => "Info",
+              "statusMessage" => "Status OK",
+              "iteratorRemainingCount" => "0",
+              "iteratorID" => "{10c05cbd-b25b-4a85-8aa0-8bce89e6e900}"
+            },
+            "item_service_ret" => {
+              "xml_attributes" => {},
+              "list_id" => "80000005-1468535148",
+              "time_created" => "2016-07-14T15:25:48+00:00",
+              "time_modified" => "2016-07-14T15:25:48+00:00",
+              "edit_sequence" => "1468535148",
+              "name" => "let's get intuit",
+              "full_name" => "let's get intuit",
+              "is_active" => true,
+              "sublevel" => 0,
+              "sales_or_purchase" => {
+                "xml_attributes" => {},
+                "price_percent" => 18.0,
+                "account_ref" => {
+                  "xml_attributes" => {},
+                  "list_id" => "80000015-1457547358",
+                  "full_name" => "Repairs and Maintenance"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+
+    xml = <<-XML
+      <QBXML>
+        <QBXMLMsgsRs>
+          <ItemQueryRs requestID="Retrieve items"
+                       statusCode="0"
+                       statusSeverity="Info"
+                       statusMessage="Status OK"
+                       iteratorRemainingCount="0"
+                       iteratorID="{10c05cbd-b25b-4a85-8aa0-8bce89e6e900}">
+            <ItemServiceRet>
+              <ListID>80000005-1468535148</ListID>
+              <TimeCreated>2016-07-14T15:25:48+00:00</TimeCreated>
+              <TimeModified>2016-07-14T15:25:48+00:00</TimeModified>
+              <EditSequence>1468535148</EditSequence>
+              <Name>let's get intuit</Name>
+              <FullName>let's get intuit</FullName>
+              <IsActive>true</IsActive>
+              <Sublevel>0</Sublevel>
+              <SalesOrPurchase>
+                <PricePercent>18.0%</PricePercent>
+                <AccountRef>
+                  <ListID>80000015-1457547358</ListID>
+                  <FullName>Repairs and Maintenance</FullName>
+                </AccountRef>
+              </SalesOrPurchase>
+            </ItemServiceRet>
+          </ItemQueryRs>
+        </QBXMLMsgsRs>
+      </QBXML>
+    XML
+
+    assert_equal h, qbxml.from_qbxml(xml)
+  end
+
+  def test_bigdecimal
+    injected_time = Time.now.strftime("%Y-%m-%dT%H:%M:%S%:z")
+
+    qbxml = Qbxml.new
+    h = {
+      "qbxml" => {
+        "xml_attributes" => {},
+        "qbxml_msgs_rs"=> {
+          "xml_attributes" => {},
+          "sales_receipt_add_rs" => {
+            "xml_attributes" => {
+              "statusCode" => "0",
+              "statusSeverity" => "Info",
+              "statusMessage" => "Status OK"
+            },
+            "sales_receipt_ret" => {
+              "xml_attributes" => {},
+              "txn_id" => "1C0-1433857054",
+              "time_created" => injected_time,
+              "time_modified" => injected_time,
+              "edit_sequence" => "1433850554",
+              "txn_number" => 89,
+              "customer_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "80000013-1433852150",
+                "full_name" => "custfullname"
+              },
+              "template_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "80000009-1433199758",
+                "full_name" => "Custom Sales Receipt"
+              },
+              "txn_date" => "2019-06-09",
+              "ref_number" => "1040000529",
+              "is_pending" => false,
+              "payment_method_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "8000000A-1433718272",
+                "full_name" => "paymentmethod"
+              },
+              "due_date" => "2019-06-09",
+              "ship_date" => "2019-06-09",
+              "subtotal" => 0.2,
+              "item_sales_tax_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "80000009-1433719484",
+                "full_name" => "Tax agency"
+              },
+              "sales_tax_percentage" => 8.25,
+              "sales_tax_total" => 0.02,
+              "total_amount" => 0.22,
+              "is_to_be_printed" => true,
+              "is_to_be_emailed" => false,
+              "customer_sales_tax_code_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "80000002-1403304324",
+                "full_name" => "Non"
+              },
+              "deposit_to_account_ref" => {
+                "xml_attributes" => {},
+                "list_id" => "8000003D-1433719666",
+                "full_name" => "Undeposited Funds"
+              },
+              "sales_receipt_line_ret" => {
+                "xml_attributes" => {},
+                "txn_line_id" => "1C2-1433632154",
+                "item_ref" => {
+                  "xml_attributes" => {},
+                  "list_id" => "8000001F-1433854453",
+                  "full_name" => "ABCD0000"
+                },
+                "desc" => "description",
+                "quantity" => 0.2,
+                "rate" => 1.0,
+                "amount" => 0.2,
+                "service_date" => "2019-06-09",
+                "sales_tax_code_ref"=> {
+                  "xml_attributes" => {},
+                  "list_id" => "80000001-1403304324",
+                  "full_name"=>"Tax"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+
+    xml = <<-XML
+      <QBXML>
+        <QBXMLMsgsRs>
+          <SalesReceiptAddRs statusCode="0" statusSeverity="Info" statusMessage="Status OK">
+              <SalesReceiptRet>
+                <TxnID>1C0-1433857054</TxnID>
+                <TimeCreated>#{injected_time}</TimeCreated>
+                <TimeModified>#{injected_time}</TimeModified>
+                <EditSequence>1433850554</EditSequence>
+                <TxnNumber>89</TxnNumber>
+                <CustomerRef>
+                  <ListID>80000013-1433852150</ListID>
+                  <FullName>custfullname</FullName>
+                </CustomerRef>
+                <TemplateRef>
+                  <ListID>80000009-1433199758</ListID>
+                  <FullName>Custom Sales Receipt</FullName>
+                </TemplateRef>
+                <TxnDate>2019-06-09</TxnDate>
+                <RefNumber>1040000529</RefNumber>
+                <IsPending>false</IsPending>
+                <PaymentMethodRef>
+                  <ListID>8000000A-1433718272</ListID>
+                  <FullName>paymentmethod</FullName>
+                </PaymentMethodRef>
+                <DueDate>2019-06-09</DueDate>
+                <ShipDate>2019-06-09</ShipDate>
+                <Subtotal>0.20</Subtotal>
+                <ItemSalesTaxRef>
+                  <ListID>80000009-1433719484</ListID>
+                  <FullName>Tax agency</FullName>
+                </ItemSalesTaxRef>
+                <SalesTaxPercentage>8.25</SalesTaxPercentage>
+                <SalesTaxTotal>0.02</SalesTaxTotal>
+                <TotalAmount>0.22</TotalAmount>
+                <IsToBePrinted>true</IsToBePrinted>
+                <IsToBeEmailed>false</IsToBeEmailed>
+                <CustomerSalesTaxCodeRef>
+                  <ListID>80000002-1403304324</ListID>
+                  <FullName>Non</FullName>
+                </CustomerSalesTaxCodeRef>
+                <DepositToAccountRef>
+                  <ListID>8000003D-1433719666</ListID>
+                  <FullName>Undeposited Funds</FullName>
+                </DepositToAccountRef>
+                <SalesReceiptLineRet>
+                  <TxnLineID>1C2-1433632154</TxnLineID>
+                  <ItemRef>
+                    <ListID>8000001F-1433854453</ListID>
+                    <FullName>ABCD0000</FullName>
+                  </ItemRef>
+                  <Desc>description</Desc>
+                  <Quantity>0.2</Quantity>
+                  <Rate>1.00</Rate>
+                  <Amount>0.20</Amount>
+                  <ServiceDate>2019-06-09</ServiceDate>
+                  <SalesTaxCodeRef>
+                    <ListID>80000001-1403304324</ListID>
+                    <FullName>Tax</FullName>
+                  </SalesTaxCodeRef>
+                </SalesReceiptLineRet>
+              </SalesReceiptRet>
+          </SalesReceiptAddRs>
+        </QBXMLMsgsRs>
+      </QBXML>
+    XML
+
+    assert_equal h, qbxml.from_qbxml(xml)
+  end
+end