tracker-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f189c896ac1d5dcf3de93c29dfa2d959dec382d
+  data.tar.gz: bf3bbbd61e66e09de3e0beee5bdfc34aa49e067f
+SHA512:
+  metadata.gz: 610917a9319d41d41eb073ddc6dc7f9ba1ffdd3741f839fdcf604802c1bee3c34627fe07a2eedd6f235b0e41ac0848527788292965ec48b1153f18511a94e44b
+  data.tar.gz: 857d4a4844321313a9729237f6ded4fe82e6062237549873342096262ad2ec7b5596598feb94ebcfb392044e9cd83c0fd95b298d0817250177fba51cf8937313

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.rspec
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    tracker-cli (0.1.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    hashdiff (0.3.0)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  rake (~> 10.0)
+  rspec
+  tracker-cli!
+  webmock
+
+BUNDLED WITH
+   1.13.1

data/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2016 Benjamin Joffe Bergstein <bennyjbergstein@gmail.com>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,94 @@
+# Tracker CLI
+
+A mostly-for-fun Command Line Interface (CLI) for Pivotal Tracker
+
+# Installation
+
+## Configure
+
+An API Token and Project ID are required in the configuration file.
+
+### 1) Find your API Token
+
+Your API Token is located at https://www.pivotaltracker.com/profile.
+
+### 2) Find your Project ID
+
+Your Project ID is located in the project's url. If your project url is https://www.pivotaltracker.com/n/projects/999999, this project's id is 999999.
+
+### 3) Create a config file
+
+Open ~/.tracker.config in your favorite text editor and enter the following yaml:
+
+```
+api_token: {{API_TOKEN}}
+project: {{PROJECT_ID}}
+```
+
+## Add to your Gemfile
+
+```
+gem 'tracker-cli', github: 'benastan/tracker-cli'
+```
+
+## Take it for a test drive
+
+```
+tracker --list stories
+=> 00001  "My First Story"
+```
+
+# Usage
+
+## List
+
+```
+tracker --list stories
+
+00001 "Story 1"
+00002 "Story 2"
+
+tracker --list stories --format json # JSON format
+tracker --list projects
+tracker --list projects --format json # JSON format
+```
+
+## Fetch
+
+```
+tracker --fetch [OBJECT_TYPE]
+```
+
+`OBJECT_TYPE` can be story.
+ 
+### Story
+
+A story can be fetched interactively: 
+
+```
+tracker --fetch story -i
+ 
+(1) 00001 "Story #1"
+(2) 00002 "Story #2"
+(3) 00002 "Story #3"
+ 
+Which Story? 1
+```
+
+Or with an id: 
+
+```
+tracker --fetch story --id 00001
+```
+
+Make a commit for a started story of your choice.
+
+```
+tracker --fetch story -i --parameter with_state,started --commit
+(1) 133544285 "Test Story"
+
+Which Story? 1
+
+[master 2886e30] [#133544285] Test Story
+ 7 files changed, 94 insertions(+), 23 deletions(-)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.require
+$LOAD_PATH.push(File.expand_path('./lib'))
+require 'tracker'
+require 'irb'
+
+@client = Tracker::Client.new(Tracker.api_token)
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/tracker

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$LOAD_PATH.push(File.expand_path('./lib'))
+require 'tracker'
+require 'tracker/cli'
+
+Tracker::Cli.new(ARGV)

data/lib/tracker/cli/command/fetch.rb

@@ -0,0 +1,52 @@
+module Tracker
+  class Cli
+    module Command
+      class Fetch
+        attr_reader :cli, :arguments
+        
+        def initialize(cli: , object_type: , **arguments)
+          @cli = cli
+          @arguments = arguments
+          
+          case object_type
+          when 'story' then fetch_story(**arguments)
+          end
+        end
+        
+        def fetch_story(object_id: nil, interactive: false, commit: false, **arguments)
+          if object_id
+            story = cli.connection.fetch_story(object_id)
+          elsif interactive
+            story = select_story
+          end
+    
+          if commit
+            create_commit(story)
+          else
+            print "#{story['id']}\t#{story['name'].to_json}\n"
+          end
+        end
+        
+        def select_story
+          query_params = arguments.fetch(:query_params, {})
+          stories = cli.connection.fetch_stories(project: Tracker.project, query: query_params)
+          stories.each_with_index do |story, index|
+            print "(#{index + 1}) #{story['id']} #{story['name'].to_json}\n"
+          end
+  
+          print "\nWhich Story? "
+          index = $stdin.gets.chomp.to_i - 1
+          print "\n"
+          stories[index]
+        end
+        
+        def create_commit(story)
+          commit_message = "\"[##{story['id']}] #{story['name'].to_json[1..-2]}\""
+          command = [ 'git', 'commit', '-m', commit_message ]
+          _, stdout = Open3.popen2(*command)
+          print stdout.read
+        end
+      end
+    end
+  end
+end

data/lib/tracker/cli/command/list.rb

@@ -0,0 +1,50 @@
+module Tracker
+  class Cli
+    module Command
+      class List
+        attr_reader :cli, :arguments, :objects, :columns
+        
+        def initialize(cli: , object_type: , **arguments)
+          @cli = cli
+          @arguments = arguments
+          
+          case object_type
+          when 'stories' then list_stories
+          when 'projects' then list_projects
+          end
+    
+          case arguments[:format_name]
+          when 'json'
+            print JSON.dump(objects)
+          else
+            print_objects
+          end
+        end
+        
+        def list_stories
+          query_params = arguments.fetch(:query_params, {})
+          @objects = cli.connection.fetch_stories(project: Tracker.project, query: query_params)
+          @columns = [ 'id', 'name', 'current_state', 'story_type' ]
+        end
+        
+        def list_projects
+          @objects = cli.connection.get('projects').body
+          @columns = [ 'id', 'name' ]
+        end
+        
+        def print_objects
+          objects.each do |object|
+            row = object.map do |(k, v)|
+              if columns.include?(k)
+                k == 'name' ? v.to_json : v
+              end
+            end.compact
+    
+            print row.join("\t")
+            print "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tracker/cli/command.rb

@@ -0,0 +1,8 @@
+module Tracker
+  class Cli
+    module Command
+      autoload :Fetch, 'tracker/cli/command/fetch'
+      autoload :List, 'tracker/cli/command/list'
+    end
+  end
+end

data/lib/tracker/cli/version.rb

@@ -0,0 +1,5 @@
+module Tracker
+  class Cli
+    VERSION = "0.1.0"
+  end
+end

data/lib/tracker/cli.rb

@@ -0,0 +1,35 @@
+module Tracker
+  class Cli
+    autoload :Command, 'tracker/cli/command'
+  
+    def initialize(argv)
+      validate_configuration!
+      
+      arguments = OptionParser.parse!(argv)
+      arguments[:cli] = self
+      
+      case arguments[:method]
+      when :list then Command::List.new(**arguments)
+      when :fetch then Command::Fetch.new(**arguments)
+      end
+    end
+    
+    def connection
+      @connection ||= Client.new(Tracker.api_token)
+    end
+    
+    def validate_configuration!
+      if Tracker.api_token.nil?
+        error = "API Token missing. Find yours at https://www.pivotaltracker.com/profile and add: \n\napi_token: {{YOUR_TOKEN}}\n\n to ~/.tracker.config"
+      end
+      
+      if Tracker.project.nil?
+        error = "Project id is missing. Find the id in the url for the project and add: \n\nproject: {{YOUR_PROJECT_ID}}\n\n to ~/.tracker.config"
+      end
+      
+      if error
+        raise ArgumentError, error
+      end
+    end
+  end
+end

data/lib/tracker/client.rb

@@ -0,0 +1,20 @@
+module Tracker
+  class Client < Faraday::Connection
+    def initialize(api_token)
+      super('https://www.pivotaltracker.com/services/v5') do | builder |
+        builder.headers['X-Tracker-Token'] = api_token
+        builder.headers['X-TrackerToken'] = api_token
+        builder.response :json
+        builder.adapter Faraday.default_adapter
+      end
+    end
+    
+    def fetch_stories(project: , query: )
+      get("projects/#{project}/stories", query).body
+    end
+    
+    def fetch_story(story_id)
+      get("stories/#{story_id}").body
+    end
+  end
+end

data/lib/tracker/option_parser.rb

@@ -0,0 +1,53 @@
+module Tracker
+  module OptionParser
+    def self.parse!(argv)
+      arguments = {}
+      
+      ::OptionParser.new do |options|
+        options.banner = <<-BANNER
+
+tracker --list OBJECT_TYPE (--format FORMAT_NAME)
+tracker --fetch OBJECT_TYPE (--id OBJECT_ID)(-i)
+
+BANNER
+        
+        options.on '--list OBJECT_TYPE', 'one of: stories, projects' do |object_type|
+          arguments[:method] = :list
+          arguments[:object_type] = object_type
+        end
+        
+        options.on '--parameter QUERY_PARAM', 'set a query param for get requests in the form of key,value. Can be used multiple times. See https://www.pivotaltracker.com/help/api/rest/v5 for possible keys', Array do |query_param|
+          arguments[:query_params] ||= {}
+          key, value, *_ = query_param
+          arguments[:query_params][key] = value
+          
+        end
+        
+        options.on '--format FORMAT_NAME', 'none (default), json' do |format_name|
+          arguments[:format_name] = format_name
+        end
+  
+        options.on '--fetch OBJECT_TYPE', 'story' do |object_type|
+          arguments[:method] = :fetch
+          arguments[:object_type] = object_type
+        end
+  
+        options.on '--id OBJECT_ID', 'OBJECT_ID for --fetch' do |object_id|
+          arguments[:object_id] = object_id
+        end
+        
+        options.on '-i', 'interactive --fetch' do
+          arguments[:interactive] = true
+        end
+        
+        options.on '--commit', 'make a commit' do
+          arguments[:commit] = true
+        end
+        
+        options.parse!(argv)
+      end
+      
+      arguments
+    end
+  end
+end

data/lib/tracker.rb

@@ -0,0 +1,33 @@
+require 'psych'
+require 'optparse'
+require 'pathname'
+require 'faraday'
+require 'faraday_middleware'
+require 'open3'
+
+module Tracker
+  autoload :Cli, 'tracker/cli'
+  autoload :Client, 'tracker/client'
+  autoload :OptionParser, 'tracker/option_parser'
+  
+  def self.api_token
+    config['api_token']
+  end
+
+  def self.project
+    config['project']
+  end
+  
+  def self.config
+    if File.exist?(configuration_file_location)
+      content = File.read(configuration_file_location)
+      Psych.load(content)
+    else
+      {}
+    end
+  end
+  
+  def self.configuration_file_location
+    @configuration_file_location ||= Pathname(ENV['HOME']).join('.tracker.config').to_s
+  end
+end

data/tracker-cli.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tracker/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tracker-cli"
+  spec.version       = Tracker::Cli::VERSION
+  spec.authors       = ["Benjamin Bergstein"]
+  spec.email         = ["bennyjbergstein@gmail.com"]
+
+  spec.summary       = "A mostly for-fun Command Line Interface (CLI) for Pivotal Tracker"
+  spec.description   = "Supports listing/fetching stories and projects"
+  spec.homepage      = "https://github.com/benastan/tracker-cli"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  
+  spec.bindir        = "bin"
+  spec.executables << 'tracker'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: tracker-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin Bergstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Supports listing/fetching stories and projects
+email:
+- bennyjbergstein@gmail.com
+executables:
+- tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tracker
+- lib/tracker.rb
+- lib/tracker/cli.rb
+- lib/tracker/cli/command.rb
+- lib/tracker/cli/command/fetch.rb
+- lib/tracker/cli/command/list.rb
+- lib/tracker/cli/version.rb
+- lib/tracker/client.rb
+- lib/tracker/option_parser.rb
+- tracker-cli.gemspec
+homepage: https://github.com/benastan/tracker-cli
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A mostly for-fun Command Line Interface (CLI) for Pivotal Tracker
+test_files: []