ipt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7c0b0acbed66cdaae452c45c9ef28f5decd47c4
+  data.tar.gz: 32dfa0167b2a113c58b55d0078c82d181ef503bd
+SHA512:
+  metadata.gz: c352f0b94d487587f71e6a883d6773f8a0ed8adb4b13f0ffa73f46e9ed75041ac1b6f12953a0fe21c742217ca5acaa5ac7e8d20147f41163855c41351f0743f2
+  data.tar.gz: 11fcb1385f1b10f83e833e11a1301233d041097df53cd49d1113dcc17e094d1e7c8b2097a3135288f3faa84a0428211ad340359dde9e06755be1698686f2c813

data/.gitignore

@@ -0,0 +1,3 @@
+.pt
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7
+script: rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at botoksgonzales@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Changelog.md

@@ -0,0 +1,6 @@
+# pt changelog
+
+## v1.0.0
+
+- interactive pivotal tracker command line
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pt.gemspec
+gemspec
+group :development do
+  gem 'aruba', '~> 0.14.2'
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib spec)
+
+notification :tmux,
+  display_message: true,
+  timeout: 5, # in seconds
+  default_message_format: '%s >> %s',
+  line_separator: ' > ', # since we are single line we need a separator
+  color_location: %w[status-left-bg pane-active-border-fg ]
+
+guard :rspec, all_on_start: false, all_after_pass: false, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/pt/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Raul Murciano raul@murciano.net
+Copyright (c) 2017 Slamet Kristanto cakmet14@gmail.com
+
+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,37 @@
+[![Gem Version](https://badge.fury.io/rb/pt.svg)](https://badge.fury.io/rb/pt)
+[![Build Status](https://travis-ci.org/drselump14/ipt.svg?branch=master)](https://travis-ci.org/drselump14/ipt)
+
+# ipt
+
+Minimal client to use Pivotal Tracker API v5 from the command line.
+Interactive version of [pt](https://github.com/raul/pt)
+
+# Demo
+![gif](https://www.dropbox.com/s/whob1i5nocyk7hq/ipt.gif?raw=1)
+
+## Setup
+
+    gem install ipt
+
+The first time you run it, `ipt` will ask you some data about your Pivotal Tracker account and your current project.
+
+## Usage
+
+Run `ipt` from the root folder of your project to show all your work.
+
+## Contribute
+- clone this repository
+- `bundle install`
+- change the code
+- run test `rspec`
+- `rake build`
+- `rake install`
+- commit and create pull request
+
+## Thanks to...
+- the contributors of pt
+- the [Pivotal Tracker](https://www.pivotaltracker.com) guys for making a planning tool that doesn't suck and has an API
+- [dashofcode](http://github.com/dashofcode) for `tracker_api` gem
+
+## License
+See the LICENSE file included in the distribution.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/ipt

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+lib = (Pathname.new(__FILE__).realpath.dirname  + '../lib').to_s
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'pt'
+
+PT::CLI.start ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ipt.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pt/version'
+
+Gem::Specification.new do |spec|
+  spec.name              = "ipt"
+  spec.version           = PT::VERSION
+  spec.authors           = ["Slamet Kristanto"]
+  spec.email             = ["cakmet14@gmail.com"]
+  spec.licenses          = ['MIT']
+  spec.homepage          = "http://www.github.com/drselump14/ipt"
+  spec.summary           = "Interactive Pivotal Tracker CLI (API v5)"
+  spec.description       = "Interactive Pivotal Tracker Command Line Interface"
+  spec.executables       = ["ipt"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'vcr'
+
+  spec.add_dependency    'highline', '>= 2.0.0.pre.develop.6'
+  spec.add_dependency    'tracker_api', '~> 1.6.0'
+  spec.add_dependency    'thor'
+  spec.add_dependency    'terminal-table'
+  spec.add_dependency    'paint'
+  spec.add_dependency    'config'
+end

data/lib/pt.rb

@@ -0,0 +1,13 @@
+require 'tracker_api'
+require "pt/version"
+require 'pt/client'
+require 'pt/data_row'
+require 'pt/data_table'
+require 'pt/action'
+require 'pt/io'
+require 'pt/configuration'
+require 'pt/cli'
+
+module PT
+   # Your code goes here...
+end

data/lib/pt/action.rb

@@ -0,0 +1,280 @@
+module PT
+  module Action
+    def show_story(story)
+      clear
+      title('========================================='.red)
+      title story.name.red
+      title('========================================='.red)
+      estimation = [-1, nil].include?(story.estimate) ? "Unestimated" : "#{story.estimate} points"
+      requester = story.requested_by ? story.requested_by.initials : Settings[:user_name]
+      if story.instance_variable_get(:@owners).present?
+        owners = story.owners.map(&:initials).join(',')
+      end
+      message "#{story.current_state.capitalize} #{story.story_type} | #{estimation} | Req: #{requester} | Owners: #{owners} | ID: #{story.id}"
+
+      if story.instance_variable_get(:@labels).present?
+        message "Labels: " + story.labels.map(&:name).join(', ')
+      end
+
+      message story.description.green unless story.description.nil? || story.description.empty?
+      message "View on pivotal: #{story.url}"
+
+      if story.instance_variable_get(:@tasks).present?
+        title('tasks'.yellow)
+        story.tasks.each{ |t| compact_message "- #{t.complete ? "[done]" : ""} #{t.description}" }
+      end
+
+
+      if story.instance_variable_get(:@comments).present?
+        story.comments.each do |n|
+          title('......................................'.blue)
+          text = ">> #{n.person.initials}: #{n.text}"
+          text << "[#{n.file_attachment_ids.size}F]" if n.file_attachment_ids
+          message text
+        end
+      end
+      save_recent_task( story.id )
+      say ""
+      title '================================================='.red
+      choice = ask "Please choose action ([b]:back to table | [m]:show menu | [q] quit)"
+      case choice
+      when 'q'
+        quit
+      when 'm'
+        choose_action(story)
+      when 'b'
+        say('back to table ....')
+        return :no_request
+      end
+    end
+
+    def tasks_story(story)
+      story_task = get_open_story_task_from_params(story)
+      if story_task.position == -1
+        description = ask('Title for new task')
+        story.create_task(:description => description)
+        congrats("New todo task added to \"#{story.name}\"")
+      else
+        edit_story_task story_task
+      end
+    end
+
+    def open_story story
+      `open #{story.url}`
+      return :no_request
+    end
+
+    def assign_story story
+      owner = choose_person
+      @client.assign_story(story, owner)
+      congrats("story assigned to #{owner.initials}, thanks!")
+    end
+
+    def comment_story(story)
+      say("Please write your comment")
+      comment = edit_using_editor
+      if @client.comment_task(story, comment)
+        congrats("Comment sent, thanks!")
+        save_recent_task( story.id )
+      else
+        error("Ummm, something went wrong.")
+      end
+    end
+
+    def label_story(story)
+      label = ask("Which label?")
+      @client.add_label(story, label );
+      congrats("#{label} added, thanks!")
+    end
+
+    def estimate_story(story)
+      if story.story_type == 'feature'
+        estimation ||= ask("How many points you estimate for it? (#{project.point_scale})")
+        @client.estimate_story(story, estimation)
+        congrats("Task estimated, thanks!")
+      else
+        error('Only feature can be estimated!')
+      end
+    end
+
+    def start_story story
+      if story.story_type == 'feature' && !story.estimate
+        estimate_story(story)
+      end
+      @client.mark_task_as(story, 'started')
+      congrats("story started, go for it!")
+    end
+
+    def unstart_story story
+      @client.mark_task_as(story, 'unstarted')
+      congrats("story unstarted")
+    end
+
+    def start_story story
+      if story.story_type == 'feature' && !story.estimate
+        estimate_story(story)
+      end
+      @client.mark_task_as(story, 'started')
+      congrats("story started, go for it!")
+    end
+
+    def finish_story story
+      if story.story_type == 'chore'
+        @client.mark_task_as(story, 'accepted')
+      else
+        @client.mark_task_as(story, 'finished')
+      end
+      congrats("Another story bites the dust, yeah!")
+    end
+
+    def deliver_story story
+      return if story.story_type == 'chore'
+      @client.mark_task_as(story, 'delivered')
+      congrats("story delivered, congrats!")
+    end
+
+    def accept_story story
+      @client.mark_task_as(story, 'accepted')
+      congrats("Accepted")
+    end
+
+    def reject_story(story)
+      comment = ask("Please explain why are you rejecting the story.")
+      if @client.comment_task(story, comment)
+        @client.mark_task_as(story, 'rejected')
+        congrats("story rejected, thanks!")
+      else
+        error("Ummm, something went wrong.")
+      end
+    end
+
+    def done_story(story)
+      start_story story
+
+      finish_story story
+
+      deliver_story story
+    end
+
+    def copy_story_id(story)
+      `echo #{story.id} | pbcopy`
+      congrats("Story ID copied")
+    end
+
+    def copy_story_url(story)
+      `echo #{story.url} | pbcopy`
+      congrats("Story URL copied")
+    end
+
+    def create_interactive_story
+      # set title
+      title = ask("Name for the new task:")
+
+      # set owner
+      if ask('Do you want to assign it now? (y/n)').downcase == 'y'
+        members = @client.get_members
+        table = PersonsTable.new(members.map(&:person))
+        owner = select("Please select a member to assign him the task.", table)
+        owner_id = owner.id
+      end
+
+      # set story type
+      type = case ask('Type? (c)hore, (b)ug, anything else for feature)')
+             when 'c', 'chore'
+               'chore'
+             when 'b', 'bug'
+               'bug'
+             else
+               'feature'
+             end
+
+      description = edit_using_editor if ask('Do you want to write description now?(y/n)') == 'y'
+      story = @client.create_story(
+        name: title,
+        owner_ids: [owner_id],
+        requested_by_id: Settings[:user_id],
+        story_type: type,
+        description: description
+      )
+      congrats("#{type} #{('for' + owner.name ) if owner} has been created \n #{story.url}")
+      story
+    end
+
+    def edit_story(story)
+      # set title
+      if ask("Edit title?(y/n) [#{story.name}]")  { |yn| yn.limit = 1, yn.validate = /[yn]/i } == 'y'
+        say('Edit your story name')
+        story.name = edit_using_editor(story.name)
+      end
+
+      # set story type
+      story.story_type = case ask('Edit Type? (f)eature (c)hore, (b)ug, enter to skip)')
+             when 'c', 'chore'
+               'chore'
+             when 'b', 'bug'
+               'bug'
+             when 'f', 'feature'
+               'feature'
+             end
+
+      story.description = edit_using_editor(story.description) if ask('Do you want to edit description now?(y/n)') == 'y'
+      story = story.save
+      congrats("'#{story.name}' has been edited \n #{story.url}")
+      story
+    end
+
+    def edit_story_task(task)
+      action_class = Struct.new(:action, :key)
+
+      table = ActionTable.new([
+        action_class.new('Complete', :complete),
+        action_class.new('Edit', :edit)
+      ])
+      action_to_execute = select('What to do with todo?', table)
+
+      task.project_id = project.id
+      task.client = project.client
+      case action_to_execute.key
+      when :complete then
+        task.complete = true
+        congrats('Todo task completed!')
+      when :edit then
+        new_description = ask('New task description')
+        task.description = new_description
+        congrats("Todo task changed to: \"#{task.description}\"")
+      end
+      task.save
+    end
+
+    def edit_using_editor(content=nil)
+      editor = ENV.fetch('EDITOR') { 'vi' }
+      temp_path = "/tmp/editor-#{ Process.pid }.txt"
+      File.write(temp_path, content) if content
+      system "#{ editor } #{ temp_path }"
+      content = File.read(temp_path)
+      File.delete(temp_path)
+      content
+    end
+
+    def choose_person
+      members = @client.get_members
+      table = PersonsTable.new(members.map(&:person))
+      select("Please select a member to see his tasks.", table)
+    end
+
+    def save_recent_task( task_id )
+      # save list of recently accessed tasks
+      unless (Settings[:recent_tasks])
+        Settings[:recent_tasks] = Array.new();
+      end
+      Settings[:recent_tasks].unshift( task_id )
+      Settings[:recent_tasks] = Settings[:recent_tasks].uniq()
+      if Settings[:recent_tasks].length > 10
+        Settings[:recent_tasks].pop()
+      end
+      @config.save_config( Settings, @config.get_local_config_path )
+    end
+
+  end
+end
+