xeroizer 2.17.1 → 3.0.0

data/lib/xeroizer/record/xml_helper.rb

@@ -3,14 +3,14 @@ require 'active_support/time'
 module Xeroizer
   module Record
     module XmlHelper
-      
+
       def self.included(base)
         base.extend(ClassMethods)
         base.send :include, InstanceMethods
       end
-      
+
       module ClassMethods
-        
+
         # Build a record instance from the XML node.
         def build_from_node(node, parent, base_module)
           record = new(parent)
@@ -22,14 +22,14 @@ module Xeroizer
                 when :string      then element.text
                 when :boolean     then (element.text == 'true')
                 when :integer     then element.text.to_i
-                when :decimal     then BigDecimal.new(element.text)
+                when :decimal     then BigDecimal(element.text)
                 when :date        then Date.parse(element.text)
                 when :datetime    then Time.parse(element.text)
                 when :datetime_utc then ActiveSupport::TimeZone['UTC'].parse(element.text).utc
-                when :belongs_to  
+                when :belongs_to
                   model_name = field[:model_name] ? field[:model_name].to_sym : element.name.to_sym
                   base_module.const_get(model_name).build_from_node(element, parent, base_module)
-                  
+
                 when :has_many
                   if element.element_children.size > 0
                     sub_field_name = field[:model_name] ? field[:model_name].to_sym : element.children.first.name.to_sym
@@ -51,13 +51,13 @@ module Xeroizer
           parent.mark_clean(record)
           record
         end
-        
+
       end
-      
+
       module InstanceMethods
-        
+
         public
-        
+
           # Turn a record into its XML representation.
           def to_xml(b = Builder::XmlMarkup.new(:indent => 2))
             optional_root_tag(parent.class.optional_xml_root_name, b) do |c|
@@ -70,9 +70,9 @@ module Xeroizer
               }
             end
           end
-          
+
         protected
-        
+
           # Add top-level root name if required.
           # E.g. Payments need specifying in the form:
           #   <Payments>
@@ -87,7 +87,7 @@ module Xeroizer
               yield(b)
             end
           end
-        
+
           # Format an attribute for use in the XML passed to Xero.
           def xml_value_from_field(b, field, value)
             case field[:type]
@@ -95,10 +95,10 @@ module Xeroizer
               when :string      then b.tag!(field[:api_name], value)
               when :boolean     then b.tag!(field[:api_name], value ? 'true' : 'false')
               when :integer     then b.tag!(field[:api_name], value.to_i)
-              when :decimal   
+              when :decimal
                 real_value = case value
                   when BigDecimal   then value.to_s
-                  when String       then BigDecimal.new(value).to_s
+                  when String       then BigDecimal(value).to_s
                   else              value
                 end
                 b.tag!(field[:api_name], real_value)
@@ -111,13 +111,13 @@ module Xeroizer
                   else raise ArgumentError.new("Expected Date or Time object for the #{field[:api_name]} field")
                 end
                 b.tag!(field[:api_name], real_value)
-                
+
               when :datetime    then b.tag!(field[:api_name], value.utc.strftime("%Y-%m-%dT%H:%M:%S"))
-              when :belongs_to  
+              when :belongs_to
                 value.to_xml(b)
                 nil
 
-              when :has_many    
+              when :has_many
                 if value.size > 0
                   sub_parent = value.first.parent
                   b.tag!(sub_parent.class.xml_root_name || sub_parent.model_name.pluralize) {

data/lib/xeroizer/report/aged_receivables_by_contact.rb

@@ -31,7 +31,7 @@ module Xeroizer
         end
 
         def sum(column_name, &block)
-          sections.first.rows.inject(BigDecimal.new('0')) do | sum, row |
+          sections.first.rows.inject(BigDecimal('0')) do | sum, row |
             sum += row.cell(column_name).value if row.class == Xeroizer::Report::Row && (block.nil? || block.call(row))
             sum
           end

data/lib/xeroizer/report/cell_xml_helper.rb

@@ -1,19 +1,19 @@
 module Xeroizer
   module Report
     module CellXmlHelper
-    
+
       def self.included(base)
         base.extend(ClassMethods)
         base.send :include, InstanceMethods
       end
-    
+
       module ClassMethods
-      
+
         public
-      
+
           # Create an instance of Cell from the node.
           #
-          # Additionally, parse the attributes and return them as a hash to the 
+          # Additionally, parse the attributes and return them as a hash to the
           # cell. If a cell's attributes look like:
           #
           #     <Attributes>
@@ -22,7 +22,7 @@ module Xeroizer
           #         <Id>account</Id>
           #       </Attribute>
           #     </Attributes>
-          # 
+          #
           # Return a hash like:
           #
           #     {
@@ -42,17 +42,17 @@ module Xeroizer
             end
             cell
           end
-          
+
         protected
 
           def parse_value(value)
             case value
-              when /^[-]?\d+(\.\d+)?$/                      then BigDecimal.new(value)
-              when /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/  then Time.xmlschema(value)
-              else                                          value
+              when /\A[-]?\d+(\.\d+)?\z/                      then BigDecimal(value)
+              when /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\z/  then Time.xmlschema(value)
+              else                                            value
             end
           end
-        
+
           def parse_attribute(attribute_node)
             id = nil
             value = nil
@@ -65,10 +65,10 @@ module Xeroizer
             [id, value]
           end
       end
-    
+
       module InstanceMethods
       end
-    
+
     end
   end
 end

data/lib/xeroizer/response.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2008 Tim Connor <tlconnor@gmail.com>
-# 
+#
 # Permission to use, copy, modify, and/or distribute this software for any
 # purpose with or without fee is hereby granted, provided that the above
 # copyright notice and this permission notice appear in all copies.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
@@ -14,23 +14,23 @@
 
 module Xeroizer
   class Response
-    
+
     attr_accessor :id, :status, :errors, :provider, :date_time, :response_items, :request_params, :request_xml, :response_xml
-    
+
     class << self
-      
+
       # Parse the response retreived during any request.
       def parse(raw_response, request = {}, options = {}, &block)
         response = Xeroizer::Response.new
         response.response_xml = raw_response
-      
+
         doc = Nokogiri::XML(raw_response) { | cfg | cfg.noblanks }
-      
+
         # check for responses we don't understand
         raise Xeroizer::UnparseableResponse.new(doc.root.name) unless doc.root.name == 'Response'
-      
+
         doc.root.elements.each do | element |
-                    
+
           # Text element
           if element.children && element.children.size == 1 && element.children.first.text?
             case element.name
@@ -39,31 +39,36 @@ module Xeroizer
               when 'ProviderName' then response.provider = element.text
               when 'DateTimeUTC'  then response.date_time = Time.parse(element.text)
             end
-          
+
+          # Special case for Paystubs and PayItems because they are not wrapped in plural element or
+          # don't have singular children
+          elsif element.children && element.children.size > 0 && (element.name == 'Paystub' || element.name == 'PayItems')
+            yield(response, [element], element.name)
+
           # Records in response
           elsif element.children && element.children.size > 0
             yield(response, element.children, element.children.first.name)
           end
         end
-      
+
         response
       end
-      
+
     end
-    
+
     public
-    
+
       def initialize
         @response_items = []
       end
-    
+
       def success?
         status == 'OK'
       end
-      
+
       def error
         errors.blank? ? nil : errors[0]
       end
-      
+
   end
 end

data/lib/xeroizer/version.rb

@@ -1,3 +1,3 @@
 module Xeroizer
-  VERSION = "2.17.1".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/xeroizer.rb

@@ -5,6 +5,7 @@ require 'active_support/inflector'
 require "active_support/core_ext/array"
 require "active_support/core_ext/big_decimal/conversions"
 require 'oauth'
+require 'oauth2'
 require 'oauth/signature/rsa/sha1'
 require 'nokogiri'
 require 'builder'
@@ -17,14 +18,17 @@ $: << File.expand_path(File.dirname(__FILE__))
 require 'class_level_inheritable_attributes'
 require 'xeroizer/exceptions'
 require 'xeroizer/oauth'
+require 'xeroizer/oauth2'
 require 'xeroizer/http_encoding_helper'
 require 'xeroizer/http'
+require 'xeroizer/connection'
 
 require 'xeroizer/record/base_model'
 require 'xeroizer/record/payroll_base_model'
 require 'xeroizer/record/base'
 require 'xeroizer/record/payroll_base'
 require 'xeroizer/configuration'
+require 'xeroizer/http_response'
 
 # Include models
 require 'xeroizer/models/account'
@@ -33,6 +37,7 @@ require 'xeroizer/models/allocation'
 require 'xeroizer/models/branding_theme'
 require 'xeroizer/models/bank_transaction'
 require 'xeroizer/models/bank_account'
+require 'xeroizer/models/batch_payment'
 require 'xeroizer/models/from_bank_account'
 require 'xeroizer/models/to_bank_account'
 require 'xeroizer/models/bank_transfer'
@@ -42,8 +47,10 @@ require 'xeroizer/models/credit_note'
 require 'xeroizer/models/currency'
 require 'xeroizer/models/employee'
 require 'xeroizer/models/expense_claim'
+require 'xeroizer/models/history_record'
 require 'xeroizer/models/invoice'
 require 'xeroizer/models/invoice_reminder'
+require 'xeroizer/models/online_invoice'
 require 'xeroizer/models/item'
 require 'xeroizer/models/item_purchase_details'
 require 'xeroizer/models/item_sales_details'
@@ -55,10 +62,12 @@ require 'xeroizer/models/manual_journal_line'
 require 'xeroizer/models/option'
 require 'xeroizer/models/organisation'
 require 'xeroizer/models/payment'
+require 'xeroizer/models/payment_service'
 require 'xeroizer/models/prepayment'
 require 'xeroizer/models/overpayment'
 require 'xeroizer/models/phone'
 require 'xeroizer/models/purchase_order'
+require 'xeroizer/models/quote'
 require 'xeroizer/models/receipt'
 require 'xeroizer/models/repeating_invoice'
 require 'xeroizer/models/schedule'
@@ -71,16 +80,37 @@ require 'xeroizer/models/journal_line_tracking_category'
 require 'xeroizer/models/contact_sales_tracking_category'
 require 'xeroizer/models/contact_purchases_tracking_category'
 
-require 'xeroizer/models/payroll/home_address'
 require 'xeroizer/models/payroll/bank_account'
+require 'xeroizer/models/payroll/benefit_line'
+require 'xeroizer/models/payroll/benefit_type'
+require 'xeroizer/models/payroll/deduction_line'
+require 'xeroizer/models/payroll/deduction_type'
+require 'xeroizer/models/payroll/earnings_line'
+require 'xeroizer/models/payroll/earnings_type'
 require 'xeroizer/models/payroll/employee'
+require 'xeroizer/models/payroll/address'
+require 'xeroizer/models/payroll/leave_line'
+require 'xeroizer/models/payroll/pay_items'
+require 'xeroizer/models/payroll/pay_run'
+require 'xeroizer/models/payroll/pay_template'
+require 'xeroizer/models/payroll/payment_method'
+require 'xeroizer/models/payroll/pay_schedule'
+require 'xeroizer/models/payroll/paystub'
+require 'xeroizer/models/payroll/reimbursement_line'
+require 'xeroizer/models/payroll/reimbursement_type'
+require 'xeroizer/models/payroll/salary_and_wage'
+require 'xeroizer/models/payroll/super_line'
+require 'xeroizer/models/payroll/tax_declaration'
+require 'xeroizer/models/payroll/time_off_line'
+require 'xeroizer/models/payroll/time_off_type'
+require 'xeroizer/models/payroll/work_location'
+require 'xeroizer/models/payroll/leave_application'
+require 'xeroizer/models/payroll/leave_period'
 
 require 'xeroizer/report/factory'
 
 require 'xeroizer/response'
 
 require 'xeroizer/generic_application'
-require 'xeroizer/public_application'
-require 'xeroizer/private_application'
-require 'xeroizer/partner_application'
+require 'xeroizer/oauth2_application'
 require 'xeroizer/payroll_application'

data/test/acceptance/about_creating_bank_transactions_test.rb

@@ -4,40 +4,67 @@ require "acceptance_test"
 class AboutCreatingBankTransactions < Test::Unit::TestCase
   include AcceptanceTest
 
-  let :client do
-    Xeroizer::PrivateApplication.new(@consumer_key, @consumer_secret, @key_file)
+  def assert_exists(bank_transaction, client)
+    assert_not_nil bank_transaction.id,
+                   "Cannot check for exitence unless the bank transaction has non-null identifier"
+    assert_not_nil client.BankTransaction.find bank_transaction.id
+  end
+
+  def any_line_items(account)
+    [{
+         :description => "Clingfilm bike shorts",
+         :quantity => 1,
+         :unit_amount => "17.00",
+         :account_code => account.code,
+         :tax_type => account.tax_type
+     }]
   end
 
-  def setup
-    super
-    all_accounts = client.Account.all
+  def get_inclusive_tax(amount, tax_rate)
+    inclusive_tax = amount * (1 - (100/(100 + tax_rate)))
+    BigDecimal(inclusive_tax.to_s).round(2)
+  end
+
+  def get_exclusive_tax(amount, tax_rate)
+    exclusive_tax = amount * (tax_rate/100)
+    BigDecimal(exclusive_tax.to_s).round(2)
+  end
+
+  def get_tax_rate(tax_type, client)
+    @all_tax_types ||= client.TaxRate.all
+    @all_tax_types.select{|tax_rate| tax_rate.tax_type == tax_type}.first
+  end
+
+  setup do
+    @client = AcceptanceTestHelpers.oauth2_client
+    all_accounts = @client.Account.all
     @account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "REVENUE"}.first
-    @bank_account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "BANK"}.first    
+    @bank_account = all_accounts.select{|acct| acct.status == "ACTIVE" && acct.type == "BANK"}.first
   end
 
   can "create a new SPEND bank transaction" do
-    new_transaction = client.BankTransaction.build(
-      :type => "SPEND",
-      :contact => { :name => "Jazz Kang" },
-      :line_items => any_line_items(@account),
-      :bank_account => { :account_id => @bank_account.account_id }
+    new_transaction = @client.BankTransaction.build(
+        :type => "SPEND",
+        :contact => { :name => "Jazz Kang" },
+        :line_items => any_line_items(@account),
+        :bank_account => { :account_id => @bank_account.account_id }
     )
 
     assert new_transaction.save, "Save failed with the following errors: #{new_transaction.errors.inspect}"
-    assert_exists new_transaction
+    assert_exists(new_transaction, @client)
   end
 
   can "update a SPEND bank transaction, for example by setting its status" do
-    new_transaction = client.BankTransaction.build(
-      :type => "SPEND",
-      :contact => { :name => "Jazz Kang" },
-      :line_items => any_line_items(@account),
-      :bank_account => { :account_id => @bank_account.account_id }
+    new_transaction = @client.BankTransaction.build(
+        :type => "SPEND",
+        :contact => { :name => "Jazz Kang" },
+        :line_items => any_line_items(@account),
+        :bank_account => { :account_id => @bank_account.account_id }
     )
 
     assert new_transaction.save, "Save failed with the following errors: #{new_transaction.errors.inspect}"
 
-    assert_exists new_transaction
+    assert_exists new_transaction, @client
 
     the_new_type = "RECEIVE"
 
@@ -49,114 +76,95 @@ class AboutCreatingBankTransactions < Test::Unit::TestCase
 
     assert_equal expected_id, new_transaction.id, "Expected the id to be the same because it has been updated"
 
-    refreshed_bank_transaction = client.BankTransaction.find expected_id
+    refreshed_bank_transaction = @client.BankTransaction.find expected_id
 
     assert_equal the_new_type, refreshed_bank_transaction.type,
-      "Expected the bank transaction to've had its type updated"
+                 "Expected the bank transaction to've had its type updated"
   end
 
   can "update a bank transaction by adding line items provided you calculate the tax_amount correctly" do
-    new_transaction = client.BankTransaction.build(
-      :type => "SPEND",
-      :contact => { :name => "Jazz Kang" },
-      :line_items => any_line_items(@account),
-      :bank_account => { :account_id => @bank_account.account_id },
-      :line_amount_types => "Exclusive"
+    new_transaction = @client.BankTransaction.build(
+        :type => "SPEND",
+        :contact => { :name => "Jazz Kang" },
+        :line_items => any_line_items(@account),
+        :bank_account => { :account_id => @bank_account.account_id },
+        :line_amount_types => "Exclusive"
     )
 
     assert new_transaction.save, "Save failed with the following errors: #{new_transaction.errors.inspect}"
-    assert_exists new_transaction
+    assert_exists new_transaction, @client
 
     expected_id = new_transaction.id
 
-    tax_rate = get_tax_rate(@account.tax_type).effective_rate
+    tax_rate = get_tax_rate(@account.tax_type, @client).effective_rate
 
     unit_price = BigDecimal("1337.00")
 
     the_new_line_items = [
-      {
-        :description => "Burrito skin",
-        :quantity => 1,
-        :unit_amount => unit_price,
-        :account_code => @account.code,
-        :tax_type => @account.tax_type,
-        :tax_amount => get_exclusive_tax(unit_price, tax_rate)
-      }
+        {
+            :description => "Burrito skin",
+            :quantity => 1,
+            :unit_amount => unit_price,
+            :account_code => @account.code,
+            :tax_type => @account.tax_type,
+            :tax_amount => get_exclusive_tax(unit_price, tax_rate)
+        }
     ]
 
     new_transaction.line_items = the_new_line_items
 
     assert new_transaction.save, "Update failed with the following errors: #{new_transaction.errors.inspect}"
 
-    refreshed_bank_transaction = client.BankTransaction.find expected_id
+    refreshed_bank_transaction = @client.BankTransaction.find expected_id
 
     assert_equal expected_id, new_transaction.id,
-      "Expected the id to be the same because it has been updated"
+                 "Expected the id to be the same because it has been updated"
 
     assert_equal 1, refreshed_bank_transaction.line_items.size,
-      "Expected the bank transaction to've had its line items updated to just one"
+                 "Expected the bank transaction to've had its line items updated to just one"
 
     the_first_line_item = refreshed_bank_transaction.line_items.first
 
     assert_equal "Burrito skin", the_first_line_item.description,
-      "Expected the bank transaction to've had its line items updated, " +
-      "but the first one's description does not match: #{the_first_line_item.inspect}"
-  end
-
-  def get_inclusive_tax(amount, tax_rate)
-    inclusive_tax = amount * (1 - (100/(100 + tax_rate)))
-    BigDecimal(inclusive_tax.to_s).round(2)
-  end
-
-  def get_exclusive_tax(amount, tax_rate)
-    exclusive_tax = amount * (tax_rate/100)
-    BigDecimal(exclusive_tax.to_s).round(2)
-  end
-
-  def get_tax_rate tax_type
-    @all_tax_types ||= client.TaxRate.all
-    @all_tax_types.select{|tax_rate| tax_rate.tax_type == tax_type}.first
+                 "Expected the bank transaction to've had its line items updated, " +
+                     "but the first one's description does not match: #{the_first_line_item.inspect}"
   end
 
   can "create a new RECEIVE bank transaction" do
-    new_transaction = client.BankTransaction.build(
-      :type => "RECEIVE",
-      :contact => { :name => "Jazz Kang" },
-      :line_items => any_line_items(@account),
-      :bank_account => { :account_id => @bank_account.account_id }
+    new_transaction = @client.BankTransaction.build(
+        :type => "RECEIVE",
+        :contact => { :name => "Jazz Kang" },
+        :line_items => any_line_items(@account),
+        :bank_account => { :account_id => @bank_account.account_id }
     )
 
     assert new_transaction.save, "Save failed with the following errors: #{new_transaction.errors.inspect}"
-    assert_exists new_transaction
+    assert_exists new_transaction, @client
   end
 
   it "treats line item unit_amounts as tax EXCLUSIVE"
   must "not set the tax_amount manually on line items"
 
-  def assert_exists(bank_transaction)
-    assert_not_nil bank_transaction.id,
-      "Cannot check for exitence unless the bank transaction has non-null identifier"
-    assert_not_nil client.BankTransaction.find bank_transaction.id
-  end
 
-  def any_line_items(account)
-    [{
-      :description => "Clingfilm bike shorts",
-      :quantity => 1,
-      :unit_amount => "17.00",
-      :account_code => account.code,
-      :tax_type => account.tax_type
-    }]
-  end
 
-  it "fails with ApiException when you try and create a new bank account with missing account type" do
-    new_account = client.Account.build(
-      :name => "Example bank account",
-      :code => "ACC-001"
+  it "fails with ApiException when you try and create a new bank account with missing account type with save! method" do
+    new_account = @client.Account.build(
+        :name => "Example bank account",
+        :code => "ACC-001"
     )
 
     assert_raise Xeroizer::ApiException do
-      new_account.save
+      new_account.save!
     end
   end
+
+  it "returns false when you try and create a new bank account with a missing account type with save method" do
+    new_account = @client.Account.build(
+        :name => "Example bank account",
+        :code => "ACC-001"
+    )
+
+    assert new_account.save == false, "Account save method expected to return false"
+
+  end
 end