xero_gateway 2.1.0 → 2.3.0

data/test/unit/contact_group_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class ContactGroupTest < Test::Unit::TestCase
+  # Tests that a tracking category can be converted into XML that Xero can understand, and then converted back to a tracking category
+  def test_build_and_parse_xml
+    contact_group = create_test_contact_group
+    
+    # Generate the XML message
+    contact_group_as_xml = contact_group.to_xml
+
+    # Parse the XML message and retrieve the contact group element
+    contact_group_element = REXML::XPath.first(REXML::Document.new(contact_group_as_xml), "/ContactGroup")
+
+    # Build a new contact group from the XML
+    result_contact_group = XeroGateway::ContactGroup.from_xml(contact_group_element, nil)
+    
+    # Check the tracking category details
+    assert_equal contact_group.contact_group_id, result_contact_group.contact_group_id
+    assert_equal contact_group.name, result_contact_group.name
+    assert_equal contact_group.contact_ids, result_contact_group.contact_ids
+    assert_equal contact_group.status, result_contact_group.status
+  end
+
+  def test_download_and_memoize_contacts_from_partial_load
+    stub_contact_list = [stub(), stub()]
+    contact_group = create_test_contact_group
+    contact_group.gateway = stub()
+    contact_group.gateway.expects(:get_contact_group_by_id).with(contact_group.contact_group_id).returns(
+      stub(contact_group: stub(contacts: stub_contact_list))
+    ).once
+
+    assert_equal stub_contact_list, contact_group.contacts
+    assert_equal stub_contact_list, contact_group.contacts, "Should not reload API call."
+  end
+
+  private
+
+  def create_test_contact_group
+    contact_group = XeroGateway::ContactGroup.new
+    contact_group.contact_group_id = "abcd-efgh-ijkl-mnop-qrst-uvwx"
+    contact_group.name = "My Group"
+    contact_group.contact_ids = %w(abc def hij klm nop qrs)
+    contact_group.status = "ACTIVE"
+    contact_group
+  end
+
+end

data/test/unit/contact_test.rb

@@ -4,21 +4,21 @@ class ContactTest < Test::Unit::TestCase
   def setup
     @schema = LibXML::XML::Schema.document(LibXML::XML::Document.file(File.join(File.dirname(__FILE__), '../xsd/create_contact.xsd')))
   end
-  
+
   # Tests that the XML generated from a contact object validates against the Xero XSD
   def test_build_xml
     contact = create_test_contact
-    
+
     message = contact.to_xml
 
     # Check that the document matches the XSD
     assert LibXML::XML::Parser.string(message).parse.validate_schema(@schema), "The XML document generated did not validate against the XSD"
   end
-  
+
   # Tests that a contact can be converted into XML that Xero can understand, and then converted back to a contact
   def test_build_and_parse_xml
     contact = create_test_contact
-    
+
     # Generate the XML message
     contact_as_xml = contact.to_xml
 
@@ -27,17 +27,17 @@ class ContactTest < Test::Unit::TestCase
 
     # Build a new contact from the XML
     result_contact = XeroGateway::Contact.from_xml(contact_element)
-    
+
     # Check the contact details
     assert_equal contact, result_contact
   end
-  
+
   # Test Contact#add_address helper creates a valid XeroGateway::Contact object with the passed in values
   # and appends it to the Contact#addresses attribute.
   def test_add_address_helper
     contact = create_test_contact
     assert_equal(1, contact.addresses.size)
-    
+
     new_values = {
       :address_type => 'POBOX',
       :line_1 => 'NEW LINE 1',
@@ -50,7 +50,7 @@ class ContactTest < Test::Unit::TestCase
       :country => 'Australia'
     }
     contact.add_address(new_values)
-    
+
     assert_equal(2, contact.addresses.size)
     assert_kind_of(XeroGateway::Address, contact.addresses.last)
     new_values.each { |k,v| assert_equal(v, contact.addresses.last.send("#{k}")) }
@@ -58,10 +58,10 @@ class ContactTest < Test::Unit::TestCase
 
   # Test Contact#add_phone helper creates a valid XeroGateway::Phone object with the passed in values
   # and appends it to the Contact#phones attribute.
-  def test_add_address_helper
+  def test_add_phone_helper
     contact = create_test_contact
     assert_equal(1, contact.phones.size)
-    
+
     new_values = {
       :phone_type => 'MOBILE',
       :country_code => '61',
@@ -69,15 +69,34 @@ class ContactTest < Test::Unit::TestCase
       :number => '123456'
     }
     contact.add_phone(new_values)
-    
+
     assert_equal(2, contact.phones.size)
     assert_kind_of(XeroGateway::Phone, contact.phones.last)
     new_values.each { |k,v| assert_equal(v, contact.phones.last.send("#{k}")) }
-  end  
-  
-  
+  end
+
+  def test_valid_phone_number
+    phone = XeroGateway::Phone.new({
+     :phone_type => 'MOBILE',
+     :country_code => '61',
+     :area_code => '406',
+     :number => '0123456789'
+    })
+    assert(phone.valid?)
+  end
+
+  def test_invalid_phone_number
+    phone = XeroGateway::Phone.new({
+     :phone_type => 'MOBILE',
+     :country_code => '61',
+     :area_code => '406',
+     :number => '012345678901234567890123456789012345678901234567890'
+    })
+    assert(!phone.valid?)
+  end
+
   private
-  
+
   def create_test_contact
     contact = XeroGateway::Contact.new(:contact_id => "55555")
     contact.contact_number = "aaa111"
@@ -94,4 +113,4 @@ class ContactTest < Test::Unit::TestCase
 
     contact
   end
-end
+end

data/test/unit/credit_note_test.rb

@@ -40,7 +40,7 @@ class CreditNoteTest < Test::Unit::TestCase
   end
   
   # Tests the total_tax calculation and that setting it manually doesn't modify the data.
-  def test_credit_note_sub_total_calculation
+  def test_credit_note_sub_total_calculation2
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
     
@@ -61,7 +61,7 @@ class CreditNoteTest < Test::Unit::TestCase
   end
 
   # Tests the total calculation and that setting it manually doesn't modify the data.
-  def test_credit_note_sub_total_calculation
+  def test_credit_note_sub_total_calculation3
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
     

data/test/unit/gateway_test.rb

@@ -7,8 +7,144 @@ class GatewayTest < Test::Unit::TestCase
     @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
   end
 
-  context "with error handling" do
+  context "GET methods" do
+    should :get_invoices do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("invoices.xml"), :code => "200"))
+      result = @gateway.get_invoices
+      assert result.response_item.first.is_a? XeroGateway::Invoice
+    end
+
+    should :get_invoice do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("invoice.xml"), :code => "200"))
+      result = @gateway.get_invoice('a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999')
+      assert result.response_item.is_a? XeroGateway::Invoice
+    end
+
+    should :get_credit_notes do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("credit_notes.xml"), :code => "200"))
+      result = @gateway.get_credit_notes
+      assert result.response_item.first.is_a? XeroGateway::CreditNote
+    end
+
+    should :get_credit_note do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("credit_notes.xml"), :code => "200"))
+      result = @gateway.get_credit_note('a2b4370d-efd2-440d-894e-082f21d0b10a')
+      assert result.response_item.first.is_a? XeroGateway::CreditNote
+    end
+
+    should :get_bank_transactions do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("bank_transaction.xml"), :code => "200"))
+      result = @gateway.get_bank_transactions
+      assert result.response_item.is_a? XeroGateway::BankTransaction
+    end
+
+    should :get_bank_transaction do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("bank_transactions.xml"), :code => "200"))
+      result = @gateway.get_bank_transaction('c09661a2-a954-4e34-98df-f8b6d1dc9b19')
+      assert result.response_item.is_a? XeroGateway::BankTransaction
+    end
+
+    should :get_manual_journals do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("manual_journals.xml"), :code => "200"))
+      result = @gateway.get_manual_journals
+      assert result.response_item.is_a? XeroGateway::ManualJournal
+    end
+
+    should :get_payments do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("payments.xml"), :code => "200"))
+      result = @gateway.get_payments
+      assert result.response_item.first.is_a? XeroGateway::Payment
+    end
+
+    should :get_payment do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("payments.xml"), :code => "200"))
+      result = @gateway.get_payment('1234')
+      assert result.response_item.first.is_a? XeroGateway::Payment
+    end
+
+
+    should :get_contacts do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("contacts.xml"), :code => "200"))
+      result = @gateway.get_contacts
+      assert result.response_item.first.is_a? XeroGateway::Contact
+    end
+
+    should :get_contact_by_id do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("contact.xml"), :code => "200"))
+      result = @gateway.get_contact_by_id('a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999')
+      assert result.response_item.is_a? XeroGateway::Contact
+    end
+
+    should :get_contact_by_number do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("contact.xml"), :code => "200"))
+      result = @gateway.get_contact_by_number('12345')
+      assert result.response_item.is_a? XeroGateway::Contact
+    end
+
+    should :get_contact_groups do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("contact_groups.xml"), :code => "200"))
+      result = @gateway.get_contact_groups
+      assert result.response_item.first.is_a? XeroGateway::ContactGroup      
+    end
+
+    should :get_contact_group_by_id do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("contact_group.xml"), :code => "200"))
+      result = @gateway.get_contact_group_by_id('a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999')
+      assert result.response_item.is_a? XeroGateway::ContactGroup      
+    end
+
+    context :get_report do
+      should "get a BankStatements report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/bank_statement.xml"), :code => "200"))
+        result = @gateway.get_report("BankStatement", bank_account_id: "c09661a2-a954-4e34-98df-f8b6d1dc9b19")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a AgedPayablesByContact report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/aged_payables_by_contact.xml"), :code => "200"))
+        result = @gateway.get_report("AgedPayablesByContact", contactID: "c09661a2-a954-4e34-98df-f8b6d1dc9b19")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
 
+      should "get a AgedReceivablesByContact report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/aged_receivables_by_contact.xml"), :code => "200"))
+        result = @gateway.get_report("AgedReceivablesByContact", contactID: "c09661a2-a954-4e34-98df-f8b6d1dc9b19")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a BalanceSheet report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/balance_sheet.xml"), :code => "200"))
+        result = @gateway.get_report("BalanceSheet")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a BankSummary report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/bank_summary.xml"), :code => "200"))
+        result = @gateway.get_report("BankSummary")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a ExecutiveSummary report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/executive_summary.xml"), :code => "200"))
+        result = @gateway.get_report("ExecutiveSummary")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a ProfitAndLoss report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/profit_and_loss.xml"), :code => "200"))
+        result = @gateway.get_report("ProfitAndLoss")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+
+      should "get a TrialBalance report" do
+        XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("reports/trial_balance.xml"), :code => "200"))
+        result = @gateway.get_report("TrialBalance")
+        assert result.response_item.is_a? XeroGateway::Report
+      end
+    end
+  end
+
+  context "with error handling" do
     should "handle token expired" do
       XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("token_expired"), :code => "401"))
 
@@ -49,6 +185,16 @@ class GatewayTest < Test::Unit::TestCase
       end
     end
 
+    should "handle errors without advice" do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("error_without_advice"), :code => "401"))
+
+      begin
+        @gateway.get_accounts
+      rescue XeroGateway::OAuth::UnknownError => e
+        assert_equal "some_error: No description found: oauth_problem=some_error&oauth_problem_advice=\n", e.message
+      end
+    end
+
     should "handle ApiExceptions" do
       XeroGateway::OAuth.any_instance.stubs(:put).returns(stub(:plain_body => get_file_as_string("api_exception.xml"), :code => "400"))
 
@@ -81,6 +227,22 @@ class GatewayTest < Test::Unit::TestCase
       end
     end
 
+    should "handle manual journals not found" do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("api_exception.xml"), :code => "404"))
+
+      assert_raises XeroGateway::ManualJournalNotFoundError do
+        @gateway.get_manual_journal('unknown-manual-journal-id')
+      end
+    end
+
+    should "handle payments not found" do
+      XeroGateway::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_file_as_string("api_exception.xml"), :code => "404"))
+
+      assert_raises XeroGateway::PaymentNotFoundError do
+        @gateway.get_payments
+      end
+    end
+
     should "handle random root elements" do
       XeroGateway::OAuth.any_instance.stubs(:put).returns(stub(:plain_body => "<RandomRootElement></RandomRootElement>", :code => "200"))
 
@@ -89,6 +251,13 @@ class GatewayTest < Test::Unit::TestCase
       end
     end
 
+    should "handle no root element" do
+      XeroGateway::OAuth.any_instance.stubs(:put).returns(stub(:plain_body => get_file_as_string("no_certificates_registered"), :code => 400))
+
+      assert_raises RuntimeError do
+        response = @gateway.create_invoice(XeroGateway::Invoice.new)
+      end
+    end
   end
 
   def test_unknown_error_handling

data/test/unit/invoice_test.rb

@@ -2,6 +2,17 @@ require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
 class InvoiceTest < Test::Unit::TestCase
 
+  context "with line item totals" do
+
+    should "allow setting and reading these as instance variables without downloading line items" do
+      invoice = create_test_invoice(:line_items_downloaded => false, :total => 6969_00)
+
+      assert !invoice.line_items_downloaded?
+      XeroGateway::Invoice.any_instance.expects(:download_line_items).never
+      assert_equal 6969_00, invoice.total
+    end
+  end
+
   context "building and parsing XML" do
     should "work vice versa" do
       invoice = create_test_invoice
@@ -30,7 +41,7 @@ class InvoiceTest < Test::Unit::TestCase
 
   # Tests the sub_total calculation and that setting it manually doesn't modify the data.
   def test_invoice_sub_total_calculation
-    invoice = create_test_invoice
+    invoice = create_test_invoice(:line_items_downloaded => true)
     line_item = invoice.line_items.first
     
     # Make sure that everything adds up to begin with.
@@ -50,8 +61,8 @@ class InvoiceTest < Test::Unit::TestCase
   end
   
   # Tests the total_tax calculation and that setting it manually doesn't modify the data.
-  def test_invoice_sub_total_calculation
-    invoice = create_test_invoice
+  def test_invoice_sub_total_calculation2
+    invoice = create_test_invoice(:line_items_downloaded => true)
     line_item = invoice.line_items.first
     
     # Make sure that everything adds up to begin with.
@@ -71,8 +82,9 @@ class InvoiceTest < Test::Unit::TestCase
   end
 
   # Tests the total calculation and that setting it manually doesn't modify the data.
-  def test_invoice_sub_total_calculation
-    invoice = create_test_invoice
+  def test_invoice_sub_total_calculation3
+    invoice = create_test_invoice(:line_items_downloaded => true)
+    assert invoice.line_items_downloaded?
     line_item = invoice.line_items.first
     
     # Make sure that everything adds up to begin with.
@@ -81,7 +93,7 @@ class InvoiceTest < Test::Unit::TestCase
     
     # Change the total and check that it doesn't modify anything.
     invoice.total = expected_total * 10
-    assert_equal(expected_total, invoice.total)
+    assert_equal(expected_total.to_f, invoice.total.to_f)
     
     # Change the quantity of the first line item and make sure that 
     # everything still continues to add up.
@@ -146,6 +158,7 @@ class InvoiceTest < Test::Unit::TestCase
     assert_equal('ACCREC', invoice.invoice_type)
     assert_kind_of(Date, invoice.date)
     assert_kind_of(Date, invoice.due_date)
+    assert_kind_of(Time, invoice.updated_date_utc)
     assert_equal('12345', invoice.invoice_number)
     assert_equal('MY REFERENCE FOR THIS INVOICE', invoice.reference)
     assert_equal("Exclusive", invoice.line_amount_types)
@@ -245,6 +258,12 @@ class InvoiceTest < Test::Unit::TestCase
     assert_equal 'a94a78db-5cc6-4e26-a52b-045237e56e6e', invoice.branding_theme_id
   end
 
+  def test_updated_date_utc
+     time = Time.now.utc
+     invoice = create_test_invoice(:updated_date_utc => time)
+     assert_equal time, invoice.updated_date_utc
+  end
+
   private
     
   def create_test_invoice(invoice_params = {}, contact_params = {}, line_item_params = [])
@@ -255,7 +274,8 @@ class InvoiceTest < Test::Unit::TestCase
         :due_date => Date.today + 10, # 10 days in the future
         :invoice_number => '12345',
         :reference => "MY REFERENCE FOR THIS INVOICE",
-        :line_amount_types => "Exclusive"
+        :line_amount_types => "Exclusive",
+        :updated_date_utc => Time.now.utc
       }.merge(invoice_params)
     end
     invoice = XeroGateway::Invoice.new(invoice_params || {})