xeroizer 2.16.5 → 2.17.1

data/test/test_helper.rb

@@ -19,12 +19,14 @@ module TestHelper
   # rake test
   # (this probably won't work under OAuth?)
   #
+
+  $VERBOSE=nil
   
   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)
-  PRIVATE_KEY_PATH  = ENV["PRIVATE_KEY_PATH"] || "fake_key"     unless defined?(PRIVATE_KEY_PATH)
+  KEY_FILE          = ENV["KEY_FILE"]         || "fake_key"     unless defined?(KEY_FILE)
   
   # 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)
@@ -46,9 +48,9 @@ module TestHelper
   end
   
   def mock_api(model_name)
-    @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}$/ }.returns(get_record_xml("#{model_name.underscore.pluralize}".to_sym))
-    @client.send("#{model_name.singularize}".to_sym).all.each do | record |
-      @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}\/#{record.id}$/ }.returns(get_record_xml("#{model_name.underscore.singularize}".to_sym, record.id))
+    @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}$/ }.returns(get_record_xml(model_name.underscore.pluralize.to_s.to_sym))
+    @client.send(model_name.singularize.to_s.to_sym).all.each do | record |
+      @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}\/#{record.id}$/ }.returns(get_record_xml(model_name.underscore.singularize.to_s.to_sym, record.id))
     end
   end
   

data/test/unit/models/address_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class AddressTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    @contact = @client.Contact.build
+  end
+
+  def build_valid_address
+    @contact.add_address({
+      :type => "DEFAULT",
+      :address_line1 => "Baker street",
+      :address_line2 => "221",
+      :address_line3 => "Appartment: B",
+      :address_line4 => "abcdefgh",
+      :city => "London",
+      :region => "Marylebone",
+      :postal_code => "NW1 6XE",
+      :country => "UK",
+      :attention_to => "Mr Sherlock Holmes"
+    })
+  end
+
+  def generate_random_string(size)
+    charset = %w{A C D E F G H J K M N P Q R T V W X Y Z}
+    (0...size).map{ charset.to_a[rand(charset.size)] }.join
+  end
+
+   context "validators" do
+
+    should "allow valid address with valid attributes" do
+      address = build_valid_address
+      assert_equal(true, address.valid?)
+    end
+
+    should "not allow address_line1 to be longer than 500 characters" do
+      address = build_valid_address
+      address.line1 = generate_random_string(501)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow address_line2 to be longer than 500 characters" do
+      address = build_valid_address
+      address.line2 = generate_random_string(501)
+      assert_equal(false, address.valid?)
+    end
+    should "not allow address_line3 to be longer than 500 characters" do
+      address = build_valid_address
+      address.line3 = generate_random_string(501)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow address_line4 to be longer than 500 characters" do
+      address = build_valid_address
+      address.line4 = generate_random_string(501)
+      assert_equal(false, address.valid?)
+    end
+
+
+    should "not allow city to be longer than 255 characters" do
+      address = build_valid_address
+      address.city = generate_random_string(256)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow region to be longer than 255 characters" do
+      address = build_valid_address
+      address.region = generate_random_string(256)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow postal_code to be longer than 50 characters" do
+      address = build_valid_address
+      address.postal_code = generate_random_string(51)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow country to be longer than 50 characters" do
+      address = build_valid_address
+      address.country = generate_random_string(51)
+      assert_equal(false, address.valid?)
+    end
+
+    should "not allow attention_to to be longer than 255 characters" do
+      address = build_valid_address
+      address.attention_to = generate_random_string(256)
+      assert_equal(false, address.valid?)
+    end
+  end
+end

data/test/unit/models/bank_transaction_validation_test.rb

@@ -8,7 +8,7 @@ class BankTransactionValidationTest < Test::Unit::TestCase
 
     assert false == instance.valid?, "Expected invalid because of invalid type"
 
-    expected_error = "Invalid type. Expected either SPEND, RECEIVE, RECEIVE-PREPAYMENT or RECEIVE-OVERPAYMENT."
+    expected_error = "Invalid type. Expected one of https://developer.xero.com/documentation/api/types#BankTransactionTypes"
 
     assert_equal expected_error, instance.errors_for(:type).first, "Expected an error about type"
 

data/test/unit/models/contact_test.rb

@@ -20,6 +20,20 @@ class ContactTest < Test::Unit::TestCase
       assert_equal(true, contact.valid?)
       assert_equal(0, contact.errors.size)
     end
+
+    should "not allow invalid addresses" do
+      contact = @client.Contact.build(name: "SOMETHING")
+      address = contact.add_address(:type => "INVALID_TYPE")
+
+      assert_equal(false, contact.valid?)
+      invalid_error = contact.errors_for(:addresses).first
+      assert_not_nil(invalid_error)
+      assert_equal("must all be valid", invalid_error)
+
+      address.type = "DEFAULT"
+      assert_equal(true, contact.valid?)
+      assert_equal(0, contact.errors.size)
+    end
   end
 
   context "response parsing" do
@@ -53,10 +67,12 @@ class ContactTest < Test::Unit::TestCase
     end
 
     should "be able to have no name if has a contact_id" do
-      assert_equal(false, @contact.valid?)
-      @contact.contact_id = "1-2-3"
-      assert_equal(true, @contact.valid?)
-      assert_equal(0, @contact.errors.size)
+      contact = @client.Contact.build
+
+      assert_equal(false, contact.valid?)
+      contact.contact_id = "1-2-3"
+      assert_equal(true, contact.valid?)
+      assert_equal(0, contact.errors.size)
     end
 
     it "parses extra attributes when present" do

data/test/unit/models/line_item_test.rb

@@ -3,23 +3,23 @@ require "test_helper"
 class LineItemTest < Test::Unit::TestCase
   include TestHelper
   include Xeroizer::Record
-  
+
   def setup
     @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
   end
-  
+
   it "line_item tracking specified correctly" do
     invoice = @client.Invoice.build
     line_item = invoice.add_line_item({:description => "Test Description", :quantity => 1, :unit_amount => 200})
-    
+
     line_item.add_tracking(:name => "Name 1", :option => "Option 1")
     line_item.add_tracking(:name => "Name 2", :option => "Option 2")
-    
+
     doc = Nokogiri::XML(line_item.to_xml)
     assert_equal 2, doc.xpath("/LineItem/Tracking/TrackingCategory").size
   end
 
-  it "line_amount equals unit_price times quantity" do
+  it "line_amount equals unit_price times quantity if there is no discount_rate" do
     line_item = LineItem.new(nil)
 
     line_item.quantity = 1
@@ -28,7 +28,21 @@ class LineItemTest < Test::Unit::TestCase
 
     expected = BigDecimal((line_item.quantity * (line_item.unit_amount)).to_s).round(2)
 
-    assert_equal expected.to_s, line_item.line_amount.to_s
+    assert_equal expected.to_s, line_item.line_amount.to_s,
+      "expected line_amount to equal unit_amount times quantity"
+  end
+
+  it "line_amount equals unit_amount times quantity minus the discount if there is a discount_rate" do
+    line_item = LineItem.new(nil)
+    line_item.quantity = 1
+    line_item.unit_amount = BigDecimal("1337.00")
+    line_item.tax_amount = BigDecimal("0.15")
+    line_item.discount_rate = BigDecimal("10.0")
+
+    discount = (100 - line_item.discount_rate) / 100
+    expected = BigDecimal(((line_item.quantity * line_item.unit_amount) * discount).to_s).round(2)
+    assert_equal expected.to_s, line_item.line_amount.to_s,
+      "expected line_amount to equal unit_amount times quantity minus the discount"
   end
 
   it "line_amount is zero when quantity is nil or zero" do

data/test/unit/models/tax_rate_test.rb

@@ -32,6 +32,25 @@ class TaxRateTest < Test::Unit::TestCase
     assert_equal "10.0", tax_component.rate.to_s
   end
 
+  should "allow reading of the ReportTaxType" do
+    @client.expects(:http_get).with { |client, url, extra_params|
+      url == "https://api.xero.com/api.xro/2.0/TaxRates"
+    }.returns(tax_rate_get_response)
+    rates = @client.TaxRate.all
+    assert_equal "OUTPUT", rates.first.report_tax_type
+  end
+
+  should "allow GET with a filter on ReportTaxType" do
+    expected_url    = "https://api.xero.com/api.xro/2.0/TaxRates"
+    expected_params = {:where => 'ReportTaxType=="OUTPUT"'}
+
+    @client.expects(:http_get).with { |client, url, extra_params|
+      url == expected_url && extra_params == expected_params
+    }.returns(tax_rate_get_response)
+
+    @client.TaxRate.all(where: {report_tax_type: 'OUTPUT'})
+  end
+
   def expected_tax_rate_create_body
     <<-EOS
 <TaxRate>
@@ -78,4 +97,36 @@ class TaxRateTest < Test::Unit::TestCase
     EOS
   end
 
-end
+  def tax_rate_get_response
+    <<-EOS
+<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Id>53715e8f-f080-4cd8-a077-1100c0512d44</Id>
+  <Status>OK</Status>
+  <ProviderName>Xero API Previewer</ProviderName>
+  <DateTimeUTC>2014-10-28T15:39:58.5477531Z</DateTimeUTC>
+  <TaxRates>
+    <TaxRate>
+      <Name>Tax on Sales</Name>
+      <TaxType>OUTPUT</TaxType>
+      <ReportTaxType>OUTPUT</ReportTaxType>
+      <CanApplyToAssets>true</CanApplyToAssets>
+      <CanApplyToEquity>true</CanApplyToEquity>
+      <CanApplyToExpenses>true</CanApplyToExpenses>
+      <CanApplyToLiabilities>true</CanApplyToLiabilities>
+      <CanApplyToRevenue>true</CanApplyToRevenue>
+      <DisplayTaxRate>9.2500</DisplayTaxRate>
+      <EffectiveRate>9.2500</EffectiveRate>
+      <Status>ACTIVE</Status>
+      <TaxComponents>
+        <TaxComponent>
+          <Name>Sales Tax</Name>
+          <Rate>9.2500</Rate>
+          <IsCompound>false</IsCompound>
+        </TaxComponent>
+      </TaxComponents>
+    </TaxRate>
+  </TaxRates>
+</Response>
+    EOS
+  end
+end

data/test/unit/record/base_model_test.rb

@@ -31,7 +31,7 @@ class RecordBaseModelTest < Test::Unit::TestCase
     end
     
     should "set_api_controller_name should set the base controller name used by Xero" do
-     assert_equal('AppleController', @apple_model.api_controller_name)
+      assert_equal('AppleController', @apple_model.api_controller_name)
      assert_equal('PearController', @pear_model.api_controller_name)
     end
     

data/test/unit/record/base_test.rb

@@ -55,13 +55,16 @@ class RecordBaseTest < Test::Unit::TestCase
   end
 
   context "about logging" do
+    # Setup we only wish to do once:
+    class ExampleRecordClass < Xeroizer::Record::Base
+      def valid?; true; end
+      def to_xml(b = nil); "<FakeRequest />" end
+      string :id
+    end
+    class Xeroizer::Record::ExampleRecordClassModel < Xeroizer::Record::BaseModel; end
+
+    # Setup before each test
     setup do
-      class ExampleRecordClass < Xeroizer::Record::Base
-        def valid?; true; end
-        def to_xml(b = nil); "<FakeRequest />" end
-        string :id
-      end
-      class Xeroizer::Record::ExampleRecordClassModel < Xeroizer::Record::BaseModel ; end
       @example_class = ExampleRecordClass
     end
 

data/test/unit/record/model_definition_test.rb

@@ -42,7 +42,7 @@ class ModelDefinitionsTest < Test::Unit::TestCase
   class Xeroizer::Record::TestRecordModel < Xeroizer::Record::BaseModel; end
   
   class SummaryOnlyRecord < Xeroizer::Record::Base
-  class Xeroizer::Record::SummaryOnlyRecordModel < Xeroizer::Record::BaseModel; end
+    class Xeroizer::Record::SummaryOnlyRecordModel < Xeroizer::Record::BaseModel; end
     
     list_contains_summary_only true
     set_possible_primary_keys :primary_key_id
@@ -53,7 +53,7 @@ class ModelDefinitionsTest < Test::Unit::TestCase
   end
   
   class SummaryOnlyOffRecord < Xeroizer::Record::Base
-  class Xeroizer::Record::SummaryOnlyOffRecordModel < Xeroizer::Record::BaseModel; end
+    class Xeroizer::Record::SummaryOnlyOffRecordModel < Xeroizer::Record::BaseModel; end
     
     set_possible_primary_keys :primary_key_id
     set_primary_key :primary_key_id

data/test/unit/report_test.rb

@@ -63,21 +63,21 @@ class FactoryTest < Test::Unit::TestCase
     end
     
     should "convert cells to BigDecimal where possible" do
-      num_regex = /^[-]?\d+(\.\d+)?$/
+      def assess_row(row)
+        return 0 unless row.row? || row.summary?
+
+        row.cells.select {|cell| cell.value.is_a?(BigDecimal) && cell.value > 0}.length
+      end
+
       counter = 0
-      @report.rows.each do | row |
-        if row.row? || row.summary?
-          row.cells.each do | cell |
-            counter += 1 if cell.value.is_a?(BigDecimal) && cell.value > 0
-          end
-        elsif row.section?
-          row.rows.each do | row |
-            if row.row? || row.summary?
-              row.cells.each do | cell | 
-                counter += 1 if cell.value.is_a?(BigDecimal) && cell.value > 0
-              end
-            end
+
+      @report.rows.each do |row|
+        if row.section?
+          row.rows.each do |inner_row|
+            counter += assess_row(inner_row)
           end
+        else
+          counter += assess_row(row)
         end
       end
       assert_not_equal(0, counter, "at least one converted number in the report should be greater than 0")
@@ -93,13 +93,11 @@ class FactoryTest < Test::Unit::TestCase
 
     should "have working report type helpers" do
       @report.rows.each do | row |
-        if row.type == 'Section'
-          check_valid_report_type(row)
-          row.rows.each do | row |
-            check_valid_report_type(row)
-          end
-        else
-          check_valid_report_type(row)
+        check_valid_report_type(row)
+
+        next unless row.type == 'Section'
+        row.rows.each do |inner_row|
+          check_valid_report_type(inner_row)
         end
       end
     end
@@ -149,7 +147,7 @@ class FactoryTest < Test::Unit::TestCase
         when 'SummaryRow'   then assert_equal(true, row.summary?)
         when 'Section'      then assert_equal(true, row.section?)
         else
-            assert(false, "Invalid type: #{row.type}")
+          assert(false, "Invalid type: #{row.type}")
       end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xeroizer
 version: !ruby/object:Gem::Version
-  version: 2.16.5
+  version: 2.17.1
 platform: ruby
 authors:
 - Wayne Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -261,6 +261,7 @@ files:
 - lib/xeroizer/models/balances.rb
 - lib/xeroizer/models/bank_account.rb
 - lib/xeroizer/models/bank_transaction.rb
+- lib/xeroizer/models/bank_transfer.rb
 - lib/xeroizer/models/batch_payments.rb
 - lib/xeroizer/models/bills.rb
 - lib/xeroizer/models/branding_theme.rb
@@ -274,7 +275,9 @@ files:
 - lib/xeroizer/models/employee.rb
 - lib/xeroizer/models/expense_claim.rb
 - lib/xeroizer/models/external_link.rb
+- lib/xeroizer/models/from_bank_account.rb
 - lib/xeroizer/models/invoice.rb
+- lib/xeroizer/models/invoice_reminder.rb
 - lib/xeroizer/models/item.rb
 - lib/xeroizer/models/item_purchase_details.rb
 - lib/xeroizer/models/item_sales_details.rb
@@ -288,8 +291,12 @@ files:
 - lib/xeroizer/models/manual_journal_line.rb
 - lib/xeroizer/models/option.rb
 - lib/xeroizer/models/organisation.rb
+- lib/xeroizer/models/overpayment.rb
 - lib/xeroizer/models/payment.rb
 - lib/xeroizer/models/payment_terms.rb
+- lib/xeroizer/models/payroll/bank_account.rb
+- lib/xeroizer/models/payroll/employee.rb
+- lib/xeroizer/models/payroll/home_address.rb
 - lib/xeroizer/models/phone.rb
 - lib/xeroizer/models/prepayment.rb
 - lib/xeroizer/models/purchase_order.rb
@@ -299,11 +306,13 @@ files:
 - lib/xeroizer/models/schedule.rb
 - lib/xeroizer/models/tax_component.rb
 - lib/xeroizer/models/tax_rate.rb
+- lib/xeroizer/models/to_bank_account.rb
 - lib/xeroizer/models/tracking_category.rb
 - lib/xeroizer/models/tracking_category_child.rb
 - lib/xeroizer/models/user.rb
 - lib/xeroizer/oauth.rb
 - lib/xeroizer/partner_application.rb
+- lib/xeroizer/payroll_application.rb
 - lib/xeroizer/private_application.rb
 - lib/xeroizer/public_application.rb
 - lib/xeroizer/record/application_helper.rb
@@ -311,6 +320,8 @@ files:
 - lib/xeroizer/record/base_model.rb
 - lib/xeroizer/record/base_model_http_proxy.rb
 - lib/xeroizer/record/model_definition_helper.rb
+- lib/xeroizer/record/payroll_base.rb
+- lib/xeroizer/record/payroll_base_model.rb
 - lib/xeroizer/record/record_association_helper.rb
 - lib/xeroizer/record/validation_helper.rb
 - lib/xeroizer/record/validators/associated_validator.rb
@@ -334,9 +345,11 @@ files:
 - lib/xeroizer/response.rb
 - lib/xeroizer/version.rb
 - test/acceptance/about_creating_bank_transactions_test.rb
+- test/acceptance/about_creating_prepayment_test.rb
 - test/acceptance/about_fetching_bank_transactions_test.rb
 - test/acceptance/acceptance_test.rb
 - test/acceptance/bank_transaction_reference_data.rb
+- test/acceptance/bank_transfer_test.rb
 - test/acceptance/bulk_operations_test.rb
 - test/stub_responses/accounts.xml
 - test/stub_responses/api_exception.xml
@@ -578,6 +591,7 @@ files:
 - test/test_helper.rb
 - test/unit/generic_application_test.rb
 - test/unit/http_test.rb
+- test/unit/models/address_test.rb
 - test/unit/models/bank_transaction_model_parsing_test.rb
 - test/unit/models/bank_transaction_test.rb
 - test/unit/models/bank_transaction_validation_test.rb
@@ -628,15 +642,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Xero library
 test_files:
 - test/acceptance/about_creating_bank_transactions_test.rb
+- test/acceptance/about_creating_prepayment_test.rb
 - test/acceptance/about_fetching_bank_transactions_test.rb
 - test/acceptance/acceptance_test.rb
 - test/acceptance/bank_transaction_reference_data.rb
+- test/acceptance/bank_transfer_test.rb
 - test/acceptance/bulk_operations_test.rb
 - test/stub_responses/accounts.xml
 - test/stub_responses/api_exception.xml
@@ -878,6 +894,7 @@ test_files:
 - test/test_helper.rb
 - test/unit/generic_application_test.rb
 - test/unit/http_test.rb
+- test/unit/models/address_test.rb
 - test/unit/models/bank_transaction_model_parsing_test.rb
 - test/unit/models/bank_transaction_test.rb
 - test/unit/models/bank_transaction_validation_test.rb