xeroizer 0.1.3 → 0.2.0

data/test/test_helper.rb

@@ -39,11 +39,19 @@ module TestHelper
     end
   end
   
+  def get_report_xml(report_type)
+    get_file_as_string("reports/#{report_type.underscore}.xml")
+  end
+  
   def mock_api(model_name)
     @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}$/ }.returns(get_record_xml("#{model_name.underscore.pluralize}".to_sym))
     @client.send("#{model_name.singularize}".to_sym).all.each do | record |
       @client.stubs(:http_get).with {|client, url, params| url =~ /#{model_name}\/#{record.id}$/ }.returns(get_record_xml("#{model_name.underscore.singularize}".to_sym, record.id))
     end
   end
+  
+  def mock_report_api(report_type)
+    @client.stubs(:http_get).with { | client, url, params | url =~ /Report\/#{report_type}$/ }.returns(get_report_xml(report_type))
+  end
     
 end

data/test/unit/record_definition_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class RecordDefinitionTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+  end
+  
+  context "record definitions" do
+    
+    should "be defined correctly" do
+      [ 
+        :Account, :BrandingTheme, :Contact, :CreditNote, :Currency, :Invoice,
+        :Item, :Journal, :ManualJournal, :Organisation, :Payment, :TaxRate,
+        :TrackingCategory
+      ].each do | record_type |
+        record_factory = @client.send(record_type)
+        assert_kind_of(Xeroizer::Record::BaseModel, record_factory)
+        assert_kind_of(Xeroizer::GenericApplication, record_factory.application)
+        assert_equal(record_type.to_s, record_factory.model_name)
+      end
+    end
+    
+  end
+
+end

data/test/unit/report_definition_test.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class ReportDefinitionTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+  end
+  
+  context "report definitions" do
+    
+    should "be defined correctly" do
+      [ 
+        :AgedPayablesByContact, :AgedReceivablesByContact, :BalanceSheet, :BankStatement, :BankSummary,
+        :BudgetSummary, :ExecutiveSummary, :ProfitAndLoss, :TrialBalance
+      ].each do | report_type |
+        report_factory = @client.send(report_type)
+        assert_kind_of(Xeroizer::Report::Factory, report_factory)
+        assert_kind_of(Xeroizer::GenericApplication, report_factory.application)
+        assert_equal(report_type.to_s, report_factory.report_type)
+      end
+    end
+    
+  end
+
+end

data/test/unit/report_test.rb

@@ -0,0 +1,145 @@
+require File.join(File.dirname(__FILE__), '../test_helper.rb')
+
+class FactoryTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def setup
+    @client = Xeroizer::PublicApplication.new(CONSUMER_KEY, CONSUMER_SECRET)
+    mock_report_api("TrialBalance")
+    @report = @client.TrialBalance.get
+  end
+  
+  context "report factory" do
+    
+    should "have correct API-part of URL based on its type" do
+      [ 
+        :AgedPayablesByContact, :AgedReceivablesByContact, :BalanceSheet, :BankStatement, :BankSummary,
+        :BudgetSummary, :ExecutiveSummary, :ProfitAndLoss, :TrialBalance
+      ].each do | report_type |
+        report_factory = @client.send(report_type)
+        assert_equal("Report/#{report_type}", report_factory.api_controller_name)
+      end
+    end
+    
+    should "build report model from XML" do
+      assert_kind_of(Xeroizer::Report::Base, @report)
+    end
+    
+    should "have all attributes in report summary" do
+      assert_equal("TrialBalance", @report.id)
+      assert_equal("TrialBalance", @report.type)
+      assert_equal("Trial Balance", @report.name)
+      assert_equal(['Trial Balance', 'Demo Company (AU)', 'As at 23 March 2011'], @report.titles)
+      assert_equal(Date.parse('2011-03-23'), @report.date)
+      assert_equal(Time.parse('2011-03-23T00:29:12.6021453Z'), @report.updated_at)
+    end
+    
+    should "have valid rows" do
+      assert_not_equal(0, @report.rows.size)
+      @report.rows.each do | row |
+        assert_kind_of(Xeroizer::Report::Row, row)
+        assert(%w(Header Row SummaryRow Section).include?(row.type), "'#{row.type}' is not a valid row type.")
+      end
+    end
+    
+    should "have cells and no rows if not Section" do
+      @report.rows.each do | row |
+        if row.type != 'Section'
+          assert_not_equal(0, row.cells.size)
+          assert_equal(0, row.rows.size)
+        end
+      end
+    end
+    
+    should "have rows and no cells if Section" do
+      @report.rows.each do | row |
+        if row.type == 'Section'
+          assert_equal(0, row.cells.size)
+          assert_not_equal(0, row.rows.size)
+        end
+      end
+    end
+    
+    should "convert cells to BigDecimal where possible" do
+      num_regex = /^[-]?\d+(\.\d+)?$/
+      counter = 0
+      @report.rows.each do | row |
+        if row.row? || row.summary?
+          row.cells.each do | cell |
+            counter += 1 if cell.value.is_a?(BigDecimal) && cell.value > 0
+          end
+        elsif row.section?
+          row.rows.each do | row |
+            if row.row? || row.summary?
+              row.cells.each do | cell | 
+                counter += 1 if cell.value.is_a?(BigDecimal) && cell.value > 0
+              end
+            end
+          end
+        end
+      end
+      assert_not_equal(0, counter, "at least one converted number in the report should be greater than 0")
+    end
+    
+    should "be at least one Section row with a title" do
+      counter = 0
+      @report.rows.each do | row |
+        counter += 1 if row.section? && row.title.to_s != ''
+      end
+      assert_not_equal(0, counter, "at least one row with type 'Section' should have a title")
+    end
+
+    should "have working report type helpers" do
+      @report.rows.each do | row |
+        if row.type == 'Section'
+          check_valid_report_type(row)
+          row.rows.each do | row |
+            check_valid_report_type(row)
+          end
+        else
+          check_valid_report_type(row)
+        end
+      end
+    end
+    
+    should "have valid header row" do
+      assert_kind_of(Xeroizer::Report::HeaderRow, @report.header)
+      assert_equal(['Account', 'Debit', 'Credit', 'YTD Debit', 'YTD Credit'], @report.header.cells.map { | c | c.value })
+    end
+    
+    should "have sections" do
+      assert_not_equal(0, @report.sections)
+      @report.sections.each do | section |
+        assert_kind_of(Xeroizer::Report::SectionRow, section)
+      end
+    end
+    
+    should "have summary" do
+      assert_kind_of(Xeroizer::Report::SummaryRow, @report.summary)
+      assert_equal(['Total', '33244.04', '33244.04', '80938.93', '80938.93'], @report.summary.cells.map { | c | c.value.to_s })
+    end
+    
+    should "have summary on final section for trial balance (which has a blank title)" do
+      section = @report.sections.last
+      summary = section.rows.last
+      assert_kind_of(Xeroizer::Report::SummaryRow, summary)
+      assert_nil(section.title)
+      assert_equal(['Total', '33244.04', '33244.04', '80938.93', '80938.93'], summary.cells.map { | c | c.value.to_s })
+    end
+    
+  end
+  
+  private
+  
+    def check_valid_report_type(row)
+      case row.type
+        when 'Header'       then assert_equal(true, row.header?)
+        when 'Row'          then assert_equal(true, row.row?)
+        when 'SummaryRow'   then assert_equal(true, row.summary?)
+        when 'Section'      then assert_equal(true, row.section?)
+        else
+            assert(false, "Invalid type: #{row.type}")
+      end
+    end
+    
+end

data/xeroizer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xeroizer}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Robinson"]
-  s.date = %q{2011-03-02}
+  s.date = %q{2011-03-23}
   s.description = %q{Ruby library for the Xero accounting system API.}
   s.email = %q{wayne.robinson@gmail.com}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/class_level_inheritable_attributes.rb",
     "lib/nokogiri_utils.rb",
     "lib/xeroizer.rb",
+    "lib/xeroizer/application_http_proxy.rb",
     "lib/xeroizer/ca-certificates.crt",
     "lib/xeroizer/exceptions.rb",
     "lib/xeroizer/generic_application.rb",
@@ -71,6 +72,16 @@ Gem::Specification.new do |s|
     "lib/xeroizer/record/validators/presence_of_validator.rb",
     "lib/xeroizer/record/validators/validator.rb",
     "lib/xeroizer/record/xml_helper.rb",
+    "lib/xeroizer/report/base.rb",
+    "lib/xeroizer/report/cell.rb",
+    "lib/xeroizer/report/cell_xml_helper.rb",
+    "lib/xeroizer/report/factory.rb",
+    "lib/xeroizer/report/row/header.rb",
+    "lib/xeroizer/report/row/row.rb",
+    "lib/xeroizer/report/row/section.rb",
+    "lib/xeroizer/report/row/summary.rb",
+    "lib/xeroizer/report/row/xml_helper.rb",
+    "lib/xeroizer/report/xml_helper.rb",
     "lib/xeroizer/response.rb",
     "test/stub_responses/accounts.xml",
     "test/stub_responses/api_exception.xml",
@@ -291,6 +302,7 @@ Gem::Specification.new do |s|
     "test/stub_responses/records/manual_journal-bb6cfcfc-4500-4475-bd3a-93ee512428e0.xml",
     "test/stub_responses/records/manual_journal-f00a355b-7374-445c-886b-0437bea4095c.xml",
     "test/stub_responses/refresh_responses.rb",
+    "test/stub_responses/reports/trial_balance.xml",
     "test/stub_responses/tax_rates.xml",
     "test/stub_responses/token_expired",
     "test/stub_responses/tracking_categories.xml",
@@ -307,6 +319,9 @@ Gem::Specification.new do |s|
     "test/unit/record/parse_where_hash_test.rb",
     "test/unit/record/record_association_test.rb",
     "test/unit/record/validators_test.rb",
+    "test/unit/record_definition_test.rb",
+    "test/unit/report_definition_test.rb",
+    "test/unit/report_test.rb",
     "xeroizer.gemspec"
   ]
   s.homepage = %q{http://github.com/waynerobinson/xeroizer}
@@ -327,7 +342,10 @@ Gem::Specification.new do |s|
     "test/unit/record/model_definition_test.rb",
     "test/unit/record/parse_where_hash_test.rb",
     "test/unit/record/record_association_test.rb",
-    "test/unit/record/validators_test.rb"
+    "test/unit/record/validators_test.rb",
+    "test/unit/record_definition_test.rb",
+    "test/unit/report_definition_test.rb",
+    "test/unit/report_test.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xeroizer
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Wayne Robinson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-02 00:00:00 +10:00
+date: 2011-03-23 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -204,6 +204,7 @@ files:
 - lib/class_level_inheritable_attributes.rb
 - lib/nokogiri_utils.rb
 - lib/xeroizer.rb
+- lib/xeroizer/application_http_proxy.rb
 - lib/xeroizer/ca-certificates.crt
 - lib/xeroizer/exceptions.rb
 - lib/xeroizer/generic_application.rb
@@ -246,6 +247,16 @@ files:
 - lib/xeroizer/record/validators/presence_of_validator.rb
 - lib/xeroizer/record/validators/validator.rb
 - lib/xeroizer/record/xml_helper.rb
+- lib/xeroizer/report/base.rb
+- lib/xeroizer/report/cell.rb
+- lib/xeroizer/report/cell_xml_helper.rb
+- lib/xeroizer/report/factory.rb
+- lib/xeroizer/report/row/header.rb
+- lib/xeroizer/report/row/row.rb
+- lib/xeroizer/report/row/section.rb
+- lib/xeroizer/report/row/summary.rb
+- lib/xeroizer/report/row/xml_helper.rb
+- lib/xeroizer/report/xml_helper.rb
 - lib/xeroizer/response.rb
 - test/stub_responses/accounts.xml
 - test/stub_responses/api_exception.xml
@@ -466,6 +477,7 @@ files:
 - test/stub_responses/records/manual_journal-bb6cfcfc-4500-4475-bd3a-93ee512428e0.xml
 - test/stub_responses/records/manual_journal-f00a355b-7374-445c-886b-0437bea4095c.xml
 - test/stub_responses/refresh_responses.rb
+- test/stub_responses/reports/trial_balance.xml
 - test/stub_responses/tax_rates.xml
 - test/stub_responses/token_expired
 - test/stub_responses/tracking_categories.xml
@@ -482,6 +494,9 @@ files:
 - test/unit/record/parse_where_hash_test.rb
 - test/unit/record/record_association_test.rb
 - test/unit/record/validators_test.rb
+- test/unit/record_definition_test.rb
+- test/unit/report_definition_test.rb
+- test/unit/report_test.rb
 - xeroizer.gemspec
 has_rdoc: true
 homepage: http://github.com/waynerobinson/xeroizer
@@ -531,3 +546,6 @@ test_files:
 - test/unit/record/parse_where_hash_test.rb
 - test/unit/record/record_association_test.rb
 - test/unit/record/validators_test.rb
+- test/unit/record_definition_test.rb
+- test/unit/report_definition_test.rb
+- test/unit/report_test.rb