freshtrack 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,8 @@
+== 0.4.1 2009-07-31
+
+* 1 tiny enhancement:
+  * Added --aging option to list open invoices and ages
+
 == 0.4.0 2008-08-29
 
 * 1 minor enhancement:

data/README.txt

@@ -46,6 +46,15 @@ Freshtrack is used to automatically create time entries in FreshBooks from your
 The 'collector' is what freshtrack will use to gather the time data that will end up as FreshBooks time entries.
 Freshtrack ships with two collectors: 'punch' and 'one_inch_punch'. These are both gems that can be installed (by `gem install [collector name]`) and used without much effort. If these time-tracking tools aren't to your liking, you are free to write your own collector. Further documentation on that is forthcoming, but for now just take a look at the two collectors that already exist.
 
+Collector requirements:
+
+* It needs to be a class in the FreshTrack::TimeCollector namespace
+* The file needs to exist in the freshtrack/time_collectors directory
+* The class name should match the file name like Punch -> punch.rb or OneInchPunch -> one_inch_punch.rb
+* It needs an initializer that takes an options argument (which will be a hash possibly having :before and :after keys with Date values)
+* It needs a get_time_data instance method which takes a project name argument
+* The get_time_data method needs to return an array of hashes like { 'date' => date_object, 'hours' => number_of_hours_as_float, 'notes' => notes_string }
+
 == INSTALL:
 
 * gem install freshtrack

data/bin/freshtrack

@@ -13,6 +13,7 @@ require 'freshtrack'
 require 'optparse'
 require 'time'
 
+aging = false
 OPTIONS = {}
 MANDATORY_OPTIONS = %w[]
 
@@ -31,6 +32,9 @@ BANNER
           "Restrict command to only before the given time") { |time|  OPTIONS[:before] = Time.parse(time) }
   opts.on("-h", "--help",
           "Show this help message.") { puts opts; exit }
+  opts.on('--aging',
+          "Show invoice aging info.") { aging = true }
+
   opts.parse!(ARGV)
 
   if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
@@ -38,6 +42,17 @@ BANNER
   end
 end
 
+if aging
+  Freshtrack.init
+  aging = Freshtrack.invoice_aging
+  printf "%-10s\t%-50s\t%s\t%s\n", 'Invoice', 'Client', 'Age', 'Status'
+  printf "%s\n", '-' * 86
+  aging.each do |inv|
+    printf "%-10s\t%-50s\t%s\t%s\n", *inv.values_at(:number, :client, :age, :status)
+  end
+  exit
+end
+
 project = ARGV.shift
 
 unless project

data/config/hoe.rb

@@ -7,6 +7,13 @@ GEM_NAME = 'freshtrack' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = 'yomendel' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['freshbooks', '= 2.1']
+]    # An array of rubygem dependencies [name, version]
+EXTRA_DEV_DEPENDENCIES = [
+  ['rspec', '>= 1.1.4'],
+  ['mocha', '>= 0.9.1']
+]    # An array of rubygem dependencies [name, version]
 
 @config_file = "~/.rubyforge/user-config.yml"
 @config = nil
@@ -59,9 +66,8 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps = [     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-    ['freshbooks', '= 2.1']
-  ]
+  p.extra_deps = EXTRA_DEPENDENCIES
+  p.extra_dev_deps = EXTRA_DEV_DEPENDENCIES
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   

data/lib/freshbooks/extensions.rb

@@ -3,3 +3,4 @@ require 'freshbooks/extensions/base_object'
 require 'freshbooks/extensions/project'
 require 'freshbooks/extensions/task'
 require 'freshbooks/extensions/time_entry'
+require 'freshbooks/extensions/invoice'

data/lib/freshtrack/version.rb

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

data/lib/freshtrack.rb

@@ -74,5 +74,22 @@ module Freshtrack
       klass = Freshtrack::TimeCollector.const_get(class_name)
       klass.new(options)
     end
+    
+    def open_invoices
+      invoices = FreshBooks::Invoice.list || []
+      invoices.select { |i|  i.open? }
+    end
+    
+    def invoice_aging
+      open_invoices.collect do |i|
+        {
+          :id     => i.invoice_id,
+          :number => i.number,
+          :client => i.client.organization,
+          :age    => Date.today - i.date,
+          :status => i.status
+        }
+      end
+    end
   end
 end

data/spec/freshtrack_command_spec.rb

@@ -71,4 +71,77 @@ describe 'freshtrack command' do
     Freshtrack.expects(:track).with(@project, {})
     run_command(@project)
   end
+  
+  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' }
+      ]
+      Freshtrack.stubs(:invoice_aging).returns(@aging_info)
+      self.stubs(:printf)
+    end
+    
+    def aging_run
+      run_command('--aging')
+    end
+    
+    it 'should not require a project' do
+      self.expects(:puts) { |text|  text.match(/usage.+project/i) }.never
+      aging_run
+    end
+    
+    it 'should init Freshtrack' do
+      Freshtrack.expects(:init)
+      aging_run
+    end
+    
+    it 'should get the invoice aging information' do
+      Freshtrack.expects(:invoice_aging).returns(@aging_info)
+      aging_run
+    end
+    
+    it 'should print the number 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[:number]) }
+      end
+      aging_run
+    end
+    
+    it 'should print the client 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[:client]) }
+      end
+      aging_run
+    end
+    
+    it 'should print the age 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[:age]) }
+      end
+      aging_run
+    end
+    
+    it 'should print the status 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[:status]) }
+      end
+      aging_run
+    end
+    
+    it 'should not track time' do
+      Freshtrack.expects(:track).never
+      aging_run
+    end
+    
+    it 'should not track time even when given a project' do
+      Freshtrack.expects(:track).never
+      run_command('--aging', @project)
+    end
+  end
 end

data/spec/freshtrack_spec.rb

@@ -396,4 +396,92 @@ describe Freshtrack do
       end
     end
   end
+  
+  it 'should list open invoices' do
+    Freshtrack.should respond_to(:open_invoices)
+  end
+  
+  describe 'listing open invoices' do
+    before :each do
+      @invoices = Array.new(5) { stub('invoice', :open? => false) }
+      FreshBooks::Invoice.stubs(:list).returns(@invoices)
+    end
+    
+    it 'should get a list of invoices' do
+      FreshBooks::Invoice.expects(:list).returns(@invoices)
+      Freshtrack.open_invoices
+    end
+    
+    it 'should return only the open invoices' do
+      open_invoices = @invoices.values_at(0,1,2)
+      open_invoices.each { |i|  i.stubs(:open?).returns(true) }
+      
+      Freshtrack.open_invoices.should == open_invoices
+    end
+    
+    it 'should return an empty array if there are no open invoices' do
+      Freshtrack.open_invoices.should == []
+    end
+    
+    it 'should return an empty array if there are no invoices' do
+      FreshBooks::Invoice.stubs(:list).returns([])
+      Freshtrack.open_invoices.should == []
+    end
+    
+    it 'should return an empty array if the invoice list returns nil' do
+      FreshBooks::Invoice.stubs(:list).returns(nil)
+      Freshtrack.open_invoices.should == []
+    end
+  end
+  
+  it 'should show invoice aging' do
+    Freshtrack.should respond_to(:invoice_aging)
+  end
+  
+  describe 'showing invoice aging' do
+    before :each 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')
+      ]
+      Freshtrack.stubs(:open_invoices).returns(@invoices)
+    end
+    
+    it 'should get open invoices' do
+      Freshtrack.expects(:open_invoices).returns(@invoices)
+      Freshtrack.invoice_aging
+    end
+    
+    it 'should extract the ID for each open invoice' do
+      ids = @invoices.collect { |i|  i.invoice_id }
+      Freshtrack.invoice_aging.collect { |i| i[:id] }.should == ids
+    end
+    
+    it 'should extract the number for each open invoice' do
+      numbers = @invoices.collect { |i|  i.number }
+      Freshtrack.invoice_aging.collect { |i| i[:number] }.should == numbers
+    end
+    
+    it 'should extract the client for each open invoice' do
+      clients = @invoices.collect { |i|  i.client.organization }
+      Freshtrack.invoice_aging.collect { |i| i[:client] }.should == clients
+    end
+    
+    it 'should extract the age for each open invoice' do
+      Freshtrack.invoice_aging.collect { |i| i[:age] }.should == [3, 20, 59]
+    end
+    
+    it 'should extract the status for each open invoice' do
+      statuses = @invoices.collect { |i|  i.status }
+      Freshtrack.invoice_aging.collect { |i| i[:status] }.should == statuses
+    end
+    
+    it 'should return an empty array if there are no open invoices' do
+      Freshtrack.stubs(:open_invoices).returns([])
+      Freshtrack.invoice_aging.should == []
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-29 00:00:00 -05:00
+date: 2009-07-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.1"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -30,7 +50,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 2.3.2
     version: 
 description: Track your time on FreshBooks
 email: ymendel@pobox.com
@@ -89,6 +109,8 @@ files:
 - tasks/website.rake
 has_rdoc: true
 homepage: http://yomendel.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -110,9 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Track your time on FreshBooks
 test_files: []