jira-cli 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ec92a6c464ef57118383cdfec850349c3c6e7b
-  data.tar.gz: 072db85dd22418e94121e28294448643e8b06da6
+  metadata.gz: 25748c17ff058c8bf351f77db807ef8a5702ec26
+  data.tar.gz: ed745d5b66227e6e696dabe0c4747fd6279edecd
 SHA512:
-  metadata.gz: 0cd9b78698d419d394fb3e3945f3293e10155a1aa0c5f572f49af8dbfda892b2302d9fcba57c7215a797940051dd29c35728cc2f9d543d3e2d76a948b3096abf
-  data.tar.gz: 2c100f048e3991ee5b5be9252a42c14e0011b655a639ca3bb8496420cf2652bf3d10efe264e3ebd5940881b3feec5f02d6ceb30b4a50ab38d5390fe3fa04b7cd
+  metadata.gz: 3008287942dcfe89f3c6cd73892a55fe2b767226e620b46e611af0291d368c63269ea20a43310cb95a308124d973a70318904df9f2b369edd4fc6e9603be669d
+  data.tar.gz: c7f58f7054e546df6374a5e7848f98d628fda7c38d4ff844f9dd7a6a5a0e2788aa7a82b0a51384687efb7e735b6fff5ec5792b12ec1a640538d419e854016800

data/README.md

@@ -1,34 +1,31 @@
 # JIRA CLI [![Gem Version](https://badge.fury.io/rb/jira-cli.png)](http://badge.fury.io/rb/jira-cli)
 
-Ruby gem CLI tool used to manage JIRA workflows leveraging git
+Control JIRA from your terminal
 
 * * *
 
-[![Circle CI](https://circleci.com/gh/drn/jira-cli.svg?style=svg)](https://circleci.com/gh/drn/jira-cli)
-[![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)
+[![Circle CI](https://circleci.com/gh/ruby-jira/jira-cli.svg?style=svg)](https://circleci.com/gh/ruby-jira/jira-cli)
+[![Code Climate](https://codeclimate.com/github/ruby-jira/jira-cli.png)](https://codeclimate.com/github/ruby-jira/jira-cli)
 
 ### 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 checkout <ticket>  # Checks out a ticket from JIRA in the git branch
-    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 [jql]      # List the tickets of the input username (or jql)
-    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
+    jira assign <ticket>       # Assign a ticket to a user
+    jira attachments <ticket>  # View ticket attachments
+    jira comment <command>     # Commands for comment operations in JIRA
+    jira delete <ticket>       # Deletes a ticket
+    jira describe <ticket>     # 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 <ticket>         # Creates a link between two tickets in JIRA
+    jira log <command>         # Commands for logging operations in JIRA
+    jira new                   # Creates a new ticket
+    jira rename <ticket>       # Updates the summary of the input ticket
+    jira sprint                # Lists sprint info
+    jira tickets [jql]         # List the tickets of the input jql
+    jira transition <ticket>   # 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
 
@@ -38,27 +35,10 @@ Rubygems:
 
 Manually:
 
-    git clone git@github.com:darrenli/jira-cli.git
+    git clone git@github.com:ruby-jira/jira-cli.git
     cd jira-cli
     ./scripts/install
 
-### Project Installation
-
-In order to use this tool, you'll need to run the installation script in the
-git repository that you're managing via JIRA.
-
-    cd path/to/jira/repo
-    jira install
-
-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)

data/bin/jira

@@ -17,8 +17,6 @@ rescue Faraday::Error, UnauthorizedException
     end
   end
   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."

data/lib/jira/commands/assign.rb

@@ -1,9 +1,9 @@
 module Jira
   class CLI < Thor
 
-    desc "assign", "Assign a ticket to a user"
+    desc "assign <ticket>", "Assign a ticket to a user"
     method_option :assignee, aliases: "-a", type: :string, default: nil, lazy_default: "auto", banner: "ASSIGNEE"
-    def assign(ticket=Jira::Core.ticket)
+    def assign(ticket)
       Command::Assign.new(ticket, options).run
     end
 

data/lib/jira/commands/attachments.rb

@@ -1,8 +1,8 @@
 module Jira
   class CLI < Thor
 
-    desc "attachments", "View ticket attachments"
-    def attachments(ticket=Jira::Core.ticket)
+    desc "attachments <ticket>", "View ticket attachments"
+    def attachments(ticket)
       Command::Attachments.new(ticket).run
     end
 

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

@@ -3,7 +3,7 @@ module Jira
 
     desc 'add', 'Add a comment to the input ticket'
     method_option :text, aliases: "-t", type: :string, default: nil, lazy_default: "", banner: "TEXT"
-    def add(ticket=Jira::Core.ticket)
+    def add(ticket)
       Command::Comment::Add.new(ticket, options).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Comment < Thor
 
     desc 'delete', 'Delete a comment to the input ticket'
-    def delete(ticket=Jira::Core.ticket)
+    def delete(ticket)
       Command::Comment::Delete.new(ticket).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Comment < Thor
 
     desc 'list', 'Lists the comments of the input ticket'
-    def list(ticket=Jira::Core.ticket)
+    def list(ticket)
       Command::Comment::List.new(ticket).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Comment < Thor
 
     desc 'update', 'Update a comment to the input ticket'
-    def update(ticket=Jira::Core.ticket)
+    def update(ticket)
       Command::Comment::Update.new(ticket).run
     end
 

data/lib/jira/commands/delete.rb

@@ -1,9 +1,9 @@
 module Jira
   class CLI < Thor
 
-    desc "delete", "Deletes a ticket in JIRA and the git branch"
+    desc "delete <ticket>", "Deletes a ticket"
     method_option :force, type: :boolean, default: false
-    def delete(ticket=Jira::Core.ticket)
+    def delete(ticket)
       Command::Delete.new(ticket, options[:force]).run
     end
 
@@ -26,50 +26,12 @@ module Jira
         return if subtasks_failure?
 
         api.delete "issue/#{ticket}?deleteSubtasks=#{force}",
-          success: on_success,
-          failure: on_failure
+          success: ->{ puts "Ticket #{ticket} has been deleted." },
+          failure: ->{ puts "No change made to ticket #{ticket}." }
       end
 
     private
 
-      def on_success
-        -> do
-          on_failure and return unless create_branch?
-          on_failure and return unless delete_branch?
-        end
-      end
-
-      def on_failure
-        -> { puts "No change made to ticket #{ticket}." }
-      end
-
-      def branches
-        branches = `git branch --list 2> /dev/null`.split(' ')
-        branches.delete("*")
-        branches.delete(ticket.to_s)
-        branches
-      end
-
-      def create_branch?
-        response = io.yes?("Create branch?")
-
-        if branches.count == 1 or response
-          io.say("Creating a new branch.")
-          new_branch = io.ask("Branch?").strip
-          new_branch.delete!(" ")
-          on_failure and return false if new_branch.empty?
-          `git branch #{new_branch} 2> /dev/null`
-        end
-        true
-      end
-
-      def delete_branch?
-        response = self.io.select("Select a branch:", branches)
-        `git checkout #{response} 2> /dev/null`
-        `git branch -D #{ticket} 2> /dev/null`
-        true
-      end
-
       def subtasks_failure?
         return false unless subtask?
         if !metadata['fields']['subtasks'].empty? && !force

data/lib/jira/commands/describe.rb

@@ -1,8 +1,8 @@
 module Jira
   class CLI < Thor
 
-    desc "describe", "Describes the input ticket"
-    def describe(ticket=Jira::Core.ticket)
+    desc "describe <ticket>", "Describes the input ticket"
+    def describe(ticket)
       Command::Describe.new(ticket).run
     end
 

data/lib/jira/commands/link.rb

@@ -1,8 +1,8 @@
 module Jira
   class CLI < Thor
 
-    desc "link", "Creates a link between two tickets in JIRA"
-    def link(ticket=Jira::Core.ticket)
+    desc "link <ticket>", "Creates a link between two tickets in JIRA"
+    def link(ticket)
       Command::Link.new(ticket).run
     end
 

data/lib/jira/commands/new.rb

@@ -1,7 +1,7 @@
 module Jira
   class CLI < Thor
 
-    desc "new", "Creates a new ticket in JIRA and checks out the git branch"
+    desc 'new', 'Creates a new ticket'
     method_option :project, aliases: "-p", type: :string, default: nil, banner: "PROJECT"
     method_option :components, aliases: "-c", type: :array, default: nil, lazy_default: [], banner: "COMPONENTS"
     method_option :issuetype, aliases: "-i", type: :string, default: nil, banner: "ISSUETYPE"
@@ -50,9 +50,9 @@ module Jira
             issuetype:   { id: issue_type['id'] },
             summary:     summary,
             description: description,
-            parent:      @parent.nil? ? {} : { key: @parent },
-            components:  @components.nil? ? [] : @components
-          }
+            parent:      @parent.nil? ? nil : { key: @parent },
+            components:  @components.nil? ? nil : @components
+          }.delete_if{|_,v| v.nil? || v.eql?([])}
         }
       end
 
@@ -61,7 +61,6 @@ module Jira
           self.ticket = json['key']
           io.say("Ticket #{ticket} created.")
           assign? if options.empty? || !options['assignee'].nil?
-          create_branch? && checkout_branch? if options.empty?
         end
       end
 
@@ -69,18 +68,6 @@ module Jira
         Command::Assign.new(ticket, options).run if !options['assignee'].nil? || io.yes?('Assign?')
       end
 
-      def create_branch?
-        return false if io.no?("Create branch?")
-        `git branch #{ticket} 2> /dev/null`
-        true
-      end
-
-      def checkout_branch?
-        return false if io.no?("Check-out branch?")
-        `git checkout #{ticket} 2> /dev/null`
-        true
-      end
-
       def on_failure
         ->{ puts "No ticket created." }
       end
@@ -139,7 +126,7 @@ module Jira
       end
 
       def parent
-        @parent ||= options['parent'] || io.ask('Subtask parent:', default: Jira::Core.ticket)
+        @parent ||= options['parent'] || io.ask('Subtask parent:')
       end
 
       def issue_type
@@ -164,8 +151,9 @@ module Jira
 
       def description
         @description ||= (
-          description = options['description'] || (io.ask("Description:", default: '') if options['summary'].nil?)
-          description ||= ""
+          options['description'] ||
+            (io.ask("Description:", default: '') if options['summary'].nil?) ||
+            ""
         )
       end
 

data/lib/jira/commands/rename.rb

@@ -1,9 +1,9 @@
 module Jira
   class CLI < Thor
 
-    desc "rename", "Updates the summary of the input ticket"
+    desc "rename <ticket>", "Updates the summary of the input ticket"
     method_option :summary, aliases: "-s", type: :string, default: nil, lazy_default: "", banner: "SUMMARY"
-    def rename(ticket=Jira::Core.ticket)
+    def rename(ticket)
       Command::Rename.new(ticket, options).run
     end
 

data/lib/jira/commands/transition.rb

@@ -1,10 +1,10 @@
 module Jira
   class CLI < Thor
 
-    desc "transition", "Transitions the input ticket to the next state"
+    desc "transition <ticket>", "Transitions the input ticket to the next state"
     method_option :transition, aliases: "-t", type: :string, default: nil, lazy_default: "", banner: "TRANSITION"
     method_option :resolution, aliases: "-r", type: :string, default: nil, lazy_default: "", banner: "RESOLUTION"
-    def transition(ticket=Jira::Core.ticket)
+    def transition(ticket)
       Command::Transition.new(ticket, options).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Vote < Thor
 
     desc 'add', 'Vote for the input ticket'
-    def add(ticket=Jira::Core.ticket)
+    def add(ticket)
       Command::Vote::Add.new(ticket).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Vote < Thor
 
     desc 'delete', 'Delete vote for the input ticket'
-    def delete(ticket=Jira::Core.ticket)
+    def delete(ticket)
       Command::Vote::Delete.new(ticket).run
     end
 

data/lib/jira/commands/vote/list.rb

@@ -2,7 +2,7 @@ module Jira
   class Vote < Thor
 
     desc 'list', "List the votes on the input ticket"
-    def list(ticket=Jira::Core.ticket)
+    def list(ticket)
       Command::Vote::List.new(ticket).run
     end
 
@@ -42,7 +42,7 @@ module Jira
         end
 
         def no_voters?
-          if voters.count == 0
+          if voters.count.zero?
             puts "There are no votes on ticket #{ticket}."
             return true
           end

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

@@ -2,7 +2,7 @@ module Jira
   class Watch < Thor
 
     desc 'add', 'Watch the input ticket'
-    def add(ticket=Jira::Core.ticket)
+    def add(ticket)
       Command::Watch::Add.new(ticket).run
     end
 

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

@@ -2,7 +2,7 @@ module Jira
   class Watch < Thor
 
     desc 'delete', 'Stop watching the input ticket'
-    def delete(ticket=Jira::Core.ticket)
+    def delete(ticket)
       Command::Watch::Delete.new(ticket).run
     end
 

data/lib/jira/commands/watch/list.rb

@@ -2,7 +2,7 @@ module Jira
   class Watch < Thor
 
     desc 'list', 'Lists the watchers of the input ticket'
-    def list(ticket=Jira::Core.ticket)
+    def list(ticket)
       Command::Watch::List.new(ticket).run
     end
 
@@ -34,7 +34,7 @@ module Jira
         attr_accessor :watcher
 
         def no_watchers?
-          if watchers.count == 0
+          if watchers.count.zero?
             puts "Ticket #{ticket} has no watchers."
             return true
           end

data/lib/jira/constants.rb

@@ -2,6 +2,6 @@
 
 module Jira
 
-  VERSION = '0.3.6'.freeze
+  VERSION = '0.4.0'.freeze
 
 end

data/lib/jira/core.rb

@@ -38,13 +38,6 @@ module Jira
         { name: config[:cookie]['name'], value: config[:cookie]['value'] }
       end
 
-      #
-      # @return [String] default ticket is the current branch
-      #
-      def ticket
-        `git rev-parse --abbrev-ref HEAD 2>/dev/null`.strip
-      end
-
       #
       # Determines whether or not the input ticket matches the expected JIRA
       # ticketing syntax. Outputs a warning that the input ticket isn't a valid
@@ -69,14 +62,14 @@ module Jira
       # @return [String] path to .jira-cli file
       #
       def cli_path
-        @cli_path ||= root_path + "/.jira-cli"
+        @cli_path ||= "#{Dir.home}/.jira-cli"
       end
 
       #
       # @return [String] path to .jira-rescue-cookie file
       #
       def rescue_cookie_path
-        @rescue_cookie_path ||= root_path + "/.jira-rescue-cookie"
+        @rescue_cookie_path ||= "#{Dir.home}/.jira-rescue-cookie"
       end
 
       def config
@@ -86,16 +79,6 @@ module Jira
         )
       end
 
-    private
-
-      def root_path
-        @root_path ||= (
-          root_path = `git rev-parse --show-toplevel 2>/dev/null`.strip
-          raise GitException if root_path.empty?
-          root_path
-        )
-      end
-
     end
   end
 end

data/lib/jira/exceptions.rb

@@ -1,3 +1,2 @@
 class InstallationException < StandardError; end
-class GitException < StandardError; end
 class UnauthorizedException < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Darren Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -124,7 +124,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
-description: Ruby CLI managing git-based JIRA workflows
+description: Control JIRA from your terminal
 email: darren@thanx.com
 executables:
 - jira
@@ -137,10 +137,8 @@ files:
 - lib/jira/api.rb
 - lib/jira/auth_api.rb
 - lib/jira/command.rb
-- lib/jira/commands/all.rb
 - lib/jira/commands/assign.rb
 - lib/jira/commands/attachments.rb
-- lib/jira/commands/checkout.rb
 - lib/jira/commands/comment.rb
 - lib/jira/commands/comment/add.rb
 - lib/jira/commands/comment/delete.rb
@@ -174,7 +172,7 @@ files:
 - lib/jira/exceptions.rb
 - lib/jira/format.rb
 - lib/jira/sprint_api.rb
-homepage: https://github.com/drn/jira-cli
+homepage: https://github.com/ruby-jira/jira-cli
 licenses:
 - MIT
 metadata: {}
@@ -194,9 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: JIRA CLI
 test_files: []
-has_rdoc: 

data/lib/jira/commands/all.rb

@@ -1,72 +0,0 @@
-module Jira
-  class CLI < Thor
-
-    desc "all", "Describes all local branches that match JIRA ticketing syntax"
-    def all
-      Command::All.new.run
-    end
-
-  end
-
-  module Command
-    class All < Base
-
-      def run
-        if tickets.empty?
-          puts 'No tickets'
-          return
-        end
-        return if json.empty?
-        return unless errors.empty?
-        render_table(header, rows)
-      end
-
-    private
-
-      def header
-        [ 'Ticket', 'Assignee', 'Status', 'Summary' ]
-      end
-
-      def rows
-        json['issues'].map do |issue|
-          [
-            issue['key'],
-            issue['fields']['assignee']['name'] || 'Unassigned',
-            issue['fields']['status']['name'] || 'Unknown',
-            truncate(issue['fields']['summary'], 45)
-          ]
-        end
-      end
-
-      def errors
-        @errors ||= (json['errorMessages'] || []).join('. ')
-      end
-
-      def json
-        @json ||= api.get "search", params: params
-      end
-
-      def params
-        {
-          jql: "key in (#{tickets.join(',')})"
-        }
-      end
-
-      def tickets
-        @tickets ||= (
-          tickets = []
-          branches.each do |branch|
-            ticket = branch.delete('*').strip
-            tickets << ticket if Jira::Core.ticket?(ticket, false)
-          end
-          tickets
-        )
-      end
-
-      def branches
-        `git branch`.strip.split("\n")
-      end
-
-    end
-  end
-end

data/lib/jira/commands/checkout.rb

@@ -1,87 +0,0 @@
-module Jira
-  class CLI < Thor
-
-    desc "checkout <ticket>", "Checks out a ticket from JIRA in the git branch"
-    method_option :remote, aliases: "-r", type: :string, default: nil, lazy_default: "", banner: "REMOTE"
-    def checkout(ticket)
-      Command::Checkout.new(ticket, options).run
-    end
-
-  end
-
-  module Command
-    class Checkout < Base
-
-      attr_accessor :ticket, :options
-
-      def initialize(ticket, options)
-        self.ticket = ticket
-        self.options = options
-      end
-
-      def run
-        return unless Jira::Core.ticket?(ticket)
-        return if metadata.empty?
-        unless metadata['errorMessages'].nil?
-          on_failure
-          return
-        end
-        unless remote?
-          on_failure
-          return
-        end
-
-        create_branch unless branches.include?(ticket)
-        checkout_branch
-        reset_branch unless branches.include?(ticket)
-        on_success
-      end
-
-    private
-
-      def on_success
-        puts "Ticket #{ticket} checked out."
-      end
-
-      def on_failure
-        puts "No ticket checked out."
-      end
-
-      def branches
-        @branches ||= `git branch --list 2> /dev/null`.split(' ')
-        @branches.delete("*")
-        @branches
-      end
-
-      def create_branch
-        `git branch #{ticket} 2> /dev/null`
-      end
-
-      def checkout_branch
-        `git checkout #{ticket} 2> /dev/null`
-      end
-
-      def metadata
-        @metadata ||= api.get("issue/#{ticket}")
-      end
-
-      def remote
-        @remote ||= options['remote'] || io.select('Remote?', remotes)
-      end
-
-      def remotes
-        @remotes ||= `git remote 2> /dev/null`.split(' ')
-      end
-
-      def remote?
-        return true if remotes.include?(remote)
-        false
-      end
-
-      def reset_branch
-        `git reset --hard #{remote} 2> /dev/null`
-      end
-
-    end
-  end
-end