freshtrack 0.5.0 → 0.6.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.6.0 2012-03-30
+
+* 1 minor enhancement:
+  * Getting unbilled time on a project
+
 == 0.5.0 2011-03-28
 
 * 1 minor enhancement:

data/bin/freshtrack

@@ -14,6 +14,7 @@ require 'optparse'
 require 'time'
 
 aging = false
+unbilled = nil
 OPTIONS = {}
 MANDATORY_OPTIONS = %w[]
 
@@ -34,6 +35,8 @@ BANNER
           "Show this help message.") { puts opts; exit }
   opts.on('--aging',
           "Show invoice aging info.") { aging = true }
+  opts.on('--unbilled [PROJECT]', String,
+          "Show unbilled time info.") { |project|  unbilled = project }
 
   opts.parse!(ARGV)
 
@@ -55,6 +58,14 @@ if aging
   exit
 end
 
+if unbilled
+  project = unbilled
+  Freshtrack.init(project)
+  time = Freshtrack.unbilled_time(project)
+  puts time
+  exit
+end
+
 unless project
   puts "Usage: #{File.basename($0)} [project] [options]"
   exit

data/lib/freshbooks/extensions/base_object.rb

@@ -3,6 +3,12 @@ require 'date'
 module FreshBooks
   class BaseObject
     MAPPING_FNS[Date] = lambda { |xml_val|  Date.parse(xml_val.text) }
+    MAPPING_FNS[:boolean] = lambda do |xml_val|
+      case xml_val.text
+        when '0' : false
+        when '1' : true
+      end
+    end
     
     def to_xml
       # The root element is the elem name

data/lib/freshbooks/extensions/time_entry.rb

@@ -1,10 +1,10 @@
 module FreshBooks
-  TimeEntry = BaseObject.new(:time_entry_id, :project_id, :task_id, :hours, :date, :notes)
+  TimeEntry = BaseObject.new(:time_entry_id, :project_id, :task_id, :hours, :date, :notes, :billed)
   
   class TimeEntry
     TYPE_MAPPINGS = {
       'time_entry_id' => Fixnum, 'project_id' => Fixnum, 'task_id' => Fixnum,
-      'hours' => Float, 'date' => Date
+      'hours' => Float, 'date' => Date, 'billed' => :boolean
     }
     
     class << self

data/lib/freshtrack/version.rb

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

data/lib/freshtrack.rb

@@ -102,5 +102,16 @@ module Freshtrack
         }
       end
     end
+
+    def unbilled_time(project_name)
+      time_entries = get_unbilled_time_entries(project_name)
+      time_entries.collect(&:hours).inject(&:+)
+    end
+
+    def get_unbilled_time_entries(project_name)
+      get_project_data(project_name)
+      time_entries = FreshBooks::TimeEntry.list('project_id' => @project.project_id, 'per_page' => 100)
+      time_entries.reject(&:billed)
+    end
   end
 end

data/spec/freshbooks/base_object_spec.rb

@@ -22,6 +22,26 @@ describe FreshBooks::BaseObject do
       @func.call(@date).to_s.should == @date.text
     end
   end
+
+  it 'should have a mapping function for boolean' do
+    FreshBooks::BaseObject::MAPPING_FNS[:boolean].should.respond_to(:call)
+  end
+
+  describe 'boolean mapping function' do
+    before do
+      @func = FreshBooks::BaseObject::MAPPING_FNS[:boolean]
+    end
+
+    it "should convert '0' to false" do
+      @val  = mock('boolean arg', :text => '0')
+      @func.call(@val).should == false
+    end
+
+    it "should convert '1' to true" do
+      @val  = mock('boolean arg', :text => '1')
+      @func.call(@val).should == true
+    end
+  end
   
   describe 'converting an instance to XML' do
     before do

data/spec/freshbooks/time_entry_spec.rb

@@ -29,6 +29,10 @@ describe FreshBooks::TimeEntry do
     it 'should have notes' do
       @time_entry.should.respond_to(:notes)
     end
+
+    it 'should have billed' do
+      @time_entry.should.respond_to(:billed)
+    end
   end
   
   describe 'type mappings' do
@@ -55,6 +59,10 @@ describe FreshBooks::TimeEntry do
     it 'should map date to Date' do
       @mapping['date'].should == Date
     end
+
+    it 'should map billed to boolean' do
+      @mapping['billed'].should == :boolean
+    end
   end
   
   describe 'creating an instance' do

data/spec/freshtrack_command_spec.rb

@@ -192,4 +192,44 @@ describe 'freshtrack command' do
       aging_run(@project)
     end
   end
+
+  describe 'when --unbilled specified' do
+    before do
+      @time_info = 37.5
+      Freshtrack.stub!(:unbilled_time).and_return(@time_info)
+      self.stub!(:puts)
+    end
+    
+    def unbilled_run(project = nil)
+      args = ['--unbilled', project].compact
+      run_command(*args)
+    end
+    
+    it 'should require a project value for the option' do
+      self.should.receive(:puts) { |text|  text.to_s.match(/project.+required/i) }
+      unbilled_run(@project)
+    end
+    
+    it 'should init Freshtrack with the given project' do
+      Freshtrack.should.receive(:init) do |arg|
+        arg.should == @project
+      end
+      unbilled_run(@project)
+    end
+    
+    it 'should get the unbilled time info for the given project' do
+      Freshtrack.should.receive(:unbilled_time).with(@project)
+      unbilled_run(@project)
+    end
+
+    it 'should output the unbilled time' do
+      self.should.receive(:puts) { |text|  text.to_s.match(Regexp.new(Regexp.escape(@time_info.to_s))) }
+      unbilled_run(@project)
+    end
+
+    it 'should not track time' do
+      Freshtrack.should.receive(:track).never
+      unbilled_run
+    end
+  end
 end

data/spec/freshtrack_spec.rb

@@ -601,4 +601,73 @@ describe Freshtrack do
       Freshtrack.invoice_aging.should == []
     end
   end
+
+  it 'should get unbilled time on a project' do
+    Freshtrack.should.respond_to(:unbilled_time)
+  end
+
+  describe 'getting unbilled time on a project' do
+    before do
+      @project_name = :proj
+      @time_entries = Array.new(3) { mock('time_entry', :hours => rand(10)) }
+      Freshtrack.stub!(:get_unbilled_time_entries).and_return(@time_entries)
+    end
+
+    it 'should require a project name' do
+      lambda { Freshtrack.unbilled_time }.should.raise(ArgumentError)
+    end
+
+    it 'should accept a project name' do
+      lambda { Freshtrack.unbilled_time(@project_name) }.should.not.raise(ArgumentError)
+    end
+
+    it 'should get time entries for the given project' do
+      Freshtrack.should.receive(:get_unbilled_time_entries).with(@project_name).and_return(@time_entries)
+      Freshtrack.unbilled_time(@project_name)
+    end
+
+    it 'should return the sum total hours of the time entries' do
+      total = @time_entries.collect(&:hours).inject(&:+)
+      Freshtrack.unbilled_time(@project_name).should == total
+    end
+  end
+
+  it 'should get unbilled time entries for a project' do
+    Freshtrack.should.respond_to(:get_unbilled_time_entries)
+  end
+
+  describe 'getting unbilled time entries for a project' do
+    before do
+      @project_name = :proj
+      Freshtrack.stub!(:get_project_data)
+      @project_id = 7
+      @project = mock('project', :project_id => @project_id)
+      Freshtrack.instance_variable_set('@project', @project)
+      @time_entries = Array.new(7) { mock('time entry', :billed => rand(2).zero?) }
+      FreshBooks::TimeEntry.stub!(:list).and_return(@time_entries)
+    end
+
+    it 'should require a project name' do
+      lambda { Freshtrack.get_unbilled_time_entries }.should.raise(ArgumentError)
+    end
+
+    it 'should accept a project name' do
+      lambda { Freshtrack.get_unbilled_time_entries(@project_name) }.should.not.raise(ArgumentError)
+    end
+
+    it 'should get project data for the given project name' do
+      Freshtrack.should.receive(:get_project_data).with(@project_name)
+      Freshtrack.get_unbilled_time_entries(@project_name)
+    end
+
+    it 'should get time entries for the project (based on ID)' do
+      FreshBooks::TimeEntry.should.receive(:list).with('project_id' => @project_id, 'per_page' => 100).and_return(@time_entries)
+      Freshtrack.get_unbilled_time_entries(@project_name)
+    end
+
+    it 'should return the unbilled time entries' do
+      expected = @time_entries.reject(&:billed)
+      Freshtrack.get_unbilled_time_entries(@project_name).should == expected
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -15,94 +15,83 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 -05:00
-default_executable: freshtrack
+date: 2012-03-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: freshbooks
+  name: bacon
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 19
         segments: 
-        - 2
         - 1
-        version: "2.1"
-  type: :runtime
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bacon
+  name: facon
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 11
         segments: 
-        - 1
-        - 1
         - 0
-        version: 1.1.0
+        - 5
+        - 0
+        version: 0.5.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: facon
+  name: freshbooks
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 1
         segments: 
-        - 0
-        - 4
+        - 2
         - 1
-        version: 0.4.1
-  type: :development
+        version: "2.1"
+  type: :runtime
   version_requirements: *id003
-description: 
-email: ymendel@pobox.com
+description: A simple tool to take your locally-tracked time and put it up on FreshBooks.
+email: 
+- ymendel@pobox.com
 executables: 
 - freshtrack
 extensions: []
 
-extra_rdoc_files: 
-- README.txt
+extra_rdoc_files: []
+
 files: 
-- History.txt
 - License.txt
-- Manifest.txt
+- History.txt
 - README.txt
-- Rakefile
-- VERSION
-- bin/freshtrack
-- config/hoe.rb
-- config/requirements.rb
-- lib/freshbooks/extensions.rb
 - lib/freshbooks/extensions/base_object.rb
 - lib/freshbooks/extensions/invoice.rb
 - lib/freshbooks/extensions/project.rb
 - lib/freshbooks/extensions/task.rb
 - lib/freshbooks/extensions/time_entry.rb
-- lib/freshtrack.rb
-- lib/freshtrack/core_ext.rb
+- lib/freshbooks/extensions.rb
 - lib/freshtrack/core_ext/array.rb
 - lib/freshtrack/core_ext/numeric.rb
 - lib/freshtrack/core_ext/time.rb
+- lib/freshtrack/core_ext.rb
 - lib/freshtrack/time_collectors/one_inch_punch.rb
 - lib/freshtrack/time_collectors/punch.rb
 - lib/freshtrack/time_collectors/punchy_template.rb
 - lib/freshtrack/version.rb
-- log/debug.log
-- script/destroy
-- script/generate
-- setup.rb
-- spec/.bacon
+- lib/freshtrack.rb
 - spec/core_ext/array_spec.rb
 - spec/core_ext/numeric_spec.rb
 - spec/core_ext/time_spec.rb
@@ -117,14 +106,10 @@ files:
 - spec/spec_helper.rb
 - spec/time_collectors/one_inch_punch_spec.rb
 - spec/time_collectors/punch_spec.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/rspec.rake
-- tasks/website.rake
-has_rdoc: true
-homepage: http://github.com/flogic/freshtrack
-licenses: 
-- MIT
+- bin/freshtrack
+homepage: http://github.com/flogic/freshtrack/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -151,22 +136,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Track your time on FreshBooks
-test_files: 
-- spec/core_ext/array_spec.rb
-- spec/core_ext/numeric_spec.rb
-- spec/core_ext/time_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
-- spec/freshtrack_command_spec.rb
-- spec/freshtrack_spec.rb
-- spec/spec_helper.rb
-- spec/time_collectors/one_inch_punch_spec.rb
-- spec/time_collectors/punch_spec.rb
+test_files: []
+

data/Manifest.txt

@@ -1,46 +0,0 @@
-History.txt
-License.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/freshtrack
-config/hoe.rb
-config/requirements.rb
-lib/freshtrack.rb
-lib/freshtrack/version.rb
-lib/freshtrack/core_ext.rb
-lib/freshtrack/core_ext/array.rb
-lib/freshtrack/core_ext/numeric.rb
-lib/freshtrack/core_ext/time.rb
-lib/freshtrack/time_collectors/one_inch_punch.rb
-lib/freshtrack/time_collectors/punch.rb
-lib/freshtrack/time_collectors/punchy_template.rb
-lib/freshbooks/extensions.rb
-lib/freshbooks/extensions/base_object.rb
-lib/freshbooks/extensions/invoice.rb
-lib/freshbooks/extensions/project.rb
-lib/freshbooks/extensions/task.rb
-lib/freshbooks/extensions/time_entry.rb
-log/debug.log
-script/destroy
-script/generate
-setup.rb
-spec/core_ext/array_spec.rb
-spec/core_ext/numeric_spec.rb
-spec/core_ext/time_spec.rb
-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
-spec/freshtrack_command_spec.rb
-spec/freshtrack_spec.rb
-spec/spec.opts
-spec/spec_helper.rb
-tasks/deployment.rake
-tasks/environment.rake
-tasks/rspec.rake
-tasks/website.rake

data/Rakefile

@@ -1,51 +0,0 @@
-require 'rubygems'
-#require 'bundler'
-#begin
-#  Bundler.setup(:default, :development)
-#rescue Bundler::BundlerError => e
-#  $stderr.puts e.message
-#  $stderr.puts "Run `bundle install` to install missing gems"
-#  exit e.status_code
-#end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "freshtrack"
-  gem.homepage = "http://github.com/flogic/freshtrack"
-  gem.license = "MIT"
-  gem.summary = %Q{Track your time on FreshBooks}
-  gem.email = "ymendel@pobox.com"
-  gem.authors = ["Yossef Mendelssohn"]
-  gem.add_runtime_dependency 'freshbooks', '= 2.1'
-  gem.add_development_dependency 'bacon', '>= 1.1.0'
-  gem.add_development_dependency 'facon', '>= 0.4.1'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-#require 'rcov/rcovtask'
-#Rcov::RcovTask.new do |test|
-#  test.libs << 'test'
-#  test.pattern = 'test/**/test_*.rb'
-#  test.verbose = true
-#end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "freshtrack #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.5.0

data/config/hoe.rb

@@ -1,79 +0,0 @@
-require 'freshtrack/version'
-
-AUTHOR = 'Yossef Mendelssohn'  # can also be an array of Authors
-EMAIL = 'ymendel@pobox.com'
-DESCRIPTION = "Track your time on FreshBooks"
-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 = [
-  ['bacon', '>= 1.1.0'],
-  ['facon', '>= 0.4.1']
-]    # An array of rubygem dependencies [name, version]
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-RUBYFORGE_USERNAME = "unknown"
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
-  end
-  RUBYFORGE_USERNAME.replace @config["username"]
-end
-
-
-REV = nil 
-# UNCOMMENT IF REQUIRED: 
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
-VERS = Freshtrack::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'freshtrack documentation',
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
-    @extra_deps
-  end 
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  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.
-  
-end
-
-CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -1,17 +0,0 @@
-require 'fileutils'
-include FileUtils
-
-require 'rubygems'
-%w[rake hoe newgem rubigen].each do |req_gem|
-  begin
-    require req_gem
-  rescue LoadError
-    puts "This Rakefile requires the '#{req_gem}' RubyGem."
-    puts "Installation: gem install #{req_gem} -y"
-    exit
-  end
-end
-
-$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
-
-require 'freshtrack'

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.join(File.dirname(__FILE__), '..')
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.join(File.dirname(__FILE__), '..')
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)