big_bucks_no_whammies 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jim Jones
+
+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/README.rdoc

@@ -0,0 +1,88 @@
+= Description
+Big Bucks No Whammies (BBNW) will download your time usage from {Timesink}[http://manytricks.com/timesink/], Chrometa, or any other service/app that tracks application time usage, cross reference it with your commits to a git repository, and generate an invoice.  This is useful for developers that are independent contractors.
+
+If you don't have time usage statistics, BBNW can estimate how much each commit took by looking at the number of source changes per commit.
+
+== Contributing to big_bucks_no_whammies
+I'm assuming that you're a programmer. You're working for a client making the big bucks. You spend a ton of time in your favorite editor or maybe there's a couple of terminal sessions open.
+
+So, I assume that you're tracking all of your activity on the computer. I'm currently using {Timesink.}[http://manytricks.com/timesink/]
+
+With all of this hard work, eventually you commit these changes to a repository. I personally use git.
+
+BBNW will consult {Timesink}[http://manytricks.com/timesink/] / Chrometa / etc, gather all of the time that you've accumulated using your favorite development applications, and then it will cross reference that activity with your git commits.
+Finally, it will generate an invoice listing for each commit you've made along with the time used for each issue.
+
+BBNW makes the assumption that all of the work done before the commit was specifically for that commit.
+
+E.g.
+
+Timesink csv report :
+
+    Pool,Application,Window,Foreground Begin (Unix Time),Foreground End (Unix Time)
+    ,Finder,,1305084898.21,1305084902.27
+    ,Firefox,"Screen_shot_2011-05-10_at_11.42.19_AM.png (PNG Image, 405x336 pixels)",1305084938.45,1305084939.47
+    ,Firefox,localhost,1305084943.00,1305084946.04
+    ,Microsoft Outlook,,1305084946.55,1305085092.49
+    ,Microsoft Outlook,Inbox • MyCompany,1305084946.55,1305085092.49
+    ,RubyMine,,1305085092.99,1305085279.06
+    ,RubyMine,myproject - [/Users/jimjones/dev/myproject] - .../db/seeds.rb - JetBrains RubyMine 3.1.1,1305085092.99,1305085097.04
+    ,RubyMine,myproject - [/Users/jimjones/dev/myproject] - .../app/views/mailers/_form.html.haml - JetBrains RubyMine 3.1.1,1305085097.55,1305085100.09
+    ,RubyMine,myproject - [/Users/jimjones/dev/myproject] - .../app/views/mailers/edit.html.haml - JetBrains RubyMine 3.1.1,1305085100.59,1305085279.06
+    ,Microsoft Outlook,,1305085279.56,1305085289.21
+
+And then there's a commit in your git repository with the following :
+
+    commit 1b132d58af90af8c65738f9189eb7c8d7d29173c
+    Author: Jim Jones <jjones@aantix.com>
+    Date:   Sun Apr 5 09:17:51 2011 -0700
+
+        Added facial recognition.  No big deal.
+
+
+In your invoice, you would see the following line item :
+
+Description                             Unit Price      Quantity        Amount
+Added facial recognition.  No big deal. $100            1.5 hours       $150
+
+= Meetings, Activities, Phonecalls, Anything that isn't recorded by Timesink
+You can programmatically adds meetings/tasks to your invoice.
+
+    invoice.meeting("Progress Review", "#{meeting_date.strftime("%d/%m/%Y")} 8:30:00","#{meeting_date.strftime("%d/%m/%Y")} 9:30:00")
+    invoice.task("Answered support phone call", "04/05/2011 8:30:00","04/05/2011 8:37:00")
+
+
+= Extending BBNW
+For activity data, BBNW supports Chrometa, TimeSink and a generic CSV adapter. There's a Git repository adapater.  But if you use another time tracker (e.g. Time Sink, Freshbooks, Freckle, etc), nothing would prevent you from writing your own activity adapter.
+
+
+== Sample Usages
+If you want to cross reference your recorded activities with your Git commits, do the following :
+
+    company = ['123 Easy St', 'San Francisco, CA 94132','','(505) 555-5575','jjones@aantix.com']
+    bill_to = ['The Software Corp','100 Microsoft Drive, Suite 150','San Francisco, CA 94105']
+
+    start_date = Date.today - 365
+    end_date   = Date.today
+
+    activities  = BBNW::TimeSink.new('~/Dropbox/time_reports/2011-07-29.csv', start_date, end_date, true)
+    #activities   = BBNW::CsvFile.new('~/Dropbox/time_sink_report.csv', [1,3,4], true)
+    #activities  = BBNW::Chrometa.new('jjones@example.com', '643e011b0532dfD1gjhuytyu0bc96f4058rffa', nil, nil, start_date, end_date, true)
+    git          = BBNW::GitRepos.new('~/dev/turkee', nil, start_date, end_date, true)
+
+    invoice      = BBNW::Invoice.new
+    invoice.line_items(activities, git, BBNW::RecordedActivity, false) # No grouping of line items
+    invoice.generate(invoice_num, invoice_path, company_logo, company_name, company_details, rate_per_hour)
+
+Or if you don't have your activities recorded and would just like to generate a line itemed invoice from Git commits with the time estimated for each commit you can do the following :
+
+    git        = BBNW::GitRepos.new('~/Projects/turkee', nil, start_date, end_date, true)
+    invoice    = BBNW::Invoice.new
+    invoice.line_items(80, git, BBNW::NumberOfSourceCommits)
+    invoice.generate(invoice_num, './logo.png', 'Jim Jones', company, bill_to, 250, start_date, end_date)
+
+== Copyright
+
+Copyright (c) 2011 Jim Jones. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+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 = "big_bucks_no_whammies"
+  gem.homepage = "http://github.com/aantix/big_bucks_no_whammies"
+  gem.license = "MIT"
+  gem.summary = %Q{Big Bucks No Whammies allows software development contractors to generate a line-item invoice based on git commits. Activity}
+  gem.description = %Q{Auto-generate a pdf invoice utilizing your git commit activity. Time is automatically accounted for utilizing TimeSink and is proportionately applied towards each line item entry. }
+  gem.email = "jjones@aantix.com"
+  gem.authors = ["Jim Jones"]
+  gem.require_paths = ["lib","lib/adapters","lib/adapters/base","lib/adapters/time_estimators","lib/adapters/utils"]
+  gem.add_dependency(%q<grit>, [">= 2.4.1"])
+  gem.add_dependency(%q<payday>, [">= 1.0.2"])
+  gem.add_dependency(%q<jeweler>, [">= 1.6.0"])
+  gem.add_dependency(%<rspec>, [">= 2.3.0"])
+  # dependencies defined in Gemfile
+end
+Jeweler::GemcutterTasks.new
+
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/big_bucks_no_whammies.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{big_bucks_no_whammies}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Jim Jones}]
+  s.date = %q{2011-08-22}
+  s.description = %q{Auto-generate a pdf invoice utilizing your git commit activity. Time is automatically accounted for utilizing TimeSink and is proportionately applied towards each line item entry. }
+  s.email = %q{jjones@aantix.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "big_bucks_no_whammies.gemspec",
+    "lib/adapters/base/activities.rb",
+    "lib/adapters/base/activity.rb",
+    "lib/adapters/base/billable.rb",
+    "lib/adapters/base/commit.rb",
+    "lib/adapters/base/commits.rb",
+    "lib/adapters/base/meeting.rb",
+    "lib/adapters/chrometa.rb",
+    "lib/adapters/csv_file.rb",
+    "lib/adapters/git.rb",
+    "lib/adapters/time_estimators/number_of_source_commits.rb",
+    "lib/adapters/time_estimators/number_of_sources_changes.rb",
+    "lib/adapters/time_estimators/recorded_activity.rb",
+    "lib/adapters/time_sink.rb",
+    "lib/big_bucks_no_whammies.rb",
+    "lib/utils/date_time_utils.rb",
+    "lib/utils/invoice_display_utils.rb",
+    "lib/utils/line_item_utils.rb",
+    "sample_report.pdf",
+    "spec/big_bucks_no_whammies_spec.rb",
+    "spec/csv_file_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aantix/big_bucks_no_whammies}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}, %q{lib/adapters}, %q{lib/adapters/base}, %q{lib/adapters/time_estimators}, %q{lib/adapters/utils}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Big Bucks No Whammies allows software development contractors to generate a line-item invoice based on git commits. Activity}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<big_bucks_no_whammies>, [">= 0"])
+      s.add_runtime_dependency(%q<grit>, [">= 2.4.1"])
+      s.add_runtime_dependency(%q<payday>, [">= 1.0.2"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 2.3.0"])
+    else
+      s.add_dependency(%q<big_bucks_no_whammies>, [">= 0"])
+      s.add_dependency(%q<grit>, [">= 2.4.1"])
+      s.add_dependency(%q<payday>, [">= 1.0.2"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    end
+  else
+    s.add_dependency(%q<big_bucks_no_whammies>, [">= 0"])
+    s.add_dependency(%q<grit>, [">= 2.4.1"])
+    s.add_dependency(%q<payday>, [">= 1.0.2"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+  end
+end
+

data/lib/adapters/base/activities.rb

@@ -0,0 +1,9 @@
+module BBNW
+  module Activities
+    attr_accessor :activities
+
+    def activities
+      @activities||=get_activities
+    end
+  end
+end

data/lib/adapters/base/activity.rb

@@ -0,0 +1,31 @@
+require 'utils/invoice_display_utils'
+
+module BBNW
+  class Activity
+    include BBNW::InvoiceDisplayUtils
+
+    attr_accessor :activity, :start_time, :end_time, :billable
+
+    def initialize(activity, start_time, end_time, billable = true)
+      @activity   = activity
+      @start_time = start_time
+      @end_time   = end_time
+      @billable   = billable
+    end
+
+    def total_seconds
+      (@end_time - @start_time) rescue 0
+    end
+
+    def self.roundup(time_in_seconds, nearest = 15) # nearest 15 minutes/900 seconds
+      nearest_in_seconds = nearest * 60
+      time_in_seconds % nearest_in_seconds == 0 ? time_in_seconds : time_in_seconds + nearest_in_seconds - (time_in_seconds % nearest_in_seconds)
+    end
+
+    def self.rounddown(time_in_seconds, nearest = 15) # nearest 15 minutes/900 seconds
+      nearest_in_seconds = nearest * 60
+      time_in_seconds % nearest_in_seconds == 0 ? time_in_seconds : time_in_seconds - (time_in_seconds % nearest_in_seconds)
+    end
+
+  end
+end

data/lib/adapters/base/billable.rb

@@ -0,0 +1,17 @@
+module BBNW
+  class Billable
+    attr_accessor :descriptions, :total_time
+
+    def initialize
+      @descriptions = []
+      @total_time   = 0
+    end
+
+    def all_descriptions(header = "")
+      descriptions = "#{header}\n\n"
+      descriptions+= @descriptions.join("\n\n")
+      descriptions
+    end
+
+  end
+end

data/lib/adapters/base/commit.rb

@@ -0,0 +1,33 @@
+require 'time'
+
+module BBNW
+  class Commit
+    attr_reader :commit_id, :message, :committer, :timestamp, :total_changes
+
+    def initialize(commit_id, message, committer, timestamp, total_changes = 0)
+      @commit_id     = commit_id
+      @message       = message
+      @committer     = committer
+      @timestamp     = timestamp.is_a?(String) ? Time.parse(timestamp) : timestamp
+      @total_changes = total_changes
+    end
+
+    def start_time
+      @timestamp
+    end
+    def end_time
+      @timestamp
+    end
+    def activity
+      @message
+    end
+    # Looks for an integer > 5 chars as the task_id
+    def task_id
+      if message =~ /(\d{6,})/
+        return $1.to_i
+      end
+      nil
+    end
+
+  end
+end

data/lib/adapters/base/commits.rb

@@ -0,0 +1,9 @@
+module BBNW
+  module Commits
+    attr_accessor :commits
+
+    def self.included(base)
+      @commits = []
+    end
+  end
+end

data/lib/adapters/base/meeting.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+module BBNW
+  class Meeting
+    attr_reader :message, :start_time, :end_time
+
+    def initialize(message, start_time, end_time, account_for = true)
+      @message     = message
+      @start_time  = start_time
+      @end_time    = end_time
+      @account_for = account_for
+    end
+
+    def elapsed
+      @account_for ? (@end_time - @start_time) : 0
+    end
+
+    def total_seconds
+      elapsed
+    end
+
+    def timestamp
+      start_time
+    end
+
+    def task_id
+      nil
+    end
+
+  end
+end

data/lib/adapters/chrometa.rb

@@ -0,0 +1,98 @@
+require "uri"
+require 'cgi'
+require "net/https"
+require "rexml/document"
+require 'base/activities'
+require 'base/activity'
+require 'date'
+
+module BBNW
+
+  class Chrometa
+    include BBNW::Activities
+
+    def initialize(email, token, clients, projects, start_date, end_date, debug = false)
+      @email      = email
+      @token      = token
+      @start_date = start_date.is_a?(String) ? Date.parse(start_date) : start_date
+      @end_date   = end_date.is_a?(String) ? Date.parse(end_date) : end_date
+      @debug      = debug
+
+      @clients    = clients.is_a?(String) ? [clients] : clients
+      @projects   = projects.is_a?(String) ? [projects] : projects
+
+    end
+
+    def log(message)
+      puts message if @debug
+    end
+
+    def get_activities
+      activities   = []
+      current_date = @start_date
+      while current_date <= @end_date
+        url = URI.parse("https://api.chrometa.com/api/report")
+        params = {"date" => current_date.strftime("%m/%d/%Y")}
+        req = Net::HTTP::Post.new(url.path)
+        req.basic_auth @email, @token
+        req.set_form_data(params)
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        resp = http.start { |http| http.request(req) }
+
+        body = resp.body.clone
+
+        xml  = REXML::Document.new(body)
+        log "==================="
+        log "date  : #{current_date}"
+        log "Body  : #{body}"
+        log "==================="
+
+        root = xml.elements["chrometa-info"]
+
+        log "Email : #{root.attributes["email"]}"
+        log "Date  : #{root.attributes["date"]}"
+
+        root.elements.each do |client|
+          log "  Client Name : #{client.attributes["name"]}"
+
+          next unless (@clients.blank? || @clients.include?(client.attributes["name"]))
+
+          client.elements.each do |project|
+            log "    Project Name : #{project.attributes["name"]}"
+            log "    Project Rate : #{project.attributes["rate"]}"
+
+            next unless (@projects.blank? || @projects.include?(project.attributes["name"]))
+
+            project.elements.each do |time_entry|
+              start_time     = Time.parse(time_entry.attributes["timestamp"])
+              end_time       = start_time + time_entry.attributes["seconds"].to_i
+
+              activity_entry = BBNW::Activity.new(time_entry.attributes["activity"],
+                                                  start_time, end_time)
+              activities << activity_entry
+              log "      Application : #{time_entry.attributes['application']}"
+              log "      Timestamp   : #{time_entry.attributes['timestamp']}"
+              log "      Activity    : #{time_entry.attributes['activity']}"
+              log "      URL         : #{time_entry.attributes['url']}"
+              log "      Seconds     : #{time_entry.attributes['seconds']}"
+              log "      Billable    : #{time_entry.attributes['billable']}"
+            end
+
+          end
+        end
+        current_date+=1
+      end
+
+      File.open('chrometa.csv', 'w') do |f|
+        activities.each do |activity|
+          f.puts("#{CGI.escapeHTML(activity.activity)},#{activity.start_time},#{activity.end_time}")
+        end
+      end
+
+      activities
+    end
+
+  end
+end

data/lib/adapters/csv_file.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'base/activities'
+require 'base/activity'
+require 'utils/date_time_utils'
+require 'csv'
+
+module BBNW
+
+  class CsvFile
+    include BBNW::Activities
+    include BBNW::DateTimeUtils
+
+    def initialize(file_path, columns = [0,1,2], debug = false)
+      @files      = Dir.glob(file_path)
+      @columns    = columns
+    end
+
+    def log(message)
+      puts message if @debug
+    end
+
+    def get_activities
+      activities = []
+      blank_time = Time.at(0.0)
+
+      @files.each do |file|
+        csv     = CSV::parse(File.open(file) { |f| f.read })
+        headers = csv.shift
+
+        csv.each_with_index do |row, i|
+          activity    = row[@columns[0]]
+          s           = row[@columns[1]]
+          e           = row[@columns[2]]
+
+          start_time  = parse_time(s)
+          next if start_time == blank_time
+
+          end_time    = parse_time(e)
+          next if end_time == blank_time
+
+          time_entry  = BBNW::Activity.new(activity, start_time, end_time)
+          activities << time_entry
+        end
+      end
+      activities
+    end
+  end
+
+end

data/lib/adapters/git.rb

@@ -0,0 +1,51 @@
+require 'grit'
+require 'base/commit'
+require 'base/commits'
+require 'cgi'
+
+module BBNW
+  class GitRepos
+    include BBNW::Commits
+
+    attr_accessor :commits
+
+    def initialize(working_dir, committer = nil, start_date = nil, end_date = nil, debug = false)
+      @git = Grit::Repo.new(working_dir)
+
+      @committer  = committer
+      @start_date = start_date
+      @end_date   = end_date
+    end
+
+    def commits
+      @commits||=get_commits
+    end
+
+    def total_changes(commit)
+      total = 0
+      stats = commit.stats
+      stats.files.each do |f|
+        total+=f[3]
+      end
+      total
+    end
+
+    def get_commits
+      user_commits = []
+      commits      = @git.commits_since('master',@start_date.strftime("%Y-%m-%d"))
+      start_date   =  Time.new(@start_date.year, @start_date.month, @start_date.day, 0, 0, 0)
+      end_date     =  Time.new(@end_date.year, @end_date.month, @end_date.day, 23, 59, 59)
+
+      commits.each do |commit|
+        if (commit.author.to_s =~ /#{@committer}/i || @committer.nil?) &&
+           (start_date.nil? || commit.committed_date >= start_date) &&
+           (end_date.nil? || commit.committed_date <= end_date)
+          user_commits << BBNW::Commit.new(commit.id, commit.message, commit.committer.to_s, commit.committed_date, total_changes(commit))
+        end
+      end
+
+      user_commits
+    end
+
+  end
+end

data/lib/adapters/time_estimators/number_of_source_commits.rb

@@ -0,0 +1,34 @@
+require 'utils/invoice_display_utils'
+
+module BBNW
+  class NumberOfSourceCommits
+    extend BBNW::InvoiceDisplayUtils
+
+    def self.line_items(activities_span, repository_adapter, meetings = {})
+      line_items                 = {}
+      task_ids_commits           = {}
+
+      activities_span_in_seconds = activities_span * 3600
+      meetings.each {|m, time_elapsed| activities_span_in_seconds-=time_elapsed}
+
+      commits    = repository_adapter.commits
+      return line_items if commits.size == 0
+
+      commits.each do |commit|
+        task_id = commit.task_id
+        task_id = short_date(commit.timestamp) if task_id.nil?
+        task_ids_commits[task_id]||=[]
+        task_ids_commits[task_id] << commit
+      end
+
+      fraction_of_work = activities_span_in_seconds / commits.size
+
+      task_ids_commits.each do |task_id, task_commits|
+        task_commits.each {|tc| line_items[tc] = fraction_of_work }
+      end
+
+      line_items
+    end
+
+  end
+end

data/lib/adapters/time_estimators/number_of_sources_changes.rb

@@ -0,0 +1,38 @@
+require 'utils/invoice_display_utils'
+
+module BBNW
+  class NumberOfSourceChanges
+    extend BBNW::InvoiceDisplayUtils
+
+    def self.line_items(activities_span, repository_adapter, meetings = {})
+      line_items       = {}
+      task_ids_commits = {}
+
+      activities_span_in_seconds = activities_span * 3600
+
+      commits    = repository_adapter.commits
+      return line_items if commits.size == 0
+
+      changes_count    = 0
+      meetings.each {|m, time_elapsed| activities_span_in_seconds-=time_elapsed}
+
+      commits.each do |commit|
+        task_id = commit.task_id
+        task_id = short_date(commit.timestamp) if task_id.nil?
+        task_ids_commits[task_id]||=[]
+        task_ids_commits[task_id] << commit
+        changes_count+=commit.total_changes
+      end
+
+      meetings.each {|m,duration|  activities_span_in_seconds-=duration }
+
+      fraction_of_work = activities_span_in_seconds / changes_count
+
+      task_ids_commits.each do |task_id, task_commits|
+        task_commits.each {|tc| line_items[tc] = (fraction_of_work * tc.total_changes)}
+      end
+
+      line_items
+    end
+  end
+end

data/lib/adapters/time_estimators/recorded_activity.rb

@@ -0,0 +1,138 @@
+require 'utils/invoice_display_utils'
+
+module BBNW
+  class RecordedActivity
+    extend BBNW::InvoiceDisplayUtils
+
+    def self.line_items(activities_span, repository_adapter, meetings = {})
+      line_items     = {}
+      activities     = activities_span.activities
+      commits        = repository_adapter.commits
+
+      all_activity   = activities.concat(commits)
+      all_activity.sort! { |a, b| a.end_time <=> b.end_time }
+
+      activity_block = []
+      current_time   = all_activity.first.end_time
+
+      all_activity.each_with_index do |activity, index|
+        if day_changed?(activity, current_time)
+          record_daily_activity(activity_block, line_items, all_activity, current_time, index)
+          current_time = activity.end_time
+        end
+
+        if activity.is_a?(BBNW::Activity)
+          activity_block << activity
+        elsif activity.is_a?(BBNW::Commit)
+          record_activities(activity_block, line_items, activity)
+        end
+
+        debug_output(activity)
+      end
+
+      line_items
+    end
+
+    private
+    def self.record_daily_activity(activity_block, line_items, all_activity, current_time, index)
+      message   = ""
+      commit_id = ""
+      committer = nil
+
+      if activity_block.size == 0
+        message = "No activity."
+      else
+        upcoming_commit = upcoming_commit(all_activity, index)
+        if upcoming_commit.nil?
+          message   = "Work in progress.."
+        else
+          task_id   = upcoming_commit.task_id
+          commit_id = upcoming_commit.commit_id
+
+          message   = "Work towards story # #{task_id} (#{upcoming_commit.commit_id})" unless task_id.nil?
+          message   = "Work towards commit #{upcoming_commit.commit_id}" if task_id.nil?
+          committer = upcoming_commit.committer
+        end
+      end
+      daily_incomplete_commit = BBNW::Commit.new(commit_id, message, committer, current_time)
+
+      line_items[daily_incomplete_commit]||=[]
+      line_items[daily_incomplete_commit].concat(activity_block)
+      activity_block.clear
+
+      daily_incomplete_commit
+    end
+
+    def self.upcoming_commit(all_activity, index)
+      start_index = index + 1
+      while (start_index < all_activity.size) do
+        return all_activity[start_index] if all_activity[start_index].is_a?(BBNW::Commit)
+        start_index+=1
+      end
+      nil
+    end
+
+    def self.record_activities(activity_block, line_items, commit)
+      line_items[commit]||=[]
+      line_items[commit].concat(activity_block)
+      activity_block.clear
+      commit
+    end
+
+    def self.day_changed?(activity, current_time)
+      end_time = activity.end_time
+      !(current_time.year == end_time.year && current_time.day == end_time.day && current_time.month == end_time.month)
+    end
+
+    def self.debug_output(activity)
+      if activity.is_a?(BBNW::Activity)
+        puts "#{activity.start_time},#{activity.end_time},#{activity.activity}"
+      elsif activity.is_a?(BBNW::Commit)
+        puts "---------------------------------------------"
+        puts "Commit : #{activity.start_time},#{activity.end_time},#{activity.activity}"
+        puts "---------------------------------------------"
+      end
+    end
+
+  end
+
+end
+
+
+# Example data :
+#
+#2011-05-26 04:38:47 -0700,2011-05-26 04:38:52 -0700,1. Cypress Server (cc1)
+#2011-05-26 04:38:47 -0700,2011-05-26 04:38:49 -0700,https://www.pivotaltracker.com/signin
+#2011-05-26 04:38:47 -0700,2011-05-26 04:38:52 -0700,1. Cypress Server (git)
+#2011-05-26 04:38:47 -0700,2011-05-26 04:42:48 -0700,Searching "Inbox"
+#2011-05-26 04:38:47 -0700,2011-05-26 04:39:22 -0700,db/schema.rb at master from manilla/redwood - GitHub
+#2011-05-26 04:38:47 -0700,2011-05-26 04:38:52 -0700,manilla/redwood at master - GitHub
+#2011-05-26 04:38:47 -0700,2011-05-26 04:39:51 -0700,1. Cypress Server (bash)
+#2011-05-26 04:38:47 -0700,2011-05-26 04:40:22 -0700,1. Cypress Server (ruby)
+#2011-05-26 04:38:47 -0700,2011-05-26 04:39:01 -0700,app/models/cypress_mailer.rb at master from manilla/redwood - GitHub
+#2011-05-26 04:38:47 -0700,2011-05-26 04:38:57 -0700,1. Cypress Worker (ruby)
+#2011-05-26 04:38:47 -0700,2011-05-26 04:39:40 -0700,2. nano
+#2011-05-26 04:38:47 -0700,2011-05-26 04:39:02 -0700,manilla/redwood - GitHub
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:17 -0700,2. sh
+#2011-05-26 03:39:12 -0700,2011-05-26 03:40:25 -0700,Git Cherry Picking: Move small code patches across branches | TechnoSophos
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:17 -0700,2. gnumake
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:14 -0700,Warning: Unresponsive script
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:17 -0700,Problem loading page
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:32 -0700,Re: Remote Redwood branch clean up
+#2011-05-26 03:39:12 -0700,2011-05-26 03:39:17 -0700,2. gcc-4.2
+#---------------------------------------------
+#2011-05-26 01:23:03 -0700,2011-05-26 01:23:03 -0700,Merge branch 'feature-13269583-require_comments_on_robot_revisions' [13269583]
+#---------------------------------------------
+#---------------------------------------------
+#2011-05-26 01:19:50 -0700,2011-05-26 01:19:50 -0700,User is now prompted for a comment before publishing to production.  Comment is displayed in the show fields along with an icon next to the entry in the similar robots table. [13269583]
+#---------------------------------------------
+#---------------------------------------------
+#2011-05-25 21:33:31 -0700,2011-05-25 21:33:31 -0700,Merge branch 'master' of github.com:manilla/redwood [13269479]
+#---------------------------------------------
+#2011-05-25 16:13:28 -0700,2011-05-25 16:23:33 -0700,git_merge_fails.txt — jimjones
+#2011-05-25 16:13:28 -0700,2011-05-25 16:13:33 -0700,git cherry pick - Google Search
+#2011-05-25 16:13:28 -0700,2011-05-25 16:16:33 -0700,index.html — jquery.fancybox-1.3.4
+#2011-05-25 16:13:28 -0700,2011-05-25 16:21:59 -0700,
+#2011-05-25 16:13:28 -0700,2011-05-25 17:13:37 -0700,RubyMine
+#2011-05-25 16:13:28 -0700,2011-05-25 16:13:54 -0700,Action Controller: Exception caught
+#2011-05-25 16:13:28 -0700,2011-05-25 16:36:06 -0700,Redwood

data/lib/adapters/time_sink.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'base/activities'
+require 'base/activity'
+require 'utils/date_time_utils'
+require 'csv'
+
+module BBNW
+
+  class TimeSink
+    include BBNW::Activities
+    include BBNW::DateTimeUtils
+
+    APPLICATION = 0
+    START_TIME  = 1
+    END_TIME    = 2
+    TIME_SINK_HEADERS = {'Application'                  => APPLICATION,
+                         'Foreground Begin (Unix Time)' => START_TIME,
+                         'Foreground End (Unix Time)'   => END_TIME}
+
+
+    def initialize(file_path, start_date, end_date, debug = false)
+      @files      = Dir.glob(file_path)
+      @debug      = debug
+      @start_date =  Time.new(start_date.year, start_date.month, start_date.day, 0, 0, 0)
+      @end_date   =  Time.new(end_date.year, end_date.month, end_date.day, 23, 59, 59)
+    end
+
+    def log(message)
+      puts message if @debug
+    end
+
+    def columns(header)
+      hs = {}
+      TIME_SINK_HEADERS.each do |k,v|
+        header.each_with_index do |header_item,i|
+          if header_item == k
+            hs[v] = i
+            break
+          end
+        end
+      end
+      hs
+    end
+
+    def get_activities
+      activities = []
+      prev_e     = nil
+      blank_time = Time.at(0.0)
+
+      @files.each do |file|
+        csv     = CSV::parse(File.open(file) { |f| f.read })
+        headers = csv.shift
+        cols    = columns(headers)
+
+        csv.each_with_index do |row, i|
+          activity    = row[cols[APPLICATION]]
+          s           = row[cols[START_TIME]]
+          e           = row[cols[END_TIME]]
+
+          next unless prev_e.nil? ||  s >= prev_e
+
+          start_time  = parse_time(s)
+          #next if start_time == blank_time
+
+          end_time    = parse_time(e)
+          #next if end_time == blank_time
+
+          next if end_time < @start_date
+          next if start_time > @end_date
+          #start_time = @start_date if start_time < @start_date && end_time < @end_date
+          #end_time   = @end_date if start_time > @start_date && end_time > @end_date
+
+          time_entry  = BBNW::Activity.new(activity, start_time, end_time)
+          activities << time_entry
+
+          prev_e      = e
+        end
+      end
+      activities
+    end
+  end
+
+end

data/lib/big_bucks_no_whammies.rb

@@ -0,0 +1,95 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'adapters', '*.rb')).each {|f| require f }
+Dir.glob(File.join(File.dirname(__FILE__), 'adapters', 'base', '*.rb')).each {|f| require f }
+Dir.glob(File.join(File.dirname(__FILE__), 'adapters', 'time_estimators', '*.rb')).each {|f| require f }
+Dir.glob(File.join(File.dirname(__FILE__), 'utils', '*.rb')).each {|f| require f }
+
+require 'payday'
+
+module BBNW
+  class Invoice
+    include InvoiceDisplayUtils
+
+    attr_accessor :line_items
+
+    def initialize
+      @meetings = {}
+    end
+
+    # Usage :
+    #   Compute time usage % over a 20 hour span
+    #
+    #     line_items(git_commits, 20)
+    #
+    #   Compute time usage using recorded time activities
+    #   and cross reference that with git commits.
+    #
+    #     line_items(git_commits, time_sink_activities)
+    #
+    def line_items(repository_adapter, activities_span, time_estimate_adapter, group_by_task_id = true)
+      @line_items = time_estimate_adapter.line_items(repository_adapter, activities_span, @meetings)
+
+      @line_items = BBNW::LineItemUtils.group_line_items(@line_items, {}, group_by_task_id)
+      @line_items = BBNW::LineItemUtils.group_line_items(@meetings, @line_items, group_by_task_id)
+    end
+
+    def generate(invoice_num, company_logo, company_name,
+                 company_details, bill_to, rate_per_hour, start_date = nil, end_date = nil, hours = nil)
+
+      raise "There are not line items to generate a report with." if @line_items.empty?
+
+      rate_per_second = rate_per_hour / 3600.to_f
+      Payday::Config.default.invoice_logo    = company_logo
+      Payday::Config.default.company_name    = company_name
+      Payday::Config.default.company_details = company(company_details, start_date, end_date, hours)
+
+      due_date      = Date.today + 21
+      invoice       = Payday::Invoice.new(:invoice_number => invoice_num,
+                                          :bill_to        => bill_to.join("\n"),
+                                          :due_at         => due_date)
+
+      display_price = display_price(rate_per_hour)
+
+      build_line_item_report(display_price, invoice, rate_per_second, Fixnum)
+      build_line_item_report(display_price, invoice, rate_per_second, String)
+
+      invoice.render_pdf_to_file(invoice_path(invoice_num, bill_to[0]))
+    end
+
+    def meeting(label, start_time, end_time, account_for)
+      s = Time.parse(start_time)
+      e = Time.parse(end_time)
+      meeting_label = "Meeting (#{short_time(s)} - #{short_time(e)}): #{label}"
+      time_span = account_for ? (e - s) : 0
+      @meetings[BBNW::Meeting.new(meeting_label, s, e, account_for)] = time_span
+    end
+
+    def task(label, start_time, end_time)
+      s = Time.parse(start_time)
+      e = Time.parse(end_time)
+      label = "Task : #{label}"
+      @meetings[BBNW::Meeting.new(label, s, e)] = e - s
+    end
+
+    private
+
+    def build_line_item_report(display_price, invoice, rate_per_second, typ = nil)
+      @line_items.each do |task_id, billable_item|
+        next unless typ.nil? || task_id.is_a?(typ)
+        time_elapsed, minutes, hours = time_description(billable_item.total_time)
+        head = header(task_id)
+
+        invoice.line_items << Payday::LineItem.new(:price            => rate_per_second,
+                                                   :quantity         => billable_item.total_time,
+                                                   :display_quantity => time_elapsed,
+                                                   :display_price    => display_price,
+                                                   :description      => billable_item.all_descriptions(head))
+      end
+    end
+
+    def invoice_path(invoice_num, company_name)
+      "./#{company_name.gsub(' ','_').gsub("'",'').gsub(',','').downcase}_#{invoice_num}.pdf"
+    end
+
+  end
+end
+

data/lib/utils/date_time_utils.rb

@@ -0,0 +1,42 @@
+module BBNW
+  module DateTimeUtils
+    def short_date(time)
+      "#{Date::DAYNAMES[time.wday]}, #{Date::ABBR_MONTHNAMES[time.month]} #{time.mday}"
+    end
+
+    def long_date(time)
+      "#{Date::DAYNAMES[time.wday]}, #{Date::ABBR_MONTHNAMES[time.month]} #{time.mday}, #{time.year}"
+    end
+
+    def short_time(time)
+      time.strftime("%I:%M %P")
+    end
+
+    def long_time(time)
+      time.strftime("%I:%M.%S %P")
+    end
+
+    def long_date_time(time)
+      "#{long_date(time)} #{long_time(time)}"
+    end
+
+    def is_number?(v)
+      true if Float(v) rescue false
+    end
+
+    def parse_time(s)
+      # If it's a number, it's probably a UNIX style timestamp, otherwise parse the string
+      is_number?(s) ? Time.at(s.to_f) : Time.parse(s)
+    end
+
+    def time_description(time)
+      hours   = (time / 3600).to_i
+      minutes = (time / 60 - hours * 60).to_i
+      seconds = (time - (minutes * 60 + hours * 3600))
+
+      display = "#{minutes} minutes"
+      display = "#{hours} hours, #{display}" if hours > 0
+      return display, minutes, hours
+    end
+  end
+end

data/lib/utils/invoice_display_utils.rb

@@ -0,0 +1,27 @@
+require File.join(File.join(File.dirname(__FILE__),'date_time_utils'))
+
+module BBNW
+  module InvoiceDisplayUtils
+    include BBNW::DateTimeUtils
+
+    def header(task_id)
+      task_id.is_a?(Integer) ? "Story #: #{task_id}" : task_id
+    end
+
+    def display_price(price)
+      display_price = "$#{price}"
+      "#{display_price}.00" unless price =~ /./
+    end
+
+    def message_display(billed_commit)
+      "( #{billed_commit.timestamp} )\t#{billed_commit.message}"
+    end
+
+    def company(details, start_date, end_date, hours)
+      details << "\n\n#{long_date(start_date)} - #{long_date(end_date)}" unless start_date.nil? || end_date.nil?
+      details << "\nBillable : #{hours} hours" unless hours.nil?
+      details.join("\n")
+    end
+
+  end
+end

data/lib/utils/line_item_utils.rb

@@ -0,0 +1,40 @@
+require 'adapters/base/billable'
+require 'utils/invoice_display_utils'
+
+module BBNW
+  class LineItemUtils
+    MAX_IDLE = 900
+    extend BBNW::InvoiceDisplayUtils
+
+    def self.group_line_items(line_items, prev_line_items = {}, group_by_task_id = true)
+      grouped_line_items = prev_line_items.clone
+
+      line_items.each do |billed_commit, activities|
+
+        # Let's look for a long numeric ID and group by that; if it doesn't exist
+        #   Add the commit item as it's own line item (hence the random id).
+        task_id = "== #{short_date(billed_commit.timestamp)} =="
+        task_id = billed_commit.task_id if group_by_task_id
+
+        billable_item = grouped_line_items.has_key?(task_id) ? grouped_line_items[task_id] : BBNW::Billable.new
+
+        billable_item.total_time+=(activities.is_a?(Array) ? billed_seconds(activities) : activities)
+        billable_item.descriptions << billed_commit.message
+        grouped_line_items[task_id] = billable_item
+      end
+
+      grouped_line_items
+    end
+
+    def self.billed_seconds(activities)
+      seconds = 0
+      activities.each do |activity|
+        time_elapsed = activity.total_seconds
+        time_elapsed = MAX_IDLE if time_elapsed > MAX_IDLE
+        seconds += time_elapsed
+      end
+      seconds
+    end
+
+  end
+end

data/spec/big_bucks_no_whammies_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "BigBucksNoWhammies" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/csv_file_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe BBNW::CsvFile do
+  describe "#get_activities" do
+    it "should convert each line in the CSV into an Activity" do
+      end_date = Time.now
+      start_date = end_date + 10
+
+      puts start_date.to_s
+
+      fake_row = ['rubymine', start_date.to_s, end_date.to_s]
+      CSV.stub!(:open).with("foo", 'r').and_yield(fake_row)
+
+      csv_file = BBNW::CsvFile.new("foo", nil, nil)
+#      csv_file.get_activities.should == [
+#        BBNW::Activity.new('rubymine', start_date, end_date)
+#      ]
+      activities = csv_file.get_activities
+      activities.should be_an(Array)
+      activities.should have(1).activity
+      activity = activities.first
+      activity.start_time.to_s.should == start_date.to_s
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'big_bucks_no_whammies'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: big_bucks_no_whammies
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jim Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: big_bucks_no_whammies
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: payday
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: "Auto-generate a pdf invoice utilizing your git commit activity. Time is automatically accounted for utilizing TimeSink and is proportionately applied towards each line item entry. "
+email: jjones@aantix.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- big_bucks_no_whammies.gemspec
+- lib/adapters/base/activities.rb
+- lib/adapters/base/activity.rb
+- lib/adapters/base/billable.rb
+- lib/adapters/base/commit.rb
+- lib/adapters/base/commits.rb
+- lib/adapters/base/meeting.rb
+- lib/adapters/chrometa.rb
+- lib/adapters/csv_file.rb
+- lib/adapters/git.rb
+- lib/adapters/time_estimators/number_of_source_commits.rb
+- lib/adapters/time_estimators/number_of_sources_changes.rb
+- lib/adapters/time_estimators/recorded_activity.rb
+- lib/adapters/time_sink.rb
+- lib/big_bucks_no_whammies.rb
+- lib/utils/date_time_utils.rb
+- lib/utils/invoice_display_utils.rb
+- lib/utils/line_item_utils.rb
+- sample_report.pdf
+- spec/big_bucks_no_whammies_spec.rb
+- spec/csv_file_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aantix/big_bucks_no_whammies
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib/adapters
+- lib/adapters/base
+- lib/adapters/time_estimators
+- lib/adapters/utils
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Big Bucks No Whammies allows software development contractors to generate a line-item invoice based on git commits. Activity
+test_files: []
+