pivotal_reporting 1.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'pivotal-tracker'
+
+group :development do
+  gem 'jeweler', '~> 1.8.3'
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    git (1.2.5)
+    happymapper (0.4.0)
+      libxml-ruby (~> 2.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    libxml-ruby (2.2.2)
+    mime-types (1.17.2)
+    nokogiri (1.5.0)
+    pivotal-tracker (0.4.1)
+      builder
+      builder
+      happymapper (>= 0.3.2)
+      happymapper (>= 0.3.2)
+      nokogiri (>= 1.4.3)
+      nokogiri (~> 1.4)
+      rest-client (~> 1.6.0)
+      rest-client (~> 1.6.0)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.3)
+  pivotal-tracker

data/README.md

@@ -0,0 +1,59 @@
+## Pivotal Reporting
+
+This is a simple ruby script I use to produce a weekly report on what us
+developers have been up to.
+
+### Usage
+
+    bundle exec ./bin/pivotal_report.rb -t <pivotal token> -p <project id>
+
+Where `<pivotal token>` is your pivotal API token available at the end
+of [your profile page][1], and `<project id>` is the id of your project (I
+just look at the URL when I'm examining the project, like in
+https://www.pivotaltracker.com/projects/**12345**, 12345 is the project
+id.)
+
+
+### Output
+
+You'll get four sections: Discussion Items, Story Bullets, PPU Table,
+and In Progress. The first two are specific to my team's process (we
+pre- and post- estimate stories to improve our estimation process and
+create a feedback loop for production tokens). The PPU Table and In
+Progress sections are probably generically useful.
+
+#### The PPU Table
+
+PPU is *Points Per User*. Here's an example table:
+
+                | Elvis | Frank | Ron | Bob | Bill | Reggie |  Total || Feature | Bug | Chore |
+    client      |     0 |     5 |   9 |   0 |    8 |      3 |     25 ||      22 |   0 |     3 |
+    fires       |     0 |     1 |   1 |   0 |    0 |      0 |      2 ||       0 |   1 |     1 |
+    operations  |    10 |     1 |   0 |   5 |    0 |      1 |     17 ||      12 |   2 |     3 |
+    ops:intake  |     2 |     0 |   0 |   0 |    0 |      0 |      2 ||       2 |   0 |     0 |
+    performance |     0 |     0 |   0 |   0 |    1 |      0 |      1 ||       1 |   0 |     0 |
+    servers     |     0 |     0 |   0 |   2 |    0 |      0 |      2 ||       0 |   0 |     2 |
+    sourcing    |     0 |     0 |   0 |   1 |    0 |      0 |      1 ||       0 |   0 |     1 |
+    ------------+-------+-------+-----+-----+------+--------+--------++---------+-----+-------+
+    Total       |    12 |     7 |  10 |   8 |    9 |      4 |     50 ||      37 |   3 |    10 |
+
+This table is about the stories in the most recently completed
+iteration. The first Y axis is the unique labels in the iteration, the X
+axis is first the developers who contributed and then a breakdown of
+story type. The numbers in the body of the table are the points
+allocated to that combination of label and either developer or story
+type. There are of course a pair of totals columns.
+
+This table is useful in our process of both planning for development
+capacity and monitoring usage. I take this report and add a column for
+planned points by label and over/under by label. We then use this
+analysis to discuss the tech department's future planning and modify our
+plans and expectations.
+
+#### In Progress
+
+This is just a sum of the points allocated to stories that are currently
+started, delivered, or unaccepted. I use this to show the current state
+of projects in progress during my iteration planning meeting.
+
+[1]: https://www.pivotaltracker.com/profile

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 = "pivotal_reporting"
+  gem.homepage = "http://github.com/joshsz/pivotal_reporting"
+  gem.license = "MIT"
+  gem.summary = %Q{A command-line reporting tool for @pivotaltracker}
+  gem.description = %Q{Please see the README. This tool generates some reports that could be useful if you're managing a team of developers using Pivotal Tracker}
+  gem.email = "joshsz@gmail.com"
+  gem.authors = ["Joshua Szmajda"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# require 'rspec/core'
+# require 'rspec/core/rake_task'
+# RSpec::Core::RakeTask.new(:spec) do |spec|
+#   spec.pattern = FileList['spec/**/*_spec.rb']
+# end
+
+# RSpec::Core::RakeTask.new(:rcov) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+
+# task :default => :spec
+
+# require 'rdoc/task'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "pivotal_reporting_2 #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

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

data/bin/pivotal_report

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+opts = {}
+parser = OptionParser.new do |os|
+  os.banner =<<-EOT
+Usage: pivotal_report.rb [options]
+  EOT
+
+  os.on('-t [TOKEN]', '--token [TOKEN]', 'Set API token') do |v|
+    opts[:token] = v
+  end
+
+  os.on('-p [PROJECT ID]', '--project-id [PROJECT ID]', 'Set Project ID') do |v|
+    opts[:project_id] = v
+  end
+end
+
+begin
+  parser.parse!
+  if opts[:token].nil? || opts[:project_id].nil?
+    puts parser
+    exit
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+require 'pivotal-tracker'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'pivotal_report')
+
+app = PivotalReport.new(opts)
+app.report

data/lib/pivotal_report.rb

@@ -0,0 +1,158 @@
+class PivotalTracker::Story
+  def initials
+    owned_by.split(/ /).map{|e| e[0] }.join
+  end
+end
+class PivotalReport
+  def initialize(options)
+    PivotalTracker::Client.token = options[:token]
+    @project = PivotalTracker::Project.find(options[:project_id])
+  end
+
+  POST_EST = 'epost'
+
+  def report
+    show_discussion_items
+    separator
+    show_story_bullets
+    separator
+    show_ppu_table
+    separator
+    show_stories_in_progress
+  end
+
+  def show_accounting_breakdown
+    # TODO
+    raise 'Unimplemented!'
+  end
+
+  def separator
+    puts "\n-----\n\n"
+  end
+
+  def show_discussion_items
+    puts "Discussion Items"
+    puts ""
+    estimates = stories.sort{|a,b| a.owned_by <=> b.owned_by }.map(&:labels).map{|e| e.to_s.split(/,/) }.flatten.map(&:strip).compact.uniq.select{|l| l =~ /^(#{POST_EST}|e\d)$/ }.sort
+    estimates.each do |est|
+      set = stories_with_label(est)
+      set.each do |story|
+        puts "(\e[31m#{story.estimate}\e[0m: \e[32m#{est}\e[0m) #{story.name.strip} (\e[33m#{story.initials}\e[0m) [\e[34m#{story.labels}\e[0m]"
+      end
+    end
+  end
+
+  def show_story_bullets
+    puts "Story Bullets"
+    puts ""
+    lis = nil
+    stories.sort{|a,b| a.owned_by <=> b.owned_by }.each do |story|
+      if story.initials != lis
+        lis = story.initials
+        puts "#{story.initials}:"
+      end
+      puts "#{story.story_type.to_s[0]} #{story.name.strip} (#{story.estimate} point#{story.estimate > 1 ? 's' : ''})"
+    end
+  end
+
+  def show_ppu_table
+    puts "PPU Table"
+
+    categories = stories.map(&:labels).map{|e| e.to_s.split(/,/) }.flatten.map(&:strip).compact.uniq.reject{|l| l =~ /^(#{POST_EST}|e\d)$/ }.sort
+    people = stories.map(&:owned_by).uniq.sort.map{|p| [p, p.split(/ /).first]}
+    c_width = (['Total'] + categories).map(&:length).max
+
+    sseen = []
+
+    o = []
+    o << "".ljust(c_width)
+    o << " | "
+    people.each {|p| o << p[1]; o << " | " }
+    o << " Total || Feature | Bug | Chore |"
+    puts o.join
+
+    categories.each do |cat|
+      o = []
+      o << cat.ljust(c_width)
+      o << " | "
+      people.each do |person, short|
+        o << stories_for_user(person, stories_with_label(cat)).map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust(short.length)
+        o << " | "
+      end
+      set = stories_with_label(cat)
+      sseen += set
+      o << set.map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust('Total '.length)
+      o << " || "
+      %w{feature bug chore}.each do |type|
+        o << stories_with_label(cat, stories_for_type(type)).map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust(type.length)
+        o << " | "
+      end
+      puts o.join
+    end
+
+    o = []
+    o << "-" * c_width
+    o << "-+-"
+    people.each do |person, short|
+      o << "-" * short.length
+      o << "-+-"
+    end
+    o << "-------++---------+-----+-------+"
+    puts o.join
+
+    o = []
+    o << "Total".ljust(c_width)
+    o << " | "
+    people.each do |person, short|
+      o << stories_for_user(person).map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust(short.length)
+      o << " | "
+    end
+    o << stories.map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust('Total '.length)
+    o << " || "
+    %w{feature bug chore}.each do |type|
+      o << stories_for_type(type).map(&:estimate).inject(0){|s,e| s + e }.to_s.rjust(type.length)
+      o << " | "
+    end
+    puts o.join
+
+    missing = stories - sseen
+    if missing.any?
+      puts "Missing:"
+      puts missing.map(&:name).join("\n")
+    end
+
+  end
+
+  def show_stories_in_progress
+    in_progress = @project.stories.all(:state => ['started', 'delivered'])
+    points_in_progress = in_progress.map(&:estimate).inject(0){|s,e| s+e}
+
+    puts "In Progress: #{points_in_progress} points"
+  end
+
+
+
+  private
+    def iteration
+      @iteration ||= PivotalTracker::Iteration.done(@project, :offset => '-1').first
+    end
+
+    def stories
+      @stories ||= iteration.stories
+    end
+
+    def stories_with_label(label, set=nil)
+      set ||= stories
+      set.select{|s| s.labels =~ /#{label}/ }
+    end
+
+    def stories_for_user(user, set=nil)
+      set ||= stories
+      set.select{|s| s.owned_by == user }
+    end
+
+    def stories_for_type(type, set=nil)
+      set ||= stories
+      set.select{|s| s.story_type == type }
+    end
+end

data/pivotal_reporting.gemspec

@@ -0,0 +1,50 @@
+# 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 = "pivotal_reporting"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Szmajda"]
+  s.date = "2012-02-07"
+  s.description = "Please see the README. This tool generates some reports that could be useful if you're managing a team of developers using Pivotal Tracker"
+  s.email = "joshsz@gmail.com"
+  s.executables = ["pivotal_report"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/pivotal_report",
+    "lib/pivotal_report.rb",
+    "pivotal_reporting.gemspec"
+  ]
+  s.homepage = "http://github.com/joshsz/pivotal_reporting"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A command-line reporting tool for @pivotaltracker"
+
+  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<pivotal-tracker>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<pivotal-tracker>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<pivotal-tracker>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: pivotal_reporting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Szmajda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: &21831180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21831180
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &21830700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *21830700
+description: Please see the README. This tool generates some reports that could be
+  useful if you're managing a team of developers using Pivotal Tracker
+email: joshsz@gmail.com
+executables:
+- pivotal_report
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bin/pivotal_report
+- lib/pivotal_report.rb
+- pivotal_reporting.gemspec
+homepage: http://github.com/joshsz/pivotal_reporting
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1627381237856098628
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A command-line reporting tool for @pivotaltracker
+test_files: []