xeroizer-3-pre-beta 3.0.0.pre.beta

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

@@ -0,0 +1,164 @@
+module Xeroizer
+  module Record
+
+    class CreditNoteModel < BaseModel
+
+      set_permissions :read, :write, :update
+
+      include AttachmentModel::Extensions
+
+      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
+
+      include Attachment::Extensions
+
+      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
+      guid          :branding_theme_id
+      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
+      decimal       :currency_rate
+      datetime      :fully_paid_on_date
+      decimal       :remaining_credit
+      decimal       :applied_amount
+      boolean       :has_attachments
+
+      belongs_to    :contact
+      has_many      :line_items
+      has_many      :allocations
+
+      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
+      validates_associated :allocations, :allow_blanks => true
+
+      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))
+            overall_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.
+            overall_sum -= total_tax if line_amount_types == 'Inclusive'
+            overall_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('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
+
+        def save
+          # Calling parse_save_response() on the credit note will wipe out
+          # the allocations, so we have to manually preserve them.
+          allocations_backup = self.allocations
+          if super
+            self.allocations = allocations_backup
+            allocate unless self.allocations.empty?
+            true
+          end
+        end
+
+        def allocate
+          if self.class.possible_primary_keys && self.class.possible_primary_keys.all? { | possible_key | self[possible_key].nil? }
+            raise RecordKeyMustBeDefined.new(self.class.possible_primary_keys)
+          end
+
+          request = association_to_xml(:allocations)
+          allocations_url = "#{parent.url}/#{CGI.escape(id)}/Allocations"
+
+          log "[ALLOCATION SENT] (#{__FILE__}:#{__LINE__}) \r\n#{request}"
+          response = parent.application.http_put(parent.application.client, allocations_url, request)
+          log "[ALLOCATION RECEIVED] (#{__FILE__}:#{__LINE__}) \r\n#{response}"
+          parse_save_response(response)
+        end
+    end
+
+  end
+end

data/lib/xeroizer/models/currency.rb

@@ -0,0 +1,30 @@
+module Xeroizer
+  module Record
+    
+    class CurrencyModel < BaseModel
+        
+      set_permissions :read, :write
+
+      # Currencies can only be created (added), no update or delete is possible
+      def create_method
+        :http_put
+      end
+      
+    end
+    
+    class Currency < Base
+
+      # Currency does not have an ID
+      # This method overrides the base model to always treat a Currency as new (so it can be saved)
+      # Attempting to update a currency will result in a validation error.	
+      def new_record?
+      	true
+      end
+      
+      string  :code
+      string  :description # read only
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/employee.rb

@@ -0,0 +1,73 @@
+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
+      date    :date_of_birth
+
+      # Optional attributes
+      string  :gender # M or F
+      string  :email
+      string  :phone # (max length = 50, but AU only?)
+      string  :mobile # (max length = 50)
+      date    :start_date
+      date    :termination_date
+      boolean :is_authorised_to_approve_timesheets
+      string  :employee_group_name
+
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      
+      belongs_to  :external_link
+
+      validates_presence_of :first_name, :last_name, :date_of_birth
+
+    end
+
+  #   # AU Only API
+  #   class EmployeeAU < Employee
+  #     string :occupation
+  #     string :classification # length: 100
+  #     string :ordinary_earnings_rate_id
+  #     boolean :is_authorised_to_approve_leave
+
+  #     string :title # (max length = 10)
+  #     string :twitter_user_name # (max length = 50)
+  #     # PayrollCalendarID Xero unique identifier for payroll calendar for the employee
+  #     # BankAccounts  See BankAccount
+  #     # SuperMemberships  See SuperMemberships
+  #   end
+
+  #   # US Only API
+  #   class EmployeeUS < Employee
+  #     string :middle_names #max length = 35
+  #     string :job_title
+  #     string :employee_number
+  #     string :social_security_number # (xxx-xx-xxxx)
+  #     string :holiday_group_id
+  #     string :pay_schedule_id
+  #     string :employment_basis  # One of http://developer.xero.com/documentation/payroll-api-us/Types-Codes/#EmploymentBasis
+  #     boolean :is_authorised_to_approve_time_off
+
+  #     # MailingAddress - US only, has_one relationship
+  #     # SalaryAndWages  See SalaryAndWages
+  #     # WorkLocations See WorkLocations
+  #     # PaymentMethod See PaymentMethods
+  #     # PayTemplate See PayTemplate
+  #     # OpeningBalances See OpeningBalances
+  #   end
+  end
+end

data/lib/xeroizer/models/expense_claim.rb

@@ -0,0 +1,29 @@
+module Xeroizer
+  module Record
+    
+    class ExpenseClaimModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+    end
+    
+    class ExpenseClaim < Base
+      
+      set_primary_key :expense_claim_id
+
+      guid          :expense_claim_id
+      string        :status
+      decimal       :total
+      decimal       :amount_due
+      decimal       :amount_paid
+      date          :payment_due_date
+      date          :reporting_date
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      
+      belongs_to    :user
+      has_many      :receipts
+      
+    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/from_bank_account.rb

@@ -0,0 +1,13 @@
+module Xeroizer
+  module Record
+    class FromBankAccountModel < BaseModel
+      set_permissions :read
+    end
+
+    class FromBankAccount < Base
+      guid   :account_id
+      string :code
+      string :name
+    end
+  end
+end

data/lib/xeroizer/models/invoice.rb

@@ -0,0 +1,229 @@
+require "xeroizer/models/attachment"
+require "xeroizer/models/online_invoice"
+
+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'},...)
+      # However for existing contacts, it is better to reference them by contactid (only)
+      # see http://developer.xero.com/documentation/api/contacts/
+      # $xero_client.Invoice.build(type: 'ACCREC', ..., contact: {contact_id: 'foo123-bar456-guid'},...)
+      # Note that we are not making an api request to xero just to get the contact
+
+      set_permissions :read, :write, :update
+
+      include AttachmentModel::Extensions
+      include OnlineInvoiceModel::Extensions
+
+      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, "wb") { | 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
+
+      include Attachment::Extensions
+      include OnlineInvoice::Extensions
+
+      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      :total_discount
+      decimal      :amount_due
+      decimal      :amount_paid
+      decimal      :amount_credited
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string       :currency_code
+      decimal      :currency_rate
+      datetime     :fully_paid_on_date
+      datetime     :expected_payment_date
+      datetime     :planned_payment_date
+      boolean      :has_attachments
+
+      belongs_to   :contact
+      has_many     :line_items, :complete_on_page => true
+      has_many     :payments
+      has_many     :credit_notes
+      has_many     :prepayments
+
+      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
+        def initialize(parent)
+          super(parent)
+          @sub_total_is_set = false
+          @total_tax_is_set = false
+          @total_is_set = false
+        end
+
+        # 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)
+            overall_sum = (line_items || []).inject(BigDecimal('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.
+            overall_sum -= total_tax if line_amount_types == 'Inclusive'
+            overall_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('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!
+          change_status!('DELETED')
+        end
+
+        # Void an approved invoice with no payments.
+        def void!
+          change_status!('VOIDED')
+        end
+
+        # Approve a draft invoice
+        def approve!
+          change_status!('AUTHORISED')
+        end
+
+        # Send an email containing the invoice.
+        def email
+          email_url = "#{parent.url}/#{CGI.escape(id)}/Email"
+          parent.application.http_post(parent.application.client, email_url, "")
+        end
+
+      protected
+
+        def change_status!(new_status)
+          raise CannotChangeInvoiceStatus.new(self, new_status) unless self.payments.size == 0
+          self.status = new_status
+          self.save
+        end
+
+    end
+
+  end
+end