xero_gateway-n8vision 2.0.20

data/test/integration/get_organisation_test.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetOrganisationTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /Organisation$/ }.returns(get_file_as_string("organisation.xml"))          
+    end
+  end
+  
+  def test_get_organisation
+    result = @gateway.get_organisation
+    assert result.success?
+    assert !result.response_xml.nil?
+    
+    assert_equal XeroGateway::Organisation, result.organisation.class
+    assert_equal "Demo Company (NZ)", result.organisation.name
+  end
+end

data/test/integration/get_tax_rates_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetTaxRatesTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /TaxRates$/ }.returns(get_file_as_string("tax_rates.xml"))          
+    end
+  end
+  
+  def test_get_tax_rates
+    result = @gateway.get_tax_rates
+    assert result.success?
+    assert !result.response_xml.nil?
+    
+    assert result.tax_rates.size > 0
+    assert_equal XeroGateway::TaxRate, result.tax_rates.first.class
+    assert_equal "GST on Expenses", result.tax_rates.first.name
+  end
+end

data/test/integration/get_tracking_categories_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetTrackingCategoriesTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /TrackingCategories$/ }.returns(get_file_as_string("tracking_categories.xml"))          
+    end
+  end
+  
+  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_equal 1, result.tracking_categories.size
+      assert_equal 4, result.tracking_categories.first.options.size
+    end
+  end
+end

data/test/integration/update_bank_transaction_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateBankTransactionTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("create_bank_transaction.xml"))
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("bank_transaction.xml"))
+    end
+  end
+
+  def test_update_bank_transaction
+    bank_transaction = @gateway.create_bank_transaction(create_test_bank_transaction).bank_transaction
+
+    today = Date.today
+    bank_transaction.date = today
+
+    result = @gateway.update_bank_transaction(bank_transaction)
+
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
+    assert_equal bank_transaction.bank_transaction_id, result.bank_transaction.bank_transaction_id
+    assert_equal today, result.bank_transaction.date if !STUB_XERO_CALLS
+  end
+end

data/test/integration/update_contact_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateContactTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Contacts$/ }.returns(get_file_as_string("contact.xml"))          
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /Contacts$/ }.returns(get_file_as_string("contact.xml"))          
+    end
+  end
+  
+  def test_update_contact
+    # Make sure there is a contact in Xero to retrieve
+    contact = @gateway.create_contact(dummy_contact).contact
+
+    contact.phone.number = "123 4567"
+    
+    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
+end

data/test/integration/update_invoice_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateInvoiceTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+      
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("create_invoice.xml"))          
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("invoice.xml"))          
+    end
+  end
+  
+  def test_update_invoice
+    invoice = @gateway.create_invoice(dummy_invoice).invoice
+    
+    today = Date.today
+    invoice.due_date = today
+    
+    result = @gateway.update_invoice(invoice)
+    
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?    
+    assert_equal invoice.invoice_id, result.invoice.invoice_id
+    assert_equal today, result.invoice.due_date if !STUB_XERO_CALLS
+  end
+end

data/test/integration/update_manual_journal_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateManualJournalTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /ManualJournals$/ }.returns(get_file_as_string("create_manual_journal.xml"))
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /ManualJournals$/ }.returns(get_file_as_string("manual_journal.xml"))
+    end
+  end
+
+  def test_update_manual_journal
+    manual_journal = @gateway.create_manual_journal(create_test_manual_journal).manual_journal
+
+    today = Date.today
+    manual_journal.date = today
+
+    result = @gateway.update_manual_journal(manual_journal)
+
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
+    assert_equal manual_journal.manual_journal_id, result.manual_journal.manual_journal_id
+    assert_equal today, result.manual_journal.date if !STUB_XERO_CALLS
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,217 @@
+require "rubygems"
+
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+
+require 'libxml'
+
+require File.dirname(__FILE__) + '/../lib/xero_gateway.rb' unless defined?(XeroGateway)
+
+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  
+  # rake test
+  # (this probably won't work under OAuth?)
+  #
+  
+  STUB_XERO_CALLS = ENV["STUB_XERO_CALLS"].nil? ? true : (ENV["STUB_XERO_CALLS"] == "true") unless defined? STUB_XERO_CALLS
+  
+  CONSUMER_KEY    = ENV["CONSUMER_KEY"]    || "fake_key"    unless defined?(CONSUMER_KEY)
+  CONSUMER_SECRET = ENV["CONSUMER_SECRET"] || "fake_secret" unless defined?(CONSUMER_SECRET)
+  
+  # Helper constant for checking regex
+  GUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ unless defined?(GUID_REGEX)
+
+  
+  def dummy_invoice(with_line_items = true)
+     invoice = XeroGateway::Invoice.new({
+       :invoice_type => "ACCREC",
+       :date => Time.now,
+       :due_date => Date.today + 20,
+       :invoice_number => STUB_XERO_CALLS ? "INV-0001" : "#{Time.now.to_f}",
+       :reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
+       :line_items_downloaded => with_line_items
+     })
+     invoice.contact = dummy_contact
+     if with_line_items
+       invoice.line_items << XeroGateway::LineItem.new(
+         :description => "THE DESCRIPTION OF THE LINE ITEM",
+         :unit_amount => 1000,
+         :tax_amount => 125,
+         :tracking => [
+            XeroGateway::TrackingCategory.new(:name => "THE FIRST  TRACKING CATEGORY FOR THE LINE ITEM", :options => ["a", "b"]),
+            XeroGateway::TrackingCategory.new(:name => "THE SECOND TRACKING CATEGORY FOR THE LINE ITEM", :options => "c")
+         ]
+       )
+     end
+     invoice
+  end
+      
+  def dummy_credit_note(with_line_items = true)
+     credit_note = XeroGateway::CreditNote.new({
+       :type => "ACCRECCREDIT",
+       :date => Time.now,
+       :credit_note_number => STUB_XERO_CALLS ? "CN-0153" : "#{Time.now.to_f}",
+       :reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
+       :line_items_downloaded => with_line_items
+     })
+     credit_note.contact = dummy_contact
+     if with_line_items
+       credit_note.line_items << XeroGateway::LineItem.new(
+         :description => "THE DESCRIPTION OF THE LINE ITEM",
+         :unit_amount => 1000,
+         :tax_amount => 125,
+         :tracking => [
+            XeroGateway::TrackingCategory.new(:name => "THE FIRST  TRACKING CATEGORY FOR THE LINE ITEM", :options => ["a", "b"]),
+            XeroGateway::TrackingCategory.new(:name => "THE SECOND TRACKING CATEGORY FOR THE LINE ITEM", :options => "c")
+         ]
+       )
+     end
+     credit_note
+  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
+
+  def create_test_bank_transaction(params={}, contact_params={}, line_item_params={})
+    params = {
+      :type       => 'RECEIVE',
+      :date       => Date.today,
+      :reference  => '12345',
+      :status     => 'ACTIVE',
+    }.merge(params)
+    bank_transaction = XeroGateway::BankTransaction.new(params)
+
+    bank_transaction.contact = create_test_contact(contact_params)
+    add_test_line_items(bank_transaction, line_item_params)
+    bank_transaction.bank_account = create_test_account
+
+    bank_transaction
+  end
+
+  def add_test_line_items(bank_transaction, line_item_params={})
+    if line_item_params
+      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] = {
+        :description  => "A LINE ITEM",
+        :account_code => "200",
+        :unit_amount  => BigDecimal.new("100"),
+        :tax_amount   => BigDecimal.new("12.5"),
+        :tracking     => XeroGateway::TrackingCategory.new(:name => "blah", :options => "hello")
+      }.merge(line_item_params[0])
+
+      # Create line_items from line_item_params
+      line_item_params.each do |line_item|
+        bank_transaction.add_line_item(line_item)
+      end
+    end
+    bank_transaction
+  end
+
+  def create_test_account
+    account = XeroGateway::Account.new(:account_id => "57cedda9")
+    account.code = "200"
+    account.name = "Sales"
+    account.type = "REVENUE"
+    account.tax_type = "OUTPUT"
+    account.description = "Income from any normal business activity"
+    account.enable_payments_to_account = false
+    account
+  end
+
+  def create_test_contact(contact_params={})
+    # Strip out :address key from contact_params to use as the default address.
+    stripped_address = {
+      :address_type => 'STREET',
+      :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)
+
+    contact = XeroGateway::Contact.new(contact_params)
+    contact.address = XeroGateway::Address.new(stripped_address)
+    contact.phone = XeroGateway::Phone.new(stripped_phone)
+    contact
+  end
+
+  def create_test_manual_journal(params={}, journal_line_params={})
+    params = {      
+      :date       => Date.today,
+      :narration  => 'test narration',
+      :status     => 'POSTED'
+    }.merge(params)
+    manual_journal = XeroGateway::ManualJournal.new(params)
+    add_test_journal_lines(manual_journal, journal_line_params)
+  end
+
+  def add_test_journal_lines(manual_journal, journal_line_params)
+    if journal_line_params
+      journal_line_params = [journal_line_params].flatten # always use an array, even if only a single hash passed in
+
+      # At least one line item, make first have some defaults.
+      journal_line_params << {} if journal_line_params.size == 0
+      journal_line_params[0] = {
+        :description  => "FIRST LINE",
+        :account_code => "200",
+        :line_amount  => BigDecimal.new("100"),
+        :tracking     => XeroGateway::TrackingCategory.new(:name => "blah", :options => "hello")
+      }.merge(journal_line_params[0])
+      params_line_1 = journal_line_params[1] || {}
+      journal_line_params[1] = {
+        :description  => "SECOND LINE",
+        :account_code => "200",
+        :line_amount  => BigDecimal.new("-100"),        
+        :tracking     => XeroGateway::TrackingCategory.new(:name => "blah2", :options => "hello2")
+      }.merge(params_line_1)      
+
+      # Create line_items from line_item_params
+      journal_line_params.each do |journal_line|
+        manual_journal.add_journal_line(journal_line)
+      end
+    end
+    manual_journal
+  end
+
+end

data/test/unit/account_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+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
+
+    # 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::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_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 '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.tax_type = "OUTPUT"
+    account.description = "Income from any normal business activity"
+    account.enable_payments_to_account = false
+    account.currency_code = options[:currency_code] if options[:currency_code]
+
+    account
+  end
+end