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

data/lib/xeroizer/models/balances.rb

@@ -0,0 +1,17 @@
+require "xeroizer/models/accounts_receivable"
+require "xeroizer/models/accounts_payable"
+
+module Xeroizer
+  module Record
+    
+    class BalancesModel < BaseModel
+      set_permissions :read
+      set_api_controller_name 'Balances'
+    end
+    
+    class Balances < Base
+      has_one :accounts_receivable
+      has_one :accounts_payable
+    end
+  end
+end

data/lib/xeroizer/models/bank_account.rb

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

data/lib/xeroizer/models/bank_transaction.rb

@@ -0,0 +1,95 @@
+require 'xeroizer/models/line_item'
+require 'xeroizer/models/line_item_sum'
+require 'xeroizer/models/attachment'
+
+module Xeroizer
+  module Record
+    class BankTransactionModel < BaseModel
+      set_permissions :read
+
+      include AttachmentModel::Extensions
+    end
+
+    class BankTransaction < Base
+
+      BANK_TRANSACTION_STATUS = {
+        'AUTHORISED'  =>          'Active bank transactions',
+        'DELETED' =>          'Deleted bank transactions',
+      } unless defined?(BANK_TRANSACTION_STATUS)
+      BANK_TRANSACTION_STATUSES = BANK_TRANSACTION_STATUS.keys.sort
+
+      include Attachment::Extensions
+
+      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
+
+      datetime_utc  :updated_date_utc, :api_name => "UpdatedDateUTC"
+      date          :fully_paid_on_date
+      string        :url
+      string        :reference
+      string        :bank_transaction_id, :api_name => "BankTransactionID"
+      boolean       :is_reconciled
+      string        :status
+      string        :currency_code
+      decimal       :currency_rate
+      boolean       :has_attachments
+
+      alias_method :reconciled?, :is_reconciled
+
+      belongs_to :contact, :model_name => 'Contact'
+      string :line_amount_types
+      has_many :line_items, :model_name => 'LineItem', :complete_on_page => true
+      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{RECEIVE RECEIVE-OVERPAYMENT RECEIVE-PREPAYMENT SPEND SPEND-OVERPAYMENT SPEND-PREPAYMENT}, :allow_blanks => false,
+        :message => "Invalid type. Expected one of https://developer.xero.com/documentation/api/types#BankTransactionTypes"
+      validates_inclusion_of :status, :in => BANK_TRANSACTION_STATUSES, :allow_blanks => true
+
+      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/bank_transfer.rb

@@ -0,0 +1,28 @@
+module Xeroizer
+  module Record
+    class BankTransferModel < BaseModel
+      set_permissions :read, :write, :update
+    end
+
+    class BankTransfer < Base
+
+      def initialize(parent)
+        super parent
+      end
+
+      set_primary_key :bank_transfer_id
+
+      string          :bank_transfer_id, :api_name => "BankTransferID"
+      datetime_utc    :created_date_utc, :api_name => "CreatedDateUTC"
+      date            :date
+      decimal         :amount
+      decimal         :currency_rate
+      string          :from_bank_transaction_id, :api_name => "FromBankTransactionID"
+      string          :to_bank_transaction_id, :api_name => "ToBankTransactionID"
+
+      validates_presence_of :from_bank_account, :to_bank_account, :allow_blanks => false
+      belongs_to :from_bank_account, :model_name => 'FromBankAccount'
+      belongs_to :to_bank_account, :model_name => 'ToBankAccount'
+    end
+  end
+end

data/lib/xeroizer/models/batch_payment.rb

@@ -0,0 +1,24 @@
+module Xeroizer
+  module Record
+
+    class BatchPaymentModel < BaseModel
+      set_permissions :read
+    end
+
+    class BatchPayment < Base
+      guid    :batch_payment_id
+      string  :reference
+      string  :details
+      date    :date
+      string  :type
+      string  :status
+      decimal :total_amount
+      boolean :is_reconciled
+
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+
+      belongs_to :account
+      has_many   :payments
+    end
+  end
+end

data/lib/xeroizer/models/batch_payments.rb

@@ -0,0 +1,14 @@
+module Xeroizer
+  module Record
+    
+    class BatchPaymentsModel < BaseModel
+      set_permissions :read
+    end
+    
+    class BatchPayments < Base
+      guid   :bank_account_number
+      string :bank_account_name
+      string :details
+    end
+  end
+end

data/lib/xeroizer/models/bills.rb

@@ -0,0 +1,13 @@
+module Xeroizer
+  module Record
+    
+    class BillsModel < BaseModel
+      set_permissions :read
+    end
+    
+    class Bills < Base
+      string :day
+      string :type
+    end
+  end
+end

data/lib/xeroizer/models/branding_theme.rb

@@ -0,0 +1,62 @@
+require "xeroizer/models/payment_service"
+
+module Xeroizer
+  module Record
+
+    class BrandingThemeModel < BaseModel
+
+      set_permissions :read, :write
+
+      public
+
+      def payment_services(id)
+        @payment_services ||= @application.http_get(@application.client, payment_services_endpoint(id))
+      end
+
+      def add_payment_service(id:, payment_service_id:)
+        xml = {
+          PaymentService: {
+            PaymentServiceID: payment_service_id
+          }
+        }.to_xml
+
+        @application.http_post(@application.client, payment_services_endpoint(id), xml)
+      end
+
+      private
+
+      def payment_services_endpoint(id)
+        "#{url}/#{id}/PaymentServices"
+      end
+
+    end
+
+    class BrandingTheme < Base
+
+      set_primary_key :branding_theme_id
+
+      guid      :branding_theme_id
+      string    :name
+      integer   :sort_order
+      datetime_utc  :created_date_utc, :api_name => 'CreatedDateUTC'
+
+      # Unfortunately, this part of the API does not work the same as the rest.
+      # You cannot POST child records to Branding Themes.
+      #
+      # The endpoints are:
+      # GET /BrandingThemes/{BrandingThemeID}/PaymentServices
+      # POST /BrandingThemes/{BrandingThemeID}/PaymentServices
+      #
+      # has_one :payment_service, :model_name => 'PaymentService', :list_complete => true
+
+      def payment_services
+        parent.payment_services(id)
+      end
+
+      def add_payment_service(payment_service_id)
+        parent.add_payment_service(id: id, payment_service_id: payment_service_id)
+      end
+    end
+
+  end
+end

data/lib/xeroizer/models/contact.rb

@@ -0,0 +1,77 @@
+require "xeroizer/models/contact_person"
+require "xeroizer/models/balances"
+require "xeroizer/models/batch_payments"
+require "xeroizer/models/payment_terms"
+
+module Xeroizer
+  module Record
+
+    class ContactModel < BaseModel
+
+      set_permissions :read, :write, :update
+
+      include AttachmentModel::Extensions
+
+    end
+
+    class Contact < Base
+
+      CONTACT_STATUS = {
+        'ACTIVE' =>     'Active',
+        'DELETED' =>    'Deleted',
+        'ARCHIVED' => 'Archived'
+      } unless defined?(CONTACT_STATUS)
+
+      include Attachment::Extensions
+
+      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        :account_number
+      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        :default_currency
+      string        :purchases_default_account_code
+      string        :sales_default_account_code
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      boolean       :is_supplier
+      boolean       :is_customer
+      string        :website # read only
+      decimal       :discount # read only
+      boolean       :has_attachments
+
+      has_many  :addresses, :list_complete => true
+      has_many  :phones, :list_complete => true
+      has_many  :contact_groups, :list_complete => true
+      has_many  :contact_persons, :internal_name => :contact_people
+
+      has_many :sales_tracking_categories, :model_name => 'ContactSalesTrackingCategory'
+      has_many :purchases_tracking_categories, :model_name => 'ContactPurchasesTrackingCategory'
+
+      has_one :balances, :model_name => 'Balances', :list_complete => true
+      has_one :batch_payments, :model_name => 'BatchPayments', :list_complete => true
+      has_one :payment_terms, :model_name => 'PaymentTerms', :list_complete => true
+
+      validates_presence_of :name, :unless => Proc.new { | contact | contact.contact_id.present? || contact.contact_number.present? }
+      validates_inclusion_of :contact_status, :in => CONTACT_STATUS.keys, :allow_blanks => true
+      validates_associated :addresses, allow_blanks: true
+
+      def email_address?
+        email_address.present?
+      end
+
+    end
+
+  end
+end

data/lib/xeroizer/models/contact_group.rb

@@ -0,0 +1,64 @@
+module Xeroizer
+  module Record
+
+    class ContactGroupModel < BaseModel
+      set_permissions :read
+    end
+
+    class ContactGroup < Base
+
+      guid :contact_group_id
+      string :name
+      string :status
+
+      set_primary_key :contact_group_id
+      list_contains_summary_only true
+      has_many :contacts, :list_complete => true
+
+      # Adding Contact uses different API endpoint
+      # https://developer.xero.com/documentation/api/contactgroups#PUT
+      def add_contact(contact)
+        @contacts ||= []
+        @contacts <<  contact
+      end
+
+      def delete
+        status = 'DELETED'
+      end
+
+      def name=(value)
+        @modified = true unless @attributes[:name].nil? or @attributes[:name] == value
+        @attributes[:name] = value
+      end
+
+      def status=(value)
+        @modified = true unless @attributes[:status].nil? or @attributes[:status] == value
+        @attributes[:status] = value
+      end
+
+      def save!
+        super if new_record? or @modified
+        @modified = false
+        if @contacts
+          req = cg_xml
+          app = parent.application
+          res = app.http_put(app.client, "#{parent.url}/#{CGI.escape(id)}/Contacts", req)
+          parse_save_response(res)
+        end
+      end
+
+      def cg_xml
+        b = Builder::XmlMarkup.new(:indent => 2)
+        b.tag!('Contacts') do
+          @contacts.each do |c|
+            b.tag!('Contact') do
+              b.tag!('ContactID', c.id)
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/xeroizer/models/contact_person.rb

@@ -0,0 +1,20 @@
+require 'xeroizer/models/account'
+require 'xeroizer/models/line_amount_type'
+
+module Xeroizer
+  module Record
+    class ContactPersonModel < BaseModel
+      set_xml_root_name "ContactPersons"
+    end
+
+    class ContactPerson < Base
+
+      string  :first_name
+      string  :last_name
+      string  :email_address
+      boolean :include_in_emails
+
+    end
+
+  end
+end

data/lib/xeroizer/models/contact_purchases_tracking_category.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class ContactPurchasesTrackingCategoryModel < BaseModel
+    
+      set_xml_root_name 'PurchasesTrackingCategories'
+      set_xml_node_name 'PurchasesTrackingCategory'
+      
+    end
+    
+    class ContactPurchasesTrackingCategory < Base
+      
+      string  :tracking_category_name
+      string  :tracking_option_name
+      
+    end
+    
+  end
+end