jira-cli 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8113060c03e8b470d3c0582958c574651b0aa650
-  data.tar.gz: a9ed25712ca61c36f13e263b129922579cf78f46
+  metadata.gz: 90eee20531277d150c8a465d36bd465f87aadc09
+  data.tar.gz: 40144b5a1cb60ff669124475a6a651fa45b6691a
 SHA512:
-  metadata.gz: 7fc9c0bcc93c5f425bbcc1dd076656d7b3ca3c50e2111ac814a34d7d10a02574c74f70c0202b55af585871bf29e1ac0c1bc5975252971cdcc79892733bb1471c
-  data.tar.gz: 5ee4cb4c5adc1f38f3f4dece433a0b52cfadd3257c99e48e1b7d4073476f044a6b14eda73e5663233a674540325937eb9b00d4de72e88352acdf78deed18730a
+  metadata.gz: 74fad1cbbdc11727a57c82fa39e3184eb7d80a5b199aac67eabbc9fe14acc510412f3b30a83ad805abd89ea30dc19eddd3517195a43829bfd400ff10d04f01f4
+  data.tar.gz: fb6e29c2710f0b74bb3000cb767799aff6f0bc82c5bb9199ed9cad29a91acb7646f0ab7eb1c59f543bc2dcfe7da546853f103dd47a49d9d40dd3abb18528df71

data/README.md

@@ -10,34 +10,24 @@ Ruby gem CLI tool used to manage JIRA workflows leveraging git
 
 ### Available Commands
 
-    jira all             # Describes all local branches that match JIRA ticketing syntax
-    jira assign          # Assign a ticket to a user
-    jira attachments     # View ticket attachments
-    jira comment         # Add a comment to the input ticket
-    jira commentd        # Delete a comment to the input ticket
-    jira comments        # Lists the comments of the input ticket
-    jira commentu        # Update a comment to the input ticket
-    jira commit          # Commits uncommitted work with the ticket name and summary.
-    jira delete          # Deletes a ticket in JIRA and the git branch
-    jira describe        # Describes the input ticket
-    jira install         # Guides the user through JIRA installation
-    jira link            # Creates a link between two tickets in JIRA
-    jira log             # Logs work against the input ticket
-    jira logd            # Deletes work against the input ticket
-    jira logs            # Lists work against the input ticket
-    jira logu            # Updates 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 tickets         # List the tickets of the input username
-    jira transition      # Transitions the input ticket to the next state
-    jira unvote          # Unvote against the input ticket
-    jira unwatch         # Unwatch against the input ticket
-    jira version         # Displays the version
-    jira vote            # Vote against the input ticket
-    jira votes           # List the votes of the input ticket
-    jira watch           # Watch against the input ticket
-    jira watchers        # List the watchers of the input ticket
-    jira help [COMMAND]  # Describe available commands or one specific command
+    jira all                # Describes all local branches that match JIRA ticketing syntax
+    jira assign             # Assign a ticket to a user
+    jira attachments        # View ticket attachments
+    jira comment <command>  # Commands for comment operations in JIRA
+    jira delete             # Deletes a ticket in JIRA and the git branch
+    jira describe           # Describes the input ticket
+    jira help [COMMAND]     # Describe available commands or one specific command
+    jira install            # Guides the user through JIRA CLI installation
+    jira link               # Creates a link between two tickets in JIRA
+    jira log <command>      # Commands for logging operations in JIRA
+    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 sprint info
+    jira tickets            # List the tickets of the input username
+    jira transition         # Transitions the input ticket to the next state
+    jira version            # Displays the version
+    jira vote <command>     # Commands for voting operations in JIRA
+    jira watch <command>    # Commands for watching tickets in JIRA
 
 ### Gem Installation
 

data/bin/jira

@@ -3,10 +3,12 @@
 require 'jira'
 begin
   Jira::CLI.start
+rescue Faraday::Error
+  puts "JIRA failed connect, you may need to rerun 'jira install'"
 rescue GitException
   puts "JIRA commands can only be run within a git repository."
 rescue InstallationException
   puts "Please run #{Jira::Format.summary('jira install')} before "\
-      "running this command."
+       "running this command."
 rescue Interrupt
 end

data/lib/jira.rb

@@ -1,10 +1,16 @@
-# dependencies
+# external dependencies
 require 'thor'
-# core logic and commands
-Dir.glob(
-  File.dirname(File.absolute_path(__FILE__)) + '/jira/**/*.rb',
-  &method(:require)
-)
+require 'tty-table'
+require 'inifile'
+require 'tty-prompt'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+# internal dependencies
+require 'jira/exceptions'
+require 'jira/constants'
+require 'jira/command'
+require 'jira/format'
 
 module Jira
   class CLI < Thor

data/lib/jira/api.rb

@@ -1,6 +1,3 @@
-require 'faraday'
-require 'faraday_middleware'
-
 module Jira
   class API
 
@@ -24,7 +21,7 @@ module Jira
       process(response, options)
     end
 
-  private
+  protected
 
     def process(response, options)
       json = response.body || {}
@@ -62,7 +59,15 @@ module Jira
     end
 
     def headers
-      { 'Content-Type' => 'application/json' }
+      { 'Content-Type' => 'application/json' }.merge(cookies)
+    end
+
+    def cookies
+      cookie = Jira::Core.cookie
+      unless cookie.empty?
+        return { 'cookie' => "#{cookie[:name]}=#{cookie[:value]}" }
+      end
+      {}
     end
 
   end

data/lib/jira/auth_api.rb

@@ -0,0 +1,11 @@
+module Jira
+  class AuthAPI < API
+
+  protected
+
+    def endpoint
+      "#{Jira::Core.url}/rest/auth/1"
+    end
+
+  end
+end

data/lib/jira/command.rb

@@ -1,4 +1,8 @@
-require 'tty-table'
+# internal dependencies
+require 'jira/api'
+require 'jira/sprint_api'
+require 'jira/auth_api'
+require 'jira/core'
 
 module Jira
   module Command
@@ -14,6 +18,18 @@ module Jira
         @api ||= Jira::API.new
       end
 
+      def auth_api
+        @auth_api ||= Jira::AuthAPI.new
+      end
+
+      def body
+        @body ||= (
+          comment = io.ask("Leave a comment for ticket #{ticket}:").strip
+          comment = comment.gsub(/\@[a-zA-Z]+/,'[~\0]') || comment
+          comment.gsub('[~@','[~') || comment
+        )
+      end
+
       def sprint_api
         @sprint_api ||= Jira::SprintAPI.new
       end
@@ -34,3 +50,7 @@ module Jira
     end
   end
 end
+
+# load commands
+commands_directory = File.join(File.dirname(__FILE__), 'commands', '*.rb')
+Dir[commands_directory].each { |file| require file }

data/lib/jira/commands/all.rb

@@ -28,8 +28,8 @@ module Jira
         json['issues'].map do |issue|
           [
             issue['key'],
-            issue['fields']['assignee']['name'],
-            issue['fields']['status']['name'],
+            issue['fields']['assignee']['name'] || 'Unassigned',
+            issue['fields']['status']['name'] || 'Unknown',
             truncate(issue['fields']['summary'], 45)
           ]
         end

data/lib/jira/commands/assign.rb

@@ -1,5 +1,3 @@
-require_relative '../command'
-
 module Jira
   class CLI < Thor
 
@@ -26,6 +24,8 @@ module Jira
           failure: on_failure
       end
 
+    private
+
       def on_success
         -> do
           puts "Ticket #{ticket} assigned to #{name}."

data/lib/jira/commands/comment.rb

@@ -1,104 +1,14 @@
+require 'jira/commands/comment/add'
+require 'jira/commands/comment/delete'
+require 'jira/commands/comment/list'
+require 'jira/commands/comment/update'
+
 module Jira
   class CLI < Thor
 
-    desc "comment", "Add a comment to the input ticket"
-    def comment(ticket=Jira::Core.ticket)
-      comment = self.get_comment_body(ticket)
-      puts "No comment posted." and return if comment.empty?
-
-      self.api.post("issue/#{ticket}/comment", { body: comment }) do |json|
-        puts "Successfully posted your comment."
-        return
-      end
-      puts "No comment posted."
-    end
-
-    desc "commentd", "Delete a comment to the input ticket"
-    def commentd(ticket=Jira::Core.ticket)
-      self.comment_delete(ticket)
-    end
-
-    desc "comments", "Lists the comments of the input ticket"
-    def comments(ticket=Jira::Core.ticket)
-      self.api.get("issue/#{ticket}") do |json|
-        comments = json['fields']['comment']['comments']
-        if comments.count > 0
-          comments.each do |comment|
-            author = comment['author']['displayName']
-            time = Time.parse(comment['updated'])
-            body = comment['body']
-
-            printf "[%2d]", comments.index(comment)
-            puts "  #{Jira::Format.user(author)} @ "\
-                 "#{Jira::Format.time(time)}:\n"\
-                 "#{Jira::Format.comment(body)}"
-          end
-        else
-          puts "There are no comments on ticket #{ticket}."
-        end
-      end
-    end
-
-    desc "commentu", "Update a comment to the input ticket"
-    def commentu(ticket=Jira::Core.ticket)
-      self.comment_update(ticket)
-    end
-
-    protected
-
-      def comment_delete(ticket)
-        comments(ticket) if self.io.yes?("List comments for ticket #{ticket}?")
-
-        index = self.get_type_of_index("comment", "delete")
-        puts "No comment deleted." and return if index < 0
-
-        self.api.get("issue/#{ticket}") do |json|
-          comments = json['fields']['comment']['comments']
-          if index < comments.count
-            id = comments[index]['id']
-            self.api.delete("issue/#{ticket}/comment/#{id}") do |json|
-              puts "Successfully deleted your comment."
-              return
-            end
-          end
-        end
-        puts "No comment deleted."
-      end
-
-      def comment_update(ticket)
-        comments(ticket) if self.io.yes?("List comments for ticket #{ticket}?")
-
-        index = self.get_type_of_index("comment", "update")
-        puts "No comment updated." and return if index < 0
-
-        comment = self.get_comment_body(ticket)
-        puts "No comment updated." and return if comment.empty?
-
-        self.api.get("issue/#{ticket}") do |json|
-          comments = json['fields']['comment']['comments']
-          id = comments[index]['id']
-          self.api.put("issue/#{ticket}/comment/#{id}", { body: comment }) do |json|
-            puts "Successfully updated your comment."
-            return
-          end
-        end
-        puts "No comment updated."
-      end
-
-      #
-      # Prompts the user for a comment body, strips it, then
-      # returns a substituted version of it
-      #
-      # @return comment [String] asked comment body
-      #
-      def get_comment_body(ticket)
-        comment = self.io.ask("Leave a comment for ticket #{ticket}:").strip
-        temp = comment.gsub(/\@[a-zA-Z]+/,'[~\0]')
-        temp = comment if temp.nil?
-        temp = temp.gsub('[~@','[~')
-        comment = temp if !temp.nil?
-        comment
-      end
+    desc 'comment <command>', 'Commands for comment operations in JIRA'
+    subcommand 'comment', Comment
 
   end
+
 end

data/lib/jira/commands/comment/add.rb

@@ -0,0 +1,46 @@
+module Jira
+  class Comment < Thor
+
+    desc 'add', 'Add a comment to the input ticket'
+    def add(ticket=Jira::Core.ticket)
+      Command::Comment::Add.new(ticket).run
+    end
+
+  end
+
+  module Command
+    module Comment
+      class Add < Base
+
+        attr_accessor :ticket
+
+        def initialize(ticket)
+          self.ticket = ticket
+        end
+
+        def run
+          return if body.empty?
+          api.post "issue/#{ticket}/comment",
+            params:  params,
+            success: on_success,
+            failure: on_failure
+        end
+
+      private
+
+        def params
+          { body: body }
+        end
+
+        def on_success
+          ->{ puts "Successfully posted your comment." }
+        end
+
+        def on_failure
+          ->{ puts "No comment posted." }
+        end
+
+      end
+    end
+  end
+end

data/lib/jira/commands/comment/delete.rb

@@ -0,0 +1,80 @@
+module Jira
+  class Comment < Thor
+
+    desc 'delete', 'Delete a comment to the input ticket'
+    def delete(ticket=Jira::Core.ticket)
+      Command::Comment::Delete.new(ticket).run
+    end
+
+  end
+
+  module Command
+    module Comment
+      class Delete < Base
+
+        attr_accessor :ticket
+
+        def initialize(ticket)
+          self.ticket = ticket
+        end
+
+        def run
+          return unless comments?
+          api.delete endpoint,
+            success: on_success,
+            failure: on_failure
+        end
+
+      private
+
+        def comments?
+          if json.empty?
+            puts "Ticket #{ticket} has no comments."
+            return false
+          end
+          true
+        end
+
+        def endpoint
+          "issue/#{ticket}/comment/#{to_delete['id']}"
+        end
+
+        def on_success
+          ->{ puts "Successfully deleted comment from #{to_delete['updateAuthor']['displayName']}" }
+        end
+
+        def on_failure
+          ->{ puts "No comment deleted." }
+        end
+
+        def to_delete
+          @to_delete ||= comments[
+            io.select("Select a comment to delete:", comments.keys)
+          ]
+        end
+
+        def comments
+          @comments ||= (
+            comments = {}
+            json.each do |comment|
+              comments[description_for(comment)] = comment
+            end
+            comments
+          )
+        end
+
+        def description_for(comment)
+          author = comment['updateAuthor']['displayName']
+          updated_at = Jira::Format.time(Time.parse(comment['updated']))
+          body = comment['body'].gsub("\r\n|\r|\n", ";")
+          truncate("#{author} @ #{updated_at}: #{body}", 160)
+        end
+
+        def json
+          @json ||= api.get("issue/#{ticket}/comment")['comments']
+        end
+
+      end
+    end
+  end
+end