tlconnor-xero_gateway 1.0.2 → 1.0.3

data/test/integration/get_accounts_test.rb

@@ -1,12 +1,12 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetAccountsTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
       :customer_key => CUSTOMER_KEY,
-      :api_key => API_KEY    
+      :api_key => API_KEY
     )
     
     if STUB_XERO_CALLS
@@ -19,6 +19,7 @@ class GetAccountsTest < Test::Unit::TestCase
   def test_get_accounts
     result = @gateway.get_accounts
     assert result.success?
+    assert !result.response_xml.nil?
     assert result.accounts.size > 0
     assert_equal XeroGateway::Account, result.accounts.first.class
   end

data/test/integration/get_contact_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetContactTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -24,6 +24,8 @@ class GetContactTest < Test::Unit::TestCase
 
     result = @gateway.get_contact_by_id(contact.contact_id)
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
     assert_equal result.contact.name, contact.name
   end
 end

data/test/integration/get_contacts_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetContactsTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -24,6 +24,8 @@ class GetContactsTest < Test::Unit::TestCase
 
     result = @gateway.get_contacts
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
     assert result.contacts.collect {|c| c.contact_id}.include?(contact.contact_id)
   end  
 end

data/test/integration/get_invoice_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetInvoiceTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -23,10 +23,14 @@ class GetInvoiceTest < Test::Unit::TestCase
 
     result = @gateway.get_invoice_by_id(invoice.invoice_id)
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
     assert_equal result.invoice.invoice_number, invoice.invoice_number
 
     result = @gateway.get_invoice_by_number(invoice.invoice_number)
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
     assert_equal result.invoice.invoice_id, invoice.invoice_id
   end
 end

data/test/integration/get_invoices_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetInvoicesTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -23,6 +23,8 @@ class GetInvoicesTest < Test::Unit::TestCase
     
     result = @gateway.get_invoices
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?  
     assert result.invoices.collect {|i| i.invoice_number}.include?(invoice.invoice_number)
   end
   
@@ -34,6 +36,8 @@ class GetInvoicesTest < Test::Unit::TestCase
     # Check that it is returned
     result = @gateway.get_invoices(Date.today - 1)
     assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
     assert result.request_params.keys.include?(:modifiedSince) # make sure the flag was sent
     assert result.invoices.collect {|response_invoice| response_invoice.invoice_number}.include?(invoice.invoice_number)
   end  

data/test/integration/get_tracking_categories_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class GetTrackingCategoriesTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(:customer_key => CUSTOMER_KEY, :api_key => API_KEY)
@@ -16,7 +16,10 @@ class GetTrackingCategoriesTest < Test::Unit::TestCase
   def test_get_tracking_categories
     result = @gateway.get_tracking_categories
     assert result.success?
+    assert !result.response_xml.nil?
     if STUB_XERO_CALLS
+      # When operating against the Xero test environment, there may not be any tracking categories present,
+      # so this assertion can only be done when operating against stub responses
       assert result.tracking_categories.size == 2
     end
   end

data/test/integration/update_contact_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class UpdateContactTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -26,6 +26,8 @@ class UpdateContactTest < Test::Unit::TestCase
     result = @gateway.update_contact(contact)
 
     assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?    
     assert_equal contact.contact_id, result.contact.contact_id
     assert_equal "123 4567", result.contact.phone.number if !STUB_XERO_CALLS
   end

data/test/stub_responses/accounts.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ID>cf37ba46-29a7-4824-ad63-43482463afed</ID><Status>OK</Status><ProviderName>YOUR PROVIDER</ProviderName><DateTimeUTC>2008-12-01T08:39:54.70175Z</DateTimeUTC><Accounts><Account><Code>200</Code><Name>Sales</Name><Type>REVENUE</Type><TaxType>OUTPUT</TaxType><Description>Income from any normal business activity</Description></Account><Account><Code>260</Code><Name>Other Revenue</Name><Type>REVENUE</Type><TaxType>OUTPUT</TaxType><Description>Any other income that does not relate to normal business activities and is not recurring</Description></Account><Account><Code>270</Code><Name>Interest Income</Name><Type>REVENUE</Type><TaxType>NONE</TaxType><Description>Gross interest income (i.e. before deducting Residential Withholding Tax), such as bank interest</Description></Account><Account><Code>400</Code><Name>Advertising</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for advertising while trying to increase sales</Description></Account><Account><Code>404</Code><Name>Bank Fees</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Fees charged by your bank for transactions regarding your bank account(s).</Description></Account><Account><Code>408</Code><Name>Cleaning</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for cleaning  business property.</Description></Account><Account><Code>412</Code><Name>Consulting &amp; Accounting</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses related to paying consultants</Description></Account><Account><Code>416</Code><Name>Depreciation</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>The amount of the asset's cost (based on the useful life) that was consumed during the period</Description></Account><Account><Code>420</Code><Name>Entertainment</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>50% of the total expense relating to business-related entertainment. E.g. shouting clients or employees  a drink or a meal etc.</Description></Account><Account><Code>424</Code><Name>Entertainment - Non deductible</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Expenses paid by company for the business but are not deductable for income tax purposes.</Description></Account><Account><Code>425</Code><Name>Freight &amp; Courier</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on courier &amp; freight costs</Description></Account><Account><Code>429</Code><Name>General Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>General expenses related to the running of the business.</Description></Account><Account><Code>433</Code><Name>Insurance</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for insuring the business' assets</Description></Account><Account><Code>437</Code><Name>Interest Expense</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Any interest expenses paid to IRD, business bank accounts or credit card accounts.</Description></Account><Account><Code>441</Code><Name>Legal expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on any legal matters</Description></Account><Account><Code>445</Code><Name>Light, Power, Heating</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for lighting, powering or heating the premises</Description></Account><Account><Code>449</Code><Name>Motor Vehicle Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on the running of company motor vehicles</Description></Account><Account><Code>453</Code><Name>Office Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>General expenses related to the running of the business office.</Description></Account><Account><Code>461</Code><Name>Printing &amp; Stationery</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred by the entity as a result of printing and stationery</Description></Account><Account><Code>469</Code><Name>Rent</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>The payment to lease a building or area.</Description></Account><Account><Code>473</Code><Name>Repairs and Maintenance</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on a damaged or run down asset that will bring the asset back to its original condition.</Description></Account><Account><Code>477</Code><Name>Salaries</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Payment to employees in exchange for their resources</Description></Account><Account><Code>478</Code><Name>KiwiSaver Employer Contributions</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>KiwiSaver employer contributions</Description></Account><Account><Code>485</Code><Name>Subscriptions</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>E.g. Magazines, professional bodies.</Description></Account><Account><Code>489</Code><Name>Telephone &amp; Internet</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenditure incurred from any business-related phone calls, phone lines, or internet connections</Description></Account><Account><Code>493</Code><Name>Travel - National</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred from domestic travel which has a business purpose</Description></Account><Account><Code>494</Code><Name>Travel - International</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Expenses incurred from international travel which has a business purpose</Description></Account><Account><Code>505</Code><Name>Income Tax Expense</Name><Type>EXPENSE</Type><TaxType>NONE</TaxType><Description>A percentage of total earnings paid to the government.</Description></Account><Account><Code>610</Code><Name>Accounts Receivable</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>Outstanding invoices the company has issued out to the client but has not yet received in cash at balance date.</Description></Account><Account><Code>611</Code><Name>less Provision for Doubtful Debts</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>A provision anticipating that some of the accounts receivables will become bad debts.</Description></Account><Account><Code>620</Code><Name>Prepayments</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>An expenditure that has been paid for in advance.</Description></Account><Account><Code>625</Code><Name>Withholding tax paid</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>Withholding tax paid</Description></Account><Account><Code>710</Code><Name>Office Equipment</Name><Type>FIXED</Type><TaxType>INPUT</TaxType><Description>Office equipment that is owned and controlled by the business</Description></Account><Account><Code>711</Code><Name>Less Accumulated Depreciation on Office Equipment</Name><Type>FIXED</Type><TaxType>NONE</TaxType><Description>The total amount of office equipment cost that has been consumed by the entity (based on the useful life)</Description></Account><Account><Code>720</Code><Name>Computer Equipment</Name><Type>FIXED</Type><TaxType>INPUT</TaxType><Description>Computer equipment that is owned and controlled by the business</Description></Account><Account><Code>721</Code><Name>Less Accumulated Depreciation on Computer Equipment</Name><Type>FIXED</Type><TaxType>NONE</TaxType><Description>The total amount of computer equipment cost that has been consumed by the business (based on the useful life)</Description></Account><Account><Code>800</Code><Name>Accounts Payable</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Outstanding invoices the company has received from suppliers but has not yet paid at balance date</Description></Account><Account><Code>801</Code><Name>Unpaid Expense Claims</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Expense claims typically made by employees/shareholder employees still outstanding.</Description></Account><Account><Code>820</Code><Name>GST</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The balance in this account represents GST owing to or from the IRD. At the end of the GST period, it is this account that should be used to code against either the 'refunds from' or 'payments to' the IRD that will appear on the bank statement. Xero has been designed to use only one GST account to track GST on income and expenses, so there is no need to add any new GST accounts to Xero.</Description></Account><Account><Code>821</Code><Name>GST On Imports</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>GST paid to customs.</Description></Account><Account><Code>825</Code><Name>PAYE Payable</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The amount of PAYE tax that is due to be paid</Description></Account><Account><Code>830</Code><Name>Income Tax</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The amount of income tax that is due to be paid, also resident withholding tax paid on interest received.</Description></Account><Account><Code>840</Code><Name>Historical Adjustment</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>For accountant adjustments</Description></Account><Account><Code>850</Code><Name>Suspense</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>An entry that allows an unknown transaction to be entered, so the accounts can still be worked on in balance and the entry can be dealt with later.</Description></Account><Account><Code>860</Code><Name>Rounding</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>An adjustment entry to allow for rounding</Description></Account><Account><Code>877</Code><Name>Tracking Transfers</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Transfers between tracking categories</Description></Account><Account><Code>900</Code><Name>Loan</Name><Type>TERMLIAB</Type><TaxType>NONE</TaxType><Description>Money that has been borrowed from a creditor</Description></Account><Account><Code>960</Code><Name>Retained Earnings</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Do not Use</Description></Account><Account><Code>970</Code><Name>Owner A Funds Introduced</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Funds contributed by the owner</Description></Account><Account><Code>980</Code><Name>Owner A Drawings</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Withdrawals by the owners</Description></Account></Accounts></Response>

data/test/stub_responses/invalid_api_key_error.xml

@@ -0,0 +1 @@
+<html><head><title>Object moved</title></head><body><h2>Object moved to <a href="%2fLogin.xro%2fLogin%3fReturnUrl%3d%252fapi.xro%252f1.0%252finvoice%253fapiKey%253dAN_INVALID_API_KEY%2526xeroKey%253dYWZIMZQ3ZGVJMME1NDCWNTK3YWZMNW%2526invoiceID%253dAN_INVALID_ID%26apiKey%3dAN_INVALID_API_KEY%26xeroKey%3dYWZIMZQ3ZGVJMME1NDCWNTK3YWZMNW%26invoiceID%3dAN_INVALID_ID">here</a>.</h2></body></html>

data/test/stub_responses/invalid_customer_key_error.xml

@@ -0,0 +1 @@
+<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><Errors><Error><Description>AN_INVALID_CUSTOMER_KEY is not a valid Xero authentication key for YOUR_PROVIDER. A key for YOUR_PROVIDER must be set up by each Xero customer</Description><Exception><DateTime>2008-12-08T20:55:16.518375Z</DateTime><ExceptionType>Xero.API.Library.Exceptions.AuthKeyNotValidForProviderException</ExceptionType><Message>AN_INVALID_CUSTOMER_KEY is not a valid Xero authentication key for YOUR_PROVIDER. A key for YOUR_PROVIDER must be set up by each Xero customer</Message><Source>Xero.API.Library</Source><StackTrace>   at Xero.API.Library.Model.Organisation.ValidateAuthKey(IOrganisationService organisationService, Provider provider) in D:\Projects\network\project\Xero.API.Library\Model\Organisation.cs:line 36   at Xero.API.MVC.Controllers.APIController.InitialiseMethod(String apiKey, String xeroKey, Boolean checkAuthKey, String[] allowableMethods) in D:\Projects\network\project\Xero.API.MVC\Controllers\APIController.cs:line 101</StackTrace></Exception></Error></Errors><ID>7a3f5fb3-a22b-4d3f-8995-0e95d80d59d2</ID><Status>InternalServerError</Status><ProviderName>YOUR_PROVIDER</ProviderName><DateTimeUTC>2008-12-08T20:55:16.50275Z</DateTimeUTC></Response>

data/test/stub_responses/invoice_not_found_error.xml

@@ -0,0 +1 @@
+<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><Errors><Error><Description>Invoice with invoice number 123 does not exist for this organisation</Description><Exception><DateTime>2008-12-05T21:03:15.4445759Z</DateTime><ExceptionType>Xero.API.Library.Exceptions.ObjectDoesNotExistException</ExceptionType><Message>Invoice with invoice number 123 does not exist for this organisation</Message><Source>Xero.API.Library</Source><StackTrace>   at Xero.API.Library.Services.InvoiceService.GetInvoice(Guid organisationID, String invoiceNumber) in D:\Projects\network\project\Xero.API.Library\Services\InvoiceService.cs:line 508   at Xero.API.Web.Controllers.InvoiceController.Get(String apiKey, String xeroKey, String invoiceID, String invoiceNumber) in D:\Projects\network\project\Xero.API.Web\Controllers\InvoiceController.cs:line 37</StackTrace></Exception></Error></Errors><ID>eaf9db6c-d3b2-49e8-939a-d9f23cc7c412</ID><Status>InternalServerError</Status><ProviderName>YOUR PROVIDER</ProviderName><DateTimeUTC>2008-12-05T21:03:15.3508067Z</DateTimeUTC></Response>

data/test/stub_responses/unknown_error.xml

@@ -0,0 +1 @@
+<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><Errors><Error><Description>Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).</Description><Exception><DateTime>2008-12-05T21:02:09.9624179Z</DateTime><ExceptionType>System.FormatException</ExceptionType><Message>Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).</Message><Source>mscorlib</Source><StackTrace>   at System.Guid..ctor(String g)   at Xero.API.Web.Controllers.InvoiceController.Get(String apiKey, String xeroKey, String invoiceID, String invoiceNumber) in D:\Projects\network\project\Xero.API.Web\Controllers\InvoiceController.cs:line 37</StackTrace></Exception></Error></Errors><ID>225ad11e-601e-4e2a-bdb1-48e8517efbb3</ID><Status>InternalServerError</Status><ProviderName>YOUR PROVIDER</ProviderName><DateTimeUTC>2008-12-05T21:02:09.9467897Z</DateTimeUTC></Response>

data/test/test_helper.rb

@@ -6,4 +6,68 @@ require 'mocha'
 require 'libxml'
 
 require File.dirname(__FILE__) + '/../lib/xero_gateway.rb'
-require File.dirname(__FILE__) + '/integration/integration_test_methods.rb'
+
+module TestHelper
+  # The integration tests can be run against the Xero test environment.  You mush have a company set up in the test
+  # environment, and you must have set up a customer key for that account.
+  #
+  # You can then run the tests against the test environment using the commands (linux or mac):
+  # export STUB_XERO_CALLS=false
+  # export API_KEY=[your_api_key]
+  # export CUSTOMER_KEY=[your_customer_key]
+  # rake test
+  STUB_XERO_CALLS = ENV["STUB_XERO_CALLS"].nil? ? true : (ENV["STUB_XERO_CALLS"] == "true") unless defined? STUB_XERO_CALLS
+  
+  API_KEY = ENV["API_KEY"] unless defined? API_KEY
+  CUSTOMER_KEY = ENV["CUSTOMER_KEY"] unless defined? CUSTOMER_KEY
+
+  
+  def dummy_invoice
+     invoice = XeroGateway::Invoice.new({
+       :invoice_type => "ACCREC",
+       :due_date => Date.today + 20,
+       :invoice_number => STUB_XERO_CALLS ? "INV-0001" : "#{Time.now.to_f}",
+       :reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
+       :sub_total => 1000,
+       :total_tax => 125,
+       :total => 1125
+     })
+     invoice.contact = dummy_contact
+     invoice.line_items << XeroGateway::LineItem.new(
+       :description => "THE DESCRIPTION OF THE LINE ITEM",
+       :unit_amount => 1000,
+       :tax_amount => 125,
+       :line_amount => 1000,
+       :tracking_category => "THE TRACKING CATEGORY FOR THE LINE ITEM",
+       :tracking_option => "THE TRACKING OPTION FOR THE LINE ITEM"
+     )
+     invoice
+  end
+  
+  def dummy_contact
+    unique_id = Time.now.to_f
+    contact = XeroGateway::Contact.new(:name => STUB_XERO_CALLS ? "CONTACT NAME" : "THE NAME OF THE CONTACT #{unique_id}")
+    contact.email = "bob#{unique_id}@example.com"
+    contact.phone.number = "12345"
+    contact.address.line_1 = "LINE 1 OF THE ADDRESS"
+    contact.address.line_2 = "LINE 2 OF THE ADDRESS"
+    contact.address.line_3 = "LINE 3 OF THE ADDRESS"
+    contact.address.line_4 = "LINE 4 OF THE ADDRESS"
+    contact.address.city = "WELLINGTON"
+    contact.address.region = "WELLINGTON"
+    contact.address.country = "NEW ZEALAND"
+    contact.address.post_code = "6021"
+
+    contact
+  end
+  
+  def get_file_as_string(filename)
+    data = ''
+    f = File.open(File.dirname(__FILE__) + "/stub_responses/" + filename, "r") 
+    f.each_line do |line|
+      data += line
+    end
+    f.close
+    return data
+  end
+end

data/test/unit/{messages/account_message_test.rb → account_test.rb}

@@ -1,18 +1,18 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
-class AccountMessageTest < Test::Unit::TestCase
+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 = XeroGateway::Messages::AccountMessage.build_xml(account)
+    account_as_xml = account.to_xml
 
     # Parse the XML message and retrieve the account element
     account_element = REXML::XPath.first(REXML::Document.new(account_as_xml), "/Account")
 
     # Build a new account from the XML
-    result_account = XeroGateway::Messages::AccountMessage.from_xml(account_element)
+    result_account = XeroGateway::Account.from_xml(account_element)
     
     # Check the account details
     assert_equal account, result_account

data/test/unit/{messages/contact_message_test.rb → contact_test.rb}

@@ -1,15 +1,15 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
-class ContactMessageTest < Test::Unit::TestCase
+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')))
+    @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 = XeroGateway::Messages::ContactMessage.build_xml(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"
@@ -20,13 +20,13 @@ class ContactMessageTest < Test::Unit::TestCase
     contact = create_test_contact
     
     # Generate the XML message
-    contact_as_xml = XeroGateway::Messages::ContactMessage.build_xml(contact)
+    contact_as_xml = contact.to_xml
 
     # Parse the XML message and retrieve the contact element
     contact_element = REXML::XPath.first(REXML::Document.new(contact_as_xml), "/Contact")
 
     # Build a new contact from the XML
-    result_contact = XeroGateway::Messages::ContactMessage.from_xml(contact_element)
+    result_contact = XeroGateway::Contact.from_xml(contact_element)
     
     # Check the contact details
     assert_equal contact, result_contact

data/test/unit/gateway_test.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class GatewayTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(
+      :customer_key => CUSTOMER_KEY,
+      :api_key => API_KEY    
+    )
+  end
+  
+  def test_invalid_api_key_error_handling
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      @gateway.stubs(:http_get).with {|url, params| url =~ /invoices$/ }.returns(get_file_as_string("invalid_api_key_error.xml"))          
+    end
+
+    @gateway.api_key = "AN_INVALID_API_KEY"
+    
+    result = @gateway.get_invoices
+    assert !result.success?
+    assert_equal "INVALID_API_KEY", result.status    
+  end
+
+  def test_invalid_customer_key_error_handling
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      @gateway.stubs(:http_get).with {|url, params| url =~ /invoices$/ }.returns(get_file_as_string("invalid_customer_key_error.xml"))          
+    end
+
+    @gateway.customer_key = "AN_INVALID_CUSTOMER_KEY"
+
+    result = @gateway.get_invoices
+
+    assert !result.success?
+    assert_equal 1, result.errors.size    
+    assert result.errors.first.description =~ /^AN_INVALID_CUSTOMER_KEY is not a valid Xero authentication key/
+  end
+  
+  def test_unknown_error_handling
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      @gateway.stubs(:http_get).with {|url, params| url =~ /invoice$/ }.returns(get_file_as_string("unknown_error.xml"))          
+    end
+    
+    result = @gateway.get_invoice_by_id("AN_INVALID_ID")
+    assert !result.success?
+    assert_equal 1, result.errors.size
+    assert !result.errors.first.type.nil?
+    assert !result.errors.first.description.nil?
+  end
+
+  def test_object_not_found_error_handling
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      @gateway.stubs(:http_get).with {|url, params| url =~ /invoice$/ }.returns(get_file_as_string("invoice_not_found_error.xml"))
+    end
+    
+    result = @gateway.get_invoice_by_number("UNKNOWN_INVOICE_NO")
+    assert !result.success?
+    assert_equal 1, result.errors.size
+    assert_equal "Xero.API.Library.Exceptions.ObjectDoesNotExistException", result.errors.first.type
+    assert !result.errors.first.description.nil?
+  end
+end

data/test/unit/{messages/invoice_message_test.rb → invoice_test.rb}

@@ -1,15 +1,15 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
-class InvoiceMessageTest < Test::Unit::TestCase
+class InvoiceTest < Test::Unit::TestCase
   def setup
-    @schema = LibXML::XML::Schema.document(LibXML::XML::Document.file(File.join(File.dirname(__FILE__), '../../xsd/create_invoice.xsd')))
+    @schema = LibXML::XML::Schema.document(LibXML::XML::Document.file(File.join(File.dirname(__FILE__), '../xsd/create_invoice.xsd')))
   end
   
   # Tests that the XML generated from an invoice object validates against the Xero XSD
   def test_build_xml
     invoice = create_test_invoice
     
-    message = XeroGateway::Messages::InvoiceMessage.build_xml(invoice)
+    message = invoice.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"
@@ -20,13 +20,13 @@ class InvoiceMessageTest < Test::Unit::TestCase
     invoice = create_test_invoice
     
     # Generate the XML message
-    invoice_as_xml = XeroGateway::Messages::InvoiceMessage.build_xml(invoice)
+    invoice_as_xml = invoice.to_xml
 
     # Parse the XML message and retrieve the invoice element
     invoice_element = REXML::XPath.first(REXML::Document.new(invoice_as_xml), "/Invoice")
 
     # Build a new invoice from the XML
-    result_invoice = XeroGateway::Messages::InvoiceMessage.from_xml(invoice_element)
+    result_invoice = XeroGateway::Invoice.from_xml(invoice_element)
 
     assert_equal(invoice, result_invoice)
   end

data/test/unit/{messages/tracking_category_message_test.rb → tracking_category_test.rb}

@@ -1,18 +1,18 @@
-require File.join(File.dirname(__FILE__), '../../test_helper.rb')
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
-class TrackingCategoryMessageTest < Test::Unit::TestCase
+class TrackingCategoryTest < 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
     tracking_category = create_test_tracking_category
     
     # Generate the XML message
-    tracking_category_as_xml = XeroGateway::Messages::TrackingCategoryMessage.build_xml(tracking_category)
+    tracking_category_as_xml = tracking_category.to_xml
 
     # Parse the XML message and retrieve the tracking category element
     tracking_category_element = REXML::XPath.first(REXML::Document.new(tracking_category_as_xml), "/TrackingCategory")
 
     # Build a new tracking category from the XML
-    result_tracking_category = XeroGateway::Messages::TrackingCategoryMessage.from_xml(tracking_category_element)
+    result_tracking_category = XeroGateway::TrackingCategory.from_xml(tracking_category_element)
     
     # Check the tracking category details
     assert_equal tracking_category, result_tracking_category

data/xero_gateway.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "xero_gateway"
-  s.version  = "1.0.2"
-  s.date     = "2008-12-04"
+  s.version  = "1.0.3"
+  s.date     = "2008-12-09"
   s.summary  = "Enables ruby based applications to communicate with the Xero API"
   s.email    = "tlconnor@gmail.com"
   s.homepage = "http://github.com/tlconnor/xero_gateway"
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     "lib/xero_gateway/address.rb",
     "lib/xero_gateway/contact.rb",
     "lib/xero_gateway/dates.rb",
+    "lib/xero_gateway/error.rb",
     "lib/xero_gateway/gateway.rb",
     "lib/xero_gateway/http.rb",
     "lib/xero_gateway/invoice.rb",
@@ -27,10 +28,6 @@ Gem::Specification.new do |s|
     "lib/xero_gateway/phone.rb",
     "lib/xero_gateway/response.rb",
     "lib/xero_gateway/tracking_category.rb",
-    "lib/xero_gateway/messages/account_message.rb",
-    "lib/xero_gateway/messages/contact_message.rb",
-    "lib/xero_gateway/messages/invoice_message.rb",
-    "lib/xero_gateway/messages/tracking_category_message.rb",
     "test/test_helper.rb",
     "test/integration/create_contact_test.rb",
     "test/integration/create_invoice_test.rb",
@@ -40,18 +37,22 @@ Gem::Specification.new do |s|
     "test/integration/get_invoice_test.rb",
     "test/integration/get_invoices_test.rb",
     "test/integration/get_tracking_categories_test.rb",
-    "test/integration/integration_test_methods.rb",
-    "test/integration/stub_responses/accounts.xml",
-    "test/integration/stub_responses/contact.xml",
-    "test/integration/stub_responses/contacts.xml",
-    "test/integration/stub_responses/invoice.xml",
-    "test/integration/stub_responses/invoices.xml",
-    "test/integration/stub_responses/tracking_categories.xml",
     "test/integration/update_contact_test.rb",
-    "test/unit/messages/account_message_test.rb",
-    "test/unit/messages/contact_message_test.rb",
-    "test/unit/messages/invoice_message_test.rb",
-    "test/unit/messages/tracking_category_message_test.rb",
+    "test/stub_responses/accounts.xml",
+    "test/stub_responses/contact.xml",
+    "test/stub_responses/contacts.xml",
+    "test/stub_responses/invoice.xml",
+    "test/stub_responses/invoices.xml",
+    "test/stub_responses/invalid_api_key_error.xml",
+    "test/stub_responses/invalid_customer_key_error.xml",
+    "test/stub_responses/tracking_categories.xml",
+    "test/stub_responses/invoice_not_found_error.xml",
+    "test/stub_responses/unknown_error.xml",
+    "test/unit/account_test.rb",
+    "test/unit/contact_test.rb",
+    "test/unit/gateway_test.rb",
+    "test/unit/invoice_test.rb",
+    "test/unit/tracking_category_test.rb",
     "test/xsd/README",
     "test/xsd/create_contact.xsd",
     "test/xsd/create_invoice.xsd",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tlconnor-xero_gateway
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Tim Connor
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-04 00:00:00 -08:00
+date: 2008-12-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,7 @@ files:
 - lib/xero_gateway/address.rb
 - lib/xero_gateway/contact.rb
 - lib/xero_gateway/dates.rb
+- lib/xero_gateway/error.rb
 - lib/xero_gateway/gateway.rb
 - lib/xero_gateway/http.rb
 - lib/xero_gateway/invoice.rb
@@ -48,10 +49,6 @@ files:
 - lib/xero_gateway/phone.rb
 - lib/xero_gateway/response.rb
 - lib/xero_gateway/tracking_category.rb
-- lib/xero_gateway/messages/account_message.rb
-- lib/xero_gateway/messages/contact_message.rb
-- lib/xero_gateway/messages/invoice_message.rb
-- lib/xero_gateway/messages/tracking_category_message.rb
 - test/test_helper.rb
 - test/integration/create_contact_test.rb
 - test/integration/create_invoice_test.rb
@@ -61,18 +58,22 @@ files:
 - test/integration/get_invoice_test.rb
 - test/integration/get_invoices_test.rb
 - test/integration/get_tracking_categories_test.rb
-- test/integration/integration_test_methods.rb
-- test/integration/stub_responses/accounts.xml
-- test/integration/stub_responses/contact.xml
-- test/integration/stub_responses/contacts.xml
-- test/integration/stub_responses/invoice.xml
-- test/integration/stub_responses/invoices.xml
-- test/integration/stub_responses/tracking_categories.xml
 - test/integration/update_contact_test.rb
-- test/unit/messages/account_message_test.rb
-- test/unit/messages/contact_message_test.rb
-- test/unit/messages/invoice_message_test.rb
-- test/unit/messages/tracking_category_message_test.rb
+- test/stub_responses/accounts.xml
+- test/stub_responses/contact.xml
+- test/stub_responses/contacts.xml
+- test/stub_responses/invoice.xml
+- test/stub_responses/invoices.xml
+- test/stub_responses/invalid_api_key_error.xml
+- test/stub_responses/invalid_customer_key_error.xml
+- test/stub_responses/tracking_categories.xml
+- test/stub_responses/invoice_not_found_error.xml
+- test/stub_responses/unknown_error.xml
+- test/unit/account_test.rb
+- test/unit/contact_test.rb
+- test/unit/gateway_test.rb
+- test/unit/invoice_test.rb
+- test/unit/tracking_category_test.rb
 - test/xsd/README
 - test/xsd/create_contact.xsd
 - test/xsd/create_invoice.xsd

data/lib/xero_gateway/messages/account_message.rb

@@ -1,33 +0,0 @@
-module XeroGateway
-  module Messages
-    class AccountMessage      
-      
-      def self.build_xml(account)
-        b = Builder::XmlMarkup.new
-        
-        b.Account {
-          b.Code account.code
-          b.Name account.name
-          b.Type account.type
-          b.TaxType account.tax_type
-          b.Description account.description
-        }
-      end
-      
-      # Take an Account element and convert it into an Account object
-      def self.from_xml(account_element)        
-        account = Account.new
-        account_element.children.each do |element|
-          case(element.name)
-            when "Code" then account.code = element.text
-            when "Name" then account.name = element.text
-            when "Type" then account.type = element.text
-            when "TaxType" then account.tax_type = element.text
-            when "Description" then account.description = element.text
-          end
-        end      
-        account
-      end
-    end
-  end
-end