freshtrack 0.4.1.1 → 0.4.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.4.2 2009-08-02
+
+* 1 tiny enhancement:
+  * Added invoice amount and owed amount to aging report
+
 == 0.4.1.1 2009-07-31
 
 * Maybe adding the invoice files to the Manifest is a good idea.

data/Manifest.txt

@@ -32,6 +32,7 @@ spec/time_collectors/one_inch_punch_spec.rb
 spec/time_collectors/punch_spec.rb
 spec/freshbooks/base_object_spec.rb
 spec/freshbooks/invoice_spec.rb
+spec/freshbooks/payment_spec.rb
 spec/freshbooks/project_spec.rb
 spec/freshbooks/task_spec.rb
 spec/freshbooks/time_entry_spec.rb

data/bin/freshtrack

@@ -45,10 +45,10 @@ end
 if aging
   Freshtrack.init
   aging = Freshtrack.invoice_aging
-  printf "%-10s\t%-50s\t%s\t%s\n", 'Invoice', 'Client', 'Age', 'Status'
+  printf "%-8s  %-40s  %-5s  %-6s  %8s  %8s\n", 'Invoice', 'Client', 'Age', 'Status', 'Amount', 'Owed'
   printf "%s\n", '-' * 86
   aging.each do |inv|
-    printf "%-10s\t%-50s\t%s\t%s\n", *inv.values_at(:number, :client, :age, :status)
+    printf "%-8s  %-40s  %-5s  %-6s  %8.2f  %8.2f\n", *inv.values_at(:number, :client, :age, :status, :amount, :owed)
   end
   exit
 end

data/lib/freshbooks/extensions/invoice.rb

@@ -10,6 +10,18 @@ module FreshBooks
       Client.get(client_id)
     end
     
+    def payments
+      Payment.list('invoice_id' => invoice_id) || []
+    end
+    
+    def paid_amount
+      payments.inject(0) { |sum, pay|  sum + pay.amount }
+    end
+    
+    def owed_amount
+      amount - paid_amount
+    end
+    
     attr_accessor :number
     
     alias_method :old_brackets, :[]

data/lib/freshtrack/version.rb

@@ -2,9 +2,8 @@ module Freshtrack #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 4
-    TINY  = 1
-    FUCKUP = 1
+    TINY  = 2
 
-    STRING = [MAJOR, MINOR, TINY, FUCKUP].join('.')
+    STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/lib/freshtrack.rb

@@ -87,7 +87,9 @@ module Freshtrack
           :number => i.number,
           :client => i.client.organization,
           :age    => Date.today - i.date,
-          :status => i.status
+          :status => i.status,
+          :amount => i.amount,
+          :owed   => i.owed_amount
         }
       end
     end

data/spec/freshbooks/invoice_spec.rb

@@ -21,6 +21,10 @@ describe FreshBooks::Invoice do
     it 'should have a status' do
       @invoice.should respond_to(:status)
     end
+    
+    it 'should have an amount' do
+      @invoice.should respond_to(:amount)
+    end
   end
   
   describe 'type mappings' do
@@ -35,6 +39,10 @@ describe FreshBooks::Invoice do
     it 'should map date to Date' do
       @mapping['date'].should == Date
     end
+    
+    it 'should map amount to Float' do
+      @mapping['amount'].should == Float
+    end
   end
   
   it 'should indicate open status' do
@@ -80,7 +88,7 @@ describe FreshBooks::Invoice do
       @invoice.client
     end
     
-    it 'should return found project' do
+    it 'should return found client' do
       client = stub('client')
       client_id = stub('client ID')
       @invoice.stubs(:client_id).returns(client_id)
@@ -133,4 +141,64 @@ describe FreshBooks::Invoice do
     @invoice.client_id = 3
     @invoice['client_id'].should == 3
   end
+  
+  it 'should have payments' do
+    @invoice.should respond_to(:payments)
+  end
+  
+  describe 'payments' do
+    before :each do
+      @payments = Array.new(3) { stub('payment') }
+      FreshBooks::Payment.stubs(:list).returns(@payments)
+    end
+    
+    it 'should get a list from Payment' do
+      FreshBooks::Payment.expects(:list)
+      @invoice.payments
+    end
+    
+    it 'should pass the invoice_id when getting the list' do
+      @invoice.invoice_id = '0000073'
+      FreshBooks::Payment.expects(:list).with('invoice_id' => @invoice.invoice_id)
+      @invoice.payments
+    end
+    
+    it 'should return the list from Payment' do
+      @invoice.payments.should == @payments
+    end
+    
+    it 'should return an empty array if Payment returns nil' do
+      FreshBooks::Payment.stubs(:list).returns(nil)
+      @invoice.payments.should == []
+    end
+  end
+  
+  it 'should have a paid amount' do
+    @invoice.should respond_to(:paid_amount)
+  end
+  
+  describe 'paid amount' do
+    it 'should be the sum of payment amounts' do
+      payments = [stub('payment', :amount => 3), stub('payment', :amount => 15), stub('payment', :amount => 5)]
+      @invoice.stubs(:payments).returns(payments)
+      @invoice.paid_amount.should == 23
+    end
+    
+    it 'should be 0 if there are no payments' do
+      @invoice.stubs(:payments).returns([])
+      @invoice.paid_amount.should == 0
+    end
+  end
+  
+  it 'should have an owed amount' do
+    @invoice.should respond_to(:owed_amount)
+  end
+  
+  describe 'owed amount' do
+    it 'should be invoice amount less paid amount' do
+      @invoice.amount = 60
+      @invoice.stubs(:paid_amount).returns(50)
+      @invoice.owed_amount.should == 10
+    end
+  end
 end

data/spec/freshbooks/payment_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+describe FreshBooks::Payment do
+  before :each do
+    @payment = FreshBooks::Payment.new
+  end
+  
+  describe 'attributes' do
+    it 'should have an invoice_id' do
+      @payment.should respond_to(:invoice_id)
+    end
+    
+    it 'should have an amount' do
+      @payment.should respond_to(:amount)
+    end
+  end
+  
+  describe 'type mappings' do
+    before :each do
+      @mapping = FreshBooks::Payment::TYPE_MAPPINGS
+    end
+    
+    it 'should map amount to Float' do
+      @mapping['amount'].should == Float
+    end
+  end
+end

data/spec/freshtrack_command_spec.rb

@@ -75,9 +75,9 @@ describe 'freshtrack command' do
   describe 'when --aging specified' do
     before :each do
       @aging_info = [
-        { :id => 5,  :number => '123', :age => 31, :client => 'blah', :status => 'viewed' },
-        { :id => 53, :number => '234', :age => 43, :client => 'bang', :status => 'sent' },
-        { :id => 20, :number => '938', :age => 3,  :client => 'boom', :status => 'viewed' }
+        { :id => 5,  :number => '123', :age => 31, :client => 'blah', :status => 'viewed', :amount => 123.3, :owed => 5.67 },
+        { :id => 53, :number => '234', :age => 43, :client => 'bang', :status => 'sent',   :amount => 60.0,  :owed => 60.0 },
+        { :id => 20, :number => '938', :age => 3,  :client => 'boom', :status => 'viewed', :amount => 100.0, :owed => 100.0 }
       ]
       Freshtrack.stubs(:invoice_aging).returns(@aging_info)
       self.stubs(:printf)
@@ -134,6 +134,22 @@ describe 'freshtrack command' do
       aging_run
     end
     
+    it 'should print the amount of each invoice' do
+      pending 'making this actually test what it purports to'
+      @aging_info.each do |info|
+        self.expects(:printf) { |*args|  args.include?(info[:amount]) }
+      end
+      aging_run
+    end
+    
+    it 'should print the owed of each invoice' do
+      pending 'making this actually test what it purports to'
+      @aging_info.each do |info|
+        self.expects(:printf) { |*args|  args.include?(info[:owed]) }
+      end
+      aging_run
+    end
+    
     it 'should not track time' do
       Freshtrack.expects(:track).never
       aging_run

data/spec/freshtrack_spec.rb

@@ -443,9 +443,9 @@ describe Freshtrack do
       today = Date.today
       
       @invoices = [
-        stub('invoice', :invoice_id => '1234',  :number => '4567',  :client => stub('client', :organization => 'client 20'), :date => today - 3,  :status => 'partial'),
-        stub('invoice', :invoice_id => '19873', :number => '1456',  :client => stub('client', :organization => 'client 3'),  :date => today - 20, :status => 'viewed'),
-        stub('invoice', :invoice_id => '0038',  :number => '30267', :client => stub('client', :organization => 'client 4'),  :date => today - 59, :status => 'sent')
+        stub('invoice', :invoice_id => '1234',  :number => '4567',  :client => stub('client', :organization => 'client 20'), :date => today - 3,  :status => 'partial', :amount => 50, :owed_amount => 3),
+        stub('invoice', :invoice_id => '19873', :number => '1456',  :client => stub('client', :organization => 'client 3'),  :date => today - 20, :status => 'viewed',  :amount => 60, :owed_amount => 60),
+        stub('invoice', :invoice_id => '0038',  :number => '30267', :client => stub('client', :organization => 'client 4'),  :date => today - 59, :status => 'sent',    :amount => 20, :owed_amount => 20)
       ]
       Freshtrack.stubs(:open_invoices).returns(@invoices)
     end
@@ -479,6 +479,16 @@ describe Freshtrack do
       Freshtrack.invoice_aging.collect { |i| i[:status] }.should == statuses
     end
     
+    it 'should extract the amount for each open invoice' do
+      amounts = @invoices.collect { |i|  i.amount }
+      Freshtrack.invoice_aging.collect { |i| i[:amount] }.should == amounts
+    end
+    
+    it 'should extract the owed amount for each open invoice' do
+      oweds = @invoices.collect { |i|  i.owed_amount }
+      Freshtrack.invoice_aging.collect { |i| i[:owed] }.should == oweds
+    end
+    
     it 'should return an empty array if there are no open invoices' do
       Freshtrack.stubs(:open_invoices).returns([])
       Freshtrack.invoice_aging.should == []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  version: 0.4.1.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-31 00:00:00 -05:00
+date: 2009-08-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,6 +98,7 @@ files:
 - spec/time_collectors/punch_spec.rb
 - spec/freshbooks/base_object_spec.rb
 - spec/freshbooks/invoice_spec.rb
+- spec/freshbooks/payment_spec.rb
 - spec/freshbooks/project_spec.rb
 - spec/freshbooks/task_spec.rb
 - spec/freshbooks/time_entry_spec.rb