pivotal-slacker 1.0.1

data/bin/pivotal-slacker

@@ -0,0 +1,199 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "rubygems"
+require "pivotal-tracker"
+require "rainbow"
+require "action_view"
+require "launchy"
+require "pp"
+require "app_config"
+require "formatter"
+include ActionView::Helpers::DateHelper
+
+# ----------------------------------------------------------
+# Load config
+
+config = nil
+begin
+  config = AppConfig.load
+rescue Exception => e
+  puts e
+  exit 1
+end
+
+# ----------------------------------------------------------
+# Init
+
+PivotalTracker::Client.token = config.api_key
+project = PivotalTracker::Project.find config.project
+
+# ----------------------------------------------------------
+# Main app code
+
+require "commander/import"
+require "pivotal-tracker"
+
+program :version, "1.0"
+program :description, "Pivotal Tracker command line client."
+
+command :mine do |c|
+  c.syntax = "pivotal-slacker mine [options]"
+  c.description = "List your stories in pivotal tracker."
+  c.example "description", "command example"
+  c.option "--some-switch", "Some switch that does something"
+  c.action do |args, options|
+    # Do something or c.when_called Pivotal-slacker::Commands::Mine
+    
+    states = %w{unstarted started finished accepted rejected}
+    owned_by = config.user
+    
+    puts "Looking for stories owned by #{owned_by} in states: #{states}".color("#444444")
+
+    stories = project.stories.all(:owned_by => owned_by, :current_state => states)
+    stories.sort! { |a, b| a.created_at <=> b.created_at }
+    stories.each do |story|
+      id = Formatter.story_id(story.id)
+      name = Formatter.story_name(story.name)
+      state = Formatter.state(story.current_state)
+      requested_by = Formatter.requested_by(story.requested_by)
+      created_at = Formatter.time_ago(story.created_at)
+      
+      puts "[#{id}] #{name}  ~  #{state}, from #{requested_by}, created #{created_at}"
+    end
+  end
+end
+
+command :open do |c|
+  c.syntax = "pivotal-slacker open story_id"
+  c.description = "Open a specific Pivotal Tracker story in the browser."
+  c.example "Open a story with ID 123", "pivotal-slacker open 123"
+  c.action do |args, options|
+    story = project.stories.find(args[0].to_i)
+    Launchy.open story.url
+  end
+end
+
+command :show do |c|
+  c.syntax = "pivotal-slacker show story_id"  
+  c.description = "Show the details of a given Pivotal Tracker story."
+  c.example "Show a story with ID 123", "pivotal-slacker show 123"
+  c.action do |args, options|
+    story = project.stories.find(args[0].to_i)
+    id = Formatter.story_id(story.id)
+    state = Formatter.state(story.current_state)
+    requested_by = Formatter.requested_by(story.requested_by)
+    created_at = Formatter.time_ago(story.created_at)
+
+    puts ""
+    puts "[#{id}] #{Formatter.story_name(story.name, :heading => true)}"
+    puts "#{state}, from #{requested_by}, created #{created_at}"
+    puts ""
+    puts Formatter.description(story.description)
+    puts ""
+    
+    notes = story.notes.all.sort { |a, b| a.noted_at <=> b.noted_at }
+    notes.each do |note|
+      author = Formatter.note_author(note.author)
+      noted_at = Formatter.time_ago(note.noted_at)
+      note_text = Formatter.note_text(note.text)
+      puts "#{author} (#{noted_at}): #{note_text}"
+    end
+    
+    # Extra padding line after notes.
+    if notes != nil and notes.size > 0
+      puts ""
+    end
+  end
+end
+
+command :start do |c|
+  c.syntax = "pivotal-slacker start story_id"
+  c.description = "Mark a given Pivotal Tracker story as \"started\"."
+  c.example "Start a story with ID 123", "pivotal-slacker start 123"
+  c.action do |args, options|
+    story_id = args[0].to_i
+    
+    story = project.stories.find(story_id)
+    story.update :current_state => "started"
+    
+    puts Formatter.story_action(Formatter.state("started"), story_id, story.name) + "."
+  end
+end
+
+command :comment do |c|
+  c.syntax = "pivotal-slacker comment story_id comment"
+  c.description = "Comment on a given Pivotal Tracker story."
+  c.example "Comment on story 123", "pivotal-slacker comment 123 \"Due to my skills I will destroy this task.\""
+  c.action do |args, options|
+    story_id = args[0].to_i
+    comment = args[1]
+    
+    story = project.stories.find(story_id)
+    story.notes.create :text => comment
+    
+    comment = Formatter.note_text(comment)
+    puts "#{Formatter.story_action "Commented on", story_id, story.name}:"
+    puts "#{Formatter.note_author(config.user)}: #{comment}"
+  end
+end
+
+command :finish do |c|
+  c.syntax = "pivotal-slacker finish story_id"
+  c.description = "Mark a given Pivotal Tracker story as \"finished\"."
+  c.example "Finish a story with ID 123", "pivotal-slacker finish 123"
+  c.action do |args, options|
+    story_id = args[0].to_i
+    
+    story = project.stories.find(story_id)
+    story.update :current_state => "finished"
+    
+    puts Formatter.story_action(Formatter.state("finished"), story_id, story.name) + "."
+  end
+end
+
+command :create do |c|
+  c.syntax = "pivotal-slacker create [options]"
+  c.description = "Create a new task in Pivotal Tracker."
+  c.example "Create a new task", "pivotal-slacker create --chore --owner \"Jimmy Winkerbean\""
+  c.option "--feature", "Designate the story as a feature"
+  c.option "--bug", "Designate the story as a bug"
+  c.option "--chore", "Designate the story as a chore"
+  c.option "--release", "Designate the story as a release"
+  c.option "--owner STRING", String, "Assigns the story to a user"
+  c.option "--name STRING", String, "Name of story"
+  c.option "--description STRING", String, "Description of story"
+  c.action do |args, options|
+    options.default :chore => false, :owner => config.user, :name => nil, :description => nil
+    
+    raise "--name is required" if options.name == nil
+    raise "--description is required" if options.description == nil
+
+    story_type = "feature" if options.feature
+    story_type = "bug" if options.bug
+    story_type = "chore" if options.chore
+    story_type = "release" if options.release
+
+    puts ""
+    puts Formatter.story_name(options.name, :heading => true)
+    puts "#{Formatter.attr_descriptor('type is', Formatter.story_type(story_type))}"
+    puts "#{Formatter.attr_descriptor('requested by', Formatter.owner(config.user))}"
+    puts "#{Formatter.attr_descriptor('owned by', Formatter.owner(options.owner))}"
+    puts "#{Formatter.attr_descriptor('description is', Formatter.description(options.description))}"
+    puts ""
+    
+    if agree "Really create? (y/n)"
+      story = project.stories.create(
+        :name => options.name,
+        :story_type => story_type,
+        :description => options.description,
+        :requested_by => config.user,
+        :owned_by => options.owner
+      )
+      puts Formatter.story_action("Created", story.id, story.name)
+    else
+      puts "Didn't create story."
+    end
+  end
+end
+

data/lib/app_config.rb

@@ -0,0 +1,40 @@
+require "rubygems"
+
+class AppConfig
+  FILENAME = ".pt.yaml"
+  
+  def self.load
+    require "yaml"
+
+    # Read YAML config or quit.
+    config = nil
+    begin
+      config = YAML.load_file FILENAME
+    rescue Exception => e
+      raise "No #{FILENAME} file found in current directory; please create one."
+    end
+    
+    AppConfig.new :config => config
+  end
+  
+  def initialize opts={:config => Hash.new}
+    @config = opts[:config]
+    
+    raise "Config must include \"project\" key" if not @config.has_key? "project"
+    raise "Config must include \"api_key\" key" if not @config.has_key? "api_key"
+    raise "Config must include \"user\" key" if not @config.has_key? "user"
+  end
+  
+  def project
+    @config["project"]
+  end
+  
+  def api_key
+    @config["api_key"]
+  end
+  
+  def user
+    @config["user"]
+  end
+  
+end

data/lib/formatter.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require "rubygems"
+require "rainbow"
+
+class Formatter
+  def self.story_id id
+    id.to_s.color("#404040")
+  end
+  
+  def self.state state
+    if state == "finished"
+      # state = state.color('009900').bright #background('009900').color('ffffff')
+      " ✓ #{state} ".background('#4C9900').bright.underline
+    elsif state == "accepted"
+      " ✓ #{state} ".background('#0080ff').color(:black).underline
+    else
+      state = state.bright # .background(:green).underline
+    end
+  end
+  
+  def self.requested_by requested_by
+    requested_by.color("#3399ff")
+  end
+  
+  def self.owner owner
+    self.requested_by owner
+  end
+  
+  def self.story_name story_name, opts={:heading => false}
+    if opts[:heading] == true
+      story_name.bright.underline
+    else
+      story_name
+    end
+  end
+  
+  def self.time_ago time
+    (distance_of_time_in_words(Time.now, time) + " ago").color('#404040')
+  end
+  
+  def self.note_author author
+    self.requested_by(author)
+  end
+  
+  def self.note_text text
+    text.bright
+  end
+  
+  def self.story_action comment, story_id, story_name
+    story_name = Formatter.story_name(story_name, :heading => true)
+    "#{comment} #{Formatter.story_id(story_id)}, #{story_name}"
+  end
+  
+  def self.story_type type
+    type.color '#99004C'
+  end
+  
+  def self.attr_descriptor descriptor, attr
+    "#{descriptor} → ".color('#333333') + attr
+  end
+  
+  def self.description description
+    description
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: pivotal-slacker
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Gilbertson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies: []
+description: If you're overwhelmed with or tired of using the Pivotal Tracker web
+  UI, use this!
+email: sean.gilbertson@gmail.com
+executables:
+- pivotal-slacker
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/formatter.rb
+- lib/app_config.rb
+- bin/pivotal-slacker
+homepage: https://github.com/dreki/pivotal-slacker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.25
+signing_key: 
+specification_version: 3
+summary: A command-line client for Pivotal Tracker.
+test_files: []