terjira 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5592eeb887c0b8ce2a4437c36c3e2468417f54f3
-  data.tar.gz: 49483f95737dc6ae8f57d7871c8db30ce4da59d3
+  metadata.gz: 1daef227221455846fa59674d6cfeb9735d1e33d
+  data.tar.gz: 5dd7bbe7f90499eaf61ff4300ae5518f1a3336b3
 SHA512:
-  metadata.gz: 82a1c765c3328a83d96e4e6e5c800acaee4fac814f672d2f59d11e8292d650d7ea1c531aef9ec42c8d97f408aabd67d2a5697f5cfd24f85b0a135211fa8d5a4f
-  data.tar.gz: 04eea6bbe20ae4474c7b518374ad3a63fefea7f51030b7036e91b2018be799fb99670f2eba6cc51df25d4260e884d17806e2f84babbfcd403c72bb2dcdc5e8c5
+  metadata.gz: 6124824ac122ea72b0e7077956371b6803cd848a8a454bbb03c4e25de2a8e99902e64a5fd01763925b1cecfa9ac7e04457749c7b56ddd2c530d178bbdfd025f8
+  data.tar.gz: 4ecc886b8ab99b2bc3ddfb9f9694f6baba32f5b63484f9468ac9dd6368e5428108e4cedfb74e291024f1ce8e9a0326e6a237d79284c912f4828441836358f8b2

data/.rubocop.yml

@@ -1,14 +1,23 @@
 AllCops:
   Exclude:
+    - 'bin/*'
     - '*.gemspec'
+    - 'lib/terjira/ext/**/*'
+    - 'Rakefile'
 
 Style/Documentation:
   Enabled: false
 Style/EachWithObject:
   Enabled: false
+Style/RescueModifier:
+  Enabled: false
 
 Lint/AssignmentInCondition:
   Enabled: false
+Lint/Eval:
+  Enabled: false
+Lint/ImplicitStringConcatenation:
+  Enabled: false
 
 Metrics/BlockLength:
   Enabled: false
@@ -20,7 +29,7 @@ Metrics/AbcSize:
   Max: 20
 
 Metrics/MethodLength:
-  Max: 20
+  Max: 30
 
 Metrics/LineLength:
   Max: 100

data/Gemfile.lock

@@ -6,9 +6,9 @@ PATH
       jira-ruby (~> 1.1)
       pastel (~> 0.6.1)
       thor (~> 0.19)
-      tty-prompt (~> 0.8.0)
-      tty-spinner (~> 0.4.1)
-      tty-table (~> 0.6.0)
+      tty-prompt (~> 0.8)
+      tty-spinner (~> 0.4)
+      tty-table (~> 0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,42 +5,41 @@
 
 # Terjira
 
-Terjira is a very interactive and easy to use command line interface for Jira.
+Terjira is interactive and easy to use command line interface (or Application) for Jira. You do not need to remember reosurce key or id. Terjira suggests with interactive prompt.
 
+Your Jira must support Rest API 2.0 and Agile Rest API 1.0
 
-I'm working now..
+
+**I'm working now..**
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
 
-```ruby
-gem 'terjira'
-```
+    $ gem install terjira
 
-And then execute:
+If you have permission problem,
 
-    $ bundle
+    $ sudo gem install terjira
 
-Or install it yourself as:
+    # or
 
-    $ gem install terjira
+    $ gem install terjira --user-install
+    # You need to export your gem path
 
 ## Usage
 
-TODO: Write usage instructions here
 
-* Mock data is from jira-ruby
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/terjira. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/keepcosmos/terjira. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # Do I need bundler setup?
-# require "bundler/setup"
+require "bundler/setup"
 require "terjira"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/bin/jira

@@ -1,14 +1,22 @@
 #!/usr/bin/env ruby
+
 # Do I need bundler setup?
 # require 'bundler/setup'
 require 'terjira'
 require 'json'
+require 'pastel'
 
 begin
   Terjira::CLI.start(ARGV)
+rescue SystemExit, Interrupt
 rescue JIRA::HTTPError => e
   message = JSON.parse(e.response.body)
-  error_message = message['errorMessages']
-  error_message = error_message.join(' ') if error_message.is_a? Array
-  puts "#{e.message} :: #{error_message}"
+  pastel = Pastel.new
+  if message['errorMessages'].present?
+    puts pastel.red(message['errorMessages'].join("\n"))
+  else
+    puts pastel.red(e.message.to_s + "\n" + e.response.body)
+  end
+rescue => e
+  puts Pastel.new.dim(e.message)
 end

data/bin/terjira

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# Do I need bundler setup?
+require 'bundler/setup'
+require 'terjira'
+require 'json'
+require 'pastel'
+
+begin
+  Terjira::CLI.start(ARGV)
+rescue SystemExit, Interrupt
+rescue JIRA::HTTPError => e
+  message = JSON.parse(e.response.body)
+  pastel = Pastel.new
+  if message['errorMessages'].present?
+    puts pastel.red(message['errorMessages'].join("\n"))
+  else
+    puts pastel.red(e.message.to_s + "\n" + e.response.body)
+  end
+rescue => e
+  puts Pastel.new.dim(e.message)
+end

data/lib/terjira/base_cli.rb

@@ -1,11 +1,13 @@
 require 'thor'
 
 require_relative 'option_supportable'
-Dir[File.dirname(__FILE__) + "/presenters/*.rb"].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/presenters/*.rb'].each { |f| require f }
 
 module Terjira
+  # Jira client based on jira-ruby gem
   module Client
-    %w[Base Field Project Board Sprint Issue User Status Resolution Priority RapidView Agile].each do |klass|
+    %w(Base Field Issuetype Project Board Sprint Issue User
+       Status Resolution Priority RapidView Agile).each do |klass|
       autoload klass, "terjira/client/#{klass.gsub(/(.)([A-Z](?=[a-z]))/,'\1_\2').downcase}"
     end
   end
@@ -19,7 +21,7 @@ module Terjira
     include BoardPresenter
     include SprintPresenter
 
-    def self.banner(command, namespace = nil, subcommand = false)
+    def self.banner(command, _namespace = nil, _subcommand = false)
       "#{basename} #{subcommand_prefix} #{command.usage}"
     end
 

data/lib/terjira/board_cli.rb

@@ -2,11 +2,26 @@ require_relative 'base_cli'
 
 module Terjira
   class BoardCLI < BaseCLI
-    desc "list(ls)", "list all boards"
+    no_commands do
+      def client_class
+        Client::Board
+      end
+    end
+
+    desc "( ls | list)", "list all boards"
     map ls: :list
     def list
-      boards = Client::Board.all
+      boards = client_class.all
       render_boards_summary(boards.sort_by { |b| b.id })
     end
+
+    desc "backlog", "Backlog from the board"
+    jira_options :board, :assignee, :issuetype, :priority
+    def backlog
+      opts = suggest_options(required: [:board])
+      board = opts.delete(:board)
+      issues = client_class.backlog(board.key_value, opts)
+      render_issues(issues)
+    end
   end
 end

data/lib/terjira/client/agile.rb

@@ -7,22 +7,22 @@ module Terjira
         delegate :all, :get_sprints, :backlog_issues, to: :resource
 
         def project_by_board(board_id)
-          resp = agile_api_get("board/#{board_id}/project")
+          agile_api_get("board/#{board_id}/project")
         end
 
         def boards
-          all["values"]
+          all['values']
         end
 
-        def sprints(board_id, options = {})
-          sprints = get_sprints(board_id)["values"]
+        def sprints(board_id)
+          sprints = get_sprints(board_id)['values']
           sprints.sort_by do |sprint|
-            if sprint["state"] == 'active'
-              [0, sprint["id"]]
-            elsif sprint["state"] == 'future'
-              [1, sprint["id"]]
-            elsif sprint["state"] == 'closed'
-              [2, sprint["id"] * -1]
+            if sprint['state'] == 'active'
+              [0, sprint['id']]
+            elsif sprint['state'] == 'future'
+              [1, sprint['id']]
+            elsif sprint['state'] == 'closed'
+              [2, sprint['id'] * -1]
             else
               [3, 0]
             end
@@ -32,9 +32,6 @@ module Terjira
         def backlog_issues(board_id)
           get_backlog_issues(board_id)
         end
-
-        def sprint_issues(board_id)
-        end
       end
     end
   end

data/lib/terjira/client/auth_option_builder.rb

@@ -17,7 +17,7 @@ module Terjira
       end
 
       def expire_auth_options(cache_key = AUTH_CACHE_KEY)
-        auth_file_cache.delete(cache_key)
+        Terjira::FileCache.clear_all
       end
 
       def build_auth_options_by_tty

data/lib/terjira/client/base.rb

@@ -1,23 +1,22 @@
-require_relative 'jql_query_builer'
+require_relative 'jql_builder'
 require_relative 'auth_option_builder'
 
 module Terjira
   module Client
     # Abstract class to delegate jira-ruby resource class
     class Base
-      extend JQLQueryBuilder
+      extend JQLBuilder
       extend AuthOptionBuilder
 
       DEFAULT_CACHE_SEC = 60
-      DEFAULT_API_PATH = "/rest/api/2/"
-      AGILE_API_PATH = "/rest/agile/1.0/"
+      DEFAULT_API_PATH = '/rest/api/2/'.freeze
+      AGILE_API_PATH = '/rest/agile/1.0/'.freeze
 
       class << self
-
         delegate :build, to: :resource
 
         def client
-          @@client ||= JIRA::Client.new(build_auth_options)
+          @client ||= JIRA::Client.new(build_auth_options)
         end
 
         def resource
@@ -29,7 +28,7 @@ module Terjira
         end
 
         def class_name
-          self.to_s.split("::").last
+          to_s.split('::').last
         end
 
         def cache(options = {})
@@ -38,16 +37,14 @@ module Terjira
         end
 
         # define `#api_get(post, put, delete)` and `#agile_api_get(post, put, delete)`
-        { DEFAULT_API_PATH => "api_",
-          AGILE_API_PATH => "agile_api_"
-        }.each do |url_prefix, method_prefix|
-
+        { DEFAULT_API_PATH => 'api_',
+          AGILE_API_PATH => 'agile_api_' }.each do |url_prefix, method_prefix|
           [:get, :delete].each do |http_method|
             method_name = "#{method_prefix}#{http_method}"
             define_method(method_name) do |path, params = {}, headers = {}|
               url = url_prefix + path
               if params.present?
-                params.reject! { |k, v| v.blank? }
+                params.reject! { |_k, v| v.blank? }
                 url += "?#{URI.encode_www_form(params)}"
               end
               parse_body client.send(http_method, url, headers)

data/lib/terjira/client/board.rb

@@ -6,13 +6,23 @@ module Terjira
 
         def all(options = {})
           params = options.slice(:type)
-          resp = agile_api_get("board", params)
-          resp["values"].map { |value| build(value) }
+          resp = agile_api_get('board', params)
+          resp['values'].map { |value| build(value) }
         end
 
         def find(board_id)
           resp = agile_api_get("board/#{board_id}")
-          self.build(resp)
+          build(resp)
+        end
+
+        def backlog(board_id, options = {})
+          jql = build_jql(options)
+          resp = if jql.present?
+                  agile_api_get("board/#{board_id}/backlog", jql: jql)
+                 else
+                   agile_api_get("board/#{board_id}/backlog")
+                 end
+          resp["issues"].map { |issue| Issue.build(issue) }
         end
       end
     end

data/lib/terjira/client/field.rb

@@ -5,11 +5,21 @@ module Terjira
     class Field < Base
       class << self
         def all
-          @all_fields ||= resource.all
+          @all_fields ||= file_cache.fetch("all") do
+            resource.all
+          end
         end
 
         def epic_name
-          all.find { |field| field.name == "Epic Name" }
+          all.find { |field| field.name == 'Epic Name' }
+        end
+
+        def epiclink
+          all.find { |field| field.name == 'Epic Link' }
+        end
+
+        def file_cache
+          Terjira::FileCache.new("resource/fields", 60 * 60 * 24)
         end
       end
     end

data/lib/terjira/client/issue.rb

@@ -5,22 +5,21 @@ module Terjira
     class Issue < Base
       class << self
         delegate :build, :find, to: :resource
-        ISSUE_JQL_KEYS = [:sprint, :assignee, :reporter, :project, :issuetype, :priority, :status, :statusCategory]
 
         def all(options = {})
-          opts = options.slice(*ISSUE_JQL_KEYS)
           return resource.all if options.blank?
           max_results = options.delete(:max_results) || 500
-          resource.jql(build_jql_query(opts), max_results: max_results)
+          resource.jql(build_jql(options), max_results: max_results)
         end
 
-        def find(issue, options = {})
-          resp = api_get("issue/#{issue.key_value}", options)
-          build(resp)
+        def all_epic_issues(epic)
+          resp = agile_api_get("epic/#{epic.key}/issue")
+          resp["issues"].map { |issue| build(issue) }
         end
 
-        def current_my_issues
-          jql("assignee = #{self.key_value} AND statusCategory != 'Done'")
+        def find(issue, options = {})
+          resp = agile_api_get("issue/#{issue.key_value}", options)
+          build(resp)
         end
 
         def assign(issue, assignee)
@@ -29,7 +28,7 @@ module Terjira
         end
 
         def write_comment(issue, message)
-          resp = api_post("issue/#{issue.key_value}/comment", { body: message }.to_json)
+          api_post("issue/#{issue.key_value}/comment", { body: message }.to_json)
           find(issue)
         end
 
@@ -39,9 +38,8 @@ module Terjira
             params.merge!(transition_param)
           end
 
-          resp = api_post "issue", params.to_json
-          result_id = resp["id"]
-          find(result_id)
+          resp = api_post 'issue', params.to_json
+          find(resp['id'])
         end
 
         def update(issue, options = {})
@@ -80,7 +78,7 @@ module Terjira
           params = {}
 
           custom_fields = options.keys.select { |k| k.to_s =~ /^customfield/ }
-          (custom_fields + [:summary, :description]).each do |k, v|
+          (custom_fields + [:summary, :description]).each do |k, _v|
             params[k] = opts.delete(k) if opts.key?(k)
           end
 
@@ -88,6 +86,10 @@ module Terjira
             params[:project] = { key: opts.delete(:project).key_value }
           end
 
+          if opts.key?(:parent)
+            params[:parent] = { key: opts.delete(:parent).key_value }
+          end
+
           opts.each do |k, v|
             params[k] = convert_param_key_value_hash(v)
           end

data/lib/terjira/client/issuetype.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module Terjira
+  module Client
+    class Issuetype < Base
+      class << self
+        def all
+          resp = api_get("issuetype")
+          resp.map { |issuetype| build(issuetype) }
+        end
+
+        def subtask_issuetypes
+          all.select(&:subtask)
+        end
+      end
+    end
+  end
+end

data/lib/terjira/client/jql_builder.rb

@@ -0,0 +1,25 @@
+module Terjira
+  module Client
+    module JQLBuilder
+      JQL_KEYS = %w(sprint assignee issuetype priority project status statusCategory).freeze
+
+      def build_jql(options = {})
+        q_options = options.inject({}) do |memo, (k, v)|
+          memo[k.to_s] = v
+          memo
+        end.slice(*JQL_KEYS)
+
+        query = q_options.map do |key, value|
+          if value.is_a? Array
+            values = value.map { |v| "\"#{v.key_value}\"" }.join(',')
+            "#{key} IN (#{values})"
+          else
+            "#{key}=#{value.key_value}"
+          end
+        end.reject(&:blank?).join(' AND ')
+
+        query
+      end
+    end
+  end
+end

data/lib/terjira/client/priority.rb

@@ -5,7 +5,7 @@ module Terjira
     class Priority < Base
       class << self
         def all
-          resp = api_get "priority"
+          resp = api_get 'priority'
           resp.map { |priority| build(priority) }
         end
       end

data/lib/terjira/client/resolution.rb

@@ -5,7 +5,7 @@ module Terjira
     class Resolution < Base
       class << self
         def all
-          resp = api_get("resolution")
+          resp = api_get('resolution')
           resp.map { |resolution| build(resolution) }
         end
       end

data/lib/terjira/client/status.rb

@@ -6,7 +6,7 @@ module Terjira
       class << self
         def all(project)
           resp = api_get "project/#{project.key_value}/statuses"
-          statuses_json = resp.map { |issuetype| issuetype["statuses"] }.flatten.uniq
+          statuses_json = resp.map { |issuetype| issuetype['statuses'] }.flatten.uniq
           statuses_json.map { |status| build(status) }
         end
       end

data/lib/terjira/client/user.rb

@@ -6,10 +6,10 @@ module Terjira
       class << self
         def assignables_by_project(project)
           if project.is_a? Array
-            keys = project.map(&:key_value).join(",")
-            fetch_assignables "user/assignable/multiProjectSearch", {projectKeys: keys }
+            keys = project.map(&:key_value).join(',')
+            fetch_assignables 'user/assignable/multiProjectSearch', projectKeys: keys
           else
-            fetch_assignables "user/assignable/search", { project: project.key_value }
+            fetch_assignables 'user/assignable/search', project: project.key_value
           end
         end
 
@@ -28,15 +28,14 @@ module Terjira
         end
 
         def assignables_by_issue(issue)
-          fetch_assignables "user/assignable/search", {issueKey: issue.key_value }
+          fetch_assignables 'user/assignable/search', issueKey: issue.key_value
         end
 
         private
 
         def fetch_assignables(path, params)
           resp = api_get(path, params)
-          resp.map { |user| build(user) }.
-            reject { |user| user.key_value =~ /^addon/ }
+          resp.map { |user| build(user) }.reject { |user| user.key_value =~ /^addon/ }
         end
       end
     end

data/lib/terjira/ext/jira_ruby.rb

@@ -9,15 +9,12 @@ module JIRA
     alias origin_make_request make_request
 
     def make_request(http_method, path, body = '', headers = {})
-      title = http_method.to_s.upcase
-      title = Pastel.new.dim(title)
+      title = Pastel.new.dim(http_method.to_s.upcase)
       spinner = TTY::Spinner.new ":spinner #{title}", format: :dots, clear: true
       result = nil
-
       spinner.run do
         result = origin_make_request(http_method, path, body, headers)
       end
-
       result
     end
   end
@@ -33,16 +30,27 @@ module JIRA
     class BoardFactory < JIRA::BaseFactory # :nodoc:
     end
 
+    class EpicFactory < JIRA::BaseFactory # :nodoc:
+    end
+
     class Board < JIRA::Base
       def self.key_attribute; :id; end
     end
 
+    class Epic < JIRA::Base
+      def self.key_attribute; :key; end
+    end
+
     class User
       def self.key_attribute; :name; end
     end
 
     class Issue
       def self.key_attribute; :key; end
+      has_one :epic, class: JIRA::Resource::Epic, nested_under: 'fields'
+      has_one :sprint, class: JIRA::Resource::Sprint, nested_under: 'fields'
+      has_one :parent, class: JIRA::Resource::Issue, nested_under: 'fields'
+      has_many :subtasks, class: JIRA::Resource::Issue, nested_under: 'fields'
     end
 
     class Issuetype

data/lib/terjira/ext/tty_prompt.rb

@@ -3,9 +3,6 @@ require 'tty-prompt'
 module TTY
   class Prompt
     class Question
-      # Decide how to handle input from user
-      #
-      # @api private
       def process_input
         @input = read_input
         if Utils.blank?(@input)