xeroizer 0.2.2 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/xeroizer/exceptions.rb

@@ -94,4 +94,17 @@ module Xeroizer
     
   end
   
+  class AssociationTypeMismatch < StandardError
+    
+    def initialize(model_class, actual_class)
+      @model_class = model_class
+      @actual_class = actual_class
+    end
+  
+    def message
+      "#{@model_class} expected, got #{@actual_class}"
+    end
+    
+  end
+  
 end

data/lib/xeroizer/generic_application.rb

@@ -16,6 +16,7 @@ module Xeroizer
     record :Contact
     record :CreditNote
     record :Currency
+    record :Employee
     record :Invoice
     record :Item
     record :Journal

data/lib/xeroizer/models/credit_note.rb

@@ -58,6 +58,7 @@ module Xeroizer
       datetime  :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

data/lib/xeroizer/models/employee.rb

@@ -0,0 +1,28 @@
+require 'xeroizer/models/external_link'
+
+module Xeroizer
+  module Record
+    
+    class EmployeeModel < BaseModel
+        
+      set_permissions :read, :write, :update
+        
+    end
+    
+    class Employee < Base
+          
+      set_primary_key :employee_id
+            
+      guid    :employee_id
+      string  :status
+      string  :first_name
+      string  :last_name
+
+      belongs_to  :external_link
+
+      validates_presence_of :first_name, :last_name
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/external_link.rb

@@ -0,0 +1,16 @@
+module Xeroizer
+  module Record
+    
+    class ExternalLinkModel < BaseModel
+                
+    end
+    
+    class ExternalLink < Base
+          
+      string :url
+      string :description
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/invoice.rb

@@ -70,10 +70,12 @@ module Xeroizer
       datetime  :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
       
       validates_presence_of :date, :due_date
       validates_inclusion_of :type, :in => INVOICE_TYPES

data/lib/xeroizer/models/organisation.rb

@@ -10,13 +10,19 @@ module Xeroizer
     
     class Organisation < Base
       
-      string :name
-      string :legal_name
-      boolean :pays_tax
-      string :version
-      string :organisation_type
-      string :base_currency
-      
+      string    :name
+      string    :legal_name
+      boolean   :pays_tax
+      string    :version
+      string    :organisation_type
+      string    :base_currency
+      integer   :financial_year_end_day
+      integer   :financial_year_end_month
+      date      :period_lock_date
+      date      :end_of_year_lock_date
+      string    :registration_number
+      datetime  :created_date_utc, :api_name => 'CreatedDateUTC'
+
     end
     
   end

data/lib/xeroizer/models/payment.rb

@@ -3,7 +3,7 @@ module Xeroizer
     
     class PaymentModel < BaseModel
         
-      set_permissions :write
+      set_permissions :read, :write
       
     end
     

data/lib/xeroizer/models/tracking_category_child.rb

@@ -2,7 +2,10 @@ module Xeroizer
   module Record
     
     class TrackingCategoryChildModel < BaseModel
-                  
+    
+      set_xml_root_name 'Tracking'
+      set_xml_node_name 'TrackingCategory'
+      
     end
     
     class TrackingCategoryChild < Base

data/lib/xeroizer/record/base.rb

@@ -109,8 +109,8 @@ module Xeroizer
         
         # Parse the response from a create/update request.
         def parse_save_response(response_xml)
-          record = parent.parse_response(response_xml)
-          record = record.first if record.is_a?(Array)
+          response = parent.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

data/lib/xeroizer/record/base_model.rb

@@ -14,6 +14,9 @@ module Xeroizer
       ALLOWED_PERMISSIONS = [:read, :write, :update]
       class_inheritable_attributes :permissions
       
+      class_inheritable_attributes :xml_root_name
+      class_inheritable_attributes :xml_node_name
+      
       include BaseModelHttpProxy
 
       attr_reader :application
@@ -43,6 +46,19 @@ module Xeroizer
           end
         end
         
+        # Method to allow override of the default XML node name.
+        #
+        # Default: singularized model name in camel-case.
+        def set_xml_node_name(node_name)
+          self.xml_node_name = node_name
+        end
+        
+        # Method to allow override of the default XML root name to use
+        # in has_many associations.
+        def set_xml_root_name(root_name)
+          self.xml_root_name = root_name
+        end
+        
       end
             
       public
@@ -73,7 +89,8 @@ module Xeroizer
         def all(options = {})
           raise MethodNotAllowed.new(self, :all) unless self.class.permissions[:read]
           response_xml = http_get(parse_params(options))
-          parse_response(response_xml, options) || []
+          response = parse_response(response_xml, options)
+          response.response_items || []
         end
         
         # Helper method to retrieve just the first element from
@@ -88,8 +105,8 @@ module Xeroizer
         def find(id, options = {})
           raise MethodNotAllowed.new(self, :all) unless self.class.permissions[:read]
           response_xml = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}", options)
-          result = parse_response(response_xml, options)
-          result = result.first if result.is_a?(Array)
+          response = parse_response(response_xml, options)
+          result = response.response_items.first if response.response_items.is_a?(Array)
           result.complete_record_downloaded = true if result
           result
         end
@@ -97,6 +114,7 @@ module Xeroizer
         def parse_response(response_xml, options = {})
           Response.parse(response_xml, options) do | response, elements, response_model_name |
             if model_name == response_model_name
+              @response = response
               parse_records(response, elements)
             end
           end

data/lib/xeroizer/record/model_definition_helper.rb

@@ -56,6 +56,7 @@ module Xeroizer
         #   :api_name => allows the API name to be specified if it can't be properly converted from camelize.
         #   :model_name => allows class used for children to be different from it's ndoe name in the XML.
         #   :type => type of field
+        #   :skip_writer => skip the writer method
         def define_simple_attribute(field_name, field_type, options, value_if_nil = nil)
           self.fields ||= {}
           
@@ -68,8 +69,11 @@ module Xeroizer
           define_method internal_field_name do 
             @attributes[field_name] || value_if_nil
           end
-          define_method "#{internal_field_name}=".to_sym do | value | 
-            @attributes[field_name] = value
+          
+          unless options[:skip_writer]
+            define_method "#{internal_field_name}=".to_sym do | value | 
+              @attributes[field_name] = value
+            end
           end
         end
         

data/lib/xeroizer/record/record_association_helper.rb

@@ -62,27 +62,65 @@ module Xeroizer
             end
           
             # Add each record.
+            record = nil
             records.each do | record |
               record = record_class.build(record, model_parent) if record.is_a?(Hash)
               raise StandardError.new("Record #{record.class.name} is not a #{record_class.name}.") unless record.is_a?(record_class)
               self.attributes[field_name] ||= []
               self.attributes[field_name] << record
             end
+            record # last record
           end
           
         end
         
         def define_association_attribute(field_name, internal_field_name, association_type, options)
-          value_if_nil = (association_type == :has_many) ? [] : nil
-          define_simple_attribute(field_name, association_type, options, value_if_nil)
-
+          define_simple_attribute(field_name, association_type, options.merge!(:skip_writer => true), ((association_type == :has_many) ? [] : nil))
+          
+          internal_field_name = options[:internal_name] || field_name
+          internal_singular_field_name = internal_field_name.to_s.singularize
+          model_name = options[:model_name] ? options[:model_name].to_sym : field_name.to_s.singularize.camelize.to_sym
+    
+          define_method "#{internal_field_name}=".to_sym do | value | 
+            record_class = Xeroizer::Record.const_get(model_name)
+            case value
+              when Hash 
+                self.attributes[field_name] = ((association_type == :has_many) ? [] : nil)
+                case association_type
+                  when :has_many  
+                    self.attributes[field_name] = []
+                    self.send("add_#{internal_singular_field_name}".to_sym, value)
+                    
+                  when :belongs_to  
+                    self.attributes[field_name] = Xeroizer::Record.const_get(model_name).build(value, new_model_class(model_name))
+                    
+                end
+                
+              when Array
+                self.attributes[field_name] = ((association_type == :has_many) ? [] : nil)
+                value.each do | single_value |
+                  case single_value
+                    when Hash         then send("add_#{internal_singular_field_name}".to_sym, single_value)
+                    when record_class then self.attributes[field_name] << single_value
+                    else                   raise AssociationTypeMismatch.new(record_class, single_value.class)
+                  end
+                end
+                
+              when record_class
+                self.attributes[field_name] = ((association_type == :has_many) ? [value] : value)
+                
+              else
+                raise AssociationTypeMismatch.new(record_class, value.class)
+            end
+          end
+          
           # Override reader for this association if this association belongs
           # to a summary-typed record. This will automatically attempt to download
           # the complete version of the record before accessing the association.
           if list_contains_summary_only?
             define_method internal_field_name do
               download_complete_record! unless new_record? || complete_record_downloaded?
-              @attributes[field_name] || value_if_nil
+              self.attributes[field_name] || ((association_type == :has_many) ? [] : nil)
             end
           end
         end

data/lib/xeroizer/record/xml_helper.rb

@@ -56,7 +56,7 @@ module Xeroizer
         
           # Turn a record into its XML representation.
           def to_xml(b = Builder::XmlMarkup.new(:indent => 2))
-            b.tag!(parent.model_name) { 
+            b.tag!(parent.class.xml_node_name || parent.model_name) { 
               attributes.each do | key, value |
                 unless value.nil?
                   field = self.class.fields[key]
@@ -97,7 +97,8 @@ module Xeroizer
 
               when :has_many    
                 if value.size > 0
-                  b.tag!(value.first.parent.model_name.pluralize) {
+                  sub_parent = value.first.parent
+                  b.tag!(sub_parent.class.xml_root_name || sub_parent.model_name.pluralize) {
                     value.each { | record | record.to_xml(b) }
                   }
                   nil

data/lib/xeroizer/report/factory.rb

@@ -23,9 +23,10 @@ module Xeroizer
         # valid query-string parameters to pass to the API.
         def get(options = {})
           response_xml = options[:cache_file] ? File.read(options[:cache_file]) : http_get(options)          
-          Response.parse(response_xml, options) do | response, elements |
+          response = Response.parse(response_xml, options) do | response, elements |
             parse_reports(response, elements)
-          end.first # there is is only one
+          end
+          response.response_items.first # there is is only one
         end
       
         def api_controller_name

data/lib/xeroizer/response.rb

@@ -32,7 +32,7 @@ module Xeroizer
           end
         end
       
-        response.response_items
+        response
       end
       
     end

data/lib/xeroizer.rb

@@ -33,6 +33,7 @@ require 'xeroizer/models/contact'
 require 'xeroizer/models/contact_group'
 require 'xeroizer/models/credit_note'
 require 'xeroizer/models/currency'
+require 'xeroizer/models/employee'
 require 'xeroizer/models/invoice'
 require 'xeroizer/models/item'
 require 'xeroizer/models/item_purchase_sale_details'