freshtrack 0.6.0 → 0.7.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.7.0 2012-03-30
+
+* 1 minor enhancement:
+  * Tracking time is now idempotent. If a time entry already exists for a date/project/task combination, that time entry will be updated rather than a new entry created.
+* 1 bugfix:
+  * Tracking time for a project when you're punched in no longer raises an exception. Time entries that aren't completed (not punched out) are now ignored.
+
 == 0.6.0 2012-03-30
 
 * 1 minor enhancement:

data/lib/freshbooks/extensions/base_object.rb

@@ -9,16 +9,17 @@ module FreshBooks
         when '1' : true
       end
     end
-    
+
     def to_xml
       # The root element is the elem name
       root = Element.new elem_name
-      
+
       # Add each BaseObject member to the root elem
-      self.members.each do |field_name|
-        
+
+      self.included_members.each do |field_name|
+
         value = self.send(field_name)
-        
+
         if value.is_a?(Array)
           node = root.add_element(field_name)
           value.each { |array_elem| node.add_element(array_elem.to_xml) }
@@ -28,10 +29,19 @@ module FreshBooks
       end
       root
     end
-    
+
     # The root element is the class name, downcased (and underscored if there is any CamelCase)
     def elem_name
       elem_name = self.class.to_s.split('::').last.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
     end
+
+    def included_members
+      members - excluded_members
+    end
+
+    def excluded_members
+      return [] unless self.class.const_defined?(:EXCLUDE_XML_ATTRIBUTES)
+      self.class.const_get(:EXCLUDE_XML_ATTRIBUTES)
+    end
   end
 end

data/lib/freshbooks/extensions/time_entry.rb

@@ -6,7 +6,9 @@ module FreshBooks
       'time_entry_id' => Fixnum, 'project_id' => Fixnum, 'task_id' => Fixnum,
       'hours' => Float, 'date' => Date, 'billed' => :boolean
     }
-    
+
+    EXCLUDE_XML_ATTRIBUTES = %w[billed]
+
     class << self
       def get(time_entry_id)
         resp = FreshBooks.call_api('time_entry.get', 'time_entry_id' => time_entry_id)

data/lib/freshtrack.rb

@@ -52,22 +52,31 @@ module Freshtrack
     
     def track(project_name, options = {})
       data = get_data(project_name, options)
+      tracked = get_tracked_data(data)
       data.each do |entry_data|
-        create_entry(entry_data)
+        tracked_entry = tracked.detect { |t|  t.date == entry_data['date'] }
+        create_entry(entry_data, tracked_entry)
       end
     end
-    
-    def create_entry(entry_data)
-      time_entry = FreshBooks::TimeEntry.new
-      
+
+    def get_tracked_data(data)
+      return [] if data.empty?
+      dates = data.collect { |d|  d['date'] }
+      FreshBooks::TimeEntry.list('project_id' => project.project_id, 'task_id' => task.task_id, 'date_from' => dates.min, 'date_to' => dates.max)
+    end
+
+    def create_entry(entry_data, time_entry = FreshBooks::TimeEntry.new)
+      time_entry ||= FreshBooks::TimeEntry.new
+
       time_entry.project_id = project.project_id
       time_entry.task_id    = task.task_id
       time_entry.date       = entry_data['date']
       time_entry.hours      = entry_data['hours']
       time_entry.notes      = entry_data['notes']
-      
-      result = time_entry.create
-      
+
+      method = time_entry.time_entry_id ? :update : :create
+      result = time_entry.send(method)
+
       if result
         true
       else

data/lib/freshtrack/time_collectors/punchy_template.rb

@@ -2,26 +2,29 @@ module Freshtrack
   module TimeCollector
     module PunchyTemplate
       attr_reader :options
-      
+
       def initialize(options = {})
         @options = options
       end
-      
+
       def condense_time_data(time_data)
         date_data = times_to_dates(time_data)
         group_date_data(date_data)
       end
-      
+
       def times_to_dates(time_data)
-        time_data.each do |td|
+        time_data.collect do |td|
           punch_in  = td.delete('in')
           punch_out = td.delete('out')
 
-          td['date']  = punch_in.to_date
-          td['hours'] = (punch_out - punch_in).secs_to_hours
-        end
+          if punch_out
+            td['date']  = punch_in.to_date
+            td['hours'] = (punch_out - punch_in).secs_to_hours
+            td
+          end
+        end.compact
       end
-      
+
       def group_date_data(date_data)
         separator = '-' * 20
         grouped = date_data.group_by { |x|  x['date'] }

data/lib/freshtrack/version.rb

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

data/spec/freshbooks/base_object_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 
 Thing     = FreshBooks::BaseObject.new(:attr)
 ThingDeal = FreshBooks::BaseObject.new(:attr)
+OtherThing = FreshBooks::BaseObject.new(:attr, :other, :more, :stuff)
 
 describe FreshBooks::BaseObject do
   it 'should have a mapping function for Date' do
@@ -42,28 +43,56 @@ describe FreshBooks::BaseObject do
       @func.call(@val).should == true
     end
   end
-  
+
   describe 'converting an instance to XML' do
     before do
       @thing = Thing.new
     end
-    
+
     it 'should use the elem name' do
       @thing.should.receive(:elem_name)
       @thing.to_xml
     end
+
+    describe 'selective attribute inclusion' do
+      before do
+        @other_thing = OtherThing.new
+        @other_thing.attr  = 'blah'
+        @other_thing.other = 'something'
+        @other_thing.more  = 'things'
+        @other_thing.stuff = 'this'
+      end
+
+      it 'should include all attributes' do
+        xml = @other_thing.to_xml.to_s
+        xml.should.match(Regexp.new('<attr>blah</attr>'))
+        xml.should.match(Regexp.new('<other>something</other>'))
+        xml.should.match(Regexp.new('<more>things</more>'))
+        xml.should.match(Regexp.new('<stuff>this</stuff>'))
+      end
+
+      it 'should remove attributes marked for exclusion' do
+        OtherThing::EXCLUDE_XML_ATTRIBUTES = %w[other stuff]
+
+        xml = @other_thing.to_xml.to_s
+        xml.should.match(Regexp.new('<attr>blah</attr>'))
+        xml.should.not.match(Regexp.new('<other>something</other>'))
+        xml.should.match(Regexp.new('<more>things</more>'))
+        xml.should.not.match(Regexp.new('<stuff>this</stuff>'))
+      end
+    end
   end
-  
+
   describe 'getting the elem name' do
     before do
       @thing = Thing.new
       @thing_deal = ThingDeal.new
     end
-    
+
     it 'should be the class name, downcased' do
       @thing.elem_name.should == 'thing'
     end
-    
+
     it 'should be underscored if the class name has CamelCase' do
       @thing_deal.elem_name.should == 'thing_deal'
     end

data/spec/freshtrack_spec.rb

@@ -355,33 +355,35 @@ describe Freshtrack do
       lambda { Freshtrack.collector }.should.raise(LoadError)
     end
   end
-  
+
   describe 'tracking time' do
     before do
       @project_name = :proj
       @data = []
+      @tracked = []
       Freshtrack.stub!(:get_data).and_return(@data)
+      Freshtrack.stub!(:get_tracked_data).and_return(@tracked)
     end
-    
+
     it 'should require an argument' do
       lambda { Freshtrack.track }.should.raise(ArgumentError)
     end
-    
+
     it 'should accept an argument' do
       lambda { Freshtrack.track(@project_name) }.should.not.raise(ArgumentError)
     end
-    
+
     it 'should accept options' do
       lambda { Freshtrack.track(@project_name, :before => Time.now) }.should.not.raise(ArgumentError)
     end
-    
+
     it 'should get data for supplied project' do
       Freshtrack.should.receive(:get_data).and_return(@data) do |project, _|
         project.should == @project_name
       end
       Freshtrack.track(@project_name)
     end
-    
+
     it 'should pass options on when getting data' do
       options = { :after => Time.now - 12345 }
       Freshtrack.should.receive(:get_data).and_return(@data) do |project, opts|
@@ -390,7 +392,7 @@ describe Freshtrack do
       end
       Freshtrack.track(@project_name, options)
     end
-    
+
     it 'should default options to an empty hash' do
       Freshtrack.should.receive(:get_data).and_return(@data) do |project, opts|
         project.should == @project_name
@@ -398,112 +400,343 @@ describe Freshtrack do
       end
       Freshtrack.track(@project_name)
     end
-    
-    it 'should create entries for project data' do
-      2.times do
-        ent = mock('entry data')
-        @data.push(ent)
-        Freshtrack.should.receive(:create_entry).with(ent)
+
+    it 'should get already-tracked time, passing the data along' do
+      Freshtrack.should.receive(:get_tracked_data).with(@data)
+      Freshtrack.track(@project_name)
+    end
+
+    it 'should create entries for project data, matching them with the already-tracked time by date' do
+      data = Array.new(5) { |i|  { 'date' => Date.today - i*2 } }
+      tracked = Array.new(5) { |i|  te = FreshBooks::TimeEntry.new; te.date = Date.today - i*3; te }
+      Freshtrack.stub!(:get_data).and_return(data)
+      Freshtrack.stub!(:get_tracked_data).and_return(tracked)
+
+      matches = {
+        data[0] => tracked[0],
+        data[1] => nil,
+        data[2] => nil,
+        data[3] => tracked[2],
+        data[4] => nil
+      }
+
+      matches.each do |data, entry|
+        Freshtrack.should.receive(:create_entry).with(data, entry)
       end
       Freshtrack.track(@project_name)
     end
   end
-  
+
+  describe 'getting already-tracked time' do
+    before do
+      @data = [{ 'date' => Date.today - 3 }]
+      @tracked = []
+      FreshBooks::TimeEntry.stub!(:list).and_return(@tracked)
+
+      @project = mock('project', :project_id => mock('project id'))
+      @task    = mock('task',    :task_id    => mock('task id'))
+      Freshtrack.stub!(:project).and_return(@project)
+      Freshtrack.stub!(:task).and_return(@task)
+    end
+
+    it 'should accept data' do
+      lambda { Freshtrack.get_tracked_data(@data) }.should.not.raise(ArgumentError)
+    end
+
+    it 'should require data' do
+      lambda { Freshtrack.get_tracked_data }.should.raise(ArgumentError)
+    end
+
+    it 'should get a list of time entries based upon the data' do
+      data = Array.new(3) { |i|  { 'date' => Date.today - i*3 } } + Array.new(3) { |i|  { 'date' => Date.today - 5 + i*2 } }
+      data_options = { 'project_id' => @project.project_id, 'task_id' => @task.task_id }
+      data_options['date_from'] = data.collect { |d|  d['date'] }.min
+      data_options['date_to']   = data.collect { |d|  d['date'] }.max
+
+      FreshBooks::TimeEntry.should.receive(:list).with(data_options)
+      Freshtrack.get_tracked_data(data)
+    end
+
+    it 'should return the list of time entries' do
+      entries = Object.new
+      FreshBooks::TimeEntry.stub!(:list).and_return(entries)
+      Freshtrack.get_tracked_data(@data).should == entries
+    end
+
+    it 'should not bother getting data for empty input' do
+      FreshBooks::TimeEntry.should.receive(:list).never
+      Freshtrack.get_tracked_data([])
+    end
+
+    it 'should return an empty list for empty input' do
+      Freshtrack.get_tracked_data([]).should == []
+    end
+  end
+
   describe 'creating an entry' do
     before do
       @date = Date.today - 3
       @hours = 5.67
       @notes = 'notes for the time entry'
       @entry_data = { 'date' => @date, 'hours' => @hours, 'notes' => @notes }
-      @time_entry = mock('time entry', :project_id= => nil, :task_id= => nil, :date= => nil, :hours= => nil, :notes= => nil, :create => true)
+      @time_entry = FreshBooks::TimeEntry.new
+      @time_entry.stub!(:create)
+      @time_entry.stub!(:update)
       FreshBooks::TimeEntry.stub!(:new).and_return(@time_entry)
-      
+
       @project = mock('project', :project_id => mock('project id'))
       @task    = mock('task',    :task_id    => mock('task id'))
       Freshtrack.stub!(:project).and_return(@project)
       Freshtrack.stub!(:task).and_return(@task)
-      
+
       STDERR.stub!(:puts)
     end
-    
+
     it 'should require an argument' do
       lambda { Freshtrack.create_entry }.should.raise(ArgumentError)
     end
-    
+
     it 'should accept an argument' do
       lambda { Freshtrack.create_entry(@entry_data) }.should.not.raise(ArgumentError)
     end
-    
-    it 'should instantiate a new time entry' do
-      FreshBooks::TimeEntry.should.receive(:new).and_return(@time_entry)
-      Freshtrack.create_entry(@entry_data)
+
+    it 'should accept a time entry argument' do
+      lambda { Freshtrack.create_entry(@entry_data, @time_entry) }.should.not.raise(ArgumentError)
     end
-    
-    describe 'with the time entry instance' do
-      it 'should set the project' do
-        @time_entry.should.receive(:project_id=).with(@project.project_id)
+
+    describe 'when given no time entry argument' do
+      it 'should instantiate a new time entry' do
+        FreshBooks::TimeEntry.should.receive(:new).and_return(@time_entry)
         Freshtrack.create_entry(@entry_data)
       end
-      
-      it 'should set the task' do
-        @time_entry.should.receive(:task_id=).with(@task.task_id)
-        Freshtrack.create_entry(@entry_data)
+
+      describe 'with the time entry instance' do
+        it 'should set the project' do
+          @time_entry.should.receive(:project_id=).with(@project.project_id)
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should set the task' do
+          @time_entry.should.receive(:task_id=).with(@task.task_id)
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should set the date' do
+          @time_entry.should.receive(:date=).with(@date)
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should set the hours' do
+          @time_entry.should.receive(:hours=).with(@hours)
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should set the notes' do
+          @time_entry.should.receive(:notes=).with(@notes)
+          Freshtrack.create_entry(@entry_data)
+        end
       end
-      
-      it 'should set the date' do
-        @time_entry.should.receive(:date=).with(@date)
+
+      it 'should create the time entry' do
+        @time_entry.should.receive(:create)
         Freshtrack.create_entry(@entry_data)
       end
-      
-      it 'should set the hours' do
-        @time_entry.should.receive(:hours=).with(@hours)
+
+      it 'should not update the time entry' do
+        @time_entry.should.receive(:update).never
         Freshtrack.create_entry(@entry_data)
       end
-      
-      it 'should set the notes' do
-        @time_entry.should.receive(:notes=).with(@notes)
-        Freshtrack.create_entry(@entry_data)
+
+      describe 'successfully' do
+        before do
+          @time_entry.stub!(:create).and_return(5)
+        end
+
+        it 'should be silent' do
+          STDERR.should.receive(:puts).never
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should return true' do
+          Freshtrack.create_entry(@entry_data).should == true
+        end
+      end
+
+      describe 'unsuccessfully' do
+        before do
+          @time_entry.stub!(:create).and_return(nil)
+        end
+
+        it 'should output an indication' do
+          STDERR.should.receive(:puts) do |arg|
+            arg.should.match(/#{@date.to_s}/)
+          end
+          Freshtrack.create_entry(@entry_data)
+        end
+
+        it 'should return nil' do
+          Freshtrack.create_entry(@entry_data).should.be.nil
+        end
       end
     end
-    
-    it 'should create the time entry' do
-      @time_entry.should.receive(:create)
-      Freshtrack.create_entry(@entry_data)
-    end
-    
-    describe 'successfully' do
-      before do
-        @time_entry.stub!(:create).and_return(5)
+
+    describe 'when given a nil time entry argument' do
+      it 'should instantiate a new time entry' do
+        FreshBooks::TimeEntry.should.receive(:new).and_return(@time_entry)
+        Freshtrack.create_entry(@entry_data, nil)
       end
-      
-      it 'should be silent' do
-        STDERR.should.receive(:puts).never
+
+      describe 'with the time entry instance' do
+        it 'should set the project' do
+          @time_entry.should.receive(:project_id=).with(@project.project_id)
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should set the task' do
+          @time_entry.should.receive(:task_id=).with(@task.task_id)
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should set the date' do
+          @time_entry.should.receive(:date=).with(@date)
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should set the hours' do
+          @time_entry.should.receive(:hours=).with(@hours)
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should set the notes' do
+          @time_entry.should.receive(:notes=).with(@notes)
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+      end
+
+      it 'should create the time entry' do
+        @time_entry.should.receive(:create)
+        Freshtrack.create_entry(@entry_data, nil)
+      end
+
+      it 'should not update the time entry' do
+        @time_entry.should.receive(:update).never
         Freshtrack.create_entry(@entry_data)
       end
-      
-      it 'should return true' do
-        Freshtrack.create_entry(@entry_data).should == true
+
+      describe 'successfully' do
+        before do
+          @time_entry.stub!(:create).and_return(5)
+        end
+
+        it 'should be silent' do
+          STDERR.should.receive(:puts).never
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should return true' do
+          Freshtrack.create_entry(@entry_data, nil).should == true
+        end
+      end
+
+      describe 'unsuccessfully' do
+        before do
+          @time_entry.stub!(:create).and_return(nil)
+        end
+
+        it 'should output an indication' do
+          STDERR.should.receive(:puts) do |arg|
+            arg.should.match(/#{@date.to_s}/)
+          end
+          Freshtrack.create_entry(@entry_data, nil)
+        end
+
+        it 'should return nil' do
+          Freshtrack.create_entry(@entry_data, nil).should.be.nil
+        end
       end
     end
-    
-    describe 'unsuccessfully' do
+
+    describe 'when given an existing time entry argument' do
       before do
-        @time_entry.stub!(:create).and_return(nil)
+        @time_entry.time_entry_id = 293
       end
-      
-      it 'should output an indication' do
-        STDERR.should.receive(:puts) do |arg|
-          arg.should.match(/#{@date.to_s}/)
+
+      it 'should not instantiate a new time entry' do
+        FreshBooks::TimeEntry.should.receive(:new).never
+        Freshtrack.create_entry(@entry_data, @time_entry)
+      end
+
+      describe 'with the time entry instance' do
+        it 'should set the project' do
+          @time_entry.should.receive(:project_id=).with(@project.project_id)
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should set the task' do
+          @time_entry.should.receive(:task_id=).with(@task.task_id)
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should set the date' do
+          @time_entry.should.receive(:date=).with(@date)
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should set the hours' do
+          @time_entry.should.receive(:hours=).with(@hours)
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should set the notes' do
+          @time_entry.should.receive(:notes=).with(@notes)
+          Freshtrack.create_entry(@entry_data, @time_entry)
         end
-        Freshtrack.create_entry(@entry_data)
       end
-      
-      it 'should return nil' do
-        Freshtrack.create_entry(@entry_data).should.be.nil
+
+      it 'should update the time entry' do
+        @time_entry.should.receive(:update)
+        Freshtrack.create_entry(@entry_data, @time_entry)
+      end
+
+      it 'should not create the time entry' do
+        @time_entry.should.receive(:create).never
+        Freshtrack.create_entry(@entry_data, @time_entry)
+      end
+
+      describe 'successfully' do
+        before do
+          @time_entry.stub!(:update).and_return(true)
+        end
+
+        it 'should be silent' do
+          STDERR.should.receive(:puts).never
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should return true' do
+          Freshtrack.create_entry(@entry_data, @time_entry).should == true
+        end
+      end
+
+      describe 'unsuccessfully' do
+        before do
+          @time_entry.stub!(:update).and_return(false)
+        end
+
+        it 'should output an indication' do
+          STDERR.should.receive(:puts) do |arg|
+            arg.should.match(/#{@date.to_s}/)
+          end
+          Freshtrack.create_entry(@entry_data, @time_entry)
+        end
+
+        it 'should return nil' do
+          Freshtrack.create_entry(@entry_data, @time_entry).should.be.nil
+        end
       end
     end
   end
-  
+
   it 'should list open invoices' do
     Freshtrack.should.respond_to(:open_invoices)
   end

data/spec/time_collectors/one_inch_punch_spec.rb

@@ -178,6 +178,15 @@ describe Freshtrack::TimeCollector::OneInchPunch do
       result = result.first
       result['hours'].should == 1.5
     end
+
+    it 'should ignore any time data that is not finished' do
+      @time_data.push({ 'in' => Time.local(2012, 1, 25, 6,  25, 0), 'out' => Time.local(2012, 1, 25, 7,  55, 0) })
+      @time_data.push({ 'in' => Time.local(2012, 3, 25, 6,  25, 0)})
+
+      result = @collector.times_to_dates(@time_data)
+      result.length.should == 1
+      result.first['hours'].should == 1.5
+    end
   end
   
   it 'should group date data' do

data/spec/time_collectors/punch_spec.rb

@@ -224,6 +224,15 @@ describe Freshtrack::TimeCollector::Punch do
       result = result.first
       result['hours'].should == 1.5
     end
+
+    it 'should ignore any time data that is not finished' do
+      @time_data.push({ 'in' => Time.local(2012, 1, 25, 6,  25, 0), 'out' => Time.local(2012, 1, 25, 7,  55, 0) })
+      @time_data.push({ 'in' => Time.local(2012, 3, 25, 6,  25, 0)})
+
+      result = @collector.times_to_dates(@time_data)
+      result.length.should == 1
+      result.first['hours'].should == 1.5
+    end
   end
   
   it 'should group date data' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: freshtrack
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-30 00:00:00 Z
+date: 2012-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bacon