xero_gateway 2.3.0 → 2.4.0

data/test/unit/account_test.rb

@@ -4,7 +4,7 @@ class AccountTest < Test::Unit::TestCase
   # Tests that an account can be converted into XML that Xero can understand, and then converted back to an account
   def test_build_and_parse_xml
     account = create_test_account
-    
+
     # Generate the XML message
     account_as_xml = account.to_xml
 
@@ -13,30 +13,34 @@ class AccountTest < Test::Unit::TestCase
 
     # Build a new account from the XML
     result_account = XeroGateway::Account.from_xml(account_element)
-    
+
     # Check the account details
     assert_equal account, result_account
   end
-  
+
   def test_build_and_parse_xml_for_bank_accounts
-    account = create_test_account(:type => 'BANK', :currency_code => 'NZD')
+    account = create_test_account(:type => 'BANK', :status => 'ACTIVE', :account_class => 'ASSET', :currency_code => 'NZD')
     account_as_xml = account.to_xml
     assert_match 'CurrencyCode', account_as_xml.to_s
 
     account_element = REXML::XPath.first(REXML::Document.new(account_as_xml), "/Account")
     result_account = XeroGateway::Account.from_xml(account_element)
     assert_equal 'BANK', result_account.type
+    assert_equal 'ACTIVE', result_account.status
+    assert_equal 'ASSET', result_account.account_class
     assert_equal 'NZD', result_account.currency_code
     assert_equal account, result_account
   end
-  
+
   private
-  
+
   def create_test_account(options={})
     account = XeroGateway::Account.new(:account_id => "57cedda9")
     account.code = "200"
     account.name = "Sales"
     account.type = options[:type] || "REVENUE"
+    account.status = options[:status] || "ACTIVE"
+    account.account_class = options[:account_class] || "REVENUE"
     account.tax_type = "OUTPUT"
     account.description = "Income from any normal business activity"
     account.enable_payments_to_account = false

data/test/unit/bank_transaction_test.rb

@@ -37,6 +37,15 @@ class BankTransactionTest < Test::Unit::TestCase
     should "allow overriding transaction defaults" do
       assert_equal 'SPEND', create_test_bank_transaction(:type => 'SPEND').type
     end
+
+    should "support another currency" do
+      usd_code = "USD"
+      usd_rate = 1.402
+      bank_transaction = create_test_bank_transaction(:currency_code => usd_code,
+                                                      :currency_rate => usd_rate)
+      assert_equal usd_code, bank_transaction.currency_code
+      assert_equal usd_rate, bank_transaction.currency_rate
+    end
   end
 
   context "adding line items" do
@@ -124,9 +133,9 @@ class BankTransactionTest < Test::Unit::TestCase
 private
 
   def assert_xml_field(xml, field_name, options={})
-    assert_match /#{field_name}/, xml.to_s, "Didn't find the field #{field_name} in the XML document!"
+    assert_match(/#{field_name}/, xml.to_s, "Didn't find the field #{field_name} in the XML document!")
     if options[:value]
-      assert_match /#{field_name}.*#{options[:value]}.*#{field_name}/, xml.to_s, "The field #{field_name} was expected to be '#{options[:value]}'!"
+      assert_match(/#{field_name}.*#{options[:value]}.*#{field_name}/, xml.to_s, "The field #{field_name} was expected to be '#{options[:value]}'!")
     end
   end
 

data/test/unit/contact_test.rb

@@ -32,6 +32,68 @@ class ContactTest < Test::Unit::TestCase
     assert_equal contact, result_contact
   end
 
+  # this allows you to remove addresses from Xero
+  test "explicity passing an empty array for addresses should include an empty element" do
+    contact = create_test_contact
+    contact.addresses = nil
+
+    parsed = REXML::XPath.first(REXML::Document.new(contact.to_xml), "/Contact")
+    assert !parsed.children.map(&:name).include?("Addresses")
+
+    contact.addresses = []
+    parsed = REXML::XPath.first(REXML::Document.new(contact.to_xml), "/Contact")
+    assert parsed.children.map(&:name).include?("Addresses")
+  end
+
+  test "should be able to set addresses as part of initialize" do
+    contact = XeroGateway::Contact.new(contact_id: "abcdef-3abe", name: "Test", addresses: [])
+
+    parsed = REXML::XPath.first(REXML::Document.new(contact.to_xml), "/Contact")
+    assert parsed.children.map(&:name).include?("Addresses")
+  end
+
+  test "parsing from XML" do
+    test_xml = <<-TESTING.strip_heredoc.chomp
+    <Contact>
+      <ContactID>f1d403d1-7d30-46c2-a2be-fc2bb29bd295</ContactID>
+      <ContactStatus>ACTIVE</ContactStatus>
+      <Name>24 Locks</Name>
+      <Addresses>
+        <Address>
+          <AddressType>POBOX</AddressType>
+        </Address>
+        <Address>
+          <AddressType>STREET</AddressType>
+        </Address>
+      </Addresses>
+      <Phones>
+        <Phone>
+          <PhoneType>DDI</PhoneType>
+        </Phone>
+        <Phone>
+          <PhoneType>DEFAULT</PhoneType>
+        </Phone>
+        <Phone>
+          <PhoneType>FAX</PhoneType>
+        </Phone>
+        <Phone>
+          <PhoneType>MOBILE</PhoneType>
+        </Phone>
+      </Phones>
+      <UpdatedDateUTC>2016-08-31T04:55:39.217</UpdatedDateUTC>
+      <IsSupplier>false</IsSupplier>
+      <IsCustomer>false</IsCustomer>
+      <HasAttachments>false</HasAttachments>
+    </Contact>
+    TESTING
+
+    contact_element = REXML::XPath.first(REXML::Document.new(test_xml.gsub(/\s/, "")), "/Contact")
+    contact = XeroGateway::Contact.from_xml(contact_element)
+
+    assert_equal Time.new(2016, 8, 31, 04, 55, 39), contact.updated_at.utc
+
+  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

data/test/unit/credit_note_test.rb

@@ -1,11 +1,11 @@
 require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
 class CreditNoteTest < Test::Unit::TestCase
-  
+
   # Tests that a credit note can be converted into XML that Xero can understand, and then converted back to a credit note
   def test_build_and_parse_xml
     credit_note = create_test_credit_note
-    
+
     # Generate the XML message
     credit_note_as_xml = credit_note.to_xml
 
@@ -17,46 +17,38 @@ class CreditNoteTest < Test::Unit::TestCase
 
     assert_equal(credit_note, result_credit_note)
   end
-  
+
   # Tests the sub_total calculation and that setting it manually doesn't modify the data.
   def test_credit_note_sub_total_calculation
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
-    
+
     # Make sure that everything adds up to begin with.
-    expected_sub_total = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, line_item | line_item.line_amount }
-    assert_equal(expected_sub_total, credit_note.sub_total)
-    
-    # Change the sub_total and check that it doesn't modify anything.
-    credit_note.sub_total = expected_sub_total * 10
+    expected_sub_total = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, l | l.line_amount }
     assert_equal(expected_sub_total, credit_note.sub_total)
-    
-    # Change the amount of the first line item and make sure that 
+
+    # Change the amount of the first line item and make sure that
     # everything still continues to add up.
     line_item.unit_amount = line_item.unit_amount + 10
     assert_not_equal(expected_sub_total, credit_note.sub_total)
-    expected_sub_total = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, line_item | line_item.line_amount }
+    expected_sub_total = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, l | l.line_amount }
     assert_equal(expected_sub_total, credit_note.sub_total)
   end
-  
+
   # Tests the total_tax calculation and that setting it manually doesn't modify the data.
   def test_credit_note_sub_total_calculation2
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
-    
+
     # Make sure that everything adds up to begin with.
-    expected_total_tax = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, line_item | line_item.tax_amount }
-    assert_equal(expected_total_tax, credit_note.total_tax)
-    
-    # Change the total_tax and check that it doesn't modify anything.
-    credit_note.total_tax = expected_total_tax * 10
+    expected_total_tax = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, l | l.tax_amount }
     assert_equal(expected_total_tax, credit_note.total_tax)
-    
-    # Change the tax_amount of the first line item and make sure that 
+
+    # Change the tax_amount of the first line item and make sure that
     # everything still continues to add up.
     line_item.tax_amount = line_item.tax_amount + 10
     assert_not_equal(expected_total_tax, credit_note.total_tax)
-    expected_total_tax = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, line_item | line_item.tax_amount }
+    expected_total_tax = credit_note.line_items.inject(BigDecimal.new('0')) { | sum, l | l.tax_amount }
     assert_equal(expected_total_tax, credit_note.total_tax)
   end
 
@@ -64,16 +56,12 @@ class CreditNoteTest < Test::Unit::TestCase
   def test_credit_note_sub_total_calculation3
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
-    
+
     # Make sure that everything adds up to begin with.
     expected_total = credit_note.sub_total + credit_note.total_tax
     assert_equal(expected_total, credit_note.total)
-    
-    # Change the total and check that it doesn't modify anything.
-    credit_note.total = expected_total * 10
-    assert_equal(expected_total, credit_note.total)
-    
-    # Change the quantity of the first line item and make sure that 
+
+    # Change the quantity of the first line item and make sure that
     # everything still continues to add up.
     line_item.quantity = line_item.quantity + 5
     assert_not_equal(expected_total, credit_note.total)
@@ -85,72 +73,72 @@ class CreditNoteTest < Test::Unit::TestCase
   def test_line_amount_calculation
     credit_note = create_test_credit_note
     line_item = credit_note.line_items.first
-    
+
     # Make sure that everything adds up to begin with.
     expected_amount = line_item.quantity * line_item.unit_amount
     assert_equal(expected_amount, line_item.line_amount)
-    
+
     # Change the line_amount and check that it doesn't modify anything.
     line_item.line_amount = expected_amount * 10
     assert_equal(expected_amount, line_item.line_amount)
-    
+
     # Change the quantity and check that the line_amount has been updated.
     quantity = line_item.quantity + 2
     line_item.quantity = quantity
     assert_not_equal(expected_amount, line_item.line_amount)
     assert_equal(quantity * line_item.unit_amount, line_item.line_amount)
   end
-  
+
   # Ensure that the totalling methods don't raise exceptions, even when
   # credit_note.line_items is empty.
   def test_totalling_methods_when_line_items_empty
     credit_note = create_test_credit_note
     credit_note.line_items = []
-    
+
     assert_nothing_raised(Exception) {
       assert_equal(BigDecimal.new('0'), credit_note.sub_total)
       assert_equal(BigDecimal.new('0'), credit_note.total_tax)
       assert_equal(BigDecimal.new('0'), credit_note.total)
     }
   end
-  
+
   def test_type_helper_methods
     # Test accounts receivable credit_notes.
     credit_note = create_test_credit_note({:type => 'ACCRECCREDIT'})
     assert_equal(true,  credit_note.accounts_receivable?, "Accounts RECEIVABLE credit_note doesn't think it is.")
     assert_equal(false, credit_note.accounts_payable?,    "Accounts RECEIVABLE credit_note thinks it's payable.")
-    
+
     # Test accounts payable credit_notes.
     credit_note = create_test_credit_note({:type => 'ACCPAYCREDIT'})
     assert_equal(false, credit_note.accounts_receivable?, "Accounts PAYABLE credit_note doesn't think it is.")
     assert_equal(true,  credit_note.accounts_payable?,    "Accounts PAYABLE credit_note thinks it's receivable.")
   end
-  
-  
+
+
   # Make sure that the create_test_credit_note method is working correctly
   # with all the defaults and overrides.
   def test_create_test_credit_note_defaults_working
     credit_note = create_test_credit_note
-    
+
     # Test credit_note defaults.
     assert_equal('ACCRECCREDIT', credit_note.type)
     assert_kind_of(Date, credit_note.date)
     assert_equal('12345', credit_note.credit_note_number)
     assert_equal('MY REFERENCE FOR THIS CREDIT NOTE', credit_note.reference)
     assert_equal("Exclusive", credit_note.line_amount_types)
-    
+
     # Test the contact defaults.
     assert_equal('00000000-0000-0000-0000-000000000000', credit_note.contact.contact_id)
     assert_equal('CONTACT NAME', credit_note.contact.name)
-    
+
     # Test address defaults.
     assert_equal('DEFAULT', credit_note.contact.address.address_type)
     assert_equal('LINE 1 OF THE ADDRESS', credit_note.contact.address.line_1)
-    
+
     # Test phone defaults.
     assert_equal('DEFAULT', credit_note.contact.phone.phone_type)
     assert_equal('12345678', credit_note.contact.phone.number)
-    
+
     # Test the line_item defaults.
     assert_equal('A LINE ITEM', credit_note.line_items.first.description)
     assert_equal('200', credit_note.line_items.first.account_code)
@@ -160,19 +148,19 @@ class CreditNoteTest < Test::Unit::TestCase
     # Test overriding an credit_note parameter (assume works for all).
     credit_note = create_test_credit_note({:type => 'ACCPAYCREDIT'})
     assert_equal('ACCPAYCREDIT', credit_note.type)
-    
+
     # Test overriding a contact/address/phone parameter (assume works for all).
     credit_note = create_test_credit_note({}, {:name => 'OVERRIDDEN NAME', :address => {:line_1 => 'OVERRIDDEN LINE 1'}, :phone => {:number => '999'}})
     assert_equal('OVERRIDDEN NAME', credit_note.contact.name)
     assert_equal('OVERRIDDEN LINE 1', credit_note.contact.address.line_1)
     assert_equal('999', credit_note.contact.phone.number)
-    
+
     # Test overriding line_items with hash.
     credit_note = create_test_credit_note({}, {}, {:description => 'OVERRIDDEN LINE ITEM'})
     assert_equal(1, credit_note.line_items.size)
     assert_equal('OVERRIDDEN LINE ITEM', credit_note.line_items.first.description)
     assert_equal(BigDecimal.new('100'), credit_note.line_items.first.unit_amount)
-    
+
     # Test overriding line_items with array of 2 line_items.
     credit_note = create_test_credit_note({}, {}, [
       {:description => 'OVERRIDDEN ITEM 1'},
@@ -184,28 +172,28 @@ class CreditNoteTest < Test::Unit::TestCase
     assert_equal('OVERRIDDEN ITEM 2', credit_note.line_items[1].description)
     assert_equal(BigDecimal.new('200'), credit_note.line_items[1].unit_amount)
   end
-  
+
   def test_auto_creation_of_associated_contact
     credit_note = create_test_credit_note({}, nil) # no contact
-    assert_nil(credit_note.instance_variable_get("@contact"))
-    
+    assert(!credit_note.instance_variable_defined?("@contact"))
+
     new_contact = credit_note.contact
     assert_kind_of(XeroGateway::Contact, new_contact)
   end
-  
+
   def test_add_line_item
     credit_note = create_test_credit_note({}, {}, nil) # no line_items
     assert_equal(0, credit_note.line_items.size)
-    
+
     line_item_params = {:description => "Test Item 1", :unit_amount => 100}
-    
+
     # Test adding line item by hash
     line_item = credit_note.add_line_item(line_item_params)
     assert_kind_of(XeroGateway::LineItem, line_item)
     assert_equal(line_item_params[:description], line_item.description)
     assert_equal(line_item_params[:unit_amount], line_item.unit_amount)
     assert_equal(1, credit_note.line_items.size)
-    
+
     # Test adding line item by XeroGateway::LineItem
     line_item = credit_note.add_line_item(line_item_params)
     assert_kind_of(XeroGateway::LineItem, line_item)
@@ -219,9 +207,9 @@ class CreditNoteTest < Test::Unit::TestCase
       assert_equal(2, credit_note.line_items.size)
     end
   end
-  
+
   private
-    
+
   def create_test_credit_note(credit_note_params = {}, contact_params = {}, line_item_params = [])
     unless credit_note_params.nil?
       credit_note_params = {
@@ -233,36 +221,36 @@ class CreditNoteTest < Test::Unit::TestCase
       }.merge(credit_note_params)
     end
     credit_note = XeroGateway::CreditNote.new(credit_note_params || {})
-    
+
     unless contact_params.nil?
       # Strip out :address key from contact_params to use as the default address.
       stripped_address = {
         :address_type => 'DEFAULT',
         :line_1 => 'LINE 1 OF THE ADDRESS'
       }.merge(contact_params.delete(:address) || {})
-    
+
       # Strip out :phone key from contact_params to use at the default phone.
       stripped_phone = {
         :phone_type => 'DEFAULT',
         :number => '12345678'
       }.merge(contact_params.delete(:phone) || {})
-    
+
       contact_params = {
         :contact_id => '00000000-0000-0000-0000-000000000000', # Just any valid GUID
         :name => "CONTACT NAME",
         :first_name => "Bob",
         :last_name => "Builder"
       }.merge(contact_params)
-    
+
       # Create credit_note.contact from contact_params.
       credit_note.contact = XeroGateway::Contact.new(contact_params)
       credit_note.contact.address = XeroGateway::Address.new(stripped_address)
       credit_note.contact.phone = XeroGateway::Phone.new(stripped_phone)
     end
-    
+
     unless line_item_params.nil?
       line_item_params = [line_item_params].flatten # always use an array, even if only a single hash passed in
-    
+
       # At least one line item, make first have some defaults.
       line_item_params << {} if line_item_params.size == 0
       line_item_params[0] = {
@@ -272,13 +260,13 @@ class CreditNoteTest < Test::Unit::TestCase
         :tax_amount => BigDecimal.new("12.5"),
         :tracking => XeroGateway::TrackingCategory.new(:name => "blah", :options => "hello")
       }.merge(line_item_params[0])
-    
+
       # Create credit_note.line_items from line_item_params
       line_item_params.each do | line_item |
         credit_note.add_line_item(line_item)
       end
     end
-    
+
     credit_note
   end
 end

data/test/unit/gateway_test.rb

@@ -14,6 +14,19 @@ class GatewayTest < Test::Unit::TestCase
       assert result.response_item.first.is_a? XeroGateway::Invoice
     end
 
+    should "get invoices by contact ids" do
+      contact_id = 'a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999'
+      stub_response = stub(:plain_body => get_file_as_string("invoices.xml"),
+                           :code => "200")
+      expected_url = /.+\/Invoices\?ContactIDs=#{contact_id}/
+      XeroGateway::OAuth.any_instance
+                        .stubs(:get)
+                        .with(regexp_matches(expected_url), anything)
+                        .returns(stub_response)
+      result = @gateway.get_invoices(:contact_ids => [contact_id])
+      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')
@@ -62,7 +75,6 @@ class GatewayTest < Test::Unit::TestCase
       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
@@ -84,13 +96,13 @@ class GatewayTest < Test::Unit::TestCase
     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      
+      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      
+      assert result.response_item.is_a? XeroGateway::ContactGroup
     end
 
     context :get_report do
@@ -255,7 +267,7 @@ class GatewayTest < Test::Unit::TestCase
       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)
+        @gateway.create_invoice(XeroGateway::Invoice.new)
       end
     end
   end