xero_gateway-n8vision 2.0.20

data/test/unit/manual_journal_test.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class ManualJournalTest < Test::Unit::TestCase
+  include TestHelper
+
+  context "creating test manual journals" do
+    should "work" do
+      manual_journal = create_test_manual_journal
+
+      # test transaction defaults
+      assert_equal 'POSTED', manual_journal.status
+      assert_kind_of Date, manual_journal.date
+      assert_equal 'test narration', manual_journal.narration      
+
+      # Test the journal_line defaults.
+      journal_line = manual_journal.journal_lines.first
+      assert_equal('FIRST LINE', journal_line.description)
+      assert_equal('200', journal_line.account_code)
+      assert_equal(BigDecimal.new('100'), journal_line.line_amount)
+    end
+
+    should "allow overriding transaction defaults" do
+      assert_equal 'DRAFT', create_test_manual_journal(:status => 'DRAFT').status
+    end
+  end
+
+  context "adding journal lines" do
+    setup do
+      @manual_journal = create_test_manual_journal
+    end
+
+    should "work" do
+      assert_equal 2, @manual_journal.journal_lines.size
+      assert @manual_journal.valid?
+
+      journal_line_params = {:description => "Test Item 1", :line_amount => 100, :account_code => '200'}
+
+      # Test adding line item by hash
+      journal_line = @manual_journal.add_journal_line(journal_line_params)
+      assert_kind_of(XeroGateway::JournalLine, journal_line)
+      assert_equal(journal_line_params[:description], journal_line.description)
+      assert_equal(journal_line_params[:line_amount], journal_line.line_amount)
+      assert_equal(3, @manual_journal.journal_lines.size)
+
+      # Test adding line item by XeroGateway::JournalLine
+      journal_line = @manual_journal.add_journal_line(journal_line_params)
+      assert_kind_of(XeroGateway::JournalLine, journal_line)
+      assert_equal(journal_line_params[:description], journal_line.description)
+      assert_equal(journal_line_params[:line_amount], journal_line.line_amount)
+      assert_equal(4, @manual_journal.journal_lines.size)
+
+      # Test that having only 1 journal line fails.      
+      @manual_journal.journal_lines = [] 
+      @manual_journal.add_journal_line(journal_line_params)
+      assert !@manual_journal.valid?
+    end
+  end
+
+
+  context "building and parsing XML" do
+    should "work vice versa" do
+      manual_journal = create_test_manual_journal
+      manual_journal_as_xml = manual_journal.to_xml
+      manual_journal_element = REXML::XPath.first(REXML::Document.new(manual_journal_as_xml), "/ManualJournal")
+
+      # checking for mandatory fields      
+      assert_xml_field manual_journal_element, 'Date'
+      assert_xml_field manual_journal_element, 'Narration', :value => 'test narration'
+      assert_xml_field manual_journal_element, 'Status', :value => 'POSTED'            
+
+      parsed_manual_journal = XeroGateway::ManualJournal.from_xml(manual_journal_element)
+      assert_equal(manual_journal, parsed_manual_journal)
+    end
+
+    should "work for optional params" do
+      manual_journal = create_test_manual_journal(:url => 'http://example.com?with=params&and=more')
+      manual_journal_element = REXML::XPath.first(REXML::Document.new(manual_journal.to_xml), "/ManualJournal")
+
+      assert_xml_field manual_journal_element, 'Url', :value => 'http://example.com\?with=params&amp;and=more'
+
+      parsed_manual_journal = XeroGateway::ManualJournal.from_xml(manual_journal_element)
+      assert_equal 'http://example.com?with=params&and=more', parsed_manual_journal.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!"
+    assert_match /#{field_name}.*#{options[:value]}.*#{field_name}/, xml.to_s, "The field #{field_name} was expected to be '#{options[:value]}'!" if options[:value]    
+  end
+
+end

data/test/unit/oauth_test.rb

@@ -0,0 +1,116 @@
+# Shamelessly based on the xero Gem's OAuth implementation by John Nunemaker
+# Thanks!
+# 
+# http://xero.rubyforge.org/
+# http://github.com/jnunemaker/xero/
+
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class OAuthTest < Test::Unit::TestCase
+  should "initialize with consumer token and secret" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    
+    assert_equal 'token',  xero.ctoken
+    assert_equal 'secret', xero.csecret
+  end
+  
+  should "set autorization path to '/oauth/authorize' by default" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    assert_equal '/oauth/Authorize', xero.consumer.options[:authorize_path] 
+  end
+  
+  should "have a consumer" do
+    consumer = mock('oauth consumer')
+    OAuth::Consumer.expects(:new).with('token', 'secret', XeroGateway::OAuth::XERO_CONSUMER_OPTIONS).returns(consumer)
+    
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    
+    assert_equal consumer, xero.consumer
+  end
+  
+  should "have a request token from the consumer" do
+    consumer = mock('oauth consumer')
+    request_token = mock('request token')
+    consumer.expects(:get_request_token).returns(request_token)
+    OAuth::Consumer.expects(:new).with('token', 'secret', XeroGateway::OAuth::XERO_CONSUMER_OPTIONS).returns(consumer)
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    
+    assert_equal request_token, xero.request_token
+  end
+  
+  should "be able to create access token from request token and secret" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+
+    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
+    assert_equal "asecret", xero.access_token.secret
+  end
+  
+  should "be able to create access token from access token and secret" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+    
+    xero.authorize_from_access('atoken', 'asecret')
+    assert xero.access_token.is_a? OAuth::AccessToken
+    assert_equal "atoken",  xero.access_token.token
+    assert_equal "asecret", xero.access_token.secret
+  end
+
+  should "be able to create request token with callback url" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+  
+    request_token = mock('request token')
+    consumer.expects(:get_request_token).with(:oauth_callback => "http://callback.com").returns(request_token)
+  
+    xero.request_token(:oauth_callback => "http://callback.com")
+  end
+  
+  should "be able to create access token with oauth verifier" do
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    consumer = OAuth::Consumer.new('token', 'secret')
+    xero.stubs(:consumer).returns(consumer)
+    
+    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")
+  end
+  
+  should "delegate get to access token" do
+    access_token = mock('access token')
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    xero.stubs(:access_token).returns(access_token)
+    access_token.expects(:get).returns(nil)
+    xero.get('/foo')
+  end
+  
+  should "delegate post to access token" do
+    access_token = mock('access token')
+    xero = XeroGateway::OAuth.new('token', 'secret')
+    xero.stubs(:access_token).returns(access_token)
+    access_token.expects(:post).returns(nil)
+    xero.post('/foo')
+  end
+end

data/test/unit/organisation_test.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class OrganisationTest < Test::Unit::TestCase
+  
+  # Tests that an organisation can be converted into XML that Xero can understand, and then converted back to an organisation
+  def test_build_and_parse_xml
+    org = create_test_organisation
+    
+    # Generate the XML message
+    org_as_xml = org.to_xml
+
+    # Parse the XML message and retrieve the account element
+    org_element = REXML::XPath.first(REXML::Document.new(org_as_xml), "/Organisation")
+
+    # Build a new account from the XML
+    result_org = XeroGateway::Organisation.from_xml(org_element)
+    
+    # Check the account details
+    assert_equal org, result_org
+  end
+  
+  
+  private
+  
+  def create_test_organisation
+    XeroGateway::Organisation.new.tap do |org|
+      org.name                = "Demo Company (NZ)"
+      org.legal_name          = "Demo Company (NZ)"
+      org.pays_tax            = true
+      org.version             = "NZ"
+      org.base_currency       = "NZD"
+      org.country_code        = "NZ"
+      org.organisation_type   = nil
+      org.organisation_status = nil
+      org.is_demo_company     = false
+    end
+  end
+end

data/test/unit/tax_rate_test.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class TaxRateTest < Test::Unit::TestCase
+  
+  # Tests that a tax rate can be converted into XML that Xero can understand, and then converted back to a tax rate
+  def test_build_and_parse_xml
+    tax_rate = create_test_tax_rate
+    
+    # Generate the XML message
+    tax_rate_as_xml = tax_rate.to_xml
+
+    # Parse the XML message and retrieve the account element
+    tax_rate_element = REXML::XPath.first(REXML::Document.new(tax_rate_as_xml), "/TaxRate")
+
+    # Build a new account from the XML
+    result_tax_rate = XeroGateway::TaxRate.from_xml(tax_rate_element)
+    
+    # Check the account details
+    assert_equal tax_rate, result_tax_rate
+  end
+  
+  
+  private
+  
+  def create_test_tax_rate
+    XeroGateway::TaxRate.new.tap do |tax_rate|
+       tax_rate.name = "GST on Expenses"
+       tax_rate.tax_type = "INPUT"
+       tax_rate.can_apply_to_assets      = true
+       tax_rate.can_apply_to_equity      = true
+       tax_rate.can_apply_to_expenses    = true
+       tax_rate.can_apply_to_liabilities = true
+       tax_rate.can_apply_to_revenue     = false
+       tax_rate.display_tax_rate         = 12.500
+       tax_rate.effective_rate           = 12.500
+    end
+  end
+end

data/test/unit/tracking_category_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+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 = 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::TrackingCategory.from_xml(tracking_category_element)
+    
+    # Check the tracking category details
+    assert_equal tracking_category, result_tracking_category
+  end
+
+  def test_build_and_parse_xml_from_line_item
+    tracking_category = create_test_line_item_tracking_category
+
+    # Generate the XML message
+    tracking_category_as_xml = tracking_category.to_xml_for_invoice_messages
+
+    # 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::TrackingCategory.from_xml(tracking_category_element)
+
+    # Check the tracking category details
+    assert_equal tracking_category, result_tracking_category
+  end
+  
+  private
+  
+  def create_test_tracking_category
+    tracking_category = XeroGateway::TrackingCategory.new
+    tracking_category.name = "REGION"
+    tracking_category.options = ["NORTH", "SOUTH", "CENTRAL"]
+    tracking_category
+  end
+
+  def create_test_line_item_tracking_category
+    tracking_category = XeroGateway::TrackingCategory.new
+    tracking_category.name = "REGION"
+    tracking_category.options = ["NORTH"]
+    tracking_category
+  end
+end

data/xero_gateway-n8vision.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name     = "xero_gateway-n8vision"
+  s.version  = "2.0.20"
+  s.date     = "2012-07-13"
+  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"
+  s.description = "Enables ruby based applications to communicate with the Xero API"
+  s.has_rdoc = false
+  s.authors  = ["Tim Connor", "Nik Wakelin"]
+  s.files = ["Gemfile", "LICENSE", "Rakefile", "README.textile", "xero_gateway-n8vision.gemspec"] + Dir['**/*.rb'] + Dir['**/*.crt']
+  s.add_dependency('builder', '>= 2.1.2')
+  s.add_dependency('oauth', '= 0.4.5')
+  s.add_dependency('activesupport')
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: xero_gateway-n8vision
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 20
+  version: 2.0.20
+platform: ruby
+authors: 
+- Tim Connor
+- Nik Wakelin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 5
+        version: 0.4.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Enables ruby based applications to communicate with the Xero API
+email: tim@connorsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE
+- Rakefile
+- README.textile
+- xero_gateway-n8vision.gemspec
+- examples/oauth.rb
+- examples/partner_app.rb
+- init.rb
+- lib/oauth/oauth_consumer.rb
+- 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
+- lib/xero_gateway/dates.rb
+- lib/xero_gateway/error.rb
+- lib/xero_gateway/exceptions.rb
+- lib/xero_gateway/gateway.rb
+- lib/xero_gateway/http.rb
+- lib/xero_gateway/http_encoding_helper.rb
+- lib/xero_gateway/invoice.rb
+- lib/xero_gateway/journal_line.rb
+- lib/xero_gateway/line_item.rb
+- lib/xero_gateway/line_item_calculations.rb
+- lib/xero_gateway/manual_journal.rb
+- lib/xero_gateway/money.rb
+- lib/xero_gateway/oauth.rb
+- lib/xero_gateway/organisation.rb
+- lib/xero_gateway/partner_app.rb
+- lib/xero_gateway/payment.rb
+- lib/xero_gateway/phone.rb
+- lib/xero_gateway/private_app.rb
+- lib/xero_gateway/response.rb
+- lib/xero_gateway/tax_rate.rb
+- 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/create_manual_journal_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
+- test/integration/get_credit_notes_test.rb
+- test/integration/get_currencies_test.rb
+- test/integration/get_invoice_test.rb
+- test/integration/get_invoices_test.rb
+- test/integration/get_manual_journal_test.rb
+- test/integration/get_manual_journals_test.rb
+- 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/integration/update_manual_journal_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
+- test/unit/gateway_test.rb
+- test/unit/invoice_test.rb
+- test/unit/manual_journal_test.rb
+- test/unit/oauth_test.rb
+- test/unit/organisation_test.rb
+- 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: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Enables ruby based applications to communicate with the Xero API
+test_files: []
+