tpscript 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9239fce751b676a3dc58d6ac0cc61d5d1f0c5545
+  data.tar.gz: a211c7b9bd46f62807fd14335549a1f299ff1220
+SHA512:
+  metadata.gz: 505a7a4a2b6a8e873a4efc62d346a6e9959e64dd6471106c677cc6233e887795c176237c2b3e8358c80f2d87e82a0c98f8d85a9ca71f0bf57a7a1e4c67fd4480
+  data.tar.gz: bd765a20e32aed54d9c26315bee9fda67eb8fd7336ae91588090074cf5beed3ff76c9dcb8d0605b6213ffe38d35109340afb6b91ae3fa0e73e5a23380ab2440b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.json
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tpscript.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Fliri
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# tpscript
+
+Scripts for TargetProcess
+
+## Cumulative flow
+
+Extracts from TargetProcess the cumulative flow for a specific team, and prints it in CSV format.
+
+From the repository main directory, run:
+
+    ./cumulative_flow -t <a TP team> -b <TP base url> -u <TP username> -p <TP password>
+
+The team must be provided as the abbreviation assigned to it in TargetProcess.
+
+*Example:*
+
+    ./cumulative_flow -t XYZ -b https://mytpurl -u bob -p agqywq865q
+
+### Select specific states
+
+It is possible to include only specific states in the result, and to define a specific order for them.
+To do this, add the `--states` option with the names of the states you want, separated by commas.
+
+    ./cumulative_flow -t XYZ -b https://mytpurl -u bob -p agqywq865q \
+            --states 'State one,State two,State three'
+
+### Iteration day
+
+Iteration start day can be defined using the `--day` option.
+
+    ./cumulative_flow -t XYZ -b https://mytpurl -u bob -p agqywq865q --day wednesday

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cumulative_flow

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/target_process'
+require_relative '../lib/enumerable_ext'
+require_relative '../lib/cli'
+require_relative '../lib/cumulative_flow'
+
+options = Cli.options!
+
+tp = TargetProcess.new(username: options[:username], password: options[:password], base_uri: options[:base_uri])
+
+stories = tp.user_stories(options[:team])
+history = stories.flat_map {|s| tp.story_history(s["Id"]) }
+
+puts CumulativeFlow.new(history, iteration_start: options[:day], states: options[:states]).to_csv

data/lib/cli.rb

@@ -0,0 +1,46 @@
+require 'optparse'
+
+module Cli
+
+  def self.options!(args = ARGV)
+
+    options = {}
+
+    OptionParser.new do |opts|
+      opts.banner = <<-STRING.gsub(/^ +/, '')
+      Extracts from TargetProcess the cumulative flow for a specific team, and prints it in CSV format
+
+      Usage:   #{$PROGRAM_NAME} [options]
+
+      STRING
+
+      opts.on("-t", "--team TEAM_ABBREVIATION", "(required) select a team to filter the data") do |team|
+        options[:team] = team
+      end
+
+      opts.on("-u", "--username USERNAME", "(required) username to log on TargetProcess") do |username|
+        options[:username] = username
+      end
+
+      opts.on("-p", "--password PASSWORD", "(required) password to log on TargetProcess") do |password|
+        options[:password] = password
+      end
+
+      opts.on("-b", "--base-uri URI", "(required) URI of TargetProcess") do |uri|
+        options[:base_uri] = uri
+      end
+
+      opts.on("--states STATES", "included states, separated by commas") do |states|
+        options[:states] = states.split(',').map(&:chomp)
+      end
+
+      options[:day] = "tuesday"
+      opts.on("-d", "--day DAY", %w{monday tuesday wednesday thursday friday saturday sunday},
+              "day of week used as iteration start (defaults to tuesday)") do |day|
+        options[:day] = day
+      end
+    end.parse!(args)
+
+    options
+  end
+end

data/lib/cumulative_flow.rb

@@ -0,0 +1,46 @@
+require 'csv'
+require 'date'
+require 'set'
+
+class CumulativeFlow
+
+  def initialize(user_story_history, states: nil, iteration_start: nil)
+    @data = dates(user_story_history, iteration_start).map {|date| {"Date" => date}.merge(effort_by_state(snapshot(user_story_history, date))) }
+    @states = states || all_states(user_story_history)
+  end
+
+  def to_csv
+    CSV.generate do |csv|
+      csv << [''] + @states
+      @data.each do |i|
+        csv << [ i["Date"] ] + @states.map {|state| i[state] || 0.0}
+      end
+    end
+  end
+
+  private
+
+  def snapshot(history, date)
+    history.reject {|i| i["Date"] >= date}.group_by {|i| i["UserStory"]["Id"] }.values.map {|a| a.max_by {|i| i["Date"]}}
+  end
+
+  def effort_by_state(snapshot)
+    stories_by_state = snapshot.group_by {|i| i["EntityState"]["Id"] }.values
+
+    stories_by_state.hmap do |stories|
+      state_name = stories.first["EntityState"]["Name"]
+      cumulated_effort = stories.map {|i| i["Effort"]}.reduce(:+)
+      [state_name, cumulated_effort]
+    end
+  end
+
+  def all_states(history)
+    history.reduce(Set.new) {|states, i| states << i["EntityState"]["Name"] }.to_a
+  end
+
+  def dates(history, iteration_start)
+    start = Date.parse iteration_start
+    stop = history.map {|i| i["Date"]}.min
+    dates = start.step(stop, -7).to_a.reverse
+  end
+end

data/lib/enumerable_ext.rb

@@ -0,0 +1,8 @@
+module Enumerable
+  def hmap
+    self.reduce({}) do |map, item|
+      key, value = yield item
+      map.tap {|map| map[key] = value }
+    end
+  end
+end

data/lib/target_process.rb

@@ -0,0 +1,45 @@
+require 'date'
+require 'httparty'
+require 'json'
+require 'uri'
+
+class TargetProcess
+
+  def initialize(username: nil, password: nil, base_uri: nil)
+    @username = username
+    @password = password
+    @base_uri = base_uri
+  end
+
+  def user_stories(team_abbr)
+    get_items "#{@base_uri}/api/v1/UserStories?format=json&where=Team.Abbreviation%20eq%20%27#{team_abbr}%27"
+  end
+
+  def story_history(id)
+    get_items("#{@base_uri}/api/v1/UserStories/#{id}/History?format=json").map {|i| i.tap {|i| i["Date"] = parse_date(i["Date"]) }}
+  end
+
+  private
+
+  def parse_date(date)
+    match = /\/Date\(([0-9]+)([+-][0-9]+)\)\//.match date
+    DateTime.strptime(match[1], "%Q")
+  end
+
+  def get_items(url)
+    json = get(url)
+
+    if json.has_key? "Next" then
+      json["Items"] + get_items(URI.escape(json["Next"]))
+    else
+      json["Items"]
+    end
+  end
+
+  def get(url)
+    $stderr.puts "Getting #{url}..."
+    response = HTTParty.get(url, basic_auth: {username: @username, password: @password})
+    JSON.parse(response.body)
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Tpscript
+  VERSION = "0.0.1"
+end

data/tpscript.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tpscript"
+  spec.version       = Tpscript::VERSION
+  spec.authors       = ["Max Fliri"]
+  spec.email         = ["mfliri@thoughtworks.com"]
+  spec.summary       = %q{Scripts for TargetProcess}
+  spec.description   = %q{Scripts for TargetProcess}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.required_ruby_version = "~> 2.1"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "httparty", "0.13.2"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: tpscript
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Fliri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+description: Scripts for TargetProcess
+email:
+- mfliri@thoughtworks.com
+executables:
+- cumulative_flow
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cumulative_flow
+- lib/cli.rb
+- lib/cumulative_flow.rb
+- lib/enumerable_ext.rb
+- lib/target_process.rb
+- lib/version.rb
+- tpscript.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Scripts for TargetProcess
+test_files: []