freshtrack 0.2.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.2.0 2008-01-30
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Yossef Mendelssohn
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,37 @@
+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/freshbooks/extensions.rb
+lib/freshbooks/extensions/base_object.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/base_object_spec.rb
+spec/freshtrack_spec.rb
+spec/project_spec.rb
+spec/task_spec.rb
+spec/time_entry_spec.rb
+spec/array_spec.rb
+spec/numeric_spec.rb
+spec/time_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,30 @@
+Freshtrack is used to automatically create time entries in FreshBooks.
+
+It presently depends on punch, the gem by Ara T. Howard, and any arguments given to 
+freshtrack are passed along to punch as if freshtrack were an alias for 'punch list'.
+
+For example
+
+  freshtrack proj --after 2008-01-16 --before 2008-02-01
+
+would get time data for the second half of January 2008 by using the command
+
+  punch list proj --after 2008-01-16 --before 2008-02-01
+
+
+Freshtrack requires a configuration file, ~/.freshtrack.yml, that looks something like
+
+  --- 
+  company: Company Name
+  token: API Token
+  project_task_mapping:
+    project_name:
+      :project: FreshBooks Project Name
+      :task: FreshBooks Task Name
+
+The 'Company Name' is the XXX in 'XXX.freshbooks.com'. The 'project_name' is the XXX in 'punch list XXX'
+
+
+NOTE: As of this writing, punch (0.0.1) specifically requires attributes version 5.0.0 even though 5.0.1 is out.
+Because of the way gems work, punch will not work if both are installed. Make sure the specific installed version 
+of attributes is 5.0.0.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/freshtrack

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-1-30.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'freshtrack'
+
+# do stuff
+project = ARGV.shift
+
+unless project
+  puts "Usage: #{File.basename($0)} [project] [options]"
+  exit
+end
+
+Freshtrack.init
+Freshtrack.track(project, ARGV.join(' '))

data/config/hoe.rb

@@ -0,0 +1,74 @@
+require 'freshtrack/version'
+
+AUTHOR = 'Yossef Mendelssohn'  # can also be an array of Authors
+EMAIL = 'ymendel@pobox.com'
+DESCRIPTION = "description of gem"
+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}"
+
+@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 = [     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+    ['freshbooks', '>= 1.0.0'],
+    ['punch',      '>= 0.0.1']
+  ]
+  
+  #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

@@ -0,0 +1,17 @@
+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/lib/freshbooks/extensions/base_object.rb

@@ -0,0 +1,31 @@
+require 'date'
+
+module FreshBooks
+  class BaseObject
+    MAPPING_FNS[Date] = lambda { |xml_val|  Date.parse(xml_val.text) }
+    
+    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|
+        
+        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) }
+        elsif !value.nil?
+          root.add_element(field_name).text = value
+        end
+      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
+  end
+end

data/lib/freshbooks/extensions/project.rb

@@ -0,0 +1,58 @@
+module FreshBooks
+  Project = BaseObject.new(:project_id, :name, :bill_method, :client_id, :rate, :description)
+  
+  class Project
+    TYPE_MAPPINGS = { 'project_id' => Fixnum, 'client_id' => Fixnum, 'rate' => Float }
+    
+    class << self
+      def get(project_id)
+        resp = FreshBooks.call_api('project.get', 'project_id' => project_id)
+        return nil unless resp.success?
+        new_from_xml(resp.elements[1])
+      end
+      
+      def list(options = {})
+        resp = FreshBooks.call_api('project.list', options)
+        return nil unless resp.success?
+        resp.elements.collect { |elem|  new_from_xml(elem) }
+      end
+      
+      def find_by_name(name)
+        list.detect { |p|  p.name == name }
+      end
+      
+      def delete(project_id)
+        resp = FreshBooks.call_api('project.delete', 'project_id' => project_id)
+        resp.success?
+      end
+    end
+    
+    def create
+      resp = FreshBooks.call_api('project.create', 'project' => self)
+      if resp.success?
+        self.project_id = resp.elements[1].text.to_i
+      end
+    end
+    
+    def update
+      resp = FreshBooks.call_api('project.update', 'project' => self)
+      resp.success?
+    end
+    
+    def delete
+      self.class.delete(project_id)
+    end
+    
+    def client
+      Client.get(client_id)
+    end
+    
+    def tasks
+      Task.list('project_id' => project_id)
+    end
+    
+    def time_entries
+      TimeEntry.list('project_id' => project_id)
+    end
+  end
+end

data/lib/freshbooks/extensions/task.rb

@@ -0,0 +1,50 @@
+module FreshBooks
+  Task = BaseObject.new(:task_id, :name, :billable, :rate, :description)
+  
+  class Task
+    TYPE_MAPPINGS = { 'task_id' => Fixnum, 'rate' => Float }
+    
+    class << self
+      def get(task_id)
+        resp = FreshBooks.call_api('task.get', 'task_id' => task_id)
+        return nil unless resp.success?
+        new_from_xml(resp.elements[1])
+      end
+      
+      def list(options = {})
+        resp = FreshBooks.call_api('task.list', options)
+        return nil unless resp.success?
+        resp.elements.collect { |elem|  new_from_xml(elem) }
+      end
+      
+      def find_by_name(name)
+        list.detect { |p|  p.name == name }
+      end
+      
+      def delete(task_id)
+        resp = FreshBooks.call_api('task.delete', 'task_id' => task_id)
+        resp.success?
+      end
+    end
+    
+    def create
+      resp = FreshBooks.call_api('task.create', 'task' => self)
+      if resp.success?
+        self.task_id = resp.elements[1].text.to_i
+      end
+    end
+    
+    def update
+      resp = FreshBooks.call_api('task.update', 'task' => self)
+      resp.success?
+    end
+    
+    def delete
+      self.class.delete(task_id)
+    end
+    
+    def time_entries
+      TimeEntry.list('task_id' => task_id)
+    end
+  end
+end

data/lib/freshbooks/extensions/time_entry.rb

@@ -0,0 +1,53 @@
+module FreshBooks
+  TimeEntry = BaseObject.new(:time_entry_id, :project_id, :task_id, :hours, :date, :notes)
+  
+  class TimeEntry
+    TYPE_MAPPINGS = {
+      'time_entry_id' => Fixnum, 'project_id' => Fixnum, 'task_id' => Fixnum,
+      'hours' => Float, 'date' => Date
+    }
+    
+    class << self
+      def get(time_entry_id)
+        resp = FreshBooks.call_api('time_entry.get', 'time_entry_id' => time_entry_id)
+        return nil unless resp.success?
+        new_from_xml(resp.elements[1])
+      end
+      
+      def list(options = {})
+        resp = FreshBooks.call_api('time_entry.list', options)
+        return nil unless resp.success?
+        resp.elements.collect { |elem|  new_from_xml(elem) }
+      end
+      
+      def delete(time_entry_id)
+        resp = FreshBooks.call_api('time_entry.delete', 'time_entry_id' => time_entry_id)
+        resp.success?
+      end
+    end
+    
+    def create
+      resp = FreshBooks.call_api('time_entry.create', 'time_entry' => self)
+      if resp.success?
+        self.time_entry_id = resp.elements[1].text.to_i
+      end
+    end
+    
+    def update
+      resp = FreshBooks.call_api('time_entry.update', 'time_entry' => self)
+      resp.success?
+    end
+    
+    def delete
+      self.class.delete(time_entry_id)
+    end
+    
+    def task
+      Task.get(task_id)
+    end
+    
+    def project
+      Project.get(project_id)
+    end
+  end
+end

data/lib/freshbooks/extensions.rb

@@ -0,0 +1,5 @@
+require 'freshbooks'
+require 'freshbooks/extensions/base_object'
+require 'freshbooks/extensions/project'
+require 'freshbooks/extensions/task'
+require 'freshbooks/extensions/time_entry'

data/lib/freshtrack/core_ext/array.rb

@@ -0,0 +1,11 @@
+class Array
+  def group_by(&block)
+    raise ArgumentError unless block
+    inject({}) do |hash, elem|
+      key = block.call(elem)
+      hash[key] ||= []
+      hash[key].push(elem)
+      hash
+    end
+  end
+end

data/lib/freshtrack/core_ext/numeric.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def secs_to_hours
+    self / 3600.0
+  end
+end

data/lib/freshtrack/core_ext/time.rb

@@ -0,0 +1,3 @@
+class Time
+  public :to_date
+end

data/lib/freshtrack/core_ext.rb

@@ -0,0 +1,3 @@
+require 'freshtrack/core_ext/time'
+require 'freshtrack/core_ext/array'
+require 'freshtrack/core_ext/numeric'

data/lib/freshtrack/version.rb

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

data/lib/freshtrack.rb

@@ -0,0 +1,107 @@
+$:.unshift File.dirname(__FILE__)
+require 'freshbooks/extensions'
+require 'freshtrack/core_ext'
+require 'yaml'
+
+module Freshtrack
+  class << self
+    attr_reader :config, :project, :task
+    
+    def init
+      load_config
+      FreshBooks.setup("#{company}.freshbooks.com", token)
+    end
+    
+    def load_config
+      @config = YAML.load(File.read(File.expand_path('~/.freshtrack.yml')))
+    end
+    
+    def company
+      config['company']
+    end
+    
+    def token
+      config['token']
+    end
+    
+    def project_task_mapping
+      config['project_task_mapping']
+    end
+    
+    def get_project_data(project_name)
+      raise unless mapping = project_task_mapping[project_name]
+      @project = FreshBooks::Project.find_by_name(mapping[:project])
+      raise unless @project
+      @task = FreshBooks::Task.find_by_name(mapping[:task])
+      raise unless @task
+    end
+    
+    def get_time_data(project_name, options = '')
+      time_data = IO.read("| punch list #{project_name} #{options}")
+      convert_time_data(time_data)
+    end
+    
+    def convert_time_data(time_data)
+      raw = YAML.load(time_data)
+      condense_time_data(raw)
+    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|
+        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
+    end
+    
+    def group_date_data(date_data)
+      separator = '-' * 20
+      grouped = date_data.group_by { |x|  x['date'] }
+      grouped.sort.inject([]) do |arr, (date, data)|
+        this_date = { 'date' => date }
+        this_date['hours'] = data.inject(0) { |sum, x|  sum + x['hours'] }
+        this_date['hours'] = ('%.2f' % this_date['hours']).to_f
+        this_date['notes'] = data.collect { |x|  x['log'].join("\n") }.join("\n" + separator + "\n")
+        arr + [this_date]
+      end
+    end
+    
+    def get_data(project_name, options = '')
+      get_project_data(project_name)
+      get_time_data(project_name, options)
+    end
+    
+    def track(project_name, options = '')
+      data = get_data(project_name, options)
+      data.each do |entry_data|
+        create_entry(entry_data)
+      end
+    end
+    
+    def create_entry(entry_data)
+      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
+      
+      if result
+        true
+      else
+        STDERR.puts "warning: unsuccessful time entry creation for date #{entry_data['date']}"
+        nil
+      end
+    end
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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)