xeroizer 2.15.3 → 2.15.5

data/lib/xeroizer/models/line_item.rb

@@ -21,13 +21,15 @@ module Xeroizer
       
       has_many  :tracking, :model_name => 'TrackingCategoryChild'
       
-      # Swallow assignment of attributes that should only be calculated automatically.
-      def line_amount=(value);  raise SettingTotalDirectlyNotSupported.new(:line_amount);   end
-      
+      def line_amount=(line_amount)
+        @line_amount_set = true
+        attributes[:line_amount] = line_amount
+      end
+            
       # Calculate the line_total (if there is a quantity and unit_amount).
       # Description-only lines have been allowed since Xero V2.09.
       def line_amount(summary_only = false)
-        return attributes[:line_amount] if summary_only
+        return attributes[:line_amount] if summary_only || @line_amount_set
         
         BigDecimal((quantity * unit_amount).to_s).round(2) if quantity && unit_amount
       end

data/lib/xeroizer/models/manual_journal.rb

@@ -12,24 +12,24 @@ module Xeroizer
       JOURNAL_STATUS = {
         'DRAFT' =>      'Draft',
         'POSTED' =>     'Posted'
-      } unless defined?(INVOICE_TYPE)
+      } unless defined?(JOURNAL_STATUS)
       JOURNAL_STATUSES = JOURNAL_STATUS.keys.sort
             
       set_primary_key :manual_journal_id
       set_possible_primary_keys :manual_journal_id
       list_contains_summary_only true
       
-      guid      :manual_journal_id
-      date      :date
-      string    :status
-      string    :line_amount_types
-      string    :narration
-      string    :url
-      string    :external_link_provider_name # only seems to be read-only at the moment
-      boolean   :show_on_cash_basis_reports
-      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      guid          :manual_journal_id
+      date          :date
+      string        :status
+      string        :line_amount_types
+      string        :narration
+      string        :url
+      string        :external_link_provider_name # only seems to be read-only at the moment
+      boolean       :show_on_cash_basis_reports
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
       
-      has_many  :journal_lines, :model_name => 'ManualJournalLine'
+      has_many      :journal_lines, :model_name => 'ManualJournalLine'
       
       validates_presence_of :narration
       validates_associated :journal_lines
@@ -39,4 +39,4 @@ module Xeroizer
     end
     
   end
-end
+end

data/lib/xeroizer/models/payment.rb

@@ -12,17 +12,17 @@ module Xeroizer
       
       set_primary_key :payment_id
       
-      guid      :payment_id
-      date      :date
-      decimal   :amount
-      decimal   :currency_rate
-      string    :payment_type
-      string    :status
-      string    :reference
-      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      guid          :payment_id
+      date          :date
+      decimal       :amount
+      decimal       :currency_rate
+      string        :payment_type
+      string        :status
+      string        :reference
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
 
-      belongs_to  :account
-      belongs_to  :invoice
+      belongs_to    :account
+      belongs_to    :invoice
       
       def invoice_id
         invoice.id if invoice
@@ -39,4 +39,4 @@ module Xeroizer
     end
     
   end
-end
+end

data/lib/xeroizer/models/tax_rate.rb

@@ -11,6 +11,7 @@ module Xeroizer
       
       string  :name
       string  :tax_type
+      string  :status
       boolean :can_apply_to_assets
       boolean :can_apply_to_equity
       boolean :can_apply_to_expenses

data/lib/xeroizer/oauth.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
   
   # Shamelessly taken from the XeroGateway library by Tim Connor which is shamelessly 
@@ -50,6 +64,7 @@ module Xeroizer
     # @option options [String] :request_token_path base URL path for getting a RequestToken (default: "/oauth/RequestToken")
     # @option options [String] :signature_method method usd to sign requests (default: OAuth library default)
     # @option options [String] :site base site for API requests (default: "https://api.xero.com")
+    # @option options [IO] :http_debug_output filehandle to write HTTP traffic to
     # @option options [OpenSSL:X509::Certificate] :ssl_client_cert client-side SSL certificate to use for requests (used for PartnerApplication mode)
     # @option options [OpenSSL::PKey::RSA] :ssl_client_key client-side SSL private key to use for requests (used for PartnerApplication mode)
     def initialize(ctoken, csecret, options = {})
@@ -104,9 +119,9 @@ module Xeroizer
       })
       update_attributes_from_token(access_token)
     end
-    
-    private 
-    
+
+    private
+
       # Create an OAuth consumer with the SSL client key if specified in @consumer_options when
       # this instance was created.
       def create_consumer
@@ -116,8 +131,13 @@ module Xeroizer
           consumer.http.key = @consumer_options[:ssl_client_key]
         end
         consumer
+
+        if @consumer_options[:http_debug_output]
+          consumer.http.set_debug_output(@consumer_options[:http_debug_output])
+        end
+        consumer
       end
-      
+
       # Update instance variables with those from the AccessToken.
       def update_attributes_from_token(access_token)
         @expires_at = Time.now + access_token.params[:oauth_expires_in].to_i
@@ -125,6 +145,5 @@ module Xeroizer
         @session_handle = access_token.params[:oauth_session_handle]
         @atoken, @asecret = access_token.token, access_token.secret
       end
-          
   end
 end

data/lib/xeroizer/record/base.rb

@@ -51,11 +51,13 @@ module Xeroizer
         end
         
         def []=(attribute, value)
+          parent.mark_dirty(self) if parent
           self.send("#{attribute}=".to_sym, value)
         end
 
         def attributes=(new_attributes)
           return unless new_attributes.is_a?(Hash)
+          parent.mark_dirty(self) if parent
           new_attributes.each do | key, value |
             self.send("#{key}=".to_sym, value)
           end
@@ -84,6 +86,7 @@ module Xeroizer
           record = self.parent.find(self.id)
           @attributes = record.attributes if record
           @complete_record_downloaded = true
+          parent.mark_clean(self)
           self
         end
         
@@ -94,9 +97,30 @@ module Xeroizer
           else
             update
           end
+          saved!
+        end
+
+        def saved!
           @complete_record_downloaded = true
+          parent.mark_clean(self)
           true
         end
+        
+        def to_json(*args)
+          to_h.to_json(*args)
+        end
+
+        # Deprecated
+        def as_json(options = {})
+          to_h.to_json
+        end
+
+        def to_h
+          attrs = self.attributes.reject {|k, v| k == :parent }.map do |k, v|
+            [k, v.kind_of?(Array) ? v.map(&:to_h) : (v.respond_to?(:to_h) ? v.to_h : v)]
+          end
+          Hash[attrs]
+        end
 
         def inspect
           attribute_string = self.attributes.collect do |attr, value|
@@ -112,7 +136,7 @@ module Xeroizer
           request = to_xml
           log "[CREATE SENT] (#{__FILE__}:#{__LINE__}) #{request}"
           
-          response = parent.http_put(request)
+          response = parent.http_post(request)
           log "[CREATE RECEIVED] (#{__FILE__}:#{__LINE__}) #{response}"
           
           parse_save_response(response)

data/lib/xeroizer/record/base_model.rb

@@ -8,14 +8,19 @@ module Xeroizer
       include ClassLevelInheritableAttributes
       class_inheritable_attributes :api_controller_name
       
-      class InvaidPermissionError < StandardError; end
+      module InvaidPermissionError; end
+      class InvalidPermissionError < StandardError
+        include InvaidPermissionError
+      end
       ALLOWED_PERMISSIONS = [:read, :write, :update]
       class_inheritable_attributes :permissions
       
       class_inheritable_attributes :xml_root_name
       class_inheritable_attributes :optional_xml_root_name
       class_inheritable_attributes :xml_node_name
-      
+
+      DEFAULT_RECORDS_PER_BATCH_SAVE = 2000
+
       include BaseModelHttpProxy
 
       attr_reader :application
@@ -40,7 +45,7 @@ module Xeroizer
         def set_permissions(*args)
           self.permissions = {}
           args.each do | permission |
-            raise InvaidPermissionError.new("Permission #{permission} is invalid.") unless ALLOWED_PERMISSIONS.include?(permission)
+            raise InvalidPermissionError.new("Permission #{permission} is invalid.") unless ALLOWED_PERMISSIONS.include?(permission)
             self.permissions[permission] = true
           end
         end
@@ -86,7 +91,22 @@ module Xeroizer
         
         # Build a record with attributes set to the value of attributes.
         def build(attributes = {})
-          model_class.build(attributes, self)
+          model_class.build(attributes, self).tap do |resource|
+            mark_dirty(resource)
+          end
+        end
+
+        def mark_dirty(resource)
+          if @allow_batch_operations
+            @objects[model_class] ||= {}
+            @objects[model_class][resource.object_id] ||= resource
+          end
+        end
+
+        def mark_clean(resource)
+          if @objects and @objects[model_class]
+            @objects[model_class].delete(resource.object_id)
+          end
         end
 
         # Create (build and save) a record with attributes set to the value of attributes.
@@ -119,7 +139,37 @@ module Xeroizer
           result.complete_record_downloaded = true if result
           result
         end
-        
+
+        def batch_save(chunk_size = DEFAULT_RECORDS_PER_BATCH_SAVE)
+          @objects = {}
+          @allow_batch_operations = true
+
+          yield
+
+          if @objects[model_class]
+            objects = @objects[model_class].values.compact
+            return false unless objects.all?(&:valid?)
+            actions = objects.group_by {|o| o.new_record? ? :http_put : :http_post }
+            actions.each_pair do |http_method, records|
+              records.each_slice(chunk_size) do |some_records|
+                request = to_bulk_xml(some_records)
+                response = parse_response(self.send(http_method, request, {:summarizeErrors => false}))
+                response.response_items.each_with_index do |record, i|
+                  if record and record.is_a?(model_class)
+                    some_records[i].attributes = record.attributes
+                    some_records[i].errors = record.errors
+                    some_records[i].saved!
+                  end
+                end
+              end
+            end
+          end
+
+          @objects = {}
+          @allow_batch_operations = false
+          true
+        end
+
         def parse_response(response_xml, options = {})
           Response.parse(response_xml, options) do | response, elements, response_model_name |
             if model_name == response_model_name
@@ -128,17 +178,40 @@ module Xeroizer
             end
           end
         end
-                
+
       protected
-        
+
         # Parse the records part of the XML response and builds model instances as necessary.
         def parse_records(response, elements)
           elements.each do | element |
-            response.response_items << model_class.build_from_node(element, self)
+            new_record = model_class.build_from_node(element, self)
+            if element.attribute('status').try(:value) == 'ERROR'
+              new_record.errors = []
+              element.xpath('.//ValidationError').each do |err|
+                new_record.errors << err.text.gsub(/^\s+/, '').gsub(/\s+$/, '')
+              end
+            end
+            response.response_items << new_record
           end
         end
-        
-    end
-    
+
+        def to_bulk_xml(records, builder = Builder::XmlMarkup.new(:indent => 2))
+          tag = (self.class.optional_xml_root_name || model_name).pluralize
+          builder.tag!(tag) do
+            records.each {|r| r.to_xml(builder) }
+          end
+        end
+
+        # Parse the response from a create/update request.
+        def parse_save_response(response_xml)
+          response = parse_response(response_xml)
+          record = response.response_items.first if response.response_items.is_a?(Array)
+          if record && record.is_a?(self.class)
+            @attributes = record.attributes
+          end
+          self
+        end
+      end
+
   end
 end

data/lib/xeroizer/record/base_model_http_proxy.rb

@@ -17,7 +17,8 @@ module Xeroizer
           def parse_params(options)
             params = {}
             params[:ModifiedAfter]  = options[:modified_since] if options[:modified_since]          
-            params[:OrderBy]        = options[:order] if options[:order]
+            params[:order]        = options[:order] if options[:order]
+
             if options[:where]
               params[:where] =  case options[:where]
                                   when String   then options[:where] 

data/lib/xeroizer/record/model_definition_helper.rb

@@ -42,6 +42,7 @@ module Xeroizer
         def decimal(field_name, options = {});    define_simple_attribute(field_name, :decimal, options, 0.0); end
         def date(field_name, options = {});       define_simple_attribute(field_name, :date, options); end
         def datetime(field_name, options = {});   define_simple_attribute(field_name, :datetime, options); end
+        def datetime_utc(field_name, options = {});   define_simple_attribute(field_name, :datetime_utc, options); end
         
         def guid(field_name, options = {})
           # Ensure all automated Id conversions are changed to ID.
@@ -72,6 +73,7 @@ module Xeroizer
           
           unless options[:skip_writer]
             define_method "#{internal_field_name}=".to_sym do | value | 
+              parent.mark_dirty(self) if parent
               @attributes[field_name] = value
             end
           end
@@ -88,6 +90,7 @@ module Xeroizer
 
         # Sets the value of the Xero primary key for this record if it exists.
         def id=(new_id)
+          parent.mark_dirty(self) if parent
           self[self.class.primary_key_name] = new_id
         end
         

data/lib/xeroizer/record/xml_helper.rb

@@ -1,3 +1,5 @@
+require 'active_support/time'
+
 module Xeroizer
   module Record
     module XmlHelper
@@ -23,6 +25,7 @@ module Xeroizer
                 when :decimal     then BigDecimal.new(element.text)
                 when :date        then Date.parse(element.text)
                 when :datetime    then Time.parse(element.text)
+                when :datetime_utc then ActiveSupport::TimeZone['UTC'].parse(element.text).utc.round(3)
                 when :belongs_to  
                   model_name = field[:model_name] ? field[:model_name].to_sym : element.name.to_sym
                   Xeroizer::Record.const_get(model_name).build_from_node(element, parent)
@@ -44,7 +47,8 @@ module Xeroizer
               end
             end
           end
-          
+
+          parent.mark_clean(record)
           record
         end
         
@@ -84,7 +88,7 @@ module Xeroizer
             end
           end
         
-          # Format a attribute for use in the XML passed to Xero.
+          # Format an attribute for use in the XML passed to Xero.
           def xml_value_from_field(b, field, value)
             case field[:type]
               when :guid        then b.tag!(field[:api_name], value)

data/lib/xeroizer/response.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
   class Response