lita-jira 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef4c53ef081757f69c5313e99612eb6c9b5503a
-  data.tar.gz: 3c5ec6ad54539e97affbf462e71e3376aa9cdefd
+  metadata.gz: c8e25e7c623d12ae007a12d829a9982e4cd282f0
+  data.tar.gz: 4af36f87192c00de42d16201f43e351aa3c6636d
 SHA512:
-  metadata.gz: bea64e3f8e3114be601474962ce76f006415fd2c797f76033242f8eaca6f5cb70a86980fb3b1c9f8cb77ec4974b73d5494642879700b1615f6acf6cea0339b69
-  data.tar.gz: ff5eb8303c4dbc703d07759b64724cc30898ea3eb1cef9da71a9cb0cb24a0a2e31333edf97b5a748e18b4b503751aa1ffadeaf0c52b97a35bd3c220b1e941757
+  metadata.gz: 44b1d5c7b1ab88e483d1a2a8164e7e4891a58912d285d2c39399cbce34777e3ba20b6340baa5da955662f74a6fdf9116e44a70ab0ac8321e5aa9c748360a0b0e
+  data.tar.gz: 0a1f45120e30e39f0e2968789d411305b31bf91b19dfda8a65590b457da93d5d194bf044e8183a43176c4c7cc5273b155d8f96e628813a9bfe8a2f79ec142b19

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
   - 2.1
-script: bundle exec rake
-before_install:
-  - gem update --system
+  - 2.2
 services:
   - redis-server
+sudo: false
+cache: bundler

data/README.md

@@ -40,6 +40,7 @@ todo <project> "<subject>" ["<summary>"] - Creates an issue in <project> with <s
 jira <issue>                             - Shows a short summary <issue>
 jira details <issue>                     - Shows all details about <issue>
 jira comment on <issue> <comment text>   - Adds <comment text> to <issue>
+jira myissues                            - Displays a list of issues assigned to identified user
 ```
 
 ### Misc

data/lib/jirahelper/issue.rb

@@ -9,6 +9,14 @@ module JiraHelper
         nil
     end
 
+    # Leverage the jira-ruby Issue.jql search feature
+    #
+    # @param [Type String] jql Valid JQL query
+    # @return [Type Array] 0-m JIRA Issues returned from query
+    def fetch_issues(jql)
+      client.Issue.jql(jql)
+    end
+
     def fetch_project(key)
       client.Project.find(key)
       rescue
@@ -20,11 +28,20 @@ module JiraHelper
       t('issue.details',
         key: issue.key,
         summary: issue.summary,
-        assigned: issue.assignee.displayName,
-        priority: issue.priority.name,
+        assigned: optional_issue_property('unassigned') { issue.assignee.displayName },
+        priority: optional_issue_property('none') { issue.priority.name },
         status: issue.status.name)
     end
 
+    # Enumerate issues returned from JQL query and format for response
+    #
+    # @param [Type Array] issues 1-m issues returned from JQL query
+    # @return [Type Array<String>] formatted issues for display to user
+    def format_issues(issues)
+      results = [t('myissues.info')]
+      results.concat(issues.map { |issue| format_issue(issue) })
+    end
+
     def create_issue(project, subject, summary)
       project = fetch_project(project)
       return nil unless project
@@ -35,5 +52,17 @@ module JiraHelper
       issue.fetch
       issue
     end
+
+    # Attempt to retrieve optional JIRA issue property value via a provided block.
+    # JIRA properties such as assignee and priority may not exist.
+    # In that case, the fallback will be used.
+    #
+    # @param [Type String] fallback A String value to use if the JIRA property value doesn't exist
+    # @return [Type String] fallback or returned value from yield block
+    def optional_issue_property(fallback = '')
+      yield
+    rescue
+      fallback
+    end
   end
 end

data/lib/lita/handlers/jira.rb

@@ -14,6 +14,7 @@ module Lita
       include ::JiraHelper::Issue
       include ::JiraHelper::Misc
       include ::JiraHelper::Regex
+      include ::JiraHelper::Utility
 
       route(
         /^jira\s#{ISSUE_PATTERN}$/,
@@ -33,6 +34,15 @@ module Lita
         }
       )
 
+      route(
+        /^jira\smyissues$/,
+        :myissues,
+        command: true,
+        help: {
+          t('help.myissues.syntax') => t('help.myissues.desc')
+        }
+      )
+
       route(
         /^jira\scomment\son\s#{ISSUE_PATTERN}\s#{COMMENT_PATTERN}$/,
         :comment,
@@ -78,6 +88,24 @@ module Lita
         return response.reply(t('error.request')) unless issue
         response.reply(t('issue.created', key: issue.key))
       end
+
+      # rubocop:disable Metrics/AbcSize
+      def myissues(response)
+        return response.reply(t('error.not_identified')) unless user_stored?(response.user)
+
+        begin
+          issues = fetch_issues("assignee = '#{get_email(response.user)}' AND status not in (Closed)")
+        rescue
+          log.error('JIRA HTTPError')
+          response.reply(t('error.request'))
+          return
+        end
+
+        return response.reply(t('myissues.empty')) unless issues.size > 0
+
+        response.reply(format_issues(issues))
+      end
+      # rubocop:enable Metrics/AbcSize
     end
 
     Lita.register_handler(Jira)

data/lita-jira.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-jira'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = 'A JIRA plugin for Lita.'
@@ -10,17 +10,17 @@ Gem::Specification.new do |spec|
   spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'lita', '>= 4.0'
-  spec.add_runtime_dependency 'jira-ruby', '>= 0.1.8'
+  spec.add_runtime_dependency 'jira-ruby'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 3.0.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

data/locales/en.yml

@@ -28,6 +28,9 @@ en:
           todo:
             syntax: todo <project> "<subject>" ["<summary>"]
             desc: Creates an issue in <project> with <subject> and optionally <summary>
+          myissues:
+            syntax: jira myissues
+            desc: If identified, will display a list of issues currently assigned to you
         identify:
           stored: "You have been identified as %{email} to JIRA"
           deleted: You have been de-identified from JIRA
@@ -37,4 +40,7 @@ en:
           details: "%{key}: %{summary}, assigned to: %{assigned}, priority: %{priority}, status: %{status}"
           summary: "%{key}: %{summary}"
         comment:
-          added: "Comment added to %{issue}"
+          added: "Comment added to %{issue}"
+        myissues:
+          empty: "You do not have any assigned issues. Great job!"
+          info: "Here are issues currently assigned to you:"

data/spec/lita/handlers/jira_spec.rb

@@ -12,6 +12,33 @@ describe Lita::Handlers::Jira, lita_handler: true do
     result
   end
 
+  let(:saved_issue_with_fewer_details) do
+    result = double(summary: 'Some summary text',
+                    status: double(name: 'In Progress'),
+                    key: 'XYZ-987')
+    allow(result).to receive('assignee').and_raise
+    allow(result).to receive('priority').and_raise
+    allow(result).to receive('save') { true }
+    allow(result).to receive('fetch') { true }
+    result
+  end
+
+  let(:valid_search_results) do
+    result = [double(summary: 'Some summary text',
+                     assignee: double(displayName: 'A Person'),
+                     priority: double(name: 'P0'),
+                     status: double(name: 'In Progress'),
+                     key: 'XYZ-987'),
+              double(summary: 'Some summary text 2',
+                     assignee: double(displayName: 'A Person 2'),
+                     priority: double(name: 'P1'),
+                     status: double(name: 'In Progress 2'),
+                     key: 'XYZ-988')]
+    allow(result).to receive('save') { true }
+    allow(result).to receive('fetch') { true }
+    result
+  end
+
   let(:saved_project) do
     double(key: 'XYZ',
            id: 1)
@@ -23,6 +50,13 @@ describe Lita::Handlers::Jira, lita_handler: true do
     allow(issue).to receive_message_chain('Issue.find.comments.build.save!') { saved_issue }
     allow(issue).to receive_message_chain('Issue.build') { saved_issue }
     allow(issue).to receive_message_chain('Project.find') { saved_project }
+    allow(issue).to receive_message_chain('Issue.jql') { valid_search_results }
+    issue
+  end
+
+  let(:client_with_fewer_details) do
+    issue = double
+    allow(issue).to receive_message_chain('Issue.find') { saved_issue_with_fewer_details }
     issue
   end
 
@@ -32,18 +66,31 @@ describe Lita::Handlers::Jira, lita_handler: true do
     r
   end
 
+  let(:failed_find_issues) do
+    r = double
+    expect(r).to receive_message_chain('Issue.jql').and_throw(JIRA::HTTPError)
+    r
+  end
+
   let(:failed_find_project) do
     r = double
     expect(r).to receive_message_chain('Project.find').and_throw(JIRA::HTTPError)
     r
   end
 
+  let(:empty_search_result) do
+    r = double
+    expect(r).to receive_message_chain('Issue.jql') { [] }
+    r
+  end
+
   it do
     is_expected.to route_command('jira ABC-123').to(:summary)
     is_expected.to route_command('jira details ABC-123').to(:details)
     is_expected.to route_command('jira comment on ABC-123 "You just need a cat"').to(:comment)
     is_expected.to route_command('todo ABC "summary text"').to(:todo)
     is_expected.to route_command('todo ABC "summary text" "subject text"').to(:todo)
+    is_expected.to route_command('jira myissues').to(:myissues)
   end
 
   describe '#summary' do
@@ -68,6 +115,13 @@ describe Lita::Handlers::Jira, lita_handler: true do
                                  'A Person, priority: P0, status: In Progress')
     end
 
+    it 'shows fewer details when the property is not set' do
+      grab_request(client_with_fewer_details)
+      send_command('jira details XYZ-987')
+      expect(replies.last).to eq('XYZ-987: Some summary text, assigned to: ' \
+                                 'unassigned, priority: none, status: In Progress')
+    end
+
     it 'warns the user when the issue is not valid' do
       grab_request(failed_find_issue)
       send_command('jira details XYZ-987')
@@ -102,4 +156,38 @@ describe Lita::Handlers::Jira, lita_handler: true do
       expect(replies.last).to eq('Error fetching JIRA issue')
     end
   end
+
+  describe '#myissues' do
+    before { send_command('jira forget') }
+    context 'when not identified' do
+      it 'fails when user is not identified' do
+        send_command('jira myissues')
+        expect(replies.last).to eq('You do not have an email address on record')
+      end
+    end
+
+    context 'when identified' do
+      before { send_command('jira identify user@example.com') }
+
+      it 'shows default response when no results are returned' do
+        grab_request(empty_search_result)
+        send_command('jira myissues')
+        expect(replies.last).to eq('You do not have any assigned issues. Great job!')
+      end
+
+      it 'shows results when returned' do
+        grab_request(valid_client)
+        send_command('jira myissues')
+        expect(replies.last).to eq(['Here are issues currently assigned to you:',
+                                    'XYZ-987: Some summary text, assigned to: A Person, priority: P0, status: In Progress',
+                                    'XYZ-988: Some summary text 2, assigned to: A Person 2, priority: P1, status: In Progress 2'])
+      end
+
+      it 'shows an error when the search fails' do
+        grab_request(failed_find_issues)
+        send_command('jira myissues')
+        expect(replies.last).to eq('Error fetching JIRA issue')
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-jira
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -30,30 +30,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="