jira-cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7ea0efc3dfd86f41e1499971b8452215bc52492
-  data.tar.gz: 1c47e481cd91abb6707fbf90c8f5282a1c2fb63e
+  metadata.gz: 4214636b9c7269a7938393d0fc276bb674a9f206
+  data.tar.gz: 2c12b0da63379b9b90464b55be0aed1408f42e11
 SHA512:
-  metadata.gz: d4d7b6bfbac5270fb757b1134ca0df4219313cfd9c9cdd43a1c965803d70613ad16531facc1443a50d91b7443131506fc534d5c8f4b2889135a5affd5e664f37
-  data.tar.gz: 3afb8c20df14297bfea66a11a7aca5bb02523c33ff91d4f99f2410140c43ace0c3007ce5cbc78e2324e23ee9818586a5db5f200ab66e31b03db13184fdb85b0b
+  metadata.gz: f57685970220ef829e128c376f0d14a62199a1eb800e79e38e3c770a05dd843c66a0c7a93e60eeb32cb7aa100a29ca34633f8b875a0d7a9edc932a8935478d67
+  data.tar.gz: f0d6981cfac1d5f6affe7a0be5d836e74897e69cb0b125188e457ccc1281e3ce989f7bf4094ddcd4871a7d884ad3509a30f3219ff7ed0fefbb8fb4f6e881c7ad

data/README.md

@@ -9,11 +9,23 @@ Ruby gem CLI tool used to manage JIRA workflows leveraging git
 [![Dependency Status](https://gemnasium.com/darrenli/jira-cli.png)](https://gemnasium.com/darrenli/jira-cli)
 [![Code Climate](https://codeclimate.com/github/darrenli/jira-cli.png)](https://codeclimate.com/github/darrenli/jira-cli)
 
-### Disclaimer
+### Available Commands
 
-This tool is in very early alpha and its architecture and commands
-are expected to change drastically. Please only use this tool for testing
-purposes.
+    jira all             # Describes all local branches that match JIRA ticketing syntax
+    jira browse          # Opens the current input ticket in your browser
+    jira comment         # Add a comment to the input ticket
+    jira comments        # Lists the comments of the input ticket
+    jira commit          # Commits uncommitted work with the ticket name and summary.
+    jira clipboard       # Copies the url of the JIRA ticket into the clipboard
+    jira describe        # Describes the input ticket
+    jira install         # Guides the user through JIRA installation
+    jira log             # Logs work against the input ticket
+    jira new             # Creates a new ticket in JIRA and checks out the git branch
+    jira rename          # Updates the summary of the input ticket
+    jira sprint          # Lists all tickets in active sprint
+    jira transition      # Transitions the input ticket to the next state
+    jira version         # Displays the version
+    jira help [COMMAND]  # Describe available commands or one specific command
 
 ### Gem Installation
 
@@ -37,3 +49,33 @@ git repository that you're managing via JIRA.
 
 Note: Authentication files are expected to drastically change. Currently, they
 are completely unencrypted. Use are your own risk... (see disclaimer above)
+
+### Disclaimer
+
+This tool is in very early alpha and its architecture and commands
+are expected to change drastically. Please only use this tool for testing
+purposes.
+
+### License
+
+(The MIT License)
+
+Copyright © 2014 Darren Cheng
+
+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/lib/jira.rb

@@ -4,6 +4,7 @@ require 'thor'
 require 'jira/constants'
 require 'jira/core'
 require 'jira/api'
+require 'jira/io'
 require 'jira/format'
 require 'jira/mixins'
 require 'jira/exceptions'

data/lib/jira/commands/clipboard.rb

@@ -0,0 +1,10 @@
+module Jira
+  class CLI < Thor
+
+    desc "clipboard", "Copies the url of the JIRA ticket into the clipboard"
+    def clipboard(ticket=Jira::Core.ticket)
+      `echo #{Jira::Core.url}/browse/#{ticket} | pbcopy`
+    end
+
+  end
+end

data/lib/jira/commands/comment.rb

@@ -3,7 +3,7 @@ module Jira
 
     desc "comment", "Add a comment to the input ticket"
     def comment(ticket=Jira::Core.ticket)
-      comment = self.cli.ask("Leave a comment for ticket #{ticket}:")
+      comment = self.io.ask("Leave a comment for ticket #{ticket}")
       if comment.strip.empty?
         puts "No comment posted."
       else

data/lib/jira/commands/install.rb

@@ -8,15 +8,14 @@ module Jira
     desc "install", "Guides the user through JIRA installation"
     def install
 
-      create_file Jira::Core.url_path, nil, verbose:false do
-        self.cli.ask("Enter your JIRA URL: ")
+      create_file(Jira::Core.url_path, nil, verbose:false) do
+        self.io.ask("Enter your JIRA URL")
       end
 
-      create_file Jira::Core.auth_path, nil, verbose:false do
-        username = self.cli.ask("Enter your JIRA username: ")
-        password = self.cli.ask("Enter your JIRA password: ") do |q|
-          q.echo = false
-        end
+      create_file(Jira::Core.auth_path, nil, verbose:false) do
+        username = self.io.ask("Enter your JIRA username")
+        # TODO - hide password input
+        password = self.io.ask("Enter your JIRA password")
         "#{username}:#{password}"
       end
 

data/lib/jira/commands/log.rb

@@ -3,7 +3,7 @@ module Jira
 
     desc "log", "Logs work against the input ticket"
     def log(ticket=Jira::Core.ticket)
-      time_spent = self.cli.ask("Time spent on #{ticket}: ")
+      time_spent = self.io.ask("Time spent on #{ticket}")
       self.api.post("issue/#{ticket}/worklog", { timeSpent: time_spent }) do |json|
         puts "Successfully logged #{time_spent} on #{ticket}."
       end

data/lib/jira/commands/new.rb

@@ -13,8 +13,8 @@ module Jira
         return if issue_type.empty?
 
         # determine summary and description
-        summary = self.cli.ask("\nSummary: ")
-        description = self.cli.ask("Description:")
+        summary = self.io.ask("Summary")
+        description = self.io.ask("Description")
 
         # determine api parameters
         params = {
@@ -29,12 +29,12 @@ module Jira
         # post issue to server
         self.api.post("issue", params) do |json|
           ticket = json['key']
-          self.copy(ticket)
+          self.clipboard(ticket)
           puts "\nTicket #{Jira::Format.ticket(ticket)} created and copied"\
                " to your clipboard."
-          if self.cli.agree("Create branch? (yes/no) ")
+          if self.io.agree("Create branch")
             `git branch #{ticket} 2> /dev/null`
-            if self.cli.agree("Checkout branch? (yes/no) ")
+            if self.io.agree("Check-out branch")
               `git checkout #{ticket} 2> /dev/null`
             end
           end
@@ -64,22 +64,9 @@ module Jira
           projects[project['name']] = data
         end
         projects['Cancel'] = nil
-
-        self.cli.choose do |menu|
-          menu.index = :number
-          menu.index_suffix = ") "
-          menu.header = "Select a project to create issue under"
-          menu.prompt = "Project: "
-          projects.keys.each do |choice|
-            menu.choice choice do
-              project_data = projects[choice]
-              if !project_data.nil?
-                return project_data
-              end
-            end
-          end
-        end
-        return {}
+        choice = self.io.choose("Select a project", projects.keys)
+        return {} if choice == 'Cancel'
+        return projects[choice]
       end
 
       #
@@ -96,22 +83,9 @@ module Jira
           issue_types[issue_type['name']] = issue_type['id']
         end
         issue_types['Cancel'] = nil
-
-        self.cli.choose do |menu|
-          menu.index = :number
-          menu.index_suffix = ") "
-          menu.header = "\nSelect an issue type"
-          menu.prompt = "Issue type: "
-          issue_types.keys.each do |choice|
-            menu.choice choice do
-              issue_type_id = issue_types[choice]
-              if !issue_type_id.nil?
-                return issue_type_id
-              end
-            end
-          end
-        end
-        return ""
+        choice = self.io.choose("Select an issue type", issue_types.keys)
+        return '' if choice == 'Cancel'
+        return issue_types[choice]
       end
 
   end

data/lib/jira/commands/rename.rb

@@ -4,7 +4,7 @@ module Jira
     desc "rename", "Updates the summary of the input ticket"
     def rename(ticket=Jira::Core.ticket)
       self.describe(ticket)
-      summary = self.cli.ask("What should the new ticket summary be?")
+      summary = self.io.ask("New ticket summary?")
       if !summary.strip.empty?
         params =  { fields: { summary: summary } }
         self.api.put("issue/#{ticket}", params) do |json|

data/lib/jira/commands/transition.rb

@@ -10,21 +10,11 @@ module Jira
         end
         options['Cancel'] = nil
 
-        self.cli.choose do |menu|
-          menu.index = :number
-          menu.index_suffix = ") "
-          menu.header = "Transition #{Jira::Format.ticket(ticket)} to"
-          menu.prompt = "Transition to: "
-          options.keys.each do |choice|
-            menu.choice choice do
-              transition_id = options[choice]
-              if transition_id.nil?
-                puts "No transition was performed on #{ticket}."
-              else
-                self.api_transition(ticket, transition_id, choice)
-              end
-            end
-          end
+        choice = self.io.choose("Transition to", options.keys)
+        if options[choice].nil?
+          puts "No transition was performed on #{ticket}."
+        else
+          self.api_transition(ticket, transition_id, choice)
         end
       end
     end

data/lib/jira/constants.rb

@@ -1,5 +1,5 @@
 module Jira
 
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 
 end

data/lib/jira/io.rb

@@ -0,0 +1,17 @@
+module Jira
+  class IO
+
+    def ask(prompt)
+      Ask.input(prompt)
+    end
+
+    def agree(prompt)
+      Ask.confirm(prompt, default: false)
+    end
+
+    def choose(prompt, options)
+      options[Ask.list(prompt, options)]
+    end
+
+  end
+end

data/lib/jira/mixins.rb

@@ -1,10 +1,10 @@
 module Jira
   class CLI < Thor
 
-    require 'highline/import'
     require 'json'
     require 'faraday'
     require 'pry-remote' rescue nil
+    require 'inquirer'
     include Thor::Actions
 
     protected
@@ -12,8 +12,8 @@ module Jira
       #
       # @return [Highline] HighLine instance for handling input
       #
-      def cli
-        @highline ||= ::HighLine.new
+      def io
+        @io ||= Jira::IO.new
       end
 
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Darren Lin Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -31,45 +31,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.18.1
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.20
+        version: 0.9.0
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.6.20
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.20
+        version: 0.9.0
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.6.20
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: inquirer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.2.0
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.2.0
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pry-remote
   requirement: !ruby/object:Gem::Requirement
@@ -142,9 +142,9 @@ files:
 - lib/jira.rb
 - lib/jira/api.rb
 - lib/jira/commands/browse.rb
+- lib/jira/commands/clipboard.rb
 - lib/jira/commands/comment.rb
 - lib/jira/commands/commit.rb
-- lib/jira/commands/copy.rb
 - lib/jira/commands/describe.rb
 - lib/jira/commands/install.rb
 - lib/jira/commands/log.rb
@@ -157,6 +157,7 @@ files:
 - lib/jira/core.rb
 - lib/jira/exceptions.rb
 - lib/jira/format.rb
+- lib/jira/io.rb
 - lib/jira/mixins.rb
 homepage: https://github.com/darrenli/jira-cli
 licenses:

data/lib/jira/commands/copy.rb

@@ -1,10 +0,0 @@
-module Jira
-  class CLI < Thor
-
-    desc "copy", "Copies the url of the JIRA ticket into the clipboard"
-    def copy(ticket=Jira::Core.ticket)
-      `echo #{Jira::Core.url}/browse/#{ticket} | pbcopy`
-    end
-
-  end
-end