pivotal_shell 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.pivotalrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    pivotal_shell (0.0.1)
+      pivotal-tracker (= 0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    happymapper (0.3.2)
+      libxml-ruby (~> 1.1.3)
+    libxml-ruby (1.1.4)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    pivotal-tracker (0.3.0)
+      builder
+      happymapper (>= 0.3.2)
+      nokogiri (~> 1.4.3.1)
+      rest-client (~> 1.6.0)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pivotal-tracker (= 0.3)
+  pivotal_shell!

data/README.markdown

@@ -0,0 +1,65 @@
+# pivotal_shell
+
+A command-line wrapper for [Pivotal Tracker](http://www.pivotaltracker.com)
+
+## Installation
+
+    gem install pivotal_shell
+
+## Configuration
+
+First, you need to [create an API token for your profile](https://www.pivotaltracker.com/profile) (scroll to the bottom) and put it into `~/.pivotalrc`:
+
+    api_token: abcdef0123456789
+
+The token is the same for all of your Pivotal Tracker projects.
+
+Second, you need to create a `.pivotalrc` in your project root and set up projectwide settings:
+
+    # For the https://www.pivotaltracker.com/projects/123456 project, the id would be...
+    project_id: 123456
+
+    # these are your initials used in the project
+    me: LS
+
+Both `.pivotalrc` files are regular YAML files.
+
+## Usage
+
+    pivotal
+
+## Example
+
+List all your unfinished stories
+
+    pivotal stories
+
+List all your stories, regardless of status
+
+    pivotal stories --all --mine
+
+List all finished stories for everyone
+  
+    pivotal stories --all --finished
+
+List all unassigned bugs
+
+    pivotal stories --unowned --bugs
+
+Show info on a story
+    
+    pivotal story 123456
+
+## TODO
+
+Start story
+
+    pivotal start 123456
+
+Finish story
+
+    pivotal finish 123456
+
+Commit (with git, all comments after the story id go to git, story id gets appended to comments)
+
+    pivotal commit 123456 "some more comments"

data/Rakefile

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

data/bin/pivotal

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'pivotal_shell'
+require 'pivotal_shell/configuration'
+#require 'active_support/core_ext'
+
+PivotalShell::Configuration.load
+
+commands = {
+  'stories' => 'show a list of stories',
+  'story' => 'show information about a specific story',
+}
+
+banner = "Pivotal command-line client\nUsage: pivotal COMMAND PARAMS\n\nAvailable commands:\n\n#{commands.map{|c, d| "#{c} - #{d}"}.join("\n")}\n\nRun pivotal COMMAND --help for more info on a specific command\n\n"
+
+command = ARGV.shift
+
+unless commands.keys.include?(command)
+  puts banner
+  exit
+end
+
+require "pivotal_shell/commands/#{command}"
+
+command_class = PivotalShell::Commands.const_get(command[0,1].upcase+command[1..-1])
+
+command_class.new(ARGV).execute

data/lib/pivotal_shell/command.rb

@@ -0,0 +1,4 @@
+class PivotalShell::Command
+  def initialize(options)
+  end
+end

data/lib/pivotal_shell/commands/stories.rb

@@ -0,0 +1,69 @@
+#<PivotalTracker::Story:0x90b74f4 @jira_url=nil, @requested_by="Pavel Pavlovsky", @name="Add titles for the pages", @attachments=[], @project_id=110960, @jira_id=nil, @id=5952583, @current_state="accepted", @integration_id=nil, @accepted_at=#<DateTime: 212157861559/86400,1/12,2299161>, @labels="ui", @url="http://www.pivotaltracker.com/story/show/5952583", @estimate=nil, @description="so they are identified correctly by user.\nto clarify", @other_id=nil, @created_at=#<DateTime: 5303878313/2160,1/8,2299161>, @owned_by="Leonid Shevtsov", @story_type="chore">
+
+module PivotalShell::Commands
+  class PivotalShell::Commands::Stories < PivotalShell::Command
+    def initialize(options)
+      @options = {:params => {}}
+
+      available_statuses = %w(unscheduled unstarted started finished delivered accepted rejected)
+      available_types = %w(features bugs chores)
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "List Pivotal stories\nUsage: pivotal stories [options]\n\nThe default is to show all unfinished stories assigned to yourself\n\nDisplay format:\n  [id]\n  type: Feature/Bug/Chore\n  estimate: * (irrelevant)/0/1/2/3\n  state: . (unscheduled)/Unstarted/Started/Finished/Delivered/Accepted/Rejected\n  title\n\nOptions:"
+        
+        
+        opts.on('--all', 'Show all tasks (reset default filter on state and owner)') do
+          @options[:all] = true
+        end
+
+        available_statuses.each do |status|
+          opts.on("--#{status}", "Show #{status} stories") do
+            @options[:params][:state] ||= []
+            @options[:params][:state] << status
+          end
+        end
+        
+        available_types.each do |type|
+          opts.on("--#{type}", "Show #{type}") do
+            @options[:params][:type] ||= []
+            @options[:params][:type] << type[0..-2] # chomp s
+          end
+        end
+
+        opts.on('--for [USER]', 'Show tasks assigned to USER; accepts comma-separated list') do |user|
+          @options[:params][:owner] = user
+        end
+        
+        opts.on('--unowned', 'Show tasks not assigned to anyone') do
+          @options[:unowned] = true
+        end
+        
+        opts.on('--anyone', 'Show tasks assigned to anyone') do
+          @options[:anyone] = true
+        end
+
+        opts.on('--mine', 'Show your tasks') do
+          @options[:params][:owner] = PivotalShell::Configuration.me
+        end
+
+        opts.on_tail('--help', 'Show this help') do
+          puts opts
+          exit
+        end
+      end
+      opts.parse!
+      
+      @options[:params][:owner] ||= PivotalShell::Configuration.me unless @options[:unowned] || @options[:anyone] || @options[:all]
+      @options[:params][:state] ||= %w(unestimated unstarted started) unless @options[:all]
+    end
+
+    def execute
+      stories = PivotalShell::Configuration.project.stories.all(@options[:params])
+      if @options[:unowned]
+        stories.reject!{|s| !s.owned_by.nil?}
+      end
+
+      puts stories.empty? ? 'No stories!' : stories.map{|s| "#{("[#{s.id}]").rjust 12} #{PivotalShell::Configuration.icon(s.story_type, s.current_state, s.estimate)} #{s.name.strip}"}.join("\n")
+    end
+  end
+end

data/lib/pivotal_shell/commands/story.rb

@@ -0,0 +1,41 @@
+#<PivotalTracker::Story:0x90b74f4 @jira_url=nil, @requested_by="Pavel Pavlovsky", @name="Add titles for the pages", @attachments=[], @project_id=110960, @jira_id=nil, @id=5952583, @current_state="accepted", @integration_id=nil, @accepted_at=#<DateTime: 212157861559/86400,1/12,2299161>, @labels="ui", @url="http://www.pivotaltracker.com/story/show/5952583", @estimate=nil, @description="so they are identified correctly by user.\nto clarify", @other_id=nil, @created_at=#<DateTime: 5303878313/2160,1/8,2299161>, @owned_by="Leonid Shevtsov", @story_type="chore">
+require 'optparse'
+
+module PivotalShell::Commands
+  class PivotalShell::Commands::Story < PivotalShell::Command
+    def initialize(options)
+      opts = OptionParser.new do |opts|
+        opts.banner = "Show information on a Pivotal story\nUsage: pivotal story STORY_ID [options]\n\n"
+        
+        opts.on_tail('--help', 'Show this help') do
+          puts opts
+          exit
+        end
+      end
+      opts.parse!(options)
+      if options.empty? || options.length>1
+        puts opts
+        exit
+      else
+        @story_id = options.first
+      end
+    end
+
+    def execute
+      @story = PivotalShell::Configuration.project.stories.find(@story_id)
+      if @story.nil?
+        puts 'Story not found'
+      else
+        puts ["[#{@story.id}] - #{@story.name}",
+              "State: #{@story.current_state}",
+              "Owner: #{@story.owned_by}",
+              "Creator: #{@story.requested_by}",
+              "URL: #{@story.url}",
+              "",
+              "#{@story.description.strip}",
+              "",
+              ""].join("\n")
+      end
+    end
+  end
+end

data/lib/pivotal_shell/configuration.rb

@@ -0,0 +1,64 @@
+require 'yaml'
+require 'pivotal_tracker'
+
+module PivotalShell::Configuration
+  def self.load
+    @global_config = YAML.load_file(global_config_path)
+    @project_config = YAML.load_file(project_config_path)
+    PivotalTracker::Client.token = @global_config['api_token']
+  end
+
+  def self.project
+    @project ||= PivotalTracker::Project.find(@project_config['project_id'])
+  end
+
+  def self.me
+    @me ||= @project_config['me']
+  end
+
+  def self.global_config_path
+    @global_config_path ||= File.expand_path('~/.pivotalrc')
+  end
+
+  def self.project_config_path
+    @project_config_path ||= find_project_config
+  end
+
+  def self.status_icon(status)
+    {
+      'unscheduled' => ' ', 
+      'unstarted' => '.', 
+      'started' => 'S',
+      'finished' => 'F', 
+      'delivered' => 'D', 
+      'accepted' => 'A', 
+      'rejected' => 'R'
+    }[status]
+  end
+
+  def self.estimate_icon(estimate)
+    estimate.nil? ? '*' : ({-1 => '?', 0 => '0', 1=>'1', 2=>'2', 3 => '3'}[estimate] || "[#{estimate.inspect}]")
+  end
+
+  def self.type_icon(type)
+    {'feature' => 'F', 'chore' => 'C', 'bug' => 'B'}[type]
+  end
+
+  def self.icon(type, status, estimate)
+    type_icon(type) + ' ' + estimate_icon(estimate) + ' ' + status_icon(status)
+  end
+
+private
+
+  def self.find_project_config
+    dirs = File.split(Dir.pwd)
+    until dirs.empty? || File.exists?(File.join(dirs, '.pivotalrc'))
+      dirs.pop
+    end
+    if dirs.empty? || File.join(dirs, '.pivotalrc')==global_config_path
+      raise PivotalShell::Exception.new('No project .pivotalrc found')
+    else
+      File.join(dirs, '.pivotalrc')
+    end
+  end
+end

data/lib/pivotal_shell/version.rb

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

data/lib/pivotal_shell.rb

@@ -0,0 +1,27 @@
+require 'pivotal_tracker'
+
+module PivotalShell
+  class Exception < StandardError; end
+end
+
+require 'pivotal_shell/command'
+
+# fixing pivotal-tracker's options encoding; it did not work with array filters
+module PivotalTracker
+  class <<self
+    def encode_options(options)
+      return nil if !options.is_a?(Hash) || options.empty?
+      options_strings = []
+      # remove options which are not filters, and encode them as such
+      [:limit, :offset].each do |o|
+        options_strings << "#{CGI.escape(o.to_s)}=#{CGI.escape(options.delete(o))}" if options[o]
+      end
+      # assume remaining key-value pairs describe filters, and encode them as such.
+      filters_string = options.map do |key, value|
+        "#{CGI.escape(key.to_s)}%3A#{CGI.escape([value].flatten.map{|v| v.include?(' ') ? '"'+v+'"' : v}.join(','))}"
+      end
+      options_strings << "filter=#{filters_string.join('+')}" unless filters_string.empty?
+      return "?#{options_strings.join('&')}"
+    end
+  end
+end

data/pivotal_shell.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pivotal_shell/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pivotal_shell"
+  s.version     = PivotalShell::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Leonid Shevtsov"]
+  s.email       = ["leonid@shevtsov.me"]
+  s.homepage    = "http://rubygems.org/gems/pivotal_shell"
+  s.summary     = %q{A command-line client for Pivotal Tracker}
+
+  s.add_dependency 'pivotal-tracker', '=0.3'
+
+  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"]
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: pivotal_shell
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leonid Shevtsov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pivotal-tracker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- leonid@shevtsov.me
+executables: 
+- pivotal
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- bin/pivotal
+- lib/pivotal_shell.rb
+- lib/pivotal_shell/command.rb
+- lib/pivotal_shell/commands/stories.rb
+- lib/pivotal_shell/commands/story.rb
+- lib/pivotal_shell/configuration.rb
+- lib/pivotal_shell/version.rb
+- pivotal_shell.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/pivotal_shell
+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.3.7
+signing_key: 
+specification_version: 3
+summary: A command-line client for Pivotal Tracker
+test_files: []
+