jira-cli 0.2.1 → 0.2.2

data/lib/jira/constants.rb

@@ -1,5 +1,5 @@
 module Jira
 
-  VERSION = "0.2.1"
+  VERSION = '0.2.2'
 
 end

data/lib/jira/core.rb

@@ -2,41 +2,39 @@ module Jira
   class Core
     class << self
 
-      #
-      # Memoizes url, username, and password
-      #
-      def setup
-        self.url
-      end
-
-      ### Virtual Attributes
-
       #
       # @return [String] JIRA project endpoint
       #
       def url
-        @url ||= ENV['JIRA_URL'] || self.read(self.cli_path)[:global]['url']
+        @url ||= ENV['JIRA_URL'] || config[:global]['url']
       end
 
       #
       # @return [String] JIRA username
       #
       def username
-        @username ||= ENV['JIRA_USERNAME'] || self.read(self.cli_path)[:global]['username']
+        @username ||= ENV['JIRA_USERNAME'] || config[:global]['username']
       end
 
       #
       # @return [String] JIRA password
       #
       def password
-        @password ||= ENV['JIRA_PASSWORD'] || self.read(self.cli_path)[:global]['password']
+        @password ||= ENV['JIRA_PASSWORD'] || config[:global]['password']
+      end
+
+      #
+      # @return [String] JIRA token
+      #
+      def token
+        @token ||= ENV['JIRA_TOKEN'] || self.read(self.cli_path)[:global]['token']
       end
 
       #
       # @return [String] default ticket is the current branch
       #
       def ticket
-        `git rev-parse --abbrev-ref HEAD`.strip
+        `git rev-parse --abbrev-ref HEAD 2>/dev/null`.strip
       end
 
       #
@@ -63,51 +61,25 @@ module Jira
       # @return [String] path to .jira-cli file
       #
       def cli_path
-        @cli_path ||= self.root_path + "/.jira-cli"
+        @cli_path ||= root_path + "/.jira-cli"
       end
 
-      #
-      # @return [String] path of root git directory
-      #
+    private
+
       def root_path
-        return @root_path if !@root_path.nil?
-        raise GitException.new if !system('git rev-parse 2> /dev/null')
-        @root_path ||= `git rev-parse --show-toplevel`.strip
+        @root_path ||= (
+          root_path = `git rev-parse --show-toplevel 2>/dev/null`.strip
+          raise GitException if root_path.empty?
+          root_path
+        )
       end
 
-      protected
-
-        ### 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 [Object] IniFile object of the file at the input path
-        #
-        def read(path)
-          self.validate_path!(path)
-          IniFile.load(path, { :comment => '#', :encoding => 'UTF-8' })
-        end
-
-        #
-        # Aborts command if no file at the input path exists.
-        #
-        # @param path [String] path to validate
-        #
-        def validate_path!(path)
-          raise InstallationException.new if !File.exists?(path)
-        end
+      def config
+        @config ||= (
+          raise InstallationException unless File.exists?(cli_path)
+          IniFile.load(cli_path, comment: '#', encoding: 'UTF-8')
+        )
+      end
 
     end
   end

data/lib/jira/legacy_api.rb

@@ -0,0 +1,102 @@
+require 'faraday'
+
+module Jira
+  class LegacyAPI
+
+    TYPES = [
+      :rest,
+      :agile
+    ].freeze
+
+    ENDPOINTS = {
+      rest:  'rest/api/2',
+      agile: 'rest/greenhopper/latest'
+    }.freeze
+
+    #
+    # Initialize Jira::API
+    #
+    # @param type [Symbol]
+    #
+    def initialize(type)
+      @type = type
+      @client = Faraday.new
+      @client.basic_auth(Jira::Core.username, Jira::Core.password)
+
+      self.define_actions
+    end
+
+    protected
+
+      #
+      # Defines the API DELETE, GET, POST, PUT interaction methods
+      #
+      def define_actions
+        #
+        # def method(path, params={})
+        #
+        # Issue an API DELETE, 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
+        #
+        [:delete, :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
+      #
+      # @param path [String] API path
+      #
+      # @return [String] API endpoint
+      #
+      def endpoint(path)
+        "#{Jira::Core.url}/#{ENDPOINTS[@type]}/#{path}"
+      end
+
+      #
+      # Returns the default API headers
+      #
+      # @return [Hash] API headers
+      #
+      def headers
+        { 'Content-Type' => 'application/json' }
+      end
+
+  end
+end

data/lib/jira/mixins.rb

@@ -2,18 +2,14 @@ module Jira
   class CLI < Thor
 
     require 'json'
-    require 'faraday'
-    require 'inquirer'
     require 'inifile'
+    require 'tty-prompt'
     include Thor::Actions
 
     protected
 
-      #
-      # @return [Highline] HighLine instance for handling input
-      #
       def io
-        @io ||= Jira::IO.new
+        @io ||= TTY::Prompt.new
       end
 
       #
@@ -25,7 +21,7 @@ module Jira
         key = "@api_#{type}"
         klass = self.instance_variable_get(key)
         if klass.nil?
-          klass = Jira::API.new(type)
+          klass = Jira::LegacyAPI.new(type)
           self.instance_variable_set(key, klass)
         end
         return klass
@@ -38,7 +34,7 @@ module Jira
       # @return index [Integer] asked type of index
       #
       def get_type_of_index(command, description)
-        response = self.io.ask("Index for #{command} to #{description}").strip
+        response = self.io.ask("Index for #{command} to #{description}:").strip
         return -1 if response.empty?
         index = response.to_i
         return -1 if index < 0

data/lib/jira/sprint_api.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Jira
+  class SprintAPI
+
+    def sprint(rapid_view_id, sprint_id)
+      response = client.get(
+        'rapid/charts/sprintreport',
+        rapidViewId: rapid_view_id,
+        sprintId:    sprint_id
+      )
+      return response.body if response.success?
+      {}
+    end
+
+    def sprints(rapid_view_id)
+      response = client.get("sprintquery/#{rapid_view_id}")
+      return response.body if response.success?
+      {}
+    end
+
+    def rapid_views
+      response = client.get("rapidview")
+      return response.body['views'] if response.success?
+      []
+    end
+
+  private
+
+    def client
+      @client ||= Faraday.new(endpoint) do |faraday|
+        faraday.request  :basic_auth, Jira::Core.username, Jira::Core.password
+        faraday.request  :json
+        faraday.response :json
+        faraday.adapter  :net_http
+      end
+    end
+
+    def endpoint
+      "#{Jira::Core.url}/rest/greenhopper/latest"
+    end
+
+    def headers
+      { 'Content-Type' => 'application/json' }
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
-- Darren Lin Cheng
+- Darren Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -45,25 +45,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: inquirer
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.10.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.10.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +124,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CLI used to manage JIRA workflows leveraging git
 email: darren@thanx.com
 executables:
@@ -95,6 +149,8 @@ files:
 - bin/jira
 - lib/jira.rb
 - lib/jira/api.rb
+- lib/jira/command.rb
+- lib/jira/commands/all.rb
 - lib/jira/commands/assign.rb
 - lib/jira/commands/attachments.rb
 - lib/jira/commands/comment.rb
@@ -106,6 +162,7 @@ files:
 - lib/jira/commands/log.rb
 - lib/jira/commands/new.rb
 - lib/jira/commands/rename.rb
+- lib/jira/commands/sprint.rb
 - lib/jira/commands/tickets.rb
 - lib/jira/commands/transition.rb
 - lib/jira/commands/version.rb
@@ -115,9 +172,10 @@ files:
 - lib/jira/core.rb
 - lib/jira/exceptions.rb
 - lib/jira/format.rb
-- lib/jira/io.rb
+- lib/jira/legacy_api.rb
 - lib/jira/mixins.rb
-homepage: https://github.com/darrenli/jira-cli
+- lib/jira/sprint_api.rb
+homepage: https://github.com/drn/jira-cli
 licenses:
 - MIT
 metadata: {}
@@ -137,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JIRA CLI