xeroizer 0.3.5 → 0.4.0

data/test/unit/models/bank_transaction_model_parsing_test.rb

@@ -0,0 +1,131 @@
+require "test_helper"
+
+class BankTransactionModelParsingTest < Test::Unit::TestCase
+  def setup
+    # See lib/xeroizer/record/base_model.rb
+    @instance = Xeroizer::Record::BankTransactionModel.new(nil, "BankTransaction")
+  end
+
+  must "parse all the root elements except sub_total, total_tax and total" do
+    some_xml = "
+     <Response>
+        <BankTransactions>
+          <BankTransaction>
+            <Date>2010-07-30T00:00:00</Date>
+            <LineAmountTypes>Inclusive</LineAmountTypes>
+            <SubTotal>15.00</SubTotal>
+            <TotalTax>0.00</TotalTax>
+            <Total>15.00</Total>
+            <UpdatedDateUTC>2008-02-20T12:19:56.657</UpdatedDateUTC>
+            <FullyPaidOnDate>2010-07-30T00:00:00</FullyPaidOnDate>
+            <BankTransactionID>d20b6c54-7f5d-4ce6-ab83-55f609719126</BankTransactionID>
+            <Type>SPEND</Type>
+            <IsReconciled>true</IsReconciled>
+          </BankTransaction>
+        </BankTransactions>
+    </Response>"
+
+    result = @instance.parse_response(some_xml)
+
+    the_bank_transaction = result.response_items.first
+
+    assert_equal Date.parse("2010-07-30T00:00:00"), the_bank_transaction.date
+    assert_equal "Inclusive", the_bank_transaction.line_amount_types
+    assert_equal Date.parse("2008-02-20T12:19:56.657"), the_bank_transaction.updated_date_utc
+    assert_equal Date.parse("2010-07-30T00:00:00"), the_bank_transaction.fully_paid_on_date
+    assert_equal "d20b6c54-7f5d-4ce6-ab83-55f609719126", the_bank_transaction.bank_transaction_id
+    assert_equal "SPEND", the_bank_transaction.type
+    assert the_bank_transaction.reconciled?, "Expected reconciled to be true"
+  end
+
+  must "parse the contact" do
+    some_xml_with_a_contact = "
+     <Response>
+        <BankTransactions>
+          <BankTransaction>
+            <Contact>
+              <ContactID>c09661a2-a954-4e34-98df-f8b6d1dc9b19</ContactID>
+              <ContactStatus>ACTIVE</ContactStatus>
+              <Name>BNZ</Name>
+              <Addresses>
+                <Address>
+                  <AddressType>POBOX</AddressType>
+                </Address>
+                <Address>
+                  <AddressType>STREET</AddressType>
+                </Address>
+              </Addresses>
+              <Phones>
+                <Phone>
+                  <PhoneType>MOBILE</PhoneType>
+                </Phone>
+              </Phones>
+              <UpdatedDateUTC>2010-09-17T19:26:39.157</UpdatedDateUTC>
+            </Contact>
+          </BankTransaction>
+        </BankTransactions>
+    </Response>"
+
+    result = @instance.parse_response(some_xml_with_a_contact)
+    the_bank_transaction = result.response_items.first
+    the_contact = the_bank_transaction.contact
+
+    assert_equal(
+      "c09661a2-a954-4e34-98df-f8b6d1dc9b19",
+      the_contact.contact_id,
+      "Mismatched contact id for contact: #{the_contact.inspect}"
+    )
+  end
+
+  must "parse the correct number of line items" do
+    some_xml_with_a_line_item = "
+     <Response>
+        <BankTransactions>
+          <BankTransaction>
+            <LineItems>
+              <LineItem>
+                <Description>Monthly account fee</Description>
+                <UnitAmount>15</UnitAmount>
+                <TaxType>NONE</TaxType>
+                <TaxAmount>0.00</TaxAmount>
+                <LineAmount>15.00</LineAmount>
+                <AccountCode>404</AccountCode>
+                <Quantity>1.0000</Quantity>
+              </LineItem>
+            </LineItems>
+          </BankTransaction>
+        </BankTransactions>
+    </Response>"
+
+    result = @instance.parse_response(some_xml_with_a_line_item)
+    the_bank_transaction = result.response_items.first
+
+    assert_equal(1, the_bank_transaction.line_items.size,
+      "Mismatched number of line items: #{the_bank_transaction.inspect}"
+    )
+  end
+
+  must "parse the bank account" do
+    some_xml_with_a_bank_account = "
+     <Response>
+        <BankTransactions>
+          <BankTransaction>
+            <BankAccount>
+              <AccountID>297c2dc5-cc47-4afd-8ec8-74990b8761e9</AccountID>
+              <Code>BANK</Code>
+            </BankAccount>
+          </BankTransaction>
+        </BankTransactions>
+    </Response>"
+
+    result = @instance.parse_response(some_xml_with_a_bank_account)
+    the_bank_transaction = result.response_items.first
+
+    assert_not_nil(the_bank_transaction.bank_account,
+      "Missing bank_account: #{the_bank_transaction.inspect}"
+    )
+
+    assert_equal "297c2dc5-cc47-4afd-8ec8-74990b8761e9", the_bank_transaction.bank_account.account_id,
+      "Unexpected bank account id: #{the_bank_transaction.inspect}"
+  end
+end

data/test/unit/models/bank_transaction_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+
+class BankTransactionTest < Test::Unit::TestCase
+  include Xeroizer::Record
+
+  def setup
+    fake_parent = Class.new do
+      attr_accessor :application
+    end.new
+
+    the_line_items = [
+      LineItem.build({:quantity => 1, :tax_amount => 0.15, :unit_amount => 1.00, :tax_amount => 0.50}, nil),
+      LineItem.build({:quantity => 1, :tax_amount => 0.15, :unit_amount => 1.00, :tax_amount => 0.50}, nil)
+    ]
+
+    @the_bank_transaction = BankTransaction.new fake_parent
+    @the_bank_transaction.line_items = the_line_items
+  end
+
+  context "given a bank_transaction with line_amount_types set to \"Exclusive\"" do
+    setup do
+      @the_bank_transaction.line_amount_types = "Exclusive"
+    end
+
+    must "calculate the total as the sum of its line item line_amount and tax_amount" do
+      assert_equal "3.0", @the_bank_transaction.total.to_s
+    end
+
+    must "calculate the sub_total as the sum of the line_amounts" do
+      assert_equal "2.0", @the_bank_transaction.sub_total.to_s
+    end
+  end
+
+  context "given a bank_transaction with line_amount_types set to \"Inclusive\"" do
+    setup do
+      @the_bank_transaction.line_amount_types = "Inclusive"
+    end
+
+    must "calculate the total as the sum of its line item line_amount and tax_amount" do
+      assert_equal "2.0", @the_bank_transaction.total.to_s
+    end
+
+    must "calculate the sub_total as the sum of the line_amounts minus the total tax" do
+      assert_equal "1.0", @the_bank_transaction.sub_total.to_s
+    end
+  end
+end

data/test/unit/models/bank_transaction_validation_test.rb

@@ -0,0 +1,87 @@
+require "test_helper"
+
+class BankTransactionValidationTest < Test::Unit::TestCase
+  include Xeroizer::Record
+
+  must "supply either SPEND or RECEIVE as the type" do
+    instance = BankTransaction.build({:type => "xxx"}, nil)
+    
+    assert false == instance.valid?, "Expected invalid because of invalid type"
+    
+    expected_error = "Invalid type. Expected either SPEND or RECEIVE."
+
+    assert_equal expected_error, instance.errors_for(:type).first, "Expected an error about type"
+
+    instance = BankTransaction.build({:type => "SPEND"}, nil)
+    
+    instance.valid?
+    
+    assert_empty instance.errors_for(:type), "Expected no error about type"
+
+    instance = BankTransaction.build({:type => "RECEIVE"}, nil)
+    
+    instance.valid?
+    
+    assert_empty instance.errors_for(:type), "Expected no error about type"
+  end
+
+  must "supply a non-blank contact" do
+    instance = BankTransaction.build({}, nil)
+    
+    assert false == instance.valid?, "Expected invalid because of missing contact"
+
+    assert_equal "can't be blank", instance.errors_for(:contact).first, 
+      "Expected an error about blank contact"
+  end
+
+  must "supply at least one line item" do
+    zero_line_items = []
+
+    instance = BankTransaction.build({:line_items => zero_line_items}, nil)
+
+    assert false == instance.valid?, "Expected invalid because of empty line items"
+
+    assert_equal "Invalid line items. Must supply at least one.", instance.errors_for(:line_items).first,
+      "Expected an error about blank line items"
+
+    one_line_item = [LineItem.build({}, nil)]
+
+    instance.errors.clear
+    instance.line_items = one_line_item
+
+    assert_empty instance.errors_for(:line_items), "expected no errors for one line item, #{instance.errors_for(:line_items)}"
+
+    more_than_one_line_item = [LineItem.build({}, nil), LineItem.build({}, nil)]
+
+    instance.errors.clear
+    instance.line_items = more_than_one_line_item
+
+    assert_empty instance.errors_for(:line_items), "expected no errors for more than one line item, #{instance.errors_for(:line_items)}"
+  end
+
+  must "supply a non-blank bank account" do
+    instance = BankTransaction.build({}, nil)
+
+    assert false == instance.valid?, "Expected invalid because of missing bank account"
+
+    assert_equal "can't be blank", instance.errors_for(:bank_account).first, 
+      "Expected an error about blank contact"
+  end
+
+  must "supply valid line_amount_types value" do 
+    instance = BankTransaction.build({
+      :line_amount_types => "XXX_ANYTHING_INVALID_XXX"
+    }, nil)
+
+    assert false == instance.valid?, "Expected invalid because of missing bank account"
+
+    assert_equal "not one of Exclusive, Inclusive, NoTax", instance.errors_for(:line_amount_types).first, 
+      "Expected an error about blank contact"
+  end
+
+  must "line_amount_type defaults to \"Exclusive\"" do
+    instance = BankTransaction.build({}, nil)
+
+    assert_equal "Exclusive", instance.line_amount_types
+  end
+end

data/test/unit/models/contact_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require 'test_helper'
 
 class ContactTest < Test::Unit::TestCase
   include TestHelper
@@ -23,4 +23,4 @@ class ContactTest < Test::Unit::TestCase
     
   end
   
-end
+end

data/test/unit/models/credit_note_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require 'test_helper'
 
 class CreditNoteTest < Test::Unit::TestCase
   include TestHelper
@@ -34,4 +34,4 @@ class CreditNoteTest < Test::Unit::TestCase
     
   end
   
-end
+end

data/test/unit/models/invoice_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require 'test_helper'
 
 class InvoiceTest < Test::Unit::TestCase
   include TestHelper
@@ -8,7 +8,23 @@ class InvoiceTest < Test::Unit::TestCase
     mock_api('Invoices')
     @invoice = @client.Invoice.first
   end
-  
+
+  def build_valid_authorised_invoice
+    @client.Invoice.build({
+      :type => "ACCREC",
+      :contact => { :name => "ABC Limited" },
+      :status => "AUTHORISED",
+      :date => Date.today,
+      :due_date => Date.today,
+      :line_items => [{
+        :description => "Consulting services as agreed",
+        :quantity => 0.005,
+        :unit_amount => 1,
+        :account_code => 200
+      }]
+    })
+  end
+
   context "invoice types" do
     
     should "have helpers to determine invoice type" do
@@ -45,7 +61,7 @@ class InvoiceTest < Test::Unit::TestCase
         assert_equal(invoice.attributes[:total], invoice.total)
       end
     end
-    
+
   end
   
   context "invoice validations" do
@@ -65,22 +81,32 @@ class InvoiceTest < Test::Unit::TestCase
     end
 
     should "build a valid AUTHORISED invoice with complete attributes" do
-      invoice = @client.Invoice.build({
-        :type => "ACCREC",
-        :contact => { :name => "ABC Limited" },
-        :status => "AUTHORISED",
-        :date => Date.today,
-        :due_date => Date.today,
-        :line_items => [{
-          :description => "Consulting services as agreed",
-          :quantity => 5,
-          :unit_amount => 120,
-          :account_code => 200
-        }]
-      })
+      invoice = build_valid_authorised_invoice
       assert_equal(true, invoice.valid?)
     end
 
   end
 
-end
+  context "line items" do
+
+    should "round line item amounts to two decimal places" do
+      invoice = build_valid_authorised_invoice
+      assert_equal(0.01, invoice.line_items.first.line_amount)
+    end
+
+  end
+  
+  context "contact shortcuts" do
+    
+    should "have valid #contact_name and #contact_id without downloading full invoice" do
+      invoices = @client.Invoice.all
+      invoices.each do |invoice|
+        assert_not_equal("", invoice.contact_name)
+        assert_not_equal("", invoice.contact_id)
+        assert_equal(false, invoice.complete_record_downloaded?)
+      end
+    end
+    
+  end
+
+end

data/test/unit/models/line_item_sum_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class LineItemSumTest < Test::Unit::TestCase
+  include Xeroizer::Record
+
+  def setup
+    @the_line_items = [
+      LineItem.build({:quantity => 1, :unit_amount => 1.00, :tax_amount => 0.15}, nil),
+      LineItem.build({:quantity => 1, :unit_amount => 1.00, :tax_amount => 0.30}, nil)
+    ]
+  end
+
+  it "sub_total is the sum of the line_amounts" do
+    assert_equal BigDecimal("2.00"), LineItemSum.sub_total(@the_line_items)
+  end
+
+  it "total_tax is the sum of the tax_amounts" do
+    assert_equal BigDecimal("0.45"), LineItemSum.total_tax(@the_line_items)
+  end
+
+  it "total is the sum of sub_total and total_tax" do
+    assert_equal BigDecimal("2.45"), LineItemSum.total(@the_line_items)
+  end
+end

data/test/unit/models/line_item_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+class LineItemTest < Test::Unit::TestCase
+  include Xeroizer::Record
+
+  it "line_amount equals unit_price times quantity" do
+    line_item = LineItem.new(nil)
+
+    line_item.quantity = 1
+    line_item.unit_amount = BigDecimal("1337.00")
+    line_item.tax_amount = BigDecimal("0.15")
+
+    expected = BigDecimal((line_item.quantity * (line_item.unit_amount)).to_s).round(2)
+
+    assert_equal expected.to_s, line_item.line_amount.to_s
+  end
+
+  it "line_amount is zero when quantity is nil or zero" do
+    line_item = LineItem.new(nil)
+
+    line_item.quantity = nil
+    line_item.unit_amount = BigDecimal("1.00")
+    line_item.tax_amount = BigDecimal("0.15")
+
+    assert_equal "0.0", line_item.line_amount.to_s, "expected line amount zero when quantity is nil"
+
+    line_item.quantity = 0
+    assert_equal "0.0", line_item.line_amount.to_s, "expected line amount zero when quantity is zero"
+  end
+
+  it "is not possible to set unit_amount to zero" do
+    line_item = LineItem.new(nil)
+
+    line_item.quantity = 1
+    line_item.unit_amount = nil
+    line_item.tax_amount = BigDecimal("0.15")
+
+    assert_equal 0.0, line_item.unit_amount,
+      "Expected setting unit_amount to nil to be ignored, i.e., it should remain zero"
+  end
+
+  it "line_amount is zero when unit_amount is nil or zero" do
+    line_item = LineItem.new(nil)
+
+    line_item.quantity = 1
+    line_item.unit_amount = nil
+    line_item.tax_amount = BigDecimal("0.15")
+
+    assert_equal "0.0", line_item.line_amount.to_s, "expected line amount zero when unit_amount is nil"
+
+    line_item.unit_amount = BigDecimal("0.00")
+    assert_equal "0.0", line_item.line_amount.to_s, "expected line amount zero when unit_amount is zero"
+  end
+end