xeroizer 0.3.5 → 0.4.0

data/.bundle/config

@@ -1,2 +1,2 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"
+--- {}
+

data/Gemfile

@@ -4,9 +4,14 @@ gem 'builder', '>= 2.1.2'
 gem 'oauth',   '>= 0.3.6'
 gem 'activesupport'
 gem 'nokogiri'
+gem 'i18n'
+gem 'yard'
 
 group :test do
   gem 'mocha'
   gem 'shoulda'
   gem "jeweler", "~> 1.5.2"
+  gem "rest-client"
+  gem "turn"
+  gem "ansi"
 end

data/Rakefile

@@ -28,11 +28,27 @@ task :default => :test
 
 desc 'Test the xero gateway.'
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
+  t.libs << ['lib', 'test']
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
+namespace :test do 
+  desc 'Run acceptance/integration tests'
+  Rake::TestTask.new(:acceptance) do |t|
+    t.libs << ['lib', 'test']
+    t.pattern = 'test/acceptance/**/*_test.rb'
+    t.verbose = true
+  end
+
+  desc 'Run unit tests'
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << ['lib', 'test']
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+end
+
 YARD::Rake::YardocTask.new do |t|
   # t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
   # t.options = ['--any', '--extra', '--opts'] # optional

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/lib/xeroizer.rb

@@ -23,11 +23,14 @@ require 'xeroizer/exceptions'
 
 require 'xeroizer/record/base_model'
 require 'xeroizer/record/base'
+require 'xeroizer/configuration'
 
 # Include models
 require 'xeroizer/models/account'
 require 'xeroizer/models/address'
 require 'xeroizer/models/branding_theme'
+require 'xeroizer/models/bank_transaction'
+require 'xeroizer/models/bank_account'
 require 'xeroizer/models/contact'
 require 'xeroizer/models/contact_group'
 require 'xeroizer/models/credit_note'
@@ -35,7 +38,8 @@ require 'xeroizer/models/currency'
 require 'xeroizer/models/employee'
 require 'xeroizer/models/invoice'
 require 'xeroizer/models/item'
-require 'xeroizer/models/item_purchase_sale_details'
+require 'xeroizer/models/item_purchase_details'
+require 'xeroizer/models/item_sales_details'
 require 'xeroizer/models/journal'
 require 'xeroizer/models/journal_line'
 require 'xeroizer/models/line_item'

data/lib/xeroizer/configuration.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  OAuthCredentials = Struct.new "OAuthCredentials", :consumer_key, :consumer_secret, :key_file
+
+  class OAuthConfig
+    class << self
+      def load yaml_text
+        require "yaml"
+        yaml = YAML.load yaml_text
+        consumer_credential = yaml["consumer"]
+
+        OAuthCredentials.new(
+          consumer_credential["key"],
+          consumer_credential["secret"],
+          consumer_credential["key_file"]
+        )
+      end
+    end
+  end
+end

data/lib/xeroizer/generic_application.rb

@@ -25,7 +25,8 @@ module Xeroizer
     record :Payment
     record :TaxRate
     record :TrackingCategory
-    
+    record :BankTransaction
+
     report :AgedPayablesByContact
     report :AgedReceivablesByContact
     report :BalanceSheet

data/lib/xeroizer/logging.rb

@@ -0,0 +1,8 @@
+module Xeroizer
+  module Logging
+    class DevNullLog; def self.info(what); end; end
+    class StdOutLog; def self.info(what); puts what; end; end
+
+    Log = DevNullLog
+  end
+end

data/lib/xeroizer/models/account.rb

@@ -49,6 +49,7 @@ module Xeroizer
       string  :code
       string  :name
       string  :type
+      string  :class, :internal_name => :account_class
       string  :status
       string  :currency_code
       string  :tax_type
@@ -59,4 +60,4 @@ module Xeroizer
     end
     
   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
+      string :account_id
+      string :code
+    end
+  end
+end

data/lib/xeroizer/models/bank_transaction.rb

@@ -0,0 +1,74 @@
+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
+
+      date :updated_date_utc, :api_name => "UpdatedDateUTC"
+      date :fully_paid_on_date
+      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/invoice.rb

@@ -40,13 +40,6 @@ module Xeroizer
       } unless defined?(INVOICE_STATUS)
       INVOICE_STATUSES = INVOICE_STATUS.keys.sort
       
-      LINE_AMOUNT_TYPE = {
-        "Inclusive" =>        'CreditNote lines are inclusive tax',
-        "Exclusive" =>        'CreditNote lines are exclusive of tax (default)',
-        "NoTax"     =>        'CreditNotes lines have no tax'
-      } unless defined?(LINE_AMOUNT_TYPE)
-      LINE_AMOUNT_TYPES = LINE_AMOUNT_TYPE.keys.sort
-      
       set_primary_key :invoice_id
       set_possible_primary_keys :invoice_id, :invoice_number
       list_contains_summary_only true
@@ -77,15 +70,27 @@ module Xeroizer
       has_many    :payments
       has_many    :credit_notes
       
-      validates_presence_of :date, :due_date, :unless => proc { |invoice| invoice.new_record? }
+      validates_presence_of :date, :due_date, :unless => :new_record?
       validates_inclusion_of :type, :in => INVOICE_TYPES
-      validates_inclusion_of :status, :in => INVOICE_STATUSES, :unless => proc { |invoice| invoice.new_record? }
-      validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES, :unless => proc { |invoice| invoice.new_record? }
+      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 => proc { |invoice| invoice.approved? }
-      validates_associated :line_items, :if => proc { |invoice| invoice.approved? }
+      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?

data/lib/xeroizer/models/item.rb

@@ -16,12 +16,12 @@ module Xeroizer
       string  :code
       string  :description
       
-      belongs_to :purchase_details, :model_name => 'ItemPurchaseSaleDetails'
-      belongs_to :sales_details, :model_name => 'ItemPurchaseSaleDetails'
+      belongs_to :purchase_details, :model_name => 'ItemPurchaseDetails'
+      belongs_to :sales_details, :model_name => 'ItemSalesDetails'
       
       validates_presence_of :code
       
     end
     
   end
-end
+end

data/lib/xeroizer/models/item_purchase_details.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class ItemPurchaseDetailsModel < BaseModel
+        
+      set_xml_node_name 'PurchaseDetails'
+        
+    end
+    
+    class ItemPurchaseDetails < Base
+      
+      decimal :unit_price
+      string  :account_code
+      string  :tax_type
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/{item_purchase_sale_details.rb → item_sales_details.rb}

@@ -1,11 +1,13 @@
 module Xeroizer
   module Record
     
-    class ItemPurchaseSaleDetailsModel < BaseModel
+    class ItemSalesDetailsModel < BaseModel
+        
+      set_xml_node_name 'SalesDetails'
         
     end
     
-    class ItemPurchaseSaleDetails < Base
+    class ItemSalesDetails < Base
       
       decimal :unit_price
       string  :account_code
@@ -14,4 +16,4 @@ module Xeroizer
     end
     
   end
-end
+end

data/lib/xeroizer/models/line_amount_type.rb

@@ -0,0 +1,11 @@
+module Xeroizer
+  module Record
+    line_amount_type = {
+      "Inclusive" => 'Line item amounts are inclusive of tax',
+      "Exclusive" => 'Line item amounts are exclusive of tax (default)',
+      "NoTax"     => 'Line item amounts have no tax'
+    }
+
+    LINE_AMOUNT_TYPES = line_amount_type.keys.sort
+  end
+end

data/lib/xeroizer/models/line_item.rb

@@ -1,21 +1,13 @@
 require 'xeroizer/models/account'
+require 'xeroizer/models/line_amount_type'
 
 module Xeroizer
   module Record
-    
     class LineItemModel < BaseModel
         
     end
     
     class LineItem < Base
-      
-      LINE_AMOUNT_TYPE = {
-        "Inclusive" =>        'CreditNote lines are inclusive tax',
-        "Exclusive" =>        'CreditNote lines are exclusive of tax (default)',
-        "NoTax"     =>        'CreditNotes lines have no tax'
-      } unless defined?(LINE_AMOUNT_TYPE)
-      LINE_AMOUNT_TYPES = LINE_AMOUNT_TYPE.keys.sort
-      
       TAX_TYPE = Account::TAX_TYPE unless defined?(TAX_TYPE)
       
       string  :item_code
@@ -35,9 +27,7 @@ module Xeroizer
       # 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
-        unless quantity.nil? && unit_amount.nil?
-          quantity * unit_amount
-        end
+        BigDecimal((quantity * unit_amount).to_s).round(2) if quantity && unit_amount
       end
       
     end

data/lib/xeroizer/models/line_item_sum.rb

@@ -0,0 +1,21 @@
+module Xeroizer
+  module Record
+    class LineItemSum
+      def self.total(line_items)
+        sub_total(line_items) + total_tax(line_items)
+      end
+
+      def self.sub_total(line_items)
+        line_items.inject(BigDecimal("0")) do |sum, item|
+          sum += BigDecimal(item.line_amount.to_s).round(2)
+        end
+      end
+
+      def self.total_tax(line_items)
+        line_items.inject(BigDecimal("0")) do |sum, item|
+          sum += BigDecimal(item.tax_amount.to_s).round(2)
+        end
+      end
+    end
+  end
+end

data/lib/xeroizer/models/payment.rb

@@ -3,6 +3,7 @@ module Xeroizer
     
     class PaymentModel < BaseModel
         
+      set_xml_root_name 'Payments'
       set_permissions :read, :write
       
     end
@@ -16,12 +17,7 @@ module Xeroizer
       decimal   :amount
       decimal   :currency_rate
       string    :reference
-      
-      guid      :invoice_id
-      string    :invoice_number
-      guid      :account_id
-      string    :code
-      
+            
       belongs_to  :account
       belongs_to  :invoice
       

data/lib/xeroizer/oauth.rb

@@ -97,7 +97,7 @@ module Xeroizer
     # Renew an access token from a previously authorised token for a
     # PARTNER application.
     def renew_access_token(atoken = nil, asecret = nil, session_handle = nil)
-      old_token = ::OAuth::RequestToken.new(consumer, atoken || @atoken, asecret || @secret)
+      old_token = ::OAuth::RequestToken.new(consumer, atoken || @atoken, asecret || @asecret)
       access_token = old_token.get_access_token({
         :oauth_session_handle => (session_handle || @session_handle), 
         :token => old_token

data/lib/xeroizer/record/base.rb

@@ -2,6 +2,7 @@ require 'xeroizer/record/model_definition_helper'
 require 'xeroizer/record/record_association_helper'
 require 'xeroizer/record/validation_helper'
 require 'xeroizer/record/xml_helper'
+require 'xeroizer/logging'
 
 module Xeroizer
   module Record
@@ -96,7 +97,13 @@ module Xeroizer
       
         # Attempt to create a new record.
         def create
-          parse_save_response(parent.http_put(to_xml))
+          request = to_xml
+          log "[CREATE SENT] (#{__FILE__}:#{__LINE__}) #{request}"
+          
+          response = parent.http_put(request)
+          log "[CREATE RECEIVED] (#{__FILE__}:#{__LINE__}) #{response}"
+          
+          parse_save_response(response)
         end
         
         # Attempt to update an existing record.
@@ -105,7 +112,15 @@ module Xeroizer
             raise RecordKeyMustBeDefined.new(self.class.possible_primary_keys)
           end
           
-          parse_save_response(parent.http_post(to_xml))
+          request = to_xml
+          
+          log "[UPDATE SENT] (#{__FILE__}:#{__LINE__}) \r\n#{request}"
+          
+          response = parent.http_post(request)
+
+          log "[UPDATE RECEIVED] (#{__FILE__}:#{__LINE__}) \r\n#{response}"
+
+          parse_save_response(response)
         end
         
         # Parse the response from a create/update request.
@@ -117,6 +132,10 @@ module Xeroizer
           end
           self
         end
+
+        def log(what)
+          Xeroizer::Logging::Log.info what
+        end
                      
     end