lita-jira 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e25e7c623d12ae007a12d829a9982e4cd282f0
-  data.tar.gz: 4af36f87192c00de42d16201f43e351aa3c6636d
+  metadata.gz: 372aaea44e1c7953b66a0cb3afe6a53a631e08c9
+  data.tar.gz: 8ffc592e14e99e246d07effe13f1248d850c7a3f
 SHA512:
-  metadata.gz: 44b1d5c7b1ab88e483d1a2a8164e7e4891a58912d285d2c39399cbce34777e3ba20b6340baa5da955662f74a6fdf9116e44a70ab0ac8321e5aa9c748360a0b0e
-  data.tar.gz: 0a1f45120e30e39f0e2968789d411305b31bf91b19dfda8a65590b457da93d5d194bf044e8183a43176c4c7cc5273b155d8f96e628813a9bfe8a2f79ec142b19
+  metadata.gz: 74d908bfa0e64d3d9331447e75873797b5d1fb8ae485da8beff3c1ecf49cc1faa830ec41e66a4f8a7a646684e531fb8124350f193510457b3b5814944e96a439
+  data.tar.gz: 76ef2321482c259b729f97475525e671d084fdf6992e68c01b694aff11de65c3b943eae4a5a31d867560709558c1f67edda4e1ab86014cb8f1b79aa6868a083a

data/.rubocop.yml

@@ -3,4 +3,4 @@ FileName:
     - lib/lita-jira.rb
 
 LineLength:
-  Max: 130
+  Max: 190

data/CONTRIBUTING.md

@@ -7,3 +7,7 @@ Pull requests are awesome!  Pull requests with tests are even more awesome!
 3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, it needs a test!
 4. Make the test pass.
 5. Push to your fork and submit a pull request.
+
+## Reminders
+
+* Be sure to add yourself to the Gemspec

data/README.md

@@ -21,11 +21,25 @@ gem "lita-jira"
 
 Add the following variables to your lita config file:
 
-```
+``` ruby
 config.handlers.jira.username = 'your_jira_username'
 config.handlers.jira.password = 'a_password'
 config.handlers.jira.site     = 'https://your.jira.instance.example.com/'
-config.handlers.jira.context  = '' # If your instance is in a /subdirectory, put that here
+```
+
+### Optional attributes
+* `context` (string) - If your instance is in a /subdirectory, put that here. Default: `''`
+* `format` (string) - You can select a compact one line issue summary by setting this parameter to `one-line`. Default: `verbose`
+* `ambient` (boolean) - When set to `true`, Lita will show JIRA issue details when a JIRA issue key is mentioned in chat, outside the context of a command. Default: `false`
+* `ignore` (array) - Prevent ambient JIRA issue detection in certain users' messages. Default: `[]`
+* `rooms` (array) - Limit ambient JIRA issue detection to a certain list of rooms. If unspecified, the bot will respond to detected issues in all rooms.
+
+``` ruby
+config.handlers.jira.context = '/myjira'
+config.handlers.jira.ambient = true
+config.handlers.jira.format = 'one-line'
+config.handlers.jira.ignore = ['Jira', 'Github']
+config.handlers.jira.rooms = ['devtools', 'engineering']
 ```
 
 ## Usage
@@ -51,6 +65,10 @@ jira forget                   - Remove your chat user / email association
 jira whoami                   - Show your chat user / email association
 ```
 
+## CHANGELOG
+
+[CHANGELOG](https://github.com/esigler/lita-jira/releases)
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)

data/lib/jirahelper/issue.rb

@@ -2,12 +2,15 @@
 module JiraHelper
   # Issues
   module Issue
-    def fetch_issue(key)
+    # NOTE: Prefer this syntax here as it's cleaner
+    # rubocop:disable Style/RescueEnsureAlignment
+    def fetch_issue(key, expected = true)
       client.Issue.find(key)
       rescue
-        log.error('JIRA HTTPError')
+        log.error('JIRA HTTPError') if expected
         nil
     end
+    # rubocop:enable Style/RescueEnsureAlignment
 
     # Leverage the jira-ruby Issue.jql search feature
     #
@@ -17,21 +20,29 @@ module JiraHelper
       client.Issue.jql(jql)
     end
 
+    # NOTE: Prefer this syntax here as it's cleaner
+    # rubocop:disable Style/RescueEnsureAlignment
     def fetch_project(key)
       client.Project.find(key)
       rescue
         log.error('JIRA HTTPError')
         nil
     end
+    # rubocop:enable Style/RescueEnsureAlignment
 
+    # NOTE: Not breaking this function out just yet.
+    # rubocop:disable Metrics/AbcSize
     def format_issue(issue)
-      t('issue.details',
+      t(config.format == 'one-line' ? 'issue.oneline' : 'issue.details',
         key: issue.key,
         summary: issue.summary,
+        status: issue.status.name,
         assigned: optional_issue_property('unassigned') { issue.assignee.displayName },
+        fixVersion: optional_issue_property('none') { issue.fixVersions.first['name'] },
         priority: optional_issue_property('none') { issue.priority.name },
-        status: issue.status.name)
+        url: format_issue_link(issue.key))
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Enumerate issues returned from JQL query and format for response
     #
@@ -42,6 +53,10 @@ module JiraHelper
       results.concat(issues.map { |issue| format_issue(issue) })
     end
 
+    def format_issue_link(key)
+      "#{config.site}#{config.context}/browse/#{key}"
+    end
+
     def create_issue(project, subject, summary)
       project = fetch_project(project)
       return nil unless project

data/lib/lita/handlers/jira.rb

@@ -6,10 +6,14 @@ module Lita
     class Jira < Handler
       namespace 'Jira'
 
-      config :username, required: true
-      config :password, required: true
-      config :site, required: true
-      config :context, required: true
+      config :username, required: true, type: String
+      config :password, required: true, type: String
+      config :site, required: true, type: String
+      config :context, required: false, type: String, default: ''
+      config :format, required: false, type: String, default: 'verbose'
+      config :ambient, required: false, types: [TrueClass, FalseClass], default: false
+      config :ignore, required: false, type: Array, default: []
+      config :rooms, required: false, type: Array
 
       include ::JiraHelper::Issue
       include ::JiraHelper::Misc
@@ -61,6 +65,9 @@ module Lita
         }
       )
 
+      # Detect ambient JIRA issues in non-command messages
+      route ISSUE_PATTERN, :ambient, command: false
+
       def summary(response)
         issue = fetch_issue(response.match_data['issue'])
         return response.reply(t('error.request')) unless issue
@@ -105,9 +112,20 @@ module Lita
 
         response.reply(format_issues(issues))
       end
+
+      def ambient(response)
+        return if invalid_ambient(response)
+        issue = fetch_issue(response.match_data['issue'], false)
+        response.reply(format_issue(issue)) if issue
+      end
+
+      private
+
+      def invalid_ambient(response)
+        response.message.command? || !config.ambient || config.ignore.include?(response.user.name) || (config.rooms && !config.rooms.include?(response.message.source.room))
+      end
       # rubocop:enable Metrics/AbcSize
     end
-
     Lita.register_handler(Jira)
   end
 end

data/lita-jira.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-jira'
-  spec.version       = '0.6.0'
-  spec.authors       = ['Eric Sigler']
-  spec.email         = ['me@esigler.com']
+  spec.version       = '0.7.0'
+  spec.authors       = ['Eric Sigler', 'Matt Critchlow']
+  spec.email         = ['me@esigler.com', 'matt.critchlow@gmail.com']
   spec.description   = 'A JIRA plugin for Lita.'
-  spec.summary       = 'A JIRA plugin for Lita.'
+  spec.summary       = spec.description
   spec.homepage      = 'https://github.com/esigler/lita-jira'
   spec.license       = 'MIT'
   spec.metadata      = { 'lita_plugin_type' => 'handler' }

data/locales/en.yml

@@ -37,7 +37,8 @@ en:
           email: "You are identified with JIRA as %{email}"
         issue:
           created: "Issue %{key} created"
-          details: "%{key}: %{summary}, assigned to: %{assigned}, priority: %{priority}, status: %{status}"
+          details: "[%{key}] %{summary}\nStatus: %{status}, assigned to: %{assigned}, fixVersion: %{fixVersion}, priority: %{priority}\n%{url}"
+          oneline: "%{url} - %{status}, %{assigned} - %{summary}"
           summary: "%{key}: %{summary}"
         comment:
           added: "Comment added to %{issue}"

data/spec/lita/handlers/jira_spec.rb

@@ -1,11 +1,16 @@
 require 'spec_helper'
 
 describe Lita::Handlers::Jira, lita_handler: true do
+  before do
+    registry.config.handlers.jira.site = 'http://jira.local'
+  end
+
   let(:saved_issue) do
     result = double(summary: 'Some summary text',
                     assignee: double(displayName: 'A Person'),
                     priority: double(name: 'P0'),
                     status: double(name: 'In Progress'),
+                    fixVersions: [{ 'name' => 'Sprint 2' }],
                     key: 'XYZ-987')
     allow(result).to receive('save') { true }
     allow(result).to receive('fetch') { true }
@@ -15,6 +20,7 @@ describe Lita::Handlers::Jira, lita_handler: true do
   let(:saved_issue_with_fewer_details) do
     result = double(summary: 'Some summary text',
                     status: double(name: 'In Progress'),
+                    fixVersions: [],
                     key: 'XYZ-987')
     allow(result).to receive('assignee').and_raise
     allow(result).to receive('priority').and_raise
@@ -28,11 +34,13 @@ describe Lita::Handlers::Jira, lita_handler: true do
                      assignee: double(displayName: 'A Person'),
                      priority: double(name: 'P0'),
                      status: double(name: 'In Progress'),
+                     fixVersions: [{ 'name' => 'Sprint 2' }],
                      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'),
+                     fixVersions: [],
                      key: 'XYZ-988')]
     allow(result).to receive('save') { true }
     allow(result).to receive('fetch') { true }
@@ -111,15 +119,21 @@ describe Lita::Handlers::Jira, lita_handler: true do
     it 'shows details with a valid issue' do
       grab_request(valid_client)
       send_command('jira details XYZ-987')
-      expect(replies.last).to eq('XYZ-987: Some summary text, assigned to: ' \
-                                 'A Person, priority: P0, status: In Progress')
+      expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/browse/XYZ-987")
     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')
+      expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: unassigned, fixVersion: none, priority: none\nhttp://jira.local/browse/XYZ-987")
+    end
+
+    it 'displays the correct URL when config.context is set' do
+      registry.config.handlers.jira.context = '/myjira'
+      grab_request(valid_client)
+      send_command('jira details XYZ-987')
+      expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/myjira/browse/XYZ-987")
+      registry.config.handlers.jira.context = ''
     end
 
     it 'warns the user when the issue is not valid' do
@@ -127,6 +141,14 @@ describe Lita::Handlers::Jira, lita_handler: true do
       send_command('jira details XYZ-987')
       expect(replies.last).to eq('Error fetching JIRA issue')
     end
+
+    it 'shows details on one line with a valid issue if config.format is one-line' do
+      registry.config.handlers.jira.format = 'one-line'
+      grab_request(valid_client)
+      send_command('jira details XYZ-987')
+      expect(replies.last).to eq('http://jira.local/browse/XYZ-987 - In Progress, A Person - Some summary text')
+      registry.config.handlers.jira.format = 'verbose'
+    end
   end
 
   describe '#comment' do
@@ -157,6 +179,68 @@ describe Lita::Handlers::Jira, lita_handler: true do
     end
   end
 
+  describe '#ambient' do
+    it 'does not show details for a detected issue by default' do
+    end
+
+    context 'when enabled in config' do
+      before(:each) do
+        registry.config.handlers.jira.ambient = true
+        grab_request(valid_client)
+      end
+
+      it 'shows details for a detected issue in a message' do
+        send_message('foo XYZ-987 bar')
+        expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/browse/XYZ-987")
+      end
+
+      it 'does not show details for a detected issue in a command' do
+        send_command('foo XYZ-987 bar')
+        expect(replies.size).to eq(0)
+      end
+
+      context 'and an ignore list is defined' do
+        before(:each) do
+          @user1 = Lita::User.create(1, name: 'User1')
+          @user2 = Lita::User.create(2, name: 'User2')
+          registry.config.handlers.jira.ignore = ['User2']
+        end
+
+        it 'shows details for a detected issue sent by a user absent from the list' do
+          send_message('foo XYZ-987 bar', as: @user1)
+          expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/browse/XYZ-987")
+        end
+
+        it 'does not show details for a detected issue sent by a user on the list' do
+          send_message('foo XYZ-987 bar', as: @user2)
+          expect(replies.size).to eq(0)
+        end
+      end
+
+      context 'and a room list is defined' do
+        def send_room_message(body, room)
+          robot.receive(Lita::Message.new(robot, body, Lita::Source.new(user: user, room: room)))
+        end
+
+        before(:each) do
+          @room1 = 'Room1'
+          @room2 = 'Room2'
+          registry.config.handlers.jira.rooms = [@room1]
+        end
+
+        it 'shows details for a detected issue sent in a room on the list' do
+          send_room_message('foo XYZ-987 bar', @room1)
+          expect(replies.last).to eq("[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/browse/XYZ-987")
+        end
+
+        it 'does not show details for a detected issue sent in a room absent from the list' do
+          send_room_message('foo XYZ-987 bar', @room2)
+          expect(replies.size).to eq(0)
+        end
+      end
+    end
+  end
+
   describe '#myissues' do
     before { send_command('jira forget') }
     context 'when not identified' do
@@ -178,9 +262,11 @@ describe Lita::Handlers::Jira, lita_handler: true do
       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'])
+        expect(replies.last).to eq([
+          'Here are issues currently assigned to you:',
+          "[XYZ-987] Some summary text\nStatus: In Progress, assigned to: A Person, fixVersion: Sprint 2, priority: P0\nhttp://jira.local/browse/XYZ-987",
+          "[XYZ-988] Some summary text 2\nStatus: In Progress 2, assigned to: A Person 2, fixVersion: none, priority: P1\nhttp://jira.local/browse/XYZ-988"
+        ])
       end
 
       it 'shows an error when the search fails' do

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lita-jira
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Eric Sigler
+- Matt Critchlow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-19 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -125,6 +126,7 @@ dependencies:
 description: A JIRA plugin for Lita.
 email:
 - me@esigler.com
+- matt.critchlow@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A JIRA plugin for Lita.