xeroizer 2.15.3 → 2.15.5

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gem 'builder',        '>= 2.1.2'
 gem 'oauth',          '0.4.5'
 gem 'activesupport'
+gem 'tzinfo'
 gem 'nokogiri'
 gem 'i18n'
 

data/Gemfile.lock

@@ -35,6 +35,7 @@ GEM
     test-unit (2.4.8)
     turn (0.9.4)
       ansi
+    tzinfo (0.3.35)
     yard (0.7.5)
 
 PLATFORMS
@@ -54,4 +55,5 @@ DEPENDENCIES
   shoulda
   test-unit
   turn
+  tzinfo
   yard

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Wayne Robinson
+Copyright (c) 2013 Wayne Robinson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,24 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-----------------------------------------------------------------------
+
+Part of the HTTP communication and OAuth authentication library were
+provided by the https://github.com/tlconnor/xero_gateway gem created by 
+Tim Connor (github.com/tlconnor) and Nik Wakelin (github.com/nikz). 
+The license for this Gem is included below:
+
+Copyright (c) 2008 Tim Connor <tlconnor@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -6,7 +6,7 @@ Xeroizer API Library ![Project status](http://stillmaintained.com/waynerobinson/
 **Github**: 			[https://github.com/waynerobinson/xeroizer](https://github.com/waynerobinson/xeroizer)		
 **Author**: 			Wayne Robinson [http://www.wayne-robinson.com](http://www.wayne-robinson.com)		
 **Contributors**: See Contributors section below	
-**Copyright**:    2007-2010		
+**Copyright**:    2007-2013
 **License**:      MIT License		
 
 Introduction
@@ -435,9 +435,30 @@ contact.save
 Have a look at the models in `lib/xeroizer/models/` to see the valid attributes, associations and 
 minimum validation requirements for each of the record types.
 
+### Bulk Creates & Updates
+
+Xero has a hard daily limit on the number of API requests you can make (currently 1,000 requests
+per account per day). To save on requests, you can batch creates and updates into a single PUT or
+POST call, like so:
+
+```ruby
+contact1 = xero.Contact.create(some_attributes)
+xero.Contact.batch_save do
+  contact1.email_address = "foo@bar.com"
+  contact2 = xero.Contact.build(some_other_attributes)
+  contact3 = xero.Contact.build(some_more_attributes)
+end
+```
+
+`batch_save` will issue one PUT request for every 2,000 unsaved records built within its block, and one
+POST request for evert 2,000 existing records that have been altered within its block. If any of the
+unsaved records aren't valid, it'll return `false` before sending anything across the wire;
+otherwise, it returns `true`. `batch_save` takes one optional argument: the number of records to
+create/update per request. (Defaults to 2,000.)
+
 ### Errors
 
-If a record doesn't match it's internal validation requirements the `#save` method will return
+If a record doesn't match its internal validation requirements, the `#save` method will return
 `false` and the `#errors` attribute will be populated with what went wrong.
 
 For example:
@@ -527,3 +548,9 @@ client = Xeroizer::PublicApplication.new(YOUR_OAUTH_CONSUMER_KEY,
                                          YOUR_OAUTH_CONSUMER_SECRET,
                                          :rate_limit_sleep => 2)
 ```
+
+
+### 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 
+this project. Copyright for these components remains held in the name of Tim Connor.

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rubygems'
 require 'yard'
 
@@ -52,4 +52,4 @@ end
 YARD::Rake::YardocTask.new do |t|
   # t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
   # t.options = ['--any', '--extra', '--opts'] # optional
-end
+end

data/VERSION

@@ -1 +1 @@
-2.15.3
+2.15.5

data/lib/xeroizer.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require 'date'
 require 'forwardable'
 require 'active_support/inflector'
-require 'active_support/memoizable'
 # require "active_support/core_ext"
 require 'oauth'
 require 'oauth/signature/rsa/sha1'

data/lib/xeroizer/exceptions.rb

@@ -1,12 +1,27 @@
+# Copyright (c) 2008 Tim Connor <tlconnor@gmail.com>
+# 
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
 module Xeroizer
   class ApiException < StandardError
     
-    attr_reader :type, :message, :xml, :request_body
+    attr_reader :type, :message, :xml, :parsed_xml, :request_body
     
-    def initialize(type, message, xml, request_body)
+    def initialize(type, message, xml, parsed_xml, request_body)
       @type         = type
       @message      = message
       @xml          = xml
+      @parsed_xml   = parsed_xml
       @request_body = request_body
     end
     

data/lib/xeroizer/http.rb

@@ -1,3 +1,17 @@
+# Copyright (c) 2008 Tim Connor <tlconnor@gmail.com>
+# 
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
 module Xeroizer
   module Http
     
@@ -69,7 +83,7 @@ module Xeroizer
 
         begin
           attempts += 1
-          logger.info("\n== [#{Time.now.to_s}] XeroGateway Request: #{uri.request_uri} ") if self.logger
+          logger.info("\n== [#{Time.now.to_s}] XeroGateway Request: #{method.to_s.upcase} #{uri.request_uri} ") if self.logger
 
           response = case method
             when :get   then    client.get(uri.request_uri, headers)
@@ -94,6 +108,8 @@ module Xeroizer
               handle_oauth_error!(response)
             when 404
               handle_object_not_found!(response, url)
+            when 503
+              handle_oauth_error!(response)
             else
               raise "Unknown response code: #{response.code.to_i}"
           end
@@ -131,16 +147,17 @@ module Xeroizer
         
         # XeroGenericApplication API Exceptions *claim* to be UTF-16 encoded, but fail REXML/Iconv parsing...
         # So let's ignore that :)
-        # raw_response.gsub! '<?xml version="1.0" encoding="utf-16"?>', ''
+        raw_response.gsub! '<?xml version="1.0" encoding="utf-16"?>', ''
         
         # doc = REXML::Document.new(raw_response, :ignore_whitespace_nodes => :all)
         doc = Nokogiri::XML(raw_response)
         
         if doc && doc.root && doc.root.name == "ApiException"
 
-          raise ApiException.new(doc.root.xpath("Type").text, 
-                                 doc.root.xpath("Message").text, 
+          raise ApiException.new(doc.root.xpath("Type").text,
+                                 doc.root.xpath("Message").text,
                                  raw_response,
+                                 doc,
                                  request_body)
 
         else

data/lib/xeroizer/models/bank_transaction.rb

@@ -8,20 +8,31 @@ module Xeroizer
     end
 
     class BankTransaction < Base
+
+      BANK_TRANSACTION_STATUS = {
+        'ACTIVE'  =>          'Active bank transactions',
+        'DELETED' =>          'Deleted bank transactions',
+      } unless defined?(BANK_TRANSACTION_STATUS)
+      BANK_TRANSACTION_STATUSES = BANK_TRANSACTION_STATUS.keys.sort
+
+
       def initialize(parent)
         super parent
         self.line_amount_types = "Exclusive"
       end
 
       set_primary_key :bank_transaction_id
+      list_contains_summary_only true
+
       string :type
       date :date
 
-      date :updated_date_utc, :api_name => "UpdatedDateUTC"
-      date :fully_paid_on_date
-      string :reference
-      string :bank_transaction_id, :api_name => "BankTransactionID"
-      boolean :is_reconciled
+      datetime_utc  :updated_date_utc, :api_name => "UpdatedDateUTC"
+      date          :fully_paid_on_date
+      string        :reference
+      string        :bank_transaction_id, :api_name => "BankTransactionID"
+      boolean       :is_reconciled
+      string        :status
 
       alias_method :reconciled?, :is_reconciled
 
@@ -36,6 +47,7 @@ module Xeroizer
       validates_inclusion_of :type,
         :in => %w{SPEND RECEIVE}, :allow_blanks => false,
         :message => "Invalid type. Expected either SPEND or RECEIVE."
+      validates_inclusion_of :status, :in => BANK_TRANSACTION_STATUSES, :unless => :new_record?
 
       validates_presence_of :contact, :bank_account, :allow_blanks => false
 

data/lib/xeroizer/models/contact.rb

@@ -18,23 +18,23 @@ module Xeroizer
       set_possible_primary_keys :contact_id, :contact_number
       list_contains_summary_only true
       
-      guid      :contact_id
-      string    :contact_number
-      string    :contact_status
-      string    :name
-      string    :tax_number
-      string    :bank_account_details
-      string    :accounts_receivable_tax_type
-      string    :accounts_payable_tax_type
-      string    :first_name
-      string    :last_name
-      string    :email_address
-      string    :skype_user_name
-      string    :contact_groups
-      string    :default_currency
-      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-      boolean   :is_supplier
-      boolean   :is_customer
+      guid          :contact_id
+      string        :contact_number
+      string        :contact_status
+      string        :name
+      string        :tax_number
+      string        :bank_account_details
+      string        :accounts_receivable_tax_type
+      string        :accounts_payable_tax_type
+      string        :first_name
+      string        :last_name
+      string        :email_address
+      string        :skype_user_name
+      string        :contact_groups
+      string        :default_currency
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      boolean       :is_supplier
+      boolean       :is_customer
       
       has_many  :addresses, :list_complete => true
       has_many  :phones, :list_complete => true

data/lib/xeroizer/models/credit_note.rb

@@ -44,24 +44,24 @@ module Xeroizer
       set_possible_primary_keys :credit_note_id, :credit_note_number
       list_contains_summary_only true
       
-      guid      :credit_note_id
-      string    :credit_note_number
-      string    :reference
-      string    :type
-      date      :date
-      date      :due_date
-      string    :status
-      string    :line_amount_types
-      decimal   :sub_total, :calculated => true
-      decimal   :total_tax, :calculated => true
-      decimal   :total, :calculated => true
-      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-      string    :currency_code
-      datetime  :fully_paid_on_date
-      boolean   :sent_to_contact
+      guid          :credit_note_id
+      string        :credit_note_number
+      string        :reference
+      string        :type
+      date          :date
+      date          :due_date
+      string        :status
+      string        :line_amount_types
+      decimal       :sub_total, :calculated => true
+      decimal       :total_tax, :calculated => true
+      decimal       :total, :calculated => true
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string        :currency_code
+      datetime      :fully_paid_on_date
+      boolean       :sent_to_contact
       
-      belongs_to  :contact
-      has_many    :line_items
+      belongs_to    :contact
+      has_many      :line_items
       
       validates_inclusion_of :type, :in => CREDIT_NOTE_TYPES
       validates_inclusion_of :status, :in => CREDIT_NOTE_STATUSES, :allow_blanks => true
@@ -127,4 +127,4 @@ module Xeroizer
     end
     
   end
-end
+end

data/lib/xeroizer/models/invoice.rb

@@ -2,7 +2,10 @@ module Xeroizer
   module Record
     
     class InvoiceModel < BaseModel
-        
+      # To create a new invoice, use the folowing
+      # $xero_client.Invoice.build(type: 'ACCREC', ..., contact: {name: 'Foo Bar'},...)
+      # Note that we are not making an api request to xero just to get the contact
+            
       set_permissions :read, :write, :update
       
       public
@@ -44,31 +47,31 @@ module Xeroizer
       set_possible_primary_keys :invoice_id, :invoice_number
       list_contains_summary_only true
       
-      guid      :invoice_id
-      string    :invoice_number
-      string    :reference
-      guid      :branding_theme_id
-      string    :url
-      string    :type
-      date      :date
-      date      :due_date
-      string    :status
-      string    :line_amount_types
-      decimal   :sub_total, :calculated => true
-      decimal   :total_tax, :calculated => true
-      decimal   :total, :calculated => true
-      decimal   :amount_due
-      decimal   :amount_paid
-      decimal   :amount_credited
-      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-      string    :currency_code
-      datetime  :fully_paid_on_date
-      boolean   :sent_to_contact
+      guid         :invoice_id
+      string       :invoice_number
+      string       :reference
+      guid         :branding_theme_id
+      string       :url
+      string       :type
+      date         :date
+      date         :due_date
+      string       :status
+      string       :line_amount_types
+      decimal      :sub_total, :calculated => true
+      decimal      :total_tax, :calculated => true
+      decimal      :total, :calculated => true
+      decimal      :amount_due
+      decimal      :amount_paid
+      decimal      :amount_credited
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string       :currency_code
+      datetime     :fully_paid_on_date
+      boolean      :sent_to_contact
       
-      belongs_to  :contact
-      has_many    :line_items
-      has_many    :payments
-      has_many    :credit_notes
+      belongs_to   :contact
+      has_many     :line_items
+      has_many     :payments
+      has_many     :credit_notes
       
       validates_presence_of :date, :due_date, :unless => :new_record?
       validates_inclusion_of :type, :in => INVOICE_TYPES
@@ -107,14 +110,24 @@ module Xeroizer
           type == 'ACCREC'
         end
         
-        # Swallow assignment of attributes that should only be calculated automatically.
-        def sub_total=(value);  raise SettingTotalDirectlyNotSupported.new(:sub_total);   end
-        def total_tax=(value);  raise SettingTotalDirectlyNotSupported.new(:total_tax);   end
-        def total=(value);      raise SettingTotalDirectlyNotSupported.new(:total);       end
+        def sub_total=(sub_total)
+          @sub_total_is_set = true
+          attributes[:sub_total] = sub_total
+        end
+        
+        def total_tax=(total_tax)
+          @total_tax_is_set = true
+          attributes[:total_tax] = total_tax
+        end
+
+        def total=(total)
+          @total_is_set = true
+          attributes[:total] = total
+        end
 
         # Calculate sub_total from line_items.
         def sub_total(always_summary = false)
-          if !always_summary && (new_record? || (!new_record? && line_items && line_items.size > 0))
+          if !@sub_total_is_set && not_summary_or_loaded_record(always_summary)
             sum = (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.line_amount }
             
             # If the default amount types are inclusive of 'tax' then remove the tax amount from this sub-total.
@@ -127,7 +140,7 @@ module Xeroizer
 
         # Calculate total_tax from line_items.
         def total_tax(always_summary = false)
-          if !always_summary && (new_record? || (!new_record? && line_items && line_items.size > 0))
+          if !@total_tax_is_set && not_summary_or_loaded_record(always_summary)
             (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
           else
             attributes[:total_tax]
@@ -136,13 +149,22 @@ module Xeroizer
 
         # Calculate the total from line_items.
         def total(always_summary = false)
-          unless always_summary
+          if !@total_is_set && not_summary_or_loaded_record(always_summary)
             sub_total + total_tax
           else
             attributes[:total]
           end
         end
         
+        def not_summary_or_loaded_record(always_summary)
+          !always_summary && loaded_record?
+        end
+
+        def loaded_record?
+          new_record? || 
+            (!new_record? && line_items && line_items.size > 0)
+        end
+          
         # Retrieve the PDF version of this invoice.
         # @param [String] filename optional filename to store the PDF in instead of returning the data.
         def pdf(filename = nil)