xero_gateway 2.0.13 → 2.0.14

data/test/unit/account_test.rb

@@ -18,18 +18,30 @@ class AccountTest < Test::Unit::TestCase
     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
+  def create_test_account(options={})
     account = XeroGateway::Account.new(:account_id => "57cedda9")
     account.code = "200"
     account.name = "Sales"
-    account.type = "REVENUE"
+    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

data/test/unit/bank_transaction_test.rb

@@ -0,0 +1,114 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class BankTransactionTest < Test::Unit::TestCase
+  include TestHelper
+
+  context "creating test bank transactions" do
+    should "work" do
+      bank_transaction = create_test_bank_transaction
+
+      # test transaction defaults
+      assert_equal 'RECEIVE', bank_transaction.type
+      assert_kind_of Date, bank_transaction.date
+      assert_equal '12345', bank_transaction.reference
+      assert_equal 'ACTIVE', bank_transaction.status
+
+      # Test the contact defaults.
+      contact = bank_transaction.contact
+      assert_equal '00000000-0000-0000-0000-000000000000', contact.contact_id
+      assert_equal 'CONTACT NAME', contact.name
+
+      # Test address defaults.
+      assert_equal 'STREET', contact.address.address_type
+      assert_equal 'LINE 1 OF THE ADDRESS', contact.address.line_1
+
+      # Test phone defaults.
+      assert_equal('DEFAULT', contact.phone.phone_type)
+      assert_equal('12345678', contact.phone.number)
+
+      # Test the line_item defaults.
+      line_item = bank_transaction.line_items.first
+      assert_equal('A LINE ITEM', line_item.description)
+      assert_equal('200', line_item.account_code)
+      assert_equal(BigDecimal.new('100'), line_item.unit_amount)
+      assert_equal(BigDecimal.new('12.5'), line_item.tax_amount)
+    end
+
+    should "allow overriding transaction defaults" do
+      assert_equal 'SPEND', create_test_bank_transaction(:type => 'SPEND').type
+    end
+  end
+
+  context "adding line items" do
+    setup do
+      @bank_transaction = create_test_bank_transaction({}, {}, nil) # no line_items
+    end
+
+    should "work" do
+      assert_equal(0, @bank_transaction.line_items.size)
+
+      line_item_params = {:description => "Test Item 1", :unit_amount => 100}
+
+      # Test adding line item by hash
+      line_item = @bank_transaction.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, @bank_transaction.line_items.size)
+
+      # Test adding line item by XeroGateway::LineItem
+      line_item = @bank_transaction.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(2, @bank_transaction.line_items.size)
+
+      # Test that pushing anything else into add_line_item fails.
+      ["invalid", 100, nil, []].each do | invalid_object |
+        assert_raise(XeroGateway::Invoice::InvalidLineItemError) { @bank_transaction.add_line_item(invalid_object) }
+        assert_equal(2, @bank_transaction.line_items.size)
+      end
+    end
+  end
+
+
+  context "building and parsing XML" do
+    should "work vice versa" do
+      bank_transaction = create_test_bank_transaction
+      bank_transaction_as_xml = bank_transaction.to_xml
+      bank_transaction_element = REXML::XPath.first(REXML::Document.new(bank_transaction_as_xml), "/BankTransaction")
+
+      # checking for mandatory fields
+      assert_xml_field bank_transaction_element, 'Type', :value => 'RECEIVE'
+      assert_xml_field bank_transaction_element, 'Date'
+      assert_xml_field bank_transaction_element, 'Reference', :value => '12345'
+      assert_xml_field bank_transaction_element, 'Status', :value => 'ACTIVE'
+      assert_xml_field bank_transaction_element, 'Contact', :value => 'CONTACT NAME'
+      assert_xml_field bank_transaction_element, 'LineItems', :value => 'A LINE ITEM'
+      assert_xml_field bank_transaction_element, 'BankAccount'
+
+      parsed_bank_transaction = XeroGateway::BankTransaction.from_xml(bank_transaction_element)
+      assert_equal(bank_transaction, parsed_bank_transaction)
+    end
+
+    should "work for optional params" do
+      bank_transaction = create_test_bank_transaction(:url => 'http://example.com?with=params&and=more')
+      bank_transaction_element = REXML::XPath.first(REXML::Document.new(bank_transaction.to_xml), "/BankTransaction")
+
+      assert_xml_field bank_transaction_element, 'Url', :value => 'http://example.com\?with=params&amp;and=more'
+
+      parsed_bank_transaction = XeroGateway::BankTransaction.from_xml(bank_transaction_element)
+      assert_equal 'http://example.com?with=params&and=more', parsed_bank_transaction.url
+    end
+  end
+
+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!"
+    if 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
+
+end

data/test/unit/invoice_test.rb

@@ -1,39 +1,33 @@
 require File.join(File.dirname(__FILE__), '../test_helper.rb')
 
 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')))
-  end
 
-  # NB: Xero no longer appears to provide XSDs for their api, check http://blog.xero.com/developer/api/invoices/
-  #
-  # Tests that the XML generated from an invoice object validates against the Xero XSD
-  # def test_build_xml
-  #   invoice = create_test_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"
-  # end
-  
-  # Tests that an invoice can be converted into XML that Xero can understand, and then converted back to an invoice
-  def test_build_and_parse_xml
-    invoice = create_test_invoice
-    
-    # Generate the XML message
-    invoice_as_xml = invoice.to_xml
+  context "building and parsing XML" do
+    should "work vice versa" do
+      invoice = create_test_invoice
+
+      # Generate the XML message
+      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")
+      # 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::Invoice.from_xml(invoice_element)
+      # Build a new invoice from the XML
+      result_invoice = XeroGateway::Invoice.from_xml(invoice_element)
+
+      assert_equal(invoice, result_invoice)
+    end
 
-    assert_equal(invoice, result_invoice)
+    should "work for optional params" do
+      invoice = create_test_invoice(:url => 'http://example.com?with=params&and=more')
+      invoice_element = REXML::XPath.first(REXML::Document.new(invoice.to_xml), "/Invoice")
+      assert_match /<Url>http:\/\/example.com\?with=params&amp;and=more<\/Url>/, invoice_element.to_s
+
+      parsed_invoice = XeroGateway::Invoice.from_xml(invoice_element)
+      assert_equal 'http://example.com?with=params&and=more', parsed_invoice.url
+    end
   end
-  
+
   # Tests the sub_total calculation and that setting it manually doesn't modify the data.
   def test_invoice_sub_total_calculation
     invoice = create_test_invoice
@@ -174,6 +168,9 @@ class InvoiceTest < Test::Unit::TestCase
     assert_equal(BigDecimal.new('100'), invoice.line_items.first.unit_amount)
     assert_equal(BigDecimal.new('12.5'), invoice.line_items.first.tax_amount)
 
+    # Test optional params
+    assert_nil invoice.url
+
     # Test overriding an invoice parameter (assume works for all).
     invoice = create_test_invoice({:invoice_type => 'ACCPAY'})
     assert_equal('ACCPAY', invoice.invoice_type)
@@ -241,7 +238,12 @@ class InvoiceTest < Test::Unit::TestCase
     invoice = XeroGateway::Invoice.new
     assert_equal(invoice.line_amount_types, 'Exclusive')
   end
-  
+
+  def test_optional_params
+    invoice = create_test_invoice(:url => 'http://example.com')
+    assert_equal 'http://example.com', invoice.url
+  end
+
   private
     
   def create_test_invoice(invoice_params = {}, contact_params = {}, line_item_params = [])
@@ -304,4 +306,21 @@ class InvoiceTest < Test::Unit::TestCase
     
     invoice
   end
+
+  # NB: Xero no longer appears to provide XSDs for their api, check http://blog.xero.com/developer/api/invoices/
+  #
+  # context "validating against the Xero XSD" do
+  #   setup do
+  #     # @schema = LibXML::XML::Schema.document(LibXML::XML::Document.file(File.join(File.dirname(__FILE__), '../xsd/create_invoice.xsd')))
+  #   end
+  #
+  #   should "succeed" do
+  #     invoice = create_test_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"
+  #   end
+  # end
+
 end

data/test/unit/oauth_test.rb

@@ -42,12 +42,16 @@ class OAuthTest < Test::Unit::TestCase
     xero = XeroGateway::OAuth.new('token', 'secret')
     consumer = OAuth::Consumer.new('token', 'secret')
     xero.stubs(:consumer).returns(consumer)
-    
-    access_token = mock('access token', :token => 'atoken', :secret => 'asecret')
+
+    access_token = mock('access token')
+    access_token.expects(:token).twice.returns('atoken')
+    access_token.expects(:secret).twice.returns('asecret')
+    access_token.stubs(:params).returns({})
+
     request_token = mock('request token')
     request_token.expects(:get_access_token).returns(access_token)
     OAuth::RequestToken.expects(:new).with(consumer, 'rtoken', 'rsecret').returns(request_token)
-    
+
     xero.authorize_from_request('rtoken', 'rsecret')
     assert xero.access_token.is_a? OAuth::AccessToken
     assert_equal "atoken",  xero.access_token.token
@@ -81,9 +85,14 @@ class OAuthTest < Test::Unit::TestCase
     consumer = OAuth::Consumer.new('token', 'secret')
     xero.stubs(:consumer).returns(consumer)
     
-    access_token = mock('access token', :token => 'atoken', :secret => 'asecret')
+    access_token = mock('access token')
+    access_token.expects(:token).twice.returns('atoken')
+    access_token.expects(:secret).twice.returns('asecret')
+    access_token.stubs(:params).returns({})
+
     request_token = mock('request token')
     request_token.expects(:get_access_token).with(:oauth_verifier => "verifier").returns(access_token)
+
     OAuth::RequestToken.expects(:new).with(consumer, 'rtoken', 'rsecret').returns(request_token)
     
     xero.authorize_from_request('rtoken', 'rsecret', :oauth_verifier => "verifier")

data/xero_gateway.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "xero_gateway"
-  s.version  = "2.0.13"
-  s.date     = "2011-09-14"
+  s.version  = "2.0.14"
+  s.date     = "2012-05-07"
   s.summary  = "Enables ruby based applications to communicate with the Xero API"
   s.email    = "tim@connorsoftware.com"
   s.homepage = "http://github.com/tlconnor/xero_gateway"

metadata

@@ -1,79 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xero_gateway
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 2.0.14
   prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 13
-  version: 2.0.13
 platform: ruby
-authors: 
+authors:
 - Tim Connor
 - Nik Wakelin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-14 00:00:00 +12:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: builder
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70356902601560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70356902601560
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70356902601080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 3
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70356902601080
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70356902600700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70356902600700
 description: Enables ruby based applications to communicate with the Xero API
 email: tim@connorsoftware.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Gemfile
 - LICENSE
 - Rakefile
@@ -86,6 +63,7 @@ files:
 - lib/xero_gateway/account.rb
 - lib/xero_gateway/accounts_list.rb
 - lib/xero_gateway/address.rb
+- lib/xero_gateway/bank_transaction.rb
 - lib/xero_gateway/contact.rb
 - lib/xero_gateway/credit_note.rb
 - lib/xero_gateway/currency.rb
@@ -97,6 +75,7 @@ files:
 - lib/xero_gateway/http_encoding_helper.rb
 - lib/xero_gateway/invoice.rb
 - lib/xero_gateway/line_item.rb
+- lib/xero_gateway/line_item_calculations.rb
 - lib/xero_gateway/money.rb
 - lib/xero_gateway/oauth.rb
 - lib/xero_gateway/organisation.rb
@@ -109,10 +88,13 @@ files:
 - lib/xero_gateway/tracking_category.rb
 - lib/xero_gateway.rb
 - test/integration/accounts_list_test.rb
+- test/integration/create_bank_transaction_test.rb
 - test/integration/create_contact_test.rb
 - test/integration/create_credit_note_test.rb
 - test/integration/create_invoice_test.rb
 - test/integration/get_accounts_test.rb
+- test/integration/get_bank_transaction_test.rb
+- test/integration/get_bank_transactions_test.rb
 - test/integration/get_contact_test.rb
 - test/integration/get_contacts_test.rb
 - test/integration/get_credit_note_test.rb
@@ -123,10 +105,12 @@ files:
 - test/integration/get_organisation_test.rb
 - test/integration/get_tax_rates_test.rb
 - test/integration/get_tracking_categories_test.rb
+- test/integration/update_bank_transaction_test.rb
 - test/integration/update_contact_test.rb
 - test/integration/update_invoice_test.rb
 - test/test_helper.rb
 - test/unit/account_test.rb
+- test/unit/bank_transaction_test.rb
 - test/unit/contact_test.rb
 - test/unit/credit_note_test.rb
 - test/unit/currency_test.rb
@@ -137,39 +121,28 @@ files:
 - test/unit/tax_rate_test.rb
 - test/unit/tracking_category_test.rb
 - lib/xero_gateway/ca-certificates.crt
-has_rdoc: true
 homepage: http://github.com/tlconnor/xero_gateway
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Enables ruby based applications to communicate with the Xero API
 test_files: []
-