xeroizer-float 2.15.3.1

data/lib/xeroizer/models/address.rb

@@ -0,0 +1,32 @@
+module Xeroizer
+  module Record
+    
+    class AddressModel < BaseModel
+            
+    end
+    
+    class Address < Base
+      
+      ADDRESS_TYPE = {
+        'STREET' =>     'Street',
+        'POBOX' =>      'PO Box',
+        'DEFAULT' =>    'Default address type'
+      } unless defined?(ADDRESS_TYPE)
+      
+      string :address_type, :internal_name => :type
+      string :attention_to
+      string :address_line1, :internal_name => :line1
+      string :address_line2, :internal_name => :line2
+      string :address_line3, :internal_name => :line3
+      string :address_line4, :internal_name => :line4
+      string :city
+      string :region
+      string :postal_code
+      string :country
+      
+      validates_inclusion_of :type, :in => ADDRESS_TYPE.keys
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/bank_account.rb

@@ -0,0 +1,12 @@
+module Xeroizer
+  module Record
+    class BankAccountModel < BaseModel
+      set_permissions :read
+    end
+
+    class BankAccount < Base
+      guid   :account_id
+      string :code
+    end
+  end
+end

data/lib/xeroizer/models/bank_transaction.rb

@@ -0,0 +1,75 @@
+require 'xeroizer/models/line_item'
+require 'xeroizer/models/line_item_sum'
+
+module Xeroizer
+  module Record
+    class BankTransactionModel < BaseModel
+      set_permissions :read
+    end
+
+    class BankTransaction < Base
+      def initialize(parent)
+        super parent
+        self.line_amount_types = "Exclusive"
+      end
+
+      set_primary_key :bank_transaction_id
+      string :type
+      date :date
+
+      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
+
+      alias_method :reconciled?, :is_reconciled
+
+      belongs_to :contact, :model_name => 'Contact'
+      string :line_amount_types
+      has_many :line_items, :model_name => 'LineItem'
+      belongs_to :bank_account, :model_name => 'BankAccount'
+
+      validates_inclusion_of :line_amount_types,
+        :in => Xeroizer::Record::LINE_AMOUNT_TYPES, :allow_blanks => false
+
+      validates_inclusion_of :type,
+        :in => %w{SPEND RECEIVE}, :allow_blanks => false,
+        :message => "Invalid type. Expected either SPEND or RECEIVE."
+
+      validates_presence_of :contact, :bank_account, :allow_blanks => false
+
+      validates :line_items, :message => "Invalid line items. Must supply at least one." do
+        self.line_items.size > 0
+      end
+
+      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 total; sub_total + total_tax; end
+
+      def sub_total
+        if ought_to_recalculate_totals?
+          result = LineItemSum.sub_total(self.line_items)
+          result -= total_tax if line_amount_types == 'Inclusive'
+          result
+        else
+          attributes[:sub_total]
+        end
+      end
+
+      def total_tax
+        return ought_to_recalculate_totals? ?
+          LineItemSum.total_tax(self.line_items) :
+          attributes[:total_tax]
+      end
+
+      private
+
+      def ought_to_recalculate_totals?
+        new_record? || line_items && line_items.size > 0
+      end
+    end
+  end
+end

data/lib/xeroizer/models/branding_theme.rb

@@ -0,0 +1,22 @@
+module Xeroizer
+  module Record
+    
+    class BrandingThemeModel < BaseModel
+    
+      set_permissions :read
+    
+    end
+    
+    class BrandingTheme < Base
+      
+      set_primary_key :branding_theme_id
+      
+      guid      :branding_theme_id
+      string    :name
+      integer   :sort_order
+      datetime  :created_date_utc, :api_name => 'CreatedDateUTC'
+
+    end
+    
+  end
+end

data/lib/xeroizer/models/contact.rb

@@ -0,0 +1,49 @@
+module Xeroizer
+  module Record
+    
+    class ContactModel < BaseModel
+            
+      set_permissions :read, :write, :update
+      
+    end
+    
+    class Contact < Base
+      
+      CONTACT_STATUS = {
+        'ACTIVE' =>     'Active',
+        'DELETED' =>    'Deleted'
+      } unless defined?(CONTACT_STATUS)
+      
+      set_primary_key :contact_id
+      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_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
+      has_many  :contact_groups
+      
+      validates_presence_of :name
+      validates_inclusion_of :contact_status, :in => CONTACT_STATUS.keys, :allow_blanks => true
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/contact_group.rb

@@ -0,0 +1,16 @@
+module Xeroizer
+  module Record
+    
+    class ContactGroupModel < BaseModel      
+    end
+    
+    class ContactGroup < Base
+      
+      guid :contact_group_id
+      string :name
+      string :status
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/credit_note.rb

@@ -0,0 +1,130 @@
+module Xeroizer
+  module Record
+    
+    class CreditNoteModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+      public
+
+        # Retrieve the PDF version of the credit matching the `id`.
+        # @param [String] id invoice's ID.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(id, filename = nil)
+          pdf_data = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}", :response => :pdf)
+          if filename
+            File.open(filename, "w") { | fp | fp.write pdf_data }
+            nil
+          else
+            pdf_data
+          end
+        end
+      
+    end
+    
+    class CreditNote < Base
+      
+      CREDIT_NOTE_STATUS = {
+        'AUTHORISED' =>       'Approved credit_notes awaiting payment',
+        'DELETED' =>          'Draft credit_notes that are deleted',
+        'DRAFT' =>            'CreditNotes saved as draft or entered via API',
+        'PAID' =>             'CreditNotes approved and fully paid',
+        'SUBMITTED' =>        'CreditNotes entered by an employee awaiting approval',
+        'VOIDED' =>           'Approved credit_notes that are voided'
+      } unless defined?(CREDIT_NOTE_STATUS)
+      CREDIT_NOTE_STATUSES = CREDIT_NOTE_STATUS.keys.sort
+      
+      CREDIT_NOTE_TYPE = {
+        'ACCRECCREDIT' =>           'Accounts Receivable',
+        'ACCPAYCREDIT' =>           'Accounts Payable'
+      } unless defined?(CREDIT_NOTE_TYPE)
+      CREDIT_NOTE_TYPES = CREDIT_NOTE_TYPE.keys.sort
+      
+      set_primary_key :credit_note_id
+      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_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
+      
+      validates_inclusion_of :type, :in => CREDIT_NOTE_TYPES
+      validates_inclusion_of :status, :in => CREDIT_NOTE_STATUSES, :allow_blanks => true
+      validates_associated :contact
+      validates_associated :line_items
+      
+      public
+      
+        # Access the contact name without forcing a download of
+        # an incomplete, summary credit note.
+        def contact_name
+          attributes[:contact] && attributes[:contact][:name]
+        end
+
+        # Access the contact ID without forcing a download of an
+        # incomplete, summary credit note.
+        def contact_id
+          attributes[:contact] && attributes[:contact][:contact_id]
+        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
+      
+        # 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))
+            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.
+            sum -= total_tax if line_amount_types == 'Inclusive' 
+            sum
+          else
+            attributes[:sub_total]
+          end
+        end
+
+        # 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))
+            (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
+          else
+            attributes[:total_tax]
+          end
+        end
+
+        # Calculate the total from line_items.
+        def total(always_summary = false)
+          unless always_summary
+            sub_total + total_tax
+          else
+            attributes[:total]
+          end
+        end
+        
+        # Retrieve the PDF version of this credit note.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(filename = nil)
+          parent.pdf(id, filename)
+        end
+              
+    end
+    
+  end
+end

data/lib/xeroizer/models/currency.rb

@@ -0,0 +1,18 @@
+module Xeroizer
+  module Record
+    
+    class CurrencyModel < BaseModel
+        
+      set_permissions :read
+      
+    end
+    
+    class Currency < Base
+      
+      string  :code
+      string  :description
+      
+    end
+    
+  end
+end

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

@@ -0,0 +1,192 @@
+module Xeroizer
+  module Record
+    
+    class InvoiceModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+      public
+      
+        # Retrieve the PDF version of the invoice matching the `id`.
+        # @param [String] id invoice's ID.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(id, filename = nil)
+          pdf_data = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}", :response => :pdf)
+          if filename
+            File.open(filename, "w") { | fp | fp.write pdf_data }
+            nil
+          else
+            pdf_data
+          end
+        end
+      
+    end
+    
+    class Invoice < Base
+      
+      INVOICE_TYPE = {
+        'ACCREC' =>           'Accounts Receivable',
+        'ACCPAY' =>           'Accounts Payable'
+      } unless defined?(INVOICE_TYPE)
+      INVOICE_TYPES = INVOICE_TYPE.keys.sort
+
+      INVOICE_STATUS = {
+        'AUTHORISED' =>       'Approved invoices awaiting payment',
+        'DELETED' =>          'Draft invoices that are deleted',
+        'DRAFT' =>            'Invoices saved as draft or entered via API',
+        'PAID' =>             'Invoices approved and fully paid',
+        'SUBMITTED' =>        'Invoices entered by an employee awaiting approval',
+        'VOIDED' =>           'Approved invoices that are voided'
+      } unless defined?(INVOICE_STATUS)
+      INVOICE_STATUSES = INVOICE_STATUS.keys.sort
+      
+      set_primary_key :invoice_id
+      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_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
+      
+      validates_presence_of :date, :due_date, :unless => :new_record?
+      validates_inclusion_of :type, :in => INVOICE_TYPES
+      validates_inclusion_of :status, :in => INVOICE_STATUSES, :unless => :new_record?
+      validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES, :unless => :new_record?
+      validates_associated :contact
+      validates_associated :line_items, :allow_blanks => true, :unless => :approved?
+      validates_associated :line_items, :if => :approved?
+      
+      public
+      
+        # Access the contact name without forcing a download of
+        # an incomplete, summary invoice.
+        def contact_name
+          attributes[:contact] && attributes[:contact][:name]
+        end
+
+        # Access the contact ID without forcing a download of an
+        # incomplete, summary invoice.
+        def contact_id
+          attributes[:contact] && attributes[:contact][:contact_id]
+        end
+        
+        # Helper method to check if the invoice has been approved.
+        def approved?
+          [ 'AUTHORISED', 'PAID', 'VOIDED' ].include? status
+        end
+        
+        # Helper method to check if the invoice is accounts payable.
+        def accounts_payable?
+          type == 'ACCPAY'
+        end
+
+        # Helper method to check if the invoice is accounts receivable.
+        def accounts_receivable?
+          type == 'ACCREC'
+        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 !@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.
+            sum -= total_tax if line_amount_types == 'Inclusive' 
+            sum
+          else
+            attributes[:sub_total]
+          end
+        end
+
+        # Calculate total_tax from line_items.
+        def total_tax(always_summary = false)
+          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]
+          end
+        end
+
+        # Calculate the total from line_items.
+        def total(always_summary = false)
+          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)
+          parent.pdf(id, filename)
+        end
+
+        # Delete an approved invoice with no payments.
+        def delete!
+          delete_or_void_invoice!('DELETED')
+        end
+
+        # Void an approved invoice with no payments.
+        def void!
+          delete_or_void_invoice!('VOIDED')
+        end
+
+      protected
+
+        def delete_or_void_invoice!(new_status)
+          raise CannotChangeInvoiceStatus.new(record, new_status) unless self.payments.size == 0
+          self.status = new_status
+          self.save
+        end
+      
+    end
+    
+  end
+end