jira-cli 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2036d8670e831787e5b06238d5989db70d5d28e
-  data.tar.gz: 04a472335c54b49ca44dd7af30fe670a61f2863b
+  metadata.gz: cde1ac20a643d00b9b6d3308c49a84b94db85281
+  data.tar.gz: 807d024db48e5b22661a588aa6290c2ba65c3cfc
 SHA512:
-  metadata.gz: 51286f2fa3d9a52b79ad227ae62a646834881226204e66c828ba50c2e6c37bdc60bf494c16d69cdee8ce65b827e2e2355a5d0700ca5ed74f72c091cc6d1e4c5d
-  data.tar.gz: 623822ac5a21589ee525683829f69c41bc407ba14261b8122d647c28f0de9155894188dd363b49b43760d27d87dd1e61cc35dc921c4ed836406265c9e5d4bc2e
+  metadata.gz: a1c9306b45a7f7126bafda539d153d6d20fecff6dd566b7c21007ab8b33f5ec2a3aa2f7f9e1ca80c830c22ae8e4a31c7a72b0afd91378c31da9feeaaba4e401a
+  data.tar.gz: 9d0cda918e9e06385c4ae62c5872a506c7c80104a4f250507ef4a1efc143623de42ae4f152d600e4a70836104437b5021cb068701ea3d1b290b259ad3aebd0fd

data/lib/jira.rb

@@ -18,7 +18,7 @@ module Jira
     def initialize(args=[], options={}, config={})
       super
       Jira::Core.setup
-      @api = Jira::API.new
+      self.api
     end
 
   end

data/lib/jira/api.rb

@@ -7,35 +7,62 @@ module Jira
     def initialize
       @client = Faraday.new
       @client.basic_auth(Jira::Core.username, Jira::Core.password)
-    end
 
-    #
-    # Issue an API GET request and return parsed JSON
-    #
-    # @param path [String] API path
-    #
-    # @return [JSON] parsed API response
-    #
-    def get(path, params={})
-      response = @client.get(self.endpoint(path), params, self.headers)
-      return response.body.to_s.from_json
-    end
-
-    #
-    # Issue an API POST request and return parsed JSON
-    #
-    # @param path [String] API path
-    # @param params [Hash] params to post
-    #
-    # @return [JSON] parsed API response
-    #
-    def post(path, params={})
-      response = @client.post(self.endpoint(path), params, self.headers)
-      return response.body.to_s.from_json
+      self.define_actions
     end
 
     protected
 
+      #
+      # Defines the API GET, POST, PUT interaction methods
+      #
+      def define_actions
+        #
+        # def method(path, params={})
+        #
+        # Issue an API GET, POST, or PUT request and return parse JSON
+        #
+        # @param path [String] API path
+        # @param params [Hash] params to send
+        #
+        # @yield(Hash) yields to a success block
+        #
+        # @return [JSON] parased API response
+        #
+        [:get, :post, :put].each do |method|
+          self.class.send(:define_method, method) do |path, params=nil, verbose=true, &block|
+            params = params.to_json if !params.nil?
+            response = @client.send(
+              method,
+              self.endpoint(path),
+              params,
+              self.headers
+            )
+            json = response.body.to_s.from_json
+            if self.errorless?(json, verbose)
+              block.call(json)
+            end
+          end
+        end
+      end
+
+      #
+      # If any, outputs all API errors described by the input JSON
+      #
+      # @param json [Hash] API response JSON
+      # @param verbose [Boolean] true if errors should be output
+      #
+      # @return [Boolean] true if no errors exist
+      #
+      def errorless?(json, verbose=true)
+        errors = json['errorMessages']
+        if !errors.nil?
+          puts errors.join('. ') if verbose
+          return false
+        end
+        return true
+      end
+
       #
       # Returns the full JIRA REST API endpoint
       #

data/lib/jira/commands/comment.rb

@@ -7,19 +7,15 @@ module Jira
       if comment.strip.empty?
         puts "No comment posted."
       else
-        json = @api.post("issue/#{ticket}/comment", { body: comment }.to_json)
-        if json['errorMessages'].nil?
+        self.api.post("issue/#{ticket}/comment", { body: comment }) do |json|
           puts "Successfully posted your comment."
-        else
-          puts json['errorMessages'].join('. ')
         end
       end
     end
 
     desc "comments", "Lists the comments of the input ticket"
     def comments(ticket=Jira::Core.ticket)
-      json = @api.get("issue/#{ticket}")
-      if json['errorMessages'].nil?
+      self.api.get("issue/#{ticket}") do |json|
         comments = json['fields']['comment']['comments']
         if comments.count > 0
           comments.each do |comment|
@@ -34,8 +30,6 @@ module Jira
         else
           puts "There are no comments on issue #{ticket}."
         end
-      else
-        puts json['errorMessages'].join('. ')
       end
     end
 

data/lib/jira/commands/describe.rb

@@ -3,7 +3,12 @@ module Jira
 
     desc "describe", "Describes the input ticket"
     def describe(ticket=Jira::Core.ticket)
-      puts description(ticket.strip, false, true)
+      if Jira::Core.ticket?(ticket)
+        output = description(ticket.strip, false, true)
+        puts output if !output.strip.empty?
+      else
+        puts "The ticket #{ticket} is not a valid JIRA ticket."
+      end
     end
 
     desc "all", "Describes all local branches that match JIRA ticketing syntax"
@@ -30,7 +35,7 @@ module Jira
       # asynchronously fetch and describe tickets
       output = ""
       threads = []
-      if Jira::Core.ticket?(tickets[:current])
+      if !tickets[:current].nil?
         threads << Thread.new{ puts description(tickets[:current], true) }
       end
       mutex = Mutex.new
@@ -57,8 +62,7 @@ module Jira
       # @return [String] formatted summary string
       #
       def description(ticket, star=false, verbose=false)
-        json = @api.get("issue/#{ticket}")
-        if json['errorMessages'].nil?
+        self.api.get("issue/#{ticket}", nil, verbose) do |json|
           summary = json['fields']['summary']
           status = json['fields']['status']['name']
           assignee = json['fields']['assignee']['name']
@@ -67,11 +71,8 @@ module Jira
                 ("(" + Jira::Format.user(assignee) + ")").ljust(20) +
                 Jira::Format.status(status).ljust(26) +
                 Jira::Format.summary(summary)
-        elsif verbose
-          return json['errorMessages'].join('. ')
-        else
-          return ""
         end
+        return ""
       end
 
   end

data/lib/jira/commands/log.rb

@@ -4,11 +4,8 @@ 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}: ")
-      json = @api.post("issue/#{ticket}/worklog", { timeSpent: time_spent }.to_json)
-      if json['errorMessages'].nil?
+      self.api.post("issue/#{ticket}/worklog", { timeSpent: time_spent }) do |json|
         puts "Successfully logged #{time_spent} on #{ticket}."
-      else
-        puts json['errorMessages'].join('. ')
       end
     end
 

data/lib/jira/commands/new.rb

@@ -0,0 +1,111 @@
+module Jira
+  class CLI < Thor
+
+    desc "new", "Creates a new ticket in JIRA and checks out the git branch"
+    def new
+      self.api.get("issue/createmeta") do |meta|
+        # determine project
+        project = self.select_project(meta)
+        break if project.empty?
+
+        # determine issue type
+        issue_type = self.select_issue_type(project)
+        return if issue_type.empty?
+
+        # determine summary and description
+        summary = self.cli.ask("\nSummary: ")
+        description = self.cli.ask("Description:")
+
+        # determine api parameters
+        params = {
+          fields: {
+            project:     { id: project[:id] },
+            issuetype:   { id: issue_type },
+            summary:     summary,
+            description: description
+          }
+        }
+
+        # post issue to server
+        self.api.post("issue", params) do |json|
+          ticket = json['key']
+          `git checkout -b #{ticket} 2> /dev/null`
+          puts "\nTicket and branch #{Jira::Format.ticket(ticket)} created."
+          return
+        end
+      end
+      puts "No ticket created."
+    end
+
+    protected
+
+      #
+      # Given the creation metadata, prompts the user for the project to use,
+      # then return the project data hash
+      #
+      # @param json [Hash] creation metadata
+      #
+      # @return [Hash] selected project's metadata
+      #
+      def select_project(json)
+        projects = {}
+        json['projects'].each do |project|
+          data = {
+            id:     project['id'],
+            issues: project['issuetypes']
+          }
+          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 {}
+      end
+
+      #
+      # Given the project metadata, prompts the user for the issue type to use
+      # and returns the selected issue type.
+      #
+      # @param project_data [Hash] project metadata
+      #
+      # @return [String] selected issue type
+      #
+      def select_issue_type(project_data)
+        issue_types = {}
+        project_data[:issues].each do |issue_type|
+          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 ""
+      end
+
+  end
+end

data/lib/jira/commands/rename.rb

@@ -0,0 +1,19 @@
+module Jira
+  class CLI < Thor
+
+    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?")
+      if !summary.strip.empty?
+        params =  { fields: { summary: summary } }
+        self.api.put("issue/#{ticket}", params) do |json|
+          puts "Successfully updated ticket #{ticket}'s summary."
+        end
+      else
+        puts "No change made to ticket #{ticket}."
+      end
+    end
+
+  end
+end

data/lib/jira/commands/transition.rb

@@ -3,26 +3,26 @@ module Jira
 
     desc "transition", "Transitions the input ticket to the next state"
     def transition(ticket=Jira::Core.ticket)
-      json = @api.get("issue/#{ticket}/transitions")
-
-      options = {}
-      json['transitions'].each do |transition|
-        options[transition['name']] = transition['id']
-      end
-      options['Cancel'] = nil
+      self.api.get("issue/#{ticket}/transitions") do |json|
+        options = {}
+        json['transitions'].each do |transition|
+          options[transition['to']['name']] = transition['id']
+        end
+        options['Cancel'] = nil
 
-      self.cli.choose do |menu|
-        menu.index = :number
-        menu.index_suffix = ") "
-        menu.header = "Transitions Available For #{ticket}"
-        menu.prompt = "Select a transition: "
-        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)
+        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
         end
@@ -32,15 +32,10 @@ module Jira
     protected
 
       def api_transition(ticket, transition, description)
-        json = @api.post(
-          "issue/#{ticket}/transitions",
-          { transition: { id: transition } }.to_json
-        )
-        if json.empty?
+        params = { transition: { id: transition } }
+        self.api.post("issue/#{ticket}/transitions", params) do |json|
           puts "Successfully performed transition (#{description}) "\
                "on ticket #{ticket}."
-        else
-          puts json['errorMessages'].join('. ')
         end
       end
 

data/lib/jira/constants.rb

@@ -1,5 +1,5 @@
 module Jira
 
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 
 end

data/lib/jira/mixins.rb

@@ -15,15 +15,20 @@ module Jira
         @highline ||= ::HighLine.new
       end
 
+      #
+      # @return [Jira::API] Jira API class
+      #
+      def api
+        @api ||= Jira::API.new
+      end
+
   end
 end
 
 class String
 
   def from_json
-    JSON.parse(self)
-  rescue
-    {}
+    JSON.parse(self) rescue {}
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Darren Lin Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,6 +66,8 @@ files:
 - lib/jira/commands/describe.rb
 - lib/jira/commands/install.rb
 - lib/jira/commands/log.rb
+- lib/jira/commands/new.rb
+- lib/jira/commands/rename.rb
 - lib/jira/commands/transition.rb
 - lib/jira/commands/version.rb
 - lib/jira/constants.rb