pivotalprinter 0.1.7

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+pkg
+Gemfile.lock

data/COPYING

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2010 pkw.de full name
+
+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/Gemfile

@@ -0,0 +1,5 @@
+# vim: set ft=ruby:
+
+source "http://rubygems.org"
+
+gemspec

data/History.txt

@@ -0,0 +1,18 @@
+=== 0.1.7 2011-07-19
+
+* use a newver prawn version
+
+=== 0.1.4 2011-01-20
+
+* print multiple stories by id
+* story id is now included at the sheet
+
+=== 0.1.2 2010-12-22
+
+* removed dependencies:
+  * pivotal-tracker no longer needed
+
+=== 0.0.1 2010-12-07
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/pivotalprinter
+images/bug.png
+images/chore.png
+images/feature.png
+images/release.png
+lib/pivotalprinter.rb
+lib/pivotalprinter/client.rb
+lib/pivotalprinter/story.rb
+lib/pivotalprinter/iteration.rb
+pivotalprinter.gemspec
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_pivotalprinter.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on pivotalprinter, see http://github.com/pkwde/pivotalprinter

data/README.rdoc

@@ -0,0 +1,22 @@
+= pivotalprinter
+
+* https://github.com/caroo/pivotalprinter
+
+== DESCRIPTION:
+
+Script to print use stories in pivotal printer
+
+== INSTALL:
+
+Just type
+
+    $ gem install privotalprinter
+
+
+== AUTHORS
+
+pkw.de Development Team
+
+== LICENSE:
+
+The MIT License, see the COPYING file

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/pivotalprinter

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+# inspired by from http://ephemera.karmi.cz/post/622136360/create-printable-pdf-cards-for-your-pivotal-tracker-stor
+
+require 'pivotalprinter'
+
+class String; include Term::ANSIColor; end
+
+module Pivotalprinter
+  class ConfigNeeded < StandardError; end
+  class TokenMissing < StandardError; end
+  class ProjectMissing < StandardError; end
+end
+
+module Pivotalprinter
+  class Printer
+    def run
+      opts = parse_options
+      yaml = load_yaml_config 
+      project,token = extract_config(opts, yaml)
+      Pivotalprinter::Client.project = project
+      Pivotalprinter::Client.token   = token
+      @stories = case ARGV.last
+        when "done"   : Pivotalprinter::Iteration.open('done').stories
+        when "backlog": Pivotalprinter::Iteration.open('backlog').stories
+        when /^\d+$/  : Pivotalprinter::Story.open(ARGV.map(&:to_i))
+        else Pivotalprinter::Iteration.open('current').stories
+      end
+      generate_output
+    rescue ConfigNeeded      
+      print_config
+    rescue TokenMissing
+      Trollop::die :token, "token must be specified through config file or explicitly"
+    rescue ProjectMissing
+      Trollop::die :project, "project must be a valid number or one of the configured projects (#{(yaml.keys - ["default"]).join(", ")}) if no default is configured in $HOME/.pivotalprinterrc"
+    rescue SystemExit
+    rescue Exception
+      puts "[!] There was an error while generating the PDF file... What happened was:".white.on_red
+      raise
+    end
+  
+    def print_config
+      puts %{---\ndefault: &default\n  token: "YOUR TOKEN HERE"\n  project: 123\n\nsome_project:\n  <<: *default # so you don't need to rewrite the token\n  project: 789}
+    end
+  
+    def parse_options
+      opts = Trollop::options do
+        version "pivotalprinter #{Pivotalprinter::VERSION} (c) 2010#{(year = Time.now.year) > 2010 ? "-#{year}" : ''} pkw.de"
+        banner <<-EOS
+Pivotalprinter is an awesome program to print stories from the PivotalTracker.
+
+Useage:
+        pivotalprinter [-p PROJECT] [-t TOKEN] [current|backlog|done|STORY]
+        pivotalprinter --config > ~/.pivotalprinterrc
+
+Options:
+EOS
+        opt :project,  "Project Name defined in $HOME/.pivotalprinterrc or project number", :short => "-p", :type => :string
+        opt :token,    "Pivotaltracker Token",    :short => "-t", :type => :string
+        opt :config,   "show example configuration", :short => "-c"
+      end
+    
+      raise ConfigNeeded if opts[:config]
+      opts
+    end
+  
+    def load_yaml_config
+      File.exist?("#{ENV["HOME"]}/.pivotalprinterrc") ? YAML::load_file("#{ENV["HOME"]}/.pivotalprinterrc") : {}
+    end
+  
+    def extract_config(opts, yaml)
+      if opts[:project].nil? && yaml.key?("default")
+        return yaml["default"]["project"], yaml["default"]["token"]
+      elsif opts[:project] =~ /[0-9]+/
+        return opts[:project], (opts[:token] || yaml["default"]["project"])
+      elsif yaml.key?(opts[:project])
+        return yaml[opts[:project]]["project"], yaml[opts[:project]]["token"]
+      else
+        raise ProjectMissing
+      end
+    end
+  
+    def generate_output
+      Prawn::Document.generate("/tmp/stories.pdf", :page_layout => :landscape, :margin => [25, 25, 50, 25], :page_size   => 'A4') do |pdf|
+        @num_cards_on_page = 0
+        pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+        @stories.each_with_index do |story, i|
+          # --- Split pages
+          if i > 0 and i % 4 == 0
+            # puts "New page..."
+            pdf.start_new_page
+            @num_cards_on_page  = 1
+          else
+            @num_cards_on_page += 1
+          end
+
+          # --- Define 2x2 grid
+          pdf.define_grid(:columns => 2, :rows => 2, :gutter => 42)
+          # pdf.grid.show_all
+
+          row    = (@num_cards_on_page+1) / 4
+          column = i % 2
+          padding = 12
+          cell = pdf.grid( row, column )
+          cell.bounding_box do
+
+            pdf.stroke_color = "666666"
+            pdf.stroke_bounds
+            
+            pdf.text_box story.name, :size => 14, :height => 50, :overflow => :truncate, :width => cell.width-(padding*2)-50, :at => [pdf.bounds.left+padding+50, pdf.bounds.top-padding]
+            pdf.text_box story.description, :size => 8, :overflow => :truncate, :width => cell.width-(padding*2), :height => cell.height-(padding*7), :at => [pdf.bounds.left+padding, pdf.bounds.top-padding-55]
+            pdf.text_box "ID #{story.id}", :size => 8, :at => [pdf.bounds.left, pdf.bounds.bottom+padding], :align => :right
+            pdf.text_box story.created_at.strftime('%F'), :size => 8, :at => [pdf.bounds.left, pdf.bounds.bottom+padding], :align => :left
+
+            x, y = 32, 205
+            if story.story_type=="feature"
+              pdf.fill_color story.points_background
+              pdf.fill_circle [x,y], 25
+              pdf.font_size = 36
+              pdf.font "Helvetica", :style => :bold
+              pdf.fill_color 'ffffff'
+              pdf.draw_text "#{story.points}", :at => [x-10, y-12]
+              pdf.fill_color '000000'
+              pdf.font_size = 14
+              pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf", :style => :normal
+            else
+              pdf.image open("#{File.dirname(__FILE__)}/../images/#{story.story_type}.png"), :position => 5, :vposition => 5          
+            end
+          end
+        end
+      end
+      puts ">>> Generated PDF file in 'stories.pdf' with #{@stories.size} stories".black.on_green
+      system "open /tmp/stories.pdf"
+    end
+  end
+end
+
+Pivotalprinter::Printer.new.run

data/lib/pivotalprinter/client.rb

@@ -0,0 +1,13 @@
+module Pivotalprinter
+  class Client
+    class << self
+      attr_accessor :token, :project
+
+      def get(path, options={})
+        raise TokenMissing if @token.nil?
+        raise ProjectMissing if @project.nil?
+        open("http://www.pivotaltracker.com/services/v3#{path}", 'X-TrackerToken' => @token, 'Content-Type' => 'application/xml').read
+      end
+    end
+  end
+end

data/lib/pivotalprinter/iteration.rb

@@ -0,0 +1,24 @@
+module Pivotalprinter
+  class Iteration
+    
+    attr_accessor :stories
+    
+    def self.open(name)
+      self.new(name)
+    end
+    
+    def initialize(name)
+      @stories = []
+      extract_stories(Client.get "/projects/#{Client.project}/iterations/#{name}")
+    end
+    
+    private
+    
+    def extract_stories(response)
+      response = Nokogiri::XML.parse(response)
+      response.css("story").each do |story|
+        @stories << Story.new(story)
+      end
+    end
+  end
+end

data/lib/pivotalprinter/story.rb

@@ -0,0 +1,43 @@
+require 'time'
+
+module Pivotalprinter
+  class Story
+    FIELDS = [ :name, :id, :story_type, :estimate, :current_state, :description, :requested_by, :labels, :created_at, :updated_at ]
+    attr_accessor *FIELDS
+    
+    def initialize(xml)
+      FIELDS.each do |field|
+        value = xml.css("#{field}")
+        send "#{field}=", value.first.full? { |v| v.send(:text) } || value.send(:text)
+      end
+      created_at and self.created_at = Time.parse(created_at)
+      updated_at and self.updated_at = Time.parse(updated_at)
+    end
+    
+    def self.open(ids)
+      stories = ids.map do |id|
+        response = Client.get "/projects/#{Client.project}/stories/#{id}"
+        response = Nokogiri::XML.parse(response)
+        self.new(response.css('story'))        
+      end
+    end
+    
+    def points
+      estimate.to_i >= 0 ? estimate.to_i : '?'
+    end
+    
+    def points_background
+      case points
+        when '?': 'cccccc'
+        when  0: 'ccff66'
+        when  1: '408000'
+        when  2: '808000'
+        when  3: 'ffcc66'
+        when  5: 'ff8000'
+        when  8: 'ff0000'
+        else     'aa0000'
+      end
+    end
+
+  end
+end

data/lib/pivotalprinter/version.rb

@@ -0,0 +1,3 @@
+module Pivotalprinter
+  VERSION = '0.1.7'
+end

data/lib/pivotalprinter.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Pivotalprinter
+  require 'rubygems'
+  require 'pivotalprinter/version'
+  require 'term/ansicolor'
+  require 'prawn'
+  require 'prawn/layout/grid'
+  require 'spruz/xt/full'
+  require 'trollop'
+  require 'yaml'
+  require "rubygems"
+  require "open-uri"
+  require "nokogiri"
+  require "pivotalprinter/client"
+  require "pivotalprinter/iteration"
+  require "pivotalprinter/story"
+end

data/pivotalprinter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.unshift 'lib'
+require "pivotalprinter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pivotalprinter"
+  s.version     = Pivotalprinter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["pkw.de"]
+  s.email       = ["dev@pkw.de"]
+  s.homepage    = "http://pkw.de"
+  s.summary     = %q{Story printer for pivotaltracker}
+  s.description = %q{Generate nice story cards from pivotaltracker.}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('term-ansicolor','>= 0.4.4')
+  s.add_dependency('prawn','~>0.11.1')
+  s.add_dependency('spruz','>= 0.2.0')
+  s.add_dependency('trollop','>= 1.16.2')
+  s.add_dependency('nokogiri','>= 1.4.4')
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/pivotalprinter.rb'}"
+puts "Loading pivotalprinter gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(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.expand_path(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)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/pivotalprinter'

data/test/test_pivotalprinter.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPivotalprinter < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: pivotalprinter
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 7
+  version: 0.1.7
+platform: ruby
+authors: 
+- pkw.de
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 4
+        - 4
+        version: 0.4.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 11
+        - 1
+        version: 0.11.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: spruz
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id005
+description: Generate nice story cards from pivotaltracker.
+email: 
+- dev@pkw.de
+executables: 
+- pivotalprinter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- COPYING
+- Gemfile
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/pivotalprinter
+- images/bug.png
+- images/chore.png
+- images/feature.png
+- images/release.png
+- lib/pivotalprinter.rb
+- lib/pivotalprinter/client.rb
+- lib/pivotalprinter/iteration.rb
+- lib/pivotalprinter/story.rb
+- lib/pivotalprinter/version.rb
+- pivotalprinter.gemspec
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_pivotalprinter.rb
+homepage: http://pkw.de
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Story printer for pivotaltracker
+test_files: 
+- test/test_helper.rb
+- test/test_pivotalprinter.rb