xeroizer 2.15.8 → 2.15.9

data/README.md

@@ -552,7 +552,7 @@ client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
 Logging
 ---------------
 
-You can add an optional paramater to the Xeroizer Application initialization, to pass a logger object that will need to respond_to :info. For example, in a rails app:
+You can add an optional parameter to the Xeroizer Application initialization, to pass a logger object that will need to respond_to :info. For example, in a rails app:
 
 ```ruby
 XeroLogger = Logger.new('log/xero.log', 'weekly')
@@ -561,6 +561,20 @@ client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
                                          :logger => XeroLogger)
 ```
 
+Unit Price Precision
+--------------------
+
+By default, the API accepts unit prices (UnitAmount) to two decimals places. If you require greater precision, you can opt-in to 4 decimal places by setting an optional parameter when initializing an application:
+
+
+```ruby
+client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
+                                         YOUR_OAUTH_CONSUMER_SECRET,
+                                         :unitdp => 4)
+```
+
+This option adds the unitdp=4 query string parameter to all requests for models with line items - invoices, credit notes, bank transactions and receipts.
+
 ### Contributors
 Xeroizer was inspired by the https://github.com/tlconnor/xero_gateway gem created by Tim Connor 
 and Nik Wakelin and portions of the networking and authentication code are based completely off 

data/lib/xeroizer/exceptions.rb

@@ -28,6 +28,16 @@ module Xeroizer
     def message
       "#{@type}: #{@message} \n Generated by the following XML: \n #{@xml}"
     end
+
+    def validation_errors
+      errors = []
+      @parsed_xml.xpath("//ValidationError").each do |err|
+        errors << err.text.gsub(/^\s+/, '').gsub(/\s+$/, '')
+      end
+      errors
+    rescue
+      []
+    end
     
   end
   

data/lib/xeroizer/generic_application.rb

@@ -6,7 +6,7 @@ module Xeroizer
     include Http
     extend Record::ApplicationHelper
 
-    attr_reader :client, :xero_url, :logger, :rate_limit_sleep, :rate_limit_max_attempts, :default_headers
+    attr_reader :client, :xero_url, :logger, :rate_limit_sleep, :rate_limit_max_attempts, :default_headers, :unitdp
 
     extend Forwardable
     def_delegators :client, :access_token
@@ -15,6 +15,7 @@ module Xeroizer
     record :Attachment
     record :BrandingTheme
     record :Contact
+    record :ContactGroup
     record :CreditNote
     record :Currency
     record :Employee
@@ -28,6 +29,7 @@ module Xeroizer
     record :Receipt
     record :TaxRate
     record :TrackingCategory
+    record :TrackingCategoryChild
     record :BankTransaction
     record :User
 
@@ -54,6 +56,7 @@ module Xeroizer
         @default_headers = options[:default_headers] || {}
         @client   = OAuth.new(consumer_key, consumer_secret, options.merge({default_headers: default_headers}))
         @logger = options[:logger] || false
+        @unitdp = options[:unitdp] || 2
       end
 
   end

data/lib/xeroizer/http.rb

@@ -57,6 +57,9 @@ module Xeroizer
 
         headers = self.default_headers.merge({ 'charset' => 'utf-8' })
 
+        # include the unitdp query string parameter 
+        params.merge!(unitdp_param(url))
+        
         if method != :get
           headers['Content-Type'] ||= "application/x-www-form-urlencoded"
         end
@@ -195,5 +198,13 @@ module Xeroizer
         sleep seconds
       end
 
+      # unitdp query string parameter to be added to request params
+      # when the application option has been set and the model has line items
+      # http://developer.xero.com/documentation/advanced-docs/rounding-in-xero/#unitamount
+      def unitdp_param(request_url)
+        models = [/Invoices/, /CreditNotes/, /BankTransactions/, /Receipts/]
+        self.unitdp == 4 && models.any?{ |m| request_url =~ m } ? {:unitdp => 4} : {}
+      end
+
   end
 end

data/lib/xeroizer/models/bank_transaction.rb

@@ -13,7 +13,7 @@ module Xeroizer
     class BankTransaction < Base
 
       BANK_TRANSACTION_STATUS = {
-        'ACTIVE'  =>          'Active bank transactions',
+        'AUTHORISED'  =>          'Active bank transactions',
         'DELETED' =>          'Deleted bank transactions',
       } unless defined?(BANK_TRANSACTION_STATUS)
       BANK_TRANSACTION_STATUSES = BANK_TRANSACTION_STATUS.keys.sort
@@ -52,7 +52,7 @@ module Xeroizer
       validates_inclusion_of :type,
         :in => %w{SPEND RECEIVE RECEIVE-PREPAYMENT RECEIVE-OVERPAYMENT}, :allow_blanks => false,
         :message => "Invalid type. Expected either SPEND, RECEIVE, RECEIVE-PREPAYMENT or RECEIVE-OVERPAYMENT."
-      validates_inclusion_of :status, :in => BANK_TRANSACTION_STATUSES, :unless => :new_record?
+      validates_inclusion_of :status, :in => BANK_TRANSACTION_STATUSES, :allow_blanks => true
 
       validates_presence_of :contact, :bank_account, :allow_blanks => false
 

data/lib/xeroizer/models/contact.rb

@@ -24,6 +24,7 @@ module Xeroizer
       guid          :contact_id
       string        :contact_number
       string        :contact_status
+      string        :account_number
       string        :name
       string        :tax_number
       string        :bank_account_details
@@ -44,6 +45,9 @@ module Xeroizer
       has_many  :contact_groups
       has_many  :contact_persons, :internal_name => :contact_people
 
+      has_many :sales_tracking_categories, :model_name => 'ContactSalesTrackingCategory'
+      has_many :purchases_tracking_categories, :model_name => 'ContactPurchasesTrackingCategory'
+
       validates_presence_of :name
       validates_inclusion_of :contact_status, :in => CONTACT_STATUS.keys, :allow_blanks => true
 

data/lib/xeroizer/models/contact_group.rb

@@ -1,16 +1,19 @@
 module Xeroizer
   module Record
-    
-    class ContactGroupModel < BaseModel      
+
+    class ContactGroupModel < BaseModel
+      set_permissions :read
     end
-    
+
     class ContactGroup < Base
-      
+
       guid :contact_group_id
       string :name
       string :status
-      
+
+      has_many :contacts, :list_complete => true
+
     end
-    
+
   end
-end
+end

data/lib/xeroizer/models/contact_purchases_tracking_category.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class ContactPurchasesTrackingCategoryModel < BaseModel
+    
+      set_xml_root_name 'PurchasesTrackingCategories'
+      set_xml_node_name 'PurchasesTrackingCategory'
+      
+    end
+    
+    class ContactPurchasesTrackingCategory < Base
+      
+      string  :tracking_category_name
+      string  :tracking_option_name
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/contact_sales_tracking_category.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class ContactSalesTrackingCategoryModel < BaseModel
+    
+      set_xml_root_name 'SalesTrackingCategories'
+      set_xml_node_name 'SalesTrackingCategory'
+      
+    end
+    
+    class ContactSalesTrackingCategory < Base
+      
+      string  :tracking_category_name
+      string  :tracking_option_name
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/credit_note.rb

@@ -57,6 +57,7 @@ module Xeroizer
       decimal       :total, :calculated => true
       datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
       string        :currency_code
+      decimal       :currency_rate
       datetime      :fully_paid_on_date
       boolean       :sent_to_contact
       

data/lib/xeroizer/models/invoice.rb

@@ -73,6 +73,7 @@ module Xeroizer
       string       :currency_code
       decimal      :currency_rate
       datetime     :fully_paid_on_date
+      datetime     :expected_payment_date
       boolean      :sent_to_contact
       boolean      :has_attachments
 

data/lib/xeroizer/models/payment.rb

@@ -20,6 +20,7 @@ module Xeroizer
       string        :status
       string        :reference
       datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      boolean       :is_reconciled
 
       belongs_to    :account
       belongs_to    :invoice

data/lib/xeroizer/partner_application.rb

@@ -1,46 +1,55 @@
 module Xeroizer
   class PartnerApplication < GenericApplication
-    
+
     extend Forwardable
     def_delegators :client, :request_token, :authorize_from_request, :renew_access_token, :expires_at, :authorization_expires_at, :session_handle, :authorize_from_access
-    
+
     public
-    
+
       # Partner applications allow for public AccessToken's received via the stanard OAuth
       # authentication process to be renewed up until the session's expiry. The default session
       # expiry for Xero is 365 days and the default AccessToken expiry is 30 minutes.
-      # 
+      #
       # @param [String] consumer_key consumer key/token from application developer (found at http://api.xero.com for your application).
       # @param [String] consumer_secret consumer secret from application developer (found at http://api.xero.com for your application).
       # @param [String] path_to_private_key application's private key for message signing (uploaded to http://api.xero.com)
-      # @param [String] path_to_ssl_client_cert client-side SSL certificate file to use for requests
-      # @param [String] path_to_ssl_client_key client-side SSL private key to use for requests
+      # @param [String] ssl_client_cert client-side SSL certificate file to use for requests
+      # @param [String] ssl_client_key client-side SSL private key to use for requests
       # @param [Hash] options other options to pass to the GenericApplication constructor
       # @return [PartnerApplication] instance of PrivateApplication
-      def initialize(consumer_key, consumer_secret, path_to_private_key, path_to_ssl_client_cert, path_to_ssl_client_key, options = {})
+      def initialize(consumer_key, consumer_secret, path_to_private_key, ssl_client_cert, ssl_client_key, options = {})
         default_options = {
           :xero_url         => 'https://api-partner.network.xero.com/api.xro/2.0',
           :site             => 'https://api-partner.network.xero.com',
-          :authorize_url    => 'https://api.xero.com/oauth/Authorize',      
+          :authorize_url    => 'https://api.xero.com/oauth/Authorize',
           :signature_method => 'RSA-SHA1'
         }
         options = default_options.merge(options).merge(
           :private_key_file => path_to_private_key,
-          :ssl_client_cert  => OpenSSL::X509::Certificate.new(File.read(path_to_ssl_client_cert)),
-          :ssl_client_key   => OpenSSL::PKey::RSA.new(File.read(path_to_ssl_client_key))
+          :ssl_client_cert  => OpenSSL::X509::Certificate.new(read_certificate(ssl_client_cert)),
+          :ssl_client_key   => OpenSSL::PKey::RSA.new(read_certificate(ssl_client_key))
         )
         super(consumer_key, consumer_secret, options)
-        
+
         # Load up an existing token if passed the token/key.
         if options[:access_token] && options[:access_key]
           authorize_from_access(options[:access_token], options[:access_key])
         end
-        
+
         # Save the session_handle if passed in so we can renew the token.
         if options[:session_handle]
           client.session_handle = options[:session_handle]
         end
       end
-    
+
+    private
+
+      def read_certificate(cert)
+        if File.exists?(cert)
+          File.read(cert)
+        else
+          cert
+        end
+      end
   end
 end

data/lib/xeroizer/version.rb

@@ -1,3 +1,3 @@
 module Xeroizer
-  VERSION = "2.15.8".freeze
+  VERSION = "2.15.9".freeze
 end

data/lib/xeroizer.rb

@@ -57,6 +57,8 @@ require 'xeroizer/models/tracking_category'
 require 'xeroizer/models/tracking_category_child'
 require 'xeroizer/models/user'
 require 'xeroizer/models/journal_line_tracking_category'
+require 'xeroizer/models/contact_sales_tracking_category'
+require 'xeroizer/models/contact_purchases_tracking_category'
 
 require 'xeroizer/report/factory'
 

data/test/unit/generic_application_test.rb

@@ -5,7 +5,8 @@ class GenericApplicationTest < Test::Unit::TestCase
 
   def setup
     @headers = {"User-Agent" => "Xeroizer/2.15.5"}
-    @client = Xeroizer::GenericApplication.new(CONSUMER_KEY, CONSUMER_SECRET, :default_headers => @headers)
+    @unitdp = 4
+    @client = Xeroizer::GenericApplication.new(CONSUMER_KEY, CONSUMER_SECRET, :default_headers => @headers, :unitdp => @unitdp)
   end
 
   context "initialization" do
@@ -14,6 +15,10 @@ class GenericApplicationTest < Test::Unit::TestCase
       assert_equal(@headers, @client.default_headers)
     end
 
+    should "pass unitdp value" do
+      assert_equal(@unitdp, @client.unitdp)
+    end
+
   end
 
 end

data/test/unit/models/bank_transaction_validation_test.rb

@@ -5,32 +5,60 @@ class BankTransactionValidationTest < Test::Unit::TestCase
 
   must "supply either SPEND or RECEIVE as the type" do
     instance = BankTransaction.build({:type => "xxx"}, nil)
-    
+
     assert false == instance.valid?, "Expected invalid because of invalid type"
-    
+
     expected_error = "Invalid type. Expected either SPEND, RECEIVE, RECEIVE-PREPAYMENT or RECEIVE-OVERPAYMENT."
 
     assert_equal expected_error, instance.errors_for(:type).first, "Expected an error about type"
 
     instance = BankTransaction.build({:type => "SPEND"}, nil)
-    
+
     instance.valid?
-    
+
     assert_empty instance.errors_for(:type), "Expected no error about type"
 
     instance = BankTransaction.build({:type => "RECEIVE"}, nil)
-    
+
     instance.valid?
-    
+
     assert_empty instance.errors_for(:type), "Expected no error about type"
   end
 
+  can "omit the status attribute" do
+    instance = BankTransaction.build({}, nil)
+    instance.valid?
+    assert_empty instance.errors_for(:status), "Expected no error about status"
+  end
+
+  must "supply either AUTHORISED or DELETED as the status" do
+    instance = BankTransaction.build({:status => "xxx"}, nil)
+
+    assert false == instance.valid?, "Expected invalid because of invalid status"
+
+    expected_error = "not one of AUTHORISED, DELETED"
+
+    assert_equal expected_error, instance.errors_for(:status).first, "Expected an error about status"
+
+    instance = BankTransaction.build({:status => "AUTHORISED"}, nil)
+
+    instance.valid?
+
+    assert_empty instance.errors_for(:status), "Expected no error about status"
+
+    instance = BankTransaction.build({:status => "DELETED"}, nil)
+
+    instance.valid?
+
+    assert_empty instance.errors_for(:status), "Expected no error about status"
+  end
+
   must "supply a non-blank contact" do
     instance = BankTransaction.build({}, nil)
-    
+
     assert false == instance.valid?, "Expected invalid because of missing contact"
 
-    assert_equal "can't be blank", instance.errors_for(:contact).first, 
+    assert_equal "can't be blank", instance.errors_for(:contact).first,
       "Expected an error about blank contact"
   end
 
@@ -64,18 +92,18 @@ class BankTransactionValidationTest < Test::Unit::TestCase
 
     assert false == instance.valid?, "Expected invalid because of missing bank account"
 
-    assert_equal "can't be blank", instance.errors_for(:bank_account).first, 
+    assert_equal "can't be blank", instance.errors_for(:bank_account).first,
       "Expected an error about blank contact"
   end
 
-  must "supply valid line_amount_types value" do 
+  must "supply valid line_amount_types value" do
     instance = BankTransaction.build({
       :line_amount_types => "XXX_ANYTHING_INVALID_XXX"
     }, nil)
 
     assert false == instance.valid?, "Expected invalid because of missing bank account"
 
-    assert_equal "not one of Exclusive, Inclusive, NoTax", instance.errors_for(:line_amount_types).first, 
+    assert_equal "not one of Exclusive, Inclusive, NoTax", instance.errors_for(:line_amount_types).first,
       "Expected an error about blank contact"
   end
 

data/test/unit/record/base_test.rb

@@ -7,32 +7,32 @@ class RecordBaseTest < Test::Unit::TestCase
     @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
     @contact = @client.Contact.build(:name => 'Test Contact Name ABC')
   end
-  
+
   context "base record" do
-    
+
     should "create new model instance from #new_model_class" do
       model_class = @contact.new_model_class("Invoice")
       assert_kind_of(Xeroizer::Record::InvoiceModel, model_class)
       assert_equal(@contact.parent.application, model_class.application)
       assert_equal('Invoice', model_class.model_name)
     end
-    
+
     should "new_record? should be new on create" do
       assert_equal(true, @contact.new_record?)
     end
-  
+
   end
-  
+
   context "new_record? states" do
-  
+
     should "new_record? should be false when loading data" do
       Xeroizer::OAuth.any_instance.stubs(:get).returns(stub(:plain_body => get_record_xml(:contact), :code => '200'))
       contact = @client.Contact.find('TESTID')
       assert_kind_of(Xeroizer::Record::Contact, contact)
       assert_equal(false, contact.new_record?)
     end
-    
-    should "new_record? should be false after successfully creating a record" do 
+
+    should "new_record? should be false after successfully creating a record" do
       Xeroizer::OAuth.any_instance.stubs(:put).returns(stub(:plain_body => get_record_xml(:contact), :code => '200'))
       assert_equal(true, @contact.new_record?)
       assert_nil(@contact.contact_id)
@@ -40,27 +40,29 @@ class RecordBaseTest < Test::Unit::TestCase
       assert_equal(false, @contact.new_record?)
       assert(@contact.contact_id =~ GUID_REGEX, "@contact.contact_id is not a GUID, it is '#{@contact.contact_id}'")
     end
-    
+
     should "new_record? should be false if we have specified a primary key" do
       contact = @client.Contact.build(:contact_id => 'ABC')
       assert_equal(false, contact.new_record?)
-      
+
       contact = @client.Contact.build(:contact_number => 'CDE')
       assert_equal(true, contact.new_record?)
-      
+
       contact = @client.Contact.build(:name => 'TEST NAME')
       assert_equal(true, contact.new_record?)
     end
-    
+
   end
-  
+
   context "about logging" do
     setup do
-      @example_class = Class.new(Xeroizer::Record::Base) 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
 
     must "log the request and response xml when saving a new record" do
@@ -69,7 +71,10 @@ class RecordBaseTest < Test::Unit::TestCase
 
       a_fake_parent = mock "Mock parent",
         :http_put => "<FakeResponse />",
-        :parse_response => stub("Stub response", :response_items => [])
+        :parse_response => stub("Stub response", :response_items => []),
+        :mark_dirty => nil,
+        :create_method => :http_put,
+        :mark_clean => nil
 
       an_example_instance = @example_class.new(a_fake_parent)
 
@@ -83,7 +88,9 @@ class RecordBaseTest < Test::Unit::TestCase
 
       a_fake_parent = mock "Mock parent",
         :http_post => "<FakeResponse />",
-        :parse_response => stub("Stub response", :response_items => [])
+        :parse_response => stub("Stub response", :response_items => []),
+        :mark_dirty => nil,
+        :mark_clean => nil
 
       an_example_instance = @example_class.new(a_fake_parent)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xeroizer
 version: !ruby/object:Gem::Version
-  version: 2.15.8
+  version: 2.15.9
   prerelease: 
 platform: ruby
 authors:
@@ -295,6 +295,8 @@ files:
 - lib/xeroizer/models/contact.rb
 - lib/xeroizer/models/contact_group.rb
 - lib/xeroizer/models/contact_person.rb
+- lib/xeroizer/models/contact_purchases_tracking_category.rb
+- lib/xeroizer/models/contact_sales_tracking_category.rb
 - lib/xeroizer/models/credit_note.rb
 - lib/xeroizer/models/currency.rb
 - lib/xeroizer/models/employee.rb
@@ -628,18 +630,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1071589211669174391
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1071589211669174391
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.29