xero_gateway-n8vision 2.0.20

data/test/integration/get_credit_note_test.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetCreditNoteTest < 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 =~ /CreditNotes(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("credit_note.xml"))              
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /CreditNotes$/ }.returns(get_file_as_string("create_credit_note.xml"))          
+    end
+  end
+  
+  def test_get_credit_note
+    # Make sure there is an credit_note in Xero to retrieve
+    credit_note = @gateway.create_credit_note(dummy_credit_note).credit_note
+
+    result = @gateway.get_credit_note(credit_note.credit_note_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
+    assert_equal result.credit_note.credit_note_number, credit_note.credit_note_number
+
+    result = @gateway.get_credit_note(credit_note.credit_note_number)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
+    assert_equal result.credit_note.credit_note_id, credit_note.credit_note_id
+  end
+  
+  def test_line_items_downloaded_set_correctly
+    # Make sure there is an credit_note in Xero to retrieve.
+    example_credit_note = @gateway.create_credit_note(dummy_credit_note).credit_note
+    
+    # No line items.
+    response = @gateway.get_credit_note(example_credit_note.credit_note_id)
+    assert_equal(true, response.success?)
+    
+    credit_note = response.credit_note
+    assert_kind_of(XeroGateway::LineItem, credit_note.line_items.first)
+    assert_kind_of(XeroGateway::CreditNote, credit_note)
+    assert_equal(true, credit_note.line_items_downloaded?)
+  end
+  
+end

data/test/integration/get_credit_notes_test.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetCreditNotesTest < Test::Unit::TestCase
+  include TestHelper
+  
+  INVALID_CREDIT_NOTE_ID = "99999999-9999-9999-9999-999999999999" unless defined?(INVALID_CREDIT_NOTE_ID)
+  
+  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 =~ /CreditNotes/ }.returns(get_file_as_string("credit_notes.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /CreditNotes$/ }.returns(get_file_as_string("create_credit_note.xml"))
+
+      # Get an credit_note with an invalid ID number.
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ Regexp.new("CreditNotes/#{INVALID_CREDIT_NOTE_ID}") }.returns(get_file_as_string("credit_note_not_found_error.xml"))
+    end
+  end
+  
+  def test_get_credit_notes
+    # Make sure there is an credit_note in Xero to retrieve
+    credit_note = @gateway.create_credit_note(dummy_credit_note).credit_note
+    
+    result = @gateway.get_credit_notes
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?  
+    assert result.credit_notes.collect {|i| i.credit_note_number}.include?(credit_note.credit_note_number)
+  end
+  
+  def test_get_credit_notes_with_modified_since_date
+    # Create a test credit_note
+    credit_note = dummy_credit_note
+    @gateway.create_credit_note(credit_note)
+    
+    # Check that it is returned
+    result = @gateway.get_credit_notes(:modified_since => Date.today - 1)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
+    assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
+    assert result.credit_notes.collect {|response_credit_note| response_credit_note.credit_note_number}.include?(credit_note.credit_note_number)
+  end
+  
+  def test_line_items_downloaded_set_correctly
+    # No line items.
+    response = @gateway.get_credit_notes
+    assert_equal(true, response.success?)
+    
+    credit_note = response.credit_notes.first
+    assert_kind_of(XeroGateway::CreditNote, credit_note)
+    assert_equal(false, credit_note.line_items_downloaded?)
+  end
+  
+  # Make sure that a reference to gateway is passed when the get_credit_notes response is parsed.
+  def test_get_contacts_gateway_reference
+    result = @gateway.get_credit_notes
+    assert(result.success?)
+    assert_not_equal(0, result.credit_notes.size)
+    
+    result.credit_notes.each do | credit_note |
+      assert(credit_note.gateway === @gateway)
+    end
+  end
+  
+  # Test to make sure that we correctly error when an credit_note doesn't have an ID.
+  # This should usually never be ecountered, but might if a draft credit_note is deleted from Xero.
+  def test_to_ensure_that_an_credit_note_with_invalid_id_errors
+    # Make sure there is an credit_note to retrieve, even though we will mangle it later.
+    credit_note = @gateway.create_credit_note(dummy_credit_note).credit_note
+    
+    result = @gateway.get_credit_notes
+    assert_equal(true, result.success?)
+    
+    credit_note = result.credit_notes.first
+    assert_equal(false, credit_note.line_items_downloaded?)
+    
+    # Mangle credit_note_id to invalid one.
+    credit_note.credit_note_id = INVALID_CREDIT_NOTE_ID
+    
+    # Make sure we fail here.
+    line_items = nil
+    assert_raise(XeroGateway::CreditNoteNotFoundError) { line_items = credit_note.line_items }
+    assert_nil(line_items)
+    
+  end
+  
+end

data/test/integration/get_currencies_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetCurrenciesTest < 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 =~ /Currencies$/ }.returns(get_file_as_string("currencies.xml"))          
+    end
+  end
+  
+  def test_get_currencies
+    result = @gateway.get_currencies
+    assert result.success?
+    assert !result.response_xml.nil?
+    
+    assert result.currencies.size > 0
+    assert_equal XeroGateway::Currency, result.currencies.first.class
+    assert_equal "NZD", result.currencies.first.code
+  end
+end

data/test/integration/get_invoice_test.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetInvoiceTest < 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 =~ /Invoices(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("invoice.xml"))              
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("create_invoice.xml"))          
+    end
+  end
+  
+  def test_get_invoice
+    # Make sure there is an invoice in Xero to retrieve
+    invoice = @gateway.create_invoice(dummy_invoice).invoice
+
+    result = @gateway.get_invoice(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(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
+  
+  def test_line_items_downloaded_set_correctly
+    # Make sure there is an invoice in Xero to retrieve.
+    example_invoice = @gateway.create_invoice(dummy_invoice).invoice
+    
+    # No line items.
+    response = @gateway.get_invoice(example_invoice.invoice_id)
+    assert_equal(true, response.success?)
+    
+    invoice = response.invoice
+    assert_kind_of(XeroGateway::LineItem, invoice.line_items.first)
+    assert_kind_of(XeroGateway::Invoice, invoice)
+    assert_equal(true, invoice.line_items_downloaded?)
+  end
+  
+end

data/test/integration/get_invoices_test.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetInvoicesTest < Test::Unit::TestCase
+  include TestHelper
+  
+  INVALID_INVOICE_ID = "99999999-9999-9999-9999-999999999999" unless defined?(INVALID_INVOICE_ID)
+  
+  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 =~ /Invoices/ }.returns(get_file_as_string("invoices.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("create_invoice.xml"))
+
+      # Get an invoice with an invalid ID number.
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ Regexp.new("Invoices/#{INVALID_INVOICE_ID}") }.returns(get_file_as_string("invoice_not_found_error.xml"))
+    end
+  end
+  
+  def test_get_invoices
+    # Make sure there is an invoice in Xero to retrieve
+    invoice = @gateway.create_invoice(dummy_invoice).invoice
+    
+    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)
+    assert result.invoices[0].sent_to_contact == true
+    assert result.invoices[1].sent_to_contact == false
+  end
+  
+  def test_get_invoices_with_modified_since_date
+    # Create a test invoice
+    invoice = dummy_invoice
+    @gateway.create_invoice(invoice)
+    
+    # Check that it is returned
+    result = @gateway.get_invoices(:modified_since => Date.today - 1)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?    
+    assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
+    assert result.invoices.collect {|response_invoice| response_invoice.invoice_number}.include?(invoice.invoice_number)
+  end
+  
+  def test_line_items_downloaded_set_correctly
+    # No line items.
+    response = @gateway.get_invoices
+    assert_equal(true, response.success?)
+    
+    invoice = response.invoices.first
+    assert_kind_of(XeroGateway::Invoice, invoice)
+    assert_equal(false, invoice.line_items_downloaded?)
+  end
+  
+  # Make sure that a reference to gateway is passed when the get_invoices response is parsed.
+  def test_get_contacts_gateway_reference
+    result = @gateway.get_invoices
+    assert(result.success?)
+    assert_not_equal(0, result.invoices.size)
+    
+    result.invoices.each do | invoice |
+      assert(invoice.gateway === @gateway)
+    end
+  end
+  
+  # Test to make sure that we correctly error when an invoice doesn't have an ID.
+  # This should usually never be ecountered, but might if a draft invoice is deleted from Xero.
+  def test_to_ensure_that_an_invoice_with_invalid_id_errors
+    # Make sure there is an invoice to retrieve, even though we will mangle it later.
+    invoice = @gateway.create_invoice(dummy_invoice).invoice
+    
+    result = @gateway.get_invoices
+    assert_equal(true, result.success?)
+    
+    invoice = result.invoices.first
+    assert_equal(false, invoice.line_items_downloaded?)
+    
+    # Mangle invoice_id to invalid one.
+    invoice.invoice_id = INVALID_INVOICE_ID
+    
+    # Make sure we fail here.
+    line_items = nil
+    assert_raise(XeroGateway::InvoiceNotFoundError) { line_items = invoice.line_items }
+    assert_nil(line_items)
+    
+  end
+  
+end

data/test/integration/get_manual_journal_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetManualJournalTest < 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 =~ /ManualJournals(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("manual_journal.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /ManualJournals$/ }.returns(get_file_as_string("create_manual_journal.xml"))
+    end
+  end
+
+  def test_get_manual_journal
+    # Make sure there is a manual journal in Xero to retrieve
+    response = @gateway.create_manual_journal(create_test_manual_journal)
+    manual_journal = response.manual_journal
+
+    result = @gateway.get_manual_journal(manual_journal.manual_journal_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert_equal result.manual_journal.manual_journal_id, manual_journal.manual_journal_id
+    assert_equal result.manual_journal.narration, manual_journal.narration
+
+    result = @gateway.get_manual_journal(manual_journal.manual_journal_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert_equal result.manual_journal.manual_journal_id, manual_journal.manual_journal_id
+  end
+
+  def test_journal_lines_downloaded_set_correctly
+    # Make sure there is a manual journal in Xero to retrieve.
+    example_manual_journal = @gateway.create_manual_journal(create_test_manual_journal).manual_journal
+  
+    # No line items.
+    response = @gateway.get_manual_journal(example_manual_journal.manual_journal_id)
+    assert response.success?
+  
+    manual_journal = response.manual_journal
+    assert_kind_of(XeroGateway::JournalLine, manual_journal.journal_lines.first)
+    assert_kind_of(XeroGateway::ManualJournal, manual_journal)
+    assert manual_journal.journal_lines_downloaded?
+  end
+
+end

data/test/integration/get_manual_journals_test.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetManualJournalsTest < Test::Unit::TestCase
+  include TestHelper
+
+  INVALID_MANUAL_JOURNAL_ID = "99999999-9999-9999-9999-999999999999" unless defined?(INVALID_MANUAL_JOURNAL_ID)
+
+  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 =~ /ManualJournals(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("manual_journals.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /ManualJournals$/ }.returns(get_file_as_string("create_manual_journal.xml"))
+
+      # Get a manual journal with an invalid ID.
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ Regexp.new("ManualJournals/#{INVALID_MANUAL_JOURNAL_ID}") }.returns(get_file_as_string("manual_journal_not_found_error.xml"))
+    end
+  end
+
+  def test_get_manual_journals
+    # Make sure there is a manual journal in Xero to retrieve
+    manual_journal = @gateway.create_manual_journal(create_test_manual_journal).manual_journal
+
+    result = @gateway.get_manual_journals
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.manual_journals.collect {|i| i.narration}.include?(manual_journal.narration)
+    assert result.manual_journals.collect {|i| i.manual_journal_id}.include?(manual_journal.manual_journal_id)
+  end
+
+  def test_get_manual_journals_with_modified_since_date
+    # Create a test manual journal
+    @gateway.create_manual_journal(create_test_manual_journal)
+
+    # Check that it is returned
+    result = @gateway.get_manual_journals(:modified_since => Date.today - 1)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
+  end
+
+  def test_journal_lines_downloaded_set_correctly
+    # No line items.
+    response = @gateway.get_manual_journals
+    assert_equal(true, response.success?)
+
+    manual_journal = response.manual_journals.first
+    assert_kind_of(XeroGateway::ManualJournal, manual_journal)
+    assert !manual_journal.journal_lines_downloaded?
+  end
+
+  # Make sure that a reference to gateway is passed when the get_manual_journals response is parsed.
+  def test_get_manual_journals_gateway_reference
+    result = @gateway.get_manual_journals
+    assert(result.success?)
+    assert_not_equal(0, result.manual_journals.size)
+
+    result.manual_journals.each do |manual_journal|
+      assert(manual_journal.gateway === @gateway)
+    end
+  end
+
+  # Test to make sure that we correctly error when a manual journal doesn't have an ID.
+  # This should usually never be ecountered.
+  def test_to_ensure_that_a_manual_journal_with_invalid_id_errors
+    # Make sure there is a manual journal to retrieve, even though we will mangle it later.
+    manual_journal = @gateway.create_manual_journal(create_test_manual_journal).manual_journal
+
+    result = @gateway.get_manual_journals
+    assert_equal(true, result.success?)
+
+    manual_journal = result.manual_journals.first
+    assert !manual_journal.journal_lines_downloaded?
+
+    # Mangle invoice_id to invalid one.
+    manual_journal.manual_journal_id = INVALID_MANUAL_JOURNAL_ID
+
+    # Make sure we fail here.
+    journal_lines = nil
+    assert_raise(XeroGateway::ManualJournalNotFoundError) { journal_lines = manual_journal.journal_lines }
+    assert_nil(journal_lines)
+  end
+
+end