jira-cli 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26e38024a72dacde2712cf36890c7343dd878241
-  data.tar.gz: 1e5ee3a5a3719235da6f4890847c419708af349b
+  metadata.gz: 24aaafc8c0cbd9ae1830d16781ccfdae4d57c695
+  data.tar.gz: 64d3470c5ae4c3b0bcb5f9adfa403e0d0c4f0cf1
 SHA512:
-  metadata.gz: d7fcc3a1fb30afb8d9adfa180d6c36a0529ad9feb9f197a74bd273d244ce30e717bee96adc921583b5ca8faaa877942fea75e08de642c8b388f9bb86c85f9108
-  data.tar.gz: d2ddb2c5c015c9ba04492d3f7c7f31de6c52b928b1d5218001a3b1ea920ebbc91e4575c1f2aef00056837f85c2ea7e2e6fb41f467f91309102a1da254368fb6f
+  metadata.gz: ff546c7868f58330d07439fb52cbf01f9db9a076696f3b7d77b1ebde128ac5ea96f246484eb34e9194e262b75f748aba7ac3b7de6487507386e23cd60218cc8c
+  data.tar.gz: 88acd2274a38804e271b0a0f9dbbb00d19ea9e26cf3577cb72fba1f34d0cb3c8539e5030b31896b450a178379459a0fd6cdeb4671c140bfcb0dfaadab2eb0f0e

data/README.md

@@ -1,4 +1,18 @@
-jira-cli
+JIRA CLI
 ========
 
 Ruby gem CLI tool used to manage JIRA workflows leveraging git
+
+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.
+
+Installation
+------------
+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)

data/lib/jira.rb

@@ -1,6 +1,9 @@
 require 'thor'
 require 'fileutils'
 require 'jira/constants'
+require 'jira/core'
+require 'jira/api'
+require 'jira/format'
 require 'jira/mixins'
 require 'jira/version'
 require 'jira/install'
@@ -9,5 +12,11 @@ require 'jira/lookup'
 module Jira
   class CLI < Thor
 
+    def initialize(args=[], options={}, config={})
+      super
+      Jira::Core.setup
+      @api = Jira::API.new
+    end
+
   end
 end

data/lib/jira/api.rb

@@ -0,0 +1,51 @@
+module Jira
+  class API
+
+    #
+    # Initialize Jira::API
+    #
+    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)
+      response = @client.get(self.endpoint(path))
+      JSON.parse(response.body)
+    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)
+      JSON.parse(response.body)
+    end
+
+    protected
+
+      #
+      # Returns the full JIRA REST API endpoint
+      #
+      # @param path [String] API path
+      #
+      # @return [String] API endpoint
+      #
+      def endpoint(path)
+        "#{Jira::Core.url}/rest/api/2/#{path}"
+      end
+
+  end
+end

data/lib/jira/constants.rb

@@ -1,5 +1,5 @@
 module Jira
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
 end

data/lib/jira/core.rb

@@ -0,0 +1,125 @@
+module Jira
+  class Core
+    class << self
+
+      #
+      # Memoizes url, username, and password
+      #
+      def setup
+        self.url
+        self.auth
+      end
+
+      ### Virtual Attributes
+
+      #
+      # @return [String] JIRA project endpoint
+      #
+      def url
+        @url ||= self.read(self.url_path)
+      end
+
+      #
+      # @return [String] JIRA username
+      #
+      def username
+        @username ||= self.auth.first
+      end
+
+      #
+      # @return [String] JIRA password
+      #
+      def password
+        @password ||= self.auth.last
+      end
+
+      #
+      # Determines whether or not the input ticket matches the expected JIRA
+      # ticketing syntax.
+      #
+      # @param ticket [String] input ticket name
+      #
+      # @return [Boolean] whether input string matches JIRA ticket syntax
+      #
+      def ticket?(ticket)
+        !!ticket[/^[a-zA-Z]+-[0-9]+$/]
+      end
+
+      ### Relevant Paths
+
+      #
+      # @return [String] path to .jira-url file
+      #
+      def url_path
+        @url_path ||= self.root_path + "/.jira-url"
+      end
+
+      #
+      # @return [String] path to .jira-auth file
+      #
+      def auth_path
+        @auth_path ||= self.root_path + "/.jira-auth"
+      end
+
+      #
+      # @return [String] path of root git directory
+      #
+      def root_path
+        return @root_path if !@root_path.nil?
+        if !system('git rev-parse')
+          puts "JIRA commands can only be run within a git repository."
+          abort
+        end
+        @root_path ||= `git rev-parse --show-toplevel`.strip
+      end
+
+      protected
+
+        #
+        # Determines and parses the auth file
+        #
+        # @return [String] JIRA username
+        # @return [String] JIRA password
+        #
+        def auth
+          self.read(self.auth_path).split(':')
+        end
+
+        ### Core Actions
+
+        #
+        # Discards memozied class variables
+        #
+        def discard_memoized
+          @url = nil
+          @username = nil
+          @password = nil
+        end
+
+        #
+        # Validates the location and reads the contents of the input path
+        #
+        # @param path [String] path of file to read
+        #
+        # @return [String] contents of the file at the input path
+        #
+        def read(path)
+          self.validate_path!(path)
+          File.read(path).strip
+        end
+
+        #
+        # Aborts command if no file at the input path exists.
+        #
+        # @param path [String] path to validate
+        #
+        def validate_path!(path)
+          if !File.exists?(path)
+            say "Please run `jira install` before running this command."
+            abort
+          end
+        end
+
+    end
+  end
+end

data/lib/jira/format.rb

@@ -0,0 +1,35 @@
+module Jira
+  class Format
+    class << self
+
+      def star
+        "#{Thor::Shell::Color::BOLD}"\
+        "#{Thor::Shell::Color::YELLOW}"\
+        "*"\
+        "#{Thor::Shell::Color::CLEAR}"
+      end
+
+      def ticket(ticket)
+        "#{Thor::Shell::Color::RED}"\
+        "#{ticket}"\
+        "#{Thor::Shell::Color::CLEAR}"
+      end
+
+      def status(status)
+        "["\
+        "#{Thor::Shell::Color::BLUE}"\
+        "#{status}"\
+        "#{Thor::Shell::Color::CLEAR}"\
+        "]".center(26)
+      end
+
+      def summary(summary)
+        "#{Thor::Shell::Color::BOLD}"\
+        "#{Thor::Shell::Color::WHITE}"\
+        "#{summary}"\
+        "#{Thor::Shell::Color::CLEAR}"
+      end
+
+    end
+  end
+end

data/lib/jira/install.rb

@@ -7,11 +7,12 @@ module Jira
 
     desc "install", "Guides the user through JIRA installation"
     def install
-      create_file self.jira_url_path, nil, verbose:false do
+
+      create_file Jira::Core.url_path, nil, verbose:false do
         self.cli.ask("Enter your JIRA URL: ")
       end
 
-      create_file self.jira_auth_path, nil, verbose:false do
+      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
@@ -19,7 +20,7 @@ module Jira
         "#{username}:#{password}"
       end
 
-      self.discard_memoized
+      Jira::Core.send(:discard_memoized)
     end
 
   end

data/lib/jira/lookup.rb

@@ -1,42 +1,52 @@
 module Jira
   class CLI < Thor
 
-    desc "summarize", "Outputs the summary of the input ticket"
-    def summarize(ticket=nil)
-      ticket ||= ex('git rev-parse --abbrev-ref HEAD')
-      json = self.api_get("issue/#{ticket}")
-      summary = json['fields']['summary']
-      status = json['fields']['status']['name']
-      self.mutex.synchronize do
-        say "#{self.colored_ticket(ticket)} "\
-            "#{self.colored_status(status).center(26)} "\
-            "#{self.colored_summary(summary)}"
-      end
+    desc "describe", "Describes the input ticket"
+    def describe(ticket=nil)
+      ticket ||= `git rev-parse --abbrev-ref HEAD`.strip
+      output_summary(ticket)
     end
 
-    desc "all", "Summarizes all tickets that have local branches"
+    desc "all", "Describes all local branches that match JIRA ticketing syntax"
     def all
-      tickets = []
-      branches = ex("git branch").delete("*").split("\n")
+      # determine which local branches match JIRA ticket syntax
+      #   TODO - move to Jira::Git
+      tickets = {
+        current: nil,
+        others: []
+      }
+      branches = `git branch`.strip.split("\n")
       branches.each do |branch|
-        stripped = branch.strip
-        if !!stripped[/^[a-zA-Z]+-[0-9]+$/]
-          tickets << stripped
+        ticket = branch.delete('*').strip
+        if Jira::Core.ticket?(ticket)
+          if branch.include?('*')
+            tickets[:current] = ticket
+          else
+            tickets[:others] << ticket
+          end
         end
       end
 
+
+      # asynchronously fetch and describe tickets
+      output = ""
       threads = []
-      tickets.each do |ticket|
-        threads << Thread.new{ self.summarize(ticket) }
+      threads << Thread.new{ puts description(tickets[:current], true) }
+      mutex = Mutex.new
+      tickets[:others].each do |ticket|
+        threads << Thread.new do
+          out = description(ticket) + "\n"
+          mutex.synchronize{ output << out }
+        end
       end
       threads.each{ |thread| thread.join }
+
+      puts output
     end
 
     desc "comment", "Add a comment to the input ticket"
     def comment(ticket=nil)
       say "Coming soon"
-      #ticket ||= ex('get rev-parse --abbrev-ref HEAD')
-      #json = self.api_post("issue/#{ticket}")
     end
 
     desc "transition", "Transitions the input ticket to the next state"
@@ -46,55 +56,22 @@ module Jira
 
     protected
 
-      def colored_ticket(ticket)
-        "("\
-        "#{Thor::Shell::Color::RED}"\
-        "#{ticket}"\
-        "#{Thor::Shell::Color::CLEAR}"\
-        ")"
-      end
-
-      def colored_status(status)
-        "["\
-        "#{Thor::Shell::Color::BLUE}"\
-        "#{status}"\
-        "#{Thor::Shell::Color::CLEAR}"\
-        "]"
-      end
-
-      def colored_summary(summary)
-        "#{Thor::Shell::Color::BOLD}"\
-        "#{Thor::Shell::Color::WHITE}"\
-        "#{summary}"\
-        "#{Thor::Shell::Color::CLEAR}"
-      end
-
-      def api_get(path)
-        response = self.client.get self.api_path(path)
-        return JSON.parse(response.body)
-      end
-
-      def api_post(path, params)
-        response = self.client.post self.api_path(path), params
-        return JSON.parse(response)
-      end
-
-      def api_path(path)
-        "#{self.jira_url}/rest/api/2/#{path}"
-      end
-
-      def mutex
-        @mutex ||= Mutex.new
-      end
-
-      def client
-        self.mutex.synchronize do
-          return @client if !@client.nil?
-          @client = Faraday.new
-          username, password = self.jira_auth
-          @client.basic_auth(username, password)
-          return @client
-        end
+      #
+      # Returns a formatted description of the input ticket
+      #
+      # @param ticket [String] the ticket to describe
+      # @param star [Boolean] if true, adds a * indicator
+      #
+      # @return [String] formatted summary string
+      #
+      def description(ticket, star=false)
+        json = @api.get("issue/#{ticket}")
+        summary = json['fields']['summary']
+        status = json['fields']['status']['name']
+        return Jira::Format.ticket(ticket) +
+               (star ? Jira::Format.star : " ") +
+               Jira::Format.status(status) +
+               Jira::Format.summary(summary)
       end
 
   end

data/lib/jira/mixins.rb

@@ -5,57 +5,9 @@ module Jira
     require 'json'
     require 'faraday'
     include Thor::Actions
-    include Thor::Shell
 
     protected
 
-      #
-      # @return [String] JIRA endpoint
-      #
-      def jira_url
-        return @jira_url if !@jira_url.nil?
-        path = self.jira_url_path
-        self.validate_path!(path)
-        @jira_url ||= File.read(path).strip
-      end
-
-      #
-      # @return [String] JIRA authorization
-      #
-      # @return [String] username
-      # @return [String] password
-      #
-      def jira_auth
-        if !@username.nil? && !@password.nil?
-          return @username, @password
-        end
-        path = self.jira_auth_path
-        self.validate_path!(path)
-        @username, @password = File.read(path).strip.split(':')
-        return @username, @password
-      end
-
-      #
-      # @return [String] path to .jira-url file
-      #
-      def jira_url_path
-        @url_path ||= self.root_path + "/.jira-url"
-      end
-
-      #
-      # @return [String] path to .jira-auth file
-      #
-      def jira_auth_path
-        @auth_path ||= self.root_path + "/.jira-auth"
-      end
-
-      #
-      # @return [String] path to root git directory
-      #
-      def root_path
-        @root_path ||= ex "git rev-parse --show-toplevel"
-      end
-
       #
       # @return [Highline] HighLine instance for handling input
       #
@@ -63,28 +15,5 @@ module Jira
         @highline ||= ::HighLine.new
       end
 
-      #
-      # Execute shell command
-      #
-      # @param command [String] command to run
-      # @return [String] output of the run command
-      #
-      def ex(command)
-        run(command, verbose:false, capture:true).strip
-      end
-
-      def validate_path!(path)
-        if !File.exists?(path)
-          say "Please run `jira install` before running this action..."
-          abort
-        end
-      end
-
-      def discard_memoized
-        @username = nil
-        @password = nil
-        @jira_url = nil
-      end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Darren Lin Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -60,7 +60,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/jira
+- lib/jira/api.rb
 - lib/jira/constants.rb
+- lib/jira/core.rb
+- lib/jira/format.rb
 - lib/jira/install.rb
 - lib/jira/lookup.rb
 - lib/jira/mixins.rb