terjira 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1daef227221455846fa59674d6cfeb9735d1e33d
-  data.tar.gz: 5dd7bbe7f90499eaf61ff4300ae5518f1a3336b3
+  metadata.gz: 77476a02726804785494a7f8fb656fd3693414aa
+  data.tar.gz: b82d22e41c646033ce9123784055ce330adadfce
 SHA512:
-  metadata.gz: 6124824ac122ea72b0e7077956371b6803cd848a8a454bbb03c4e25de2a8e99902e64a5fd01763925b1cecfa9ac7e04457749c7b56ddd2c530d178bbdfd025f8
-  data.tar.gz: 4ecc886b8ab99b2bc3ddfb9f9694f6baba32f5b63484f9468ac9dd6368e5428108e4cedfb74e291024f1ce8e9a0326e6a237d79284c912f4828441836358f8b2
+  metadata.gz: 57c3cc8b7df5b492832613b0e78ff8e6c9b4fac73ec57005487e2bb33f8a59920aec75b65edf3cd2a457075c19a6e1db1fafd649a5865697350a005b6e440215
+  data.tar.gz: 48b8f7be412ffca233e1eeefec4c125c363fc15bfef404ede54815801760ad419b43398d84ec324b150fd35a398beeb93dd32c10007b85b632e1485cfe0b005c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terjira (0.1.1)
+    terjira (0.2.0)
       activesupport (= 4.0.13)
       jira-ruby (~> 1.1)
       pastel (~> 0.6.1)

data/README.md

@@ -5,12 +5,14 @@
 
 # Terjira
 
-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.
+Terjira is an interactive and easy to use command line interface (or Application) for Jira. You do not need to remember resource key or id. Terjira suggests it with interactive prompt.
 
 Your Jira must support Rest API 2.0 and Agile Rest API 1.0
 
+## Domo
+[Watch Demo](https://www.youtube.com/watch?v=T0hbhaXtH-Y)
 
-**I'm working now..**
+[![Sample](./sample.png)](https://www.youtube.com/watch?v=T0hbhaXtH-Y)
 
 ## Installation
 
@@ -28,8 +30,50 @@ If you have permission problem,
     # You need to export your gem path
 
 ## Usage
-
-
+```
+Authentication:
+  jira login                      # Login your Jira
+  jira logout                     # Logout your Jira
+
+Project:
+  jira project help [COMMAND]     # Describe one specific subcommand
+  jira project ( ls | list )      # List of all projects
+  jira project [PROJECT_KEY]      # Show detail of the project
+
+Board:
+  jira board help [COMMAND]       # Describe one specific subcommand
+  jira board ( ls | list)         # List of all boards
+  jira board backlog              # Backlog from the board
+
+
+Sprint:
+  jira sprint help [COMMAND]      # Describe one specific subcommand
+  jira sprint ( ls | list )       # List of all sprint from the board
+  jira sprint [SPRINT_ID]         # Show the sprint
+  jira sprint active              # Show active sprints and issues
+
+Issue:
+  jira issue help [COMMAND]       # Describe one specific subcommand
+  jira issue ( ls | list )        # List of issues
+  jira issue [ISSUE_KEY]          # Show detail of the issue
+  jira issue assign [ISSUE_KEY] ([ASSIGNEE])  # Assign the issue to user
+  jira issue comment              # Write comment on the issue
+  jira issue delete               # Delete the issue
+  jira issue edit                 # Edit the issue
+  jira issue new                  # Create an issue
+  jira issue open [ISSUE_KEY]     # Open browser
+  jira issue take [ISSUE_KEY]     # Assign the issue to self
+  jira issue trans [ISSUE_KEY] ([STATUS])     # Do transition
+
+```
+
+## Todo
+**Contributions are welcome!**
+- [ ] Manage worklog and estimate of issues
+- [ ] Manage component and version of issues
+- [ ] Track history of transitions
+- [ ] More friendly help
+- [ ] Improve test coverage
 
 ## Development
 

data/bin/jira

@@ -14,8 +14,8 @@ rescue JIRA::HTTPError => e
   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)
+  elsif message['errors'].present?
+    puts pastel.red(message['errors'].map { |k, v| "#{k}: #{v}" }.join(", "))
   end
 rescue => e
   puts Pastel.new.dim(e.message)

data/bin/terjira

@@ -14,8 +14,8 @@ rescue JIRA::HTTPError => e
   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)
+  elsif message['errors'].present?
+    puts pastel.red(message['errors'].map { |k, v| "#{k}: #{v}" }.join(", "))
   end
 rescue => e
   puts Pastel.new.dim(e.message)

data/lib/terjira/base_cli.rb

@@ -33,6 +33,18 @@ module Terjira
       def current_username
         @current_username ||= Client::Base.username
       end
+
+      def open_url(url)
+        ostype = `echo $OSTYPE`
+        open_cmd = case ostype
+                   when /darwin/ then 'open'
+                   when  /cygwin/ then 'cygstart'
+                   when /linux/ then 'xdg-open'
+                   when /msys/ then 'start ""'
+                   else puts "Platform $OSTYPE not supported"
+                   end
+        `#{open_cmd} #{url}`
+      end
     end
   end
 end

data/lib/terjira/board_cli.rb

@@ -8,7 +8,7 @@ module Terjira
       end
     end
 
-    desc "( ls | list)", "list all boards"
+    desc "( ls | list)", "List all boards"
     map ls: :list
     def list
       boards = client_class.all

data/lib/terjira/client/base.rb

@@ -23,6 +23,11 @@ module Terjira
           client.send(class_name) if client.respond_to?(class_name)
         end
 
+        def site_url
+          auth_options = build_auth_options
+          "#{auth_options[:site]}/#{auth_options[:context_path]}"
+        end
+
         def username
           client.options[:username]
         end

data/lib/terjira/client/field.rb

@@ -10,6 +10,10 @@ module Terjira
           end
         end
 
+        def find_by_key(key)
+          all.find { |field| field.key == key }
+        end
+
         def epic_name
           all.find { |field| field.name == 'Epic Name' }
         end

data/lib/terjira/client/issue.rb

@@ -22,6 +22,10 @@ module Terjira
           build(resp)
         end
 
+        def delete(issue)
+          api_delete("issue/#{issue.key_value}")
+        end
+
         def assign(issue, assignee)
           body = { name: assignee.key_value }.to_json
           api_put("issue/#{issue.key_value}/assignee", body)
@@ -34,17 +38,14 @@ module Terjira
 
         def create(options = {})
           params = extract_to_fields_params(options)
-          if transition_param = extract_to_transition_param(options)
-            params.merge!(transition_param)
-          end
-
           resp = api_post 'issue', params.to_json
           find(resp['id'])
         end
 
         def update(issue, options = {})
-          params = extract_to_fields_params(options)
-          api_put "issue/#{issue.key_value}", params.to_json
+          params = extract_to_update_params(options)
+          params.merge!(extract_to_fields_params(options))
+          resp = api_put "issue/#{issue.key_value}", params.to_json
           find(issue)
         end
 
@@ -78,21 +79,19 @@ module Terjira
           params = {}
 
           custom_fields = options.keys.select { |k| k.to_s =~ /^customfield/ }
+
           (custom_fields + [:summary, :description]).each do |k, _v|
             params[k] = opts.delete(k) if opts.key?(k)
           end
 
-          if opts.key?(:project)
-            params[:project] = { key: opts.delete(:project).key_value }
+          [:project, :parent].each do |resource|
+            if opts.key?(resource)
+              params[resource] = { key: opts.delete(resource).key_value }
+            end
           end
 
-          if opts.key?(:parent)
-            params[:parent] = { key: opts.delete(:parent).key_value }
-          end
+          opts.each { |k, v| params[k] = convert_param_key_value_hash(v) }
 
-          opts.each do |k, v|
-            params[k] = convert_param_key_value_hash(v)
-          end
           { fields: params }
         end
 

data/lib/terjira/issue_cli.rb

@@ -13,9 +13,9 @@ module Terjira
     default_task :show
 
     desc '[ISSUE_KEY]', 'Show detail of the issue'
-    def show(issue_key = nil)
-      return invoke(:help) unless issue_key
-      issue = client_class.find(issue_key)
+    def show(issue = nil)
+      return invoke(:help) unless issue
+      issue = client_class.find(issue)
       if issue.issuetype.name.casecmp('epic').zero?
         epic_issues = client_class.all_epic_issues(issue)
         render_issue_detail(issue, epic_issues)
@@ -24,6 +24,11 @@ module Terjira
       end
     end
 
+    desc 'open [ISSUE_KEY]', 'Open browser'
+    def open(issue)
+      open_url(client_class.site_url + "/browse/#{issue}")
+    end
+
     desc '( ls | list )', 'List of issues'
     jira_options :assignee, :status, :project, :issuetype, :priority
     map ls: :list
@@ -37,29 +42,7 @@ module Terjira
       render_issues(issues)
     end
 
-    desc 'trans [ISSUE_KEY] ([STATUS])', 'Do Transition'
-    jira_options :comment, :assignee, :resolution
-    def trans(*args)
-      issue = args.shift
-      raise 'must pass issue key or id' unless issue
-      status = args.join(' ') if args.present?
-      issue = client_class.find(issue, expand: 'transitions.fields')
-
-      transitions = issue.transitions
-      transition = transitions.find { |t| t.name.casecmp(status.to_s).zero? }
-
-      resources = if transition
-                    { status: transition, issue: issue }
-                  else
-                    { statuses: transitions, issue: issue }
-                  end
-
-      opts = suggest_options(required: [:status], resources: resources)
-      issue = client_class.trans(issue, opts)
-      render_issue_detail(issue)
-    end
-
-    desc 'new', 'Create issue'
+    desc 'new', 'Create an issue'
     jira_options :summary, :description, :project, :issuetype,
                  :priority, :assignee, :parent, :epiclink
     def new
@@ -71,7 +54,7 @@ module Terjira
       render_issue_detail(issue)
     end
 
-    desc 'edit', 'Edit issue'
+    desc 'edit', 'Edit the issue'
     jira_options :summary, :description, :project, :issuetype,
                  :priority, :assignee, :epiclink
     def edit(issue)
@@ -84,6 +67,12 @@ module Terjira
       render_issue_detail(issue)
     end
 
+    desc 'delete', 'Delete the issue'
+    def delete(issue)
+      client_class.delete(issue)
+      render("Deleted")
+    end
+
     desc 'comment', 'Write comment on the issue'
     jira_options :comment
     def comment(issue)
@@ -92,12 +81,12 @@ module Terjira
       render_issue_detail(issue)
     end
 
-    desc 'take [ISSUE_KEY]', 'Assign issue to self'
+    desc 'take [ISSUE_KEY]', 'Assign the issue to self'
     def take(issue)
       assign(issue, current_username)
     end
 
-    desc 'assign [ISSUE_KEY] ([ASSIGNEE])', 'Assing issue to user'
+    desc 'assign [ISSUE_KEY] ([ASSIGNEE])', 'Assign the issue to user'
     def assign(*keys)
       issue = keys[0]
       assignee = keys[1]
@@ -110,5 +99,27 @@ module Terjira
       client_class.assign(issue, assignee)
       show(issue.key_value)
     end
+
+    desc 'trans [ISSUE_KEY] ([STATUS])', 'Do transition'
+    jira_options :comment, :assignee, :resolution
+    def trans(*args)
+      issue = args.shift
+      raise 'must pass issue key or id' unless issue
+      status = args.join(' ') if args.present?
+      issue = client_class.find(issue, expand: 'transitions.fields')
+
+      transitions = issue.transitions
+      transition = transitions.find { |t| t.name.casecmp(status.to_s).zero? }
+
+      resources = if transition
+                    { status: transition, issue: issue }
+                  else
+                    { statuses: transitions, issue: issue }
+                  end
+
+      opts = suggest_options(required: [:status], resources: resources)
+      issue = client_class.trans(issue, opts)
+      render_issue_detail(issue)
+    end
   end
 end

data/lib/terjira/presenters/common_presenter.rb

@@ -30,13 +30,11 @@ module Terjira
       Time.parse(date_str).strftime(date_format)
     end
 
-    def username_with_email(user)
+    def username(user)
       if user.nil?
         dim_none
       else
-        title = "#{user.name}, #{user.displayName}"
-        title += " <#{user.emailAddress}>" if user.respond_to?(:emailAddress)
-        title
+        "#{user.name}, #{user.displayName}"
       end
     end
 

data/lib/terjira/presenters/issue_presenter.rb

@@ -40,7 +40,7 @@ module Terjira
     def render_issue_detail(issue, epic_issues = [])
       result = ERB.new(issue_detail_template, nil, '-').result(binding)
       result += ERB.new(comments_template, nil, '-').result(binding)
-      rows = insert_new_line(result, screen_width - 10)
+      rows = insert_new_line(result, screen_width - 15)
       table = TTY::Table.new nil, rows.split("\n").map { |r| [r] }
       render table.render(:unicode, padding: [0, 1, 0, 1], multiline: true)
     end
@@ -60,7 +60,7 @@ module Terjira
     end
 
     def issue_detail_template
-      """<%= bold(issue.key) + ' in ' + issue.project.name %>
+      %{<%= bold(issue.key) + ' in ' + issue.project.name %>
 
       <%= pastel.underline.bold(issue.summary) %>
 
@@ -75,8 +75,8 @@ module Terjira
         <%= bold('Sprint') %>: <%= colorize_sprint_state(issue.try(:sprint).try(:state)) %> <%= issue.try(:sprint).try(:id) %>. <%= issue.try(:sprint).try(:name) %>
       <% end -%>
 
-      <%= bold('Assignee') %>: <%= username_with_email(issue.assignee) %>
-      <%= bold('Reporter') %>: <%= username_with_email(issue.reporter) %>
+      <%= bold('Assignee') %>: <%= username(issue.assignee) %>
+      <%= bold('Reporter') %>: <%= username(issue.reporter) %>
 
       <%= bold('Description') %>
       <%= issue.description || dim_none %>
@@ -94,6 +94,11 @@ module Terjira
         <%= bold('Environment') %>
         <%= issue.environment %>
       <% end -%>
+      <% if issue.try(:attachment).present? -%>
+
+        <%= bold('Attachment') %>
+        <%= issue.attachment.map { |item| item['filename'] }.join(", ") %>
+      <% end -%>
       <% if issue.subtasks.size > 0 -%>
 
         <%= bold('SubTasks') %>
@@ -102,12 +107,13 @@ module Terjira
         <% end -%>
       <% end -%>
       <% if epic_issues.present? -%>
+
         <%= bold('Issues in Epic') %>
         <% epic_issues.each do |epic_issue| -%>
-          * <%= bold(epic_issue.key) %> <%= colorize_issue_stastus(epic_issue.status) %> <%= epic_issue.summary %> <%= issue.assignee.try(:name) %>
+          * <%= bold(epic_issue.key) %> <%= colorize_issue_stastus(epic_issue.status) %> <%= epic_issue.summary %>
         <% end -%>
       <% end -%>
-      """
+      }
     end
 
     def comments_template
@@ -121,9 +127,8 @@ module Terjira
         <%= pastel.dim('- ' + remain_comments.size.to_s + ' previous comments exist -') %>
       <% end -%>
       <% visiable_comments.each do |comment| -%>
-        <%=  pastel.bold(comment.author['displayName']) %> <%= formatted_date(comment.created) %>
         <%= comment.body %>
-
+        - <%= comment.author['displayName'] %> <%= formatted_date(comment.created) %>
       <% end -%>
       """
     end

data/lib/terjira/presenters/project_presenter.rb

@@ -43,7 +43,7 @@ module Terjira
       rows << ''
 
       rows << pastel.bold('Lead')
-      rows << username_with_email(project.lead)
+      rows << username(project.lead)
       rows << ''
       rows << render_components_and_versions(project)
 

data/lib/terjira/project_cli.rb

@@ -4,7 +4,7 @@ module Terjira
   class ProjectCLI < BaseCLI
     default_task :show
 
-    desc '[PROJECT_KEY]', 'Show detail of project'
+    desc '[PROJECT_KEY]', 'Show detail of the project'
     def show(project_key = nil)
       if project_key.nil?
         project = select_project
@@ -15,7 +15,7 @@ module Terjira
       redner_project_detail(project)
     end
 
-    desc '( ls | list )', 'list of projects'
+    desc '( ls | list )', 'List of all projects'
     map ls: :list
     def list
       projects = Client::Project.all

data/lib/terjira/sprint_cli.rb

@@ -11,7 +11,7 @@ module Terjira
 
     default_task :show
 
-    desc '[SPRINT_ID]', 'Default, show sprint'
+    desc '[SPRINT_ID]', 'Show the sprint'
     jira_option(:assignee)
     def show(sprint = nil)
       opts = suggest_options(required: [:sprint], resources: { sprint: sprint })
@@ -38,7 +38,7 @@ module Terjira
       end
     end
 
-    desc '( ls | list )', 'list all sprint from the board'
+    desc '( ls | list )', 'List of all sprint from the board'
     jira_options :board, :state
     map ls: :list
     def list

data/lib/terjira/version.rb

@@ -1,3 +1,3 @@
 module Terjira
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/terjira.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jaehyun Shin"]
   spec.email         = ["keepcosmos@gmail.com"]
 
-  spec.summary       = "Terjira is interactive command line app for Jira"
+  spec.summary       = "Terjira is interactive command line application for Jira"
   spec.description   = "Terjira is interactive and easy to use command line interface (or Application) for Jira.\nYou do not need to remember reosurce key or id. Terjira suggests with interactive prompt."
   spec.homepage      = "https://github.com/keepcosmos/terjira"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terjira
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jaehyun Shin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -253,6 +253,7 @@ files:
 - lib/terjira/sprint_cli.rb
 - lib/terjira/utils/file_cache.rb
 - lib/terjira/version.rb
+- sample.png
 - terjira.gemspec
 homepage: https://github.com/keepcosmos/terjira
 licenses:
@@ -277,6 +278,6 @@ rubyforge_project:
 rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
-summary: Terjira is interactive command line app for Jira
+summary: Terjira is interactive command line application for Jira
 test_files: []
 has_rdoc: