lita-jira 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec792cf09935ca050ad43f9267251831c2c0e551
-  data.tar.gz: 2e5658bc5ed997068470279c7fb6eaf51acfb20a
+  metadata.gz: 90dd09ba21f516a5e3ba14b4e508a701e3ba49e6
+  data.tar.gz: 5425fa36b10399c2d7be59ae6a853e7058a4aac2
 SHA512:
-  metadata.gz: cd93b6be7fe4d14ec6dc2d4f0862c63db299d9340bf64901ec58d1b2f03bd1fbf9073bbf1d27ed69865b2fbe1e273acce65d21890f12250333105fccea68343e
-  data.tar.gz: 3622a99a077d3c7784aa0cebfea90c5ff277eb5fa74baaa3e8ea28e40e50588630b219581cce1d16b6e747d4e08985acd70ebebc87bef362fa400fa0568d5c8b
+  metadata.gz: bbff8e22a6e47173002f04d361f55ab1a1bf7cd783a56bc00d4564db07dccb1bc500237ed016e8087fe3a96ea153cda28cb02b78a165fc6a7fe07c91884b611e
+  data.tar.gz: dca962c74e1fce373a8c127f330e0fa42ad99cf03a7053693aa1d5d52163dcf39fb8fe56e7a19a5df2eca8b350df0c0ff0f1ad3e4d72a99af607e6fcf986d7a9

data/.gitignore

@@ -16,4 +16,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-*.swp

data/.rubocop.yml

@@ -1,17 +1,6 @@
-ClassLength:
-  Max: 400
-
-CyclomaticComplexity:
-  Max: 10
-
-Documentation:
-  Enabled: false
-
 FileName:
-  Enabled: false
+  Exclude:
+    - lib/lita-jira.rb
 
 LineLength:
   Max: 130
-
-MethodLength:
-  Max: 30

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.1
 script: bundle exec rake
 before_install:
   - gem update --system

data/README.md

@@ -7,7 +7,7 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/esigler/lita-jira.svg)](https://codeclimate.com/github/esigler/lita-jira)
 [![Gemnasium](https://img.shields.io/gemnasium/esigler/lita-jira.svg)](https://gemnasium.com/esigler/lita-jira)
 
-JIRA (https://www.atlassian.com/software/jira) [handler](https://github.com/jimmycuadra/lita) for creating, updating issues.
+A [JIRA](https://www.atlassian.com/software/jira) plugin for [Lita](https://github.com/jimmycuadra/lita).
 
 ## Installation
 
@@ -33,36 +33,11 @@ config.handlers.jira.context  = '' # If your instance is in a /subdirectory, put
 ### Shortcuts
 
 ```
-todo <summary> - Creates an issue with your default priority and project settings, assigned to yourself
-```
-
-### Issues
-
-```
-jira issue assignee <issue ID>                 - Shows assignee of <issue ID>
-jira issue assignee <issue ID> <email address> - Sets <email address> as the assignee
-jira issue attachments <issue ID>              - Shows all attachments for <issue ID>
-jira issue attachments <issue ID> <URL>        - Adds <URL> as an attachment on <issue ID>
-jira issue comments <issue ID>                 - Shows all comments for <issue ID>
-jira issue comments <issue ID> <text>          - Adds <text> as a comment on <issue ID>
-jira issue details <issue ID>                  - Shows all details for <issue ID>
-jira issue issuetype <issue ID>                - Shows the Issue Type of <issue ID>
-jira issue issuetype <issue ID> <issuetype ID> - Sets the Issue Type of <issue ID> to <issuetype ID>
-jira issue new <project ID> <args>             - Creates a new issue in <project ID> with <args> (args is any name:"value" pair, such as summary:"Some text")
-jira issue notify <issue ID>                   - Shows who is notified when <issue ID> is changed
-jira issue notify <issue ID> <email address>   - Adds <email address> to notification list for <issue ID>
-jira issue priority <issue ID>                 - Shows priority of <issue ID>
-jira issue priority <issue ID> <new priority>  - Sets <new priority> of <issue ID>
-jira issue summary <issue ID>                  - Shows summary of <issue ID>
-jira issue summary <issue ID> <text>           - Sets summary of <issue ID> to <text>
-jira issue watchers <issue ID>                 - Shows watchers of <issue ID>
-jira issue watchers <issue ID> <email address> - Adds <email address> to watchers list for <issue ID>
-```
-
-### Issue Types
-
-```
-jira issuetype list <project ID> - List all issuetypes for <project ID>
+todo <project> "<subject>" ["<summary>"] - Creates an issue in <project> with <subject> and optionally <summary>
+jira <issue>                             - Shows a short summary <issue>
+jira details <issue>                     - Shows all details about <issue>
+jira assign <user> to <issue>            - Assigns <user> to <issue>, <user> can be a 'Full Name' or a '@mentionname'
+jira comment on <issue> <comment text>   - Adds <comment text> to <issue>
 ```
 
 ### Search
@@ -78,8 +53,6 @@ jira search <project ID> "<text>" - Search for <text> within the scope of <proje
 jira identify <email address>     - Associate your chat user with your email address
 jira forget                       - Remove your chat user / email association
 jira whoami                       - Show your chat user / email association
-jira default project <project ID> - Set your default project ID to <project ID>
-jira default priority <priority>  - Set your default priority to <priority>
 ```
 
 ## License

data/lib/jirahelper/issue.rb

@@ -0,0 +1,21 @@
+# Helper functions for lita-jira
+module JiraHelper
+  # Issues
+  module Issue
+    def fetch_issue(key)
+      client.Issue.find(key)
+      rescue
+        log.error('JIRA HTTPError')
+        nil
+    end
+
+    def format_issue(issue)
+      t('issue.details',
+        key: issue.key,
+        summary: issue.summary,
+        assigned: issue.assignee.displayName,
+        priority: issue.priority.name,
+        status: issue.status.name)
+    end
+  end
+end

data/lib/jirahelper/misc.rb

@@ -0,0 +1,15 @@
+# Helper functions for lita-jira
+module JiraHelper
+  # Misc
+  module Misc
+    def client
+      JIRA::Client.new(
+        username: config.username,
+        password: config.password,
+        site: config.site,
+        context_path: config.context,
+        auth_type: :basic
+      )
+    end
+  end
+end

data/lib/jirahelper/regex.rb

@@ -0,0 +1,9 @@
+# Helper functions for lita-jira
+module JiraHelper
+  # Regular expressions
+  module Regex
+    PROJECT_PATTERN = /(?<project>[a-zA-Z0-9]{1,10})/
+    ISSUE_PATTERN   = /(?<issue>#{PROJECT_PATTERN}-[0-9]{1,5}+)/
+    EMAIL_PATTERN   = /(?<email>[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+)/i
+  end
+end

data/lib/jirahelper/utility.rb

@@ -0,0 +1,28 @@
+# Helper functions for lita-jira
+module JiraHelper
+  # Utility helpers
+  module Utility
+    def get_email(user)
+      return nil unless user_stored?(user)
+      redis.get(normalize_user(user))
+    end
+
+    def user_stored?(user)
+      redis.exists(normalize_user(user))
+    end
+
+    def store_user!(user, email)
+      return false if user_stored?(user)
+      redis.set(normalize_user(user), email)
+    end
+
+    def delete_user!(user)
+      return false unless user_stored?(user)
+      redis.del(normalize_user(user))
+    end
+
+    def normalize_user(user)
+      "user_#{user.id}"
+    end
+  end
+end

data/lib/lita/handlers/jira.rb

@@ -1,417 +1,65 @@
+# lita-jira plugin
 module Lita
+  # Because we can.
   module Handlers
+    # Main handler
     class Jira < Handler
-      PROJECT_PATTERN = '[a-zA-Z0-9]{1,10}'
-      ISSUE_PATTERN = "#{PROJECT_PATTERN}-[0-9]{1,5}"
+      namespace 'Jira'
 
-      route(
-        /^todo\s(.*)$/,
-        :todo,
-        command: true,
-        help: {
-          t('help.todo.syntax') => t('help.todo.desc')
-        }
-      )
+      config :username, required: true
+      config :password, required: true
+      config :site, required: true
+      config :context, required: true
 
-      route(
-        /^jira\sissue\sassignee\s(#{ISSUE_PATTERN})$/,
-        :issue_assignee_list,
-        command: true,
-        help: {
-          t('help.issue.assignee_list.syntax') => t('help.issue.assignee_list.desc')
-        }
-      )
+      include ::JiraHelper::Issue
+      include ::JiraHelper::Misc
+      include ::JiraHelper::Regex
 
       route(
-        /^jira\sissue\sassignee\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_assignee_set,
+        /^jira\s#{ISSUE_PATTERN}$/,
+        :summary,
         command: true,
         help: {
-          t('help.issue.assignee_set.syntax') => t('help.issue.assignee_set.syntax')
+          t('help.summary.syntax') => t('help.summary.desc')
         }
       )
 
       route(
-        /^jira\sissue\sattachments\s(#{ISSUE_PATTERN})$/,
-        :issue_attachments_list,
+        /^jira\sdetails\s#{ISSUE_PATTERN}$/,
+        :details,
         command: true,
         help: {
-          t('help.issue.attachments_list.syntax') => t('help.issue.attachments_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\sattachments\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_attachments_set,
-        command: true,
-        help: {
-          t('help.issue.attachments_set.syntax') => t('help.issue.attachments_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\scomments\s(#{ISSUE_PATTERN})$/,
-        :issue_comments_list,
-        command: true,
-        help: {
-          t('help.issue.comments_list.syntax') => t('help.issue.comments_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\scomments\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_comments_add,
-        command: true,
-        help: {
-          t('help.issue.comments_set.syntax') => t('help.issue.comments_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\sdetails\s(#{ISSUE_PATTERN})$/,
-        :issue_details,
-        command: true,
-        help: {
-          t('help.issue.details.syntax') => t('help.issue.details.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\sissuetype\s(#{ISSUE_PATTERN})$/,
-        :issue_issuetype_list,
-        command: true,
-        help: {
-          t('help.issue.issuetype_list.syntax') => t('help.issue.issuetype_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\sissuetype\s(#{ISSUE_PATTERN})\s(\d+)$/,
-        :issue_issuetype_set,
-        command: true,
-        help: {
-          t('help.issue.issuetype_set.syntax') => t('help.issue.issuetype_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\snew\s(#{PROJECT_PATTERN})\s(.+)$/,
-        :issue_new,
-        help: {
-          t('help.issue.new.syntax') => t('help.issue.new.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\snotify\s(#{ISSUE_PATTERN})$/,
-        :issue_notify_list,
-        help: {
-          t('help.issue.notify_list.syntax') => t('help.issue.notify_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\snotify\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_notify_set,
-        help: {
-          t('help.issue.notify_set.syntax') => t('help.issue.notify_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\spriority\s(#{ISSUE_PATTERN})$/,
-        :issue_priority_list,
-        help: {
-          t('help.issue.priority_list.syntax') => t('help.issue.priority_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\spriority\s(#{ISSUE_PATTERN})\s(\d+)$/,
-        :issue_priority_set,
-        help: {
-          t('help.issue.priority_set.syntax') => t('help.issue.priority_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\ssummary\s(#{ISSUE_PATTERN})$/,
-        :issue_summary_list,
-        help: {
-          t('help.issue.summary_list.syntax') => t('help.issue.summary_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\ssummary\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_summary_set,
-        help: {
-          t('help.issue.summary_set.syntax') => t('help.issue.summary_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\swatchers\s(#{ISSUE_PATTERN})$/,
-        :issue_watchers_list,
-        help: {
-          t('help.issue.watchers_list.syntax') => t('help.issue.watchers_list.desc')
-        }
-      )
-
-      route(
-        /^jira\sissue\swatchers\s(#{ISSUE_PATTERN})\s(.+)$/,
-        :issue_watchers_set,
-        help: {
-          t('help.issue.watchers_set.syntax') => t('help.issue.watchers_set.desc')
-        }
-      )
-
-      route(
-        /^jira\sissuetype\slist\s(#{PROJECT_PATTERN})$/,
-        :issuetype_list,
-        help: {
-          t('help.issuetype.list.syntax') => t('help.issuetype.list.desc')
-        }
-      )
-
-      route(
-        /^jira\ssearch\s(.+)$/,
-        :search_full,
-        help: {
-          t('help.search.full.syntax') => t('help.search.full.desc')
-        }
-      )
-
-      route(
-        /^jira\ssearch\s(#{PROJECT_PATTERN})\s(.+)$/,
-        :search_project,
-        help: {
-          t('help.search.project.syntax') => t('help.search.project.desc')
-        }
-      )
-
-      route(
-        /^jira\sidentify\s(.+)$/,
-        :identify,
-        help: {
-          t('help.identify.syntax') => t('help.identify.desc')
+          t('help.details.syntax') => t('help.details.desc')
         }
       )
 
       route(
-        /^jira\sforget$/,
-        :forget,
-        help: {
-          t('help.forget.syntax') => t('help.forget.desc')
-        }
-      )
-
-      route(
-        /^jira\swhoami$/,
-        :whoami,
-        help: {
-          t('help.whoami.syntax') => t('help.whoami.desc')
-        }
-      )
-
-      route(
-        /^jira\sdefault\sproject\s(#{PROJECT_PATTERN})$/,
-        :default_project,
-        help: {
-          t('help.default.project.syntax') => t('help.default.project.desc')
-        }
-      )
-
-      route(
-        /^jira\sdefault\spriority\s(\d+)$/,
-        :default_priority,
-        help: {
-          t('help.default.priority.syntax') => t('help.default.priority.desc')
-        }
-      )
-
-      route(
-        /^jira\s(#{ISSUE_PATTERN})$/,
-        :issue_summary,
+        /^jira\scomment\son\s#{ISSUE_PATTERN}\s"(?<comment>.+)"$/,
+        :comment,
         command: true,
         help: {
-          'jira <issue ID>' => 'Shows summary for <issue ID>'
+          t('help.comment.syntax') => t('help.comment.desc')
         }
       )
 
-      route(
-        /^jira\s(#{ISSUE_PATTERN})\sdetails$/,
-        :issue_details,
-        command: true,
-        help: {
-          'jira <issue ID> details' => 'Shows detailed information for <issue ID>' }
-      )
-
-      def self.default_config(config)
-        config.username = nil
-        config.password = nil
-        config.site     = nil
-        config.context  = nil
-      end
-
-      def issue_summary(response)
-        key = response.matches[0][0]
-        issue = fetch_issue(key)
-        if issue
-          response.reply("#{key}: #{issue.summary}")
-        else
-          response.reply(t('error.request'))
-        end
-      end
-
-      def issue_details(response)
-        key = response.matches[0][0]
-        issue = fetch_issue(key)
-        if issue
-          response.reply(format_issue(issue))
-        else
-          response.reply(t('error.request'))
-        end
-      end
-
-      def todo(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_assignee_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_assignee_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_attachments_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_attachments_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_comments_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_comments_add(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_issuetype_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_issuetype_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_new(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_notify_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_notify_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_priority_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_priority_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_summary_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_summary_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_watchers_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issue_watchers_set(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def issuetype_list(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def search_full(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def search_project(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def identify(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def forget(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def whoami(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def default_project(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      def default_priority(response)
-        response.reply(t('error.not_implemented'))
-      end
-
-      private
-
-      def j_client
-        if Lita.config.handlers.jira.username.nil? ||
-           Lita.config.handlers.jira.password.nil? ||
-           Lita.config.handlers.jira.site.nil?     ||
-           Lita.config.handlers.jira.context.nil?
-          Lita.logger.error('Missing config for JIRA')
-          fail 'Missing config'
-        end
-
-        JIRA::Client.new(
-          username: Lita.config.handlers.jira.username,
-          password: Lita.config.handlers.jira.password,
-          site: Lita.config.handlers.jira.site,
-          context_path: Lita.config.handlers.jira.context,
-          auth_type: :basic
-        )
+      def summary(response)
+        issue = fetch_issue(response.match_data['issue'])
+        return response.reply(t('error.request')) unless issue
+        response.reply("#{issue.key}: #{issue.summary}")
       end
 
-      def fetch_issue(key)
-        j_client.Issue.find(key)
-        rescue JIRA::HTTPError
-          Lita.logger.error('JIRA HTTPError')
-          nil
+      def details(response)
+        issue = fetch_issue(response.match_data['issue'])
+        return response.reply(t('error.request')) unless issue
+        response.reply(format_issue(issue))
       end
 
-      def format_issue(issue)
-        t('issue.details',
-          key: issue.key,
-          summary: issue.summary,
-          assigned: issue.assignee.displayName,
-          priority: issue.priority.name,
-          status: issue.status.name)
+      def comment(response)
+        issue = fetch_issue(response.match_data['issue'])
+        return response.reply(t('error.request')) unless issue
+        comment = issue.comments.build
+        comment.save!(body: response.match_data['comment'])
+        response.reply(t('comment.added', issue: issue.key))
       end
     end
 

data/lib/lita/handlers/jira_utility.rb

@@ -0,0 +1,62 @@
+# lita-jira plugin
+module Lita
+  # Because we can.
+  module Handlers
+    # Utilities
+    class JiraUtility < Handler
+      namespace 'Jira'
+
+      include ::JiraHelper::Issue
+      include ::JiraHelper::Misc
+      include ::JiraHelper::Regex
+      include ::JiraHelper::Utility
+
+      route(
+        /^jira\sidentify\s#{EMAIL_PATTERN}$/,
+        :identify,
+        command: true,
+        help: {
+          t('help.identify.syntax') => t('help.identify.desc')
+        }
+      )
+
+      route(
+        /^jira\sforget$/,
+        :forget,
+        command: true,
+        help: {
+          t('help.forget.syntax') => t('help.forget.desc')
+        }
+      )
+
+      route(
+        /^jira\swhoami$/,
+        :whoami,
+        command: true,
+        help: {
+          t('help.whoami.syntax') => t('help.whoami.desc')
+        }
+      )
+
+      def identify(response)
+        email = response.match_data['email']
+        return response.reply(t('error.already_identified', email: get_email(response.user))) if user_stored?(response.user)
+        store_user!(response.user, email)
+        response.reply(t('identify.stored', email: email))
+      end
+
+      def forget(response)
+        return response.reply(t('error.not_identified')) unless user_stored?(response.user)
+        delete_user!(response.user)
+        response.reply(t('identify.deleted'))
+      end
+
+      def whoami(response)
+        return response.reply(t('error.not_identified')) unless user_stored?(response.user)
+        response.reply(t('identify.email', email: get_email(response.user)))
+      end
+
+      Lita.register_handler(JiraUtility)
+    end
+  end
+end

data/lib/lita-jira.rb

@@ -4,6 +4,12 @@ Lita.load_locales Dir[File.expand_path(
   File.join('..', '..', 'locales', '*.yml'), __FILE__
 )]
 
-require 'lita/handlers/jira'
-
 require 'jira'
+
+require 'jirahelper/issue'
+require 'jirahelper/misc'
+require 'jirahelper/regex'
+require 'jirahelper/utility'
+
+require 'lita/handlers/jira_utility'
+require 'lita/handlers/jira'

data/lita-jira.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-jira'
-  spec.version       = '0.3.1'
+  spec.version       = '0.4.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = 'A Lita handler for interacting with a JIRA ticket tracker.'
@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'lita', '>= 3.0'
+  spec.add_runtime_dependency 'lita', '>= 4.0'
   spec.add_runtime_dependency 'jira-ruby', '>= 0.1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 3.0.0.beta2'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rubocop'

data/locales/en.yml

@@ -3,39 +3,33 @@ en:
     handlers:
       jira:
         error:
-          not_implemented: Not implemented yet.
+          already_identified: "You are already identified as %{email}"
+          not_identified: You do not have an email address on record
           request: Error fetching JIRA issue
         help:
-          todo:
-            syntax: todo <summary>
-            desc: Creates an issue with your default priority and project settings, assigned to yourself
-          issue:
-            assignee_list:
-              syntax: jira issue assignee <issue ID>
-              desc: Shows assignee of <issue ID>
-            assignee_set:
-              syntax: jira issue assignee <issue ID> <email address>
-              desc: Sets <email address> as the assignee
-            attachments_list:
-              syntax: jira issue attachments <issue ID>
-              desc: Shows all attachments for <issue ID>
-            attachments_set:
-              syntax: jira issue attachments <issue ID> <URL>
-              desc: Adds <URL> as an attachment on <issue ID>
-            comments_list:
-              syntax: jira issue comments <issue ID>
-              desc: Shows all comments for <issue ID>
-            comments_set:
-              syntax: jira issue comments <issue ID> <text>
-              desc: Adds <text> as a comment on <issue ID>
-            details:
-              syntax: jira issue details <issue ID>
-              desc: Shows all details for <issue ID>
-            issuetype_list:
-              syntax: jira issue issuetype <issue ID>
-              desc: Shows the Issue Type of <issue ID>
-            issuetype_set:
-              syntax: jira issue issuetype <issue ID> <issuetype ID>
-              desc: Sets the Issue Type of <issue ID> to <issuetype ID>
+          identify:
+            syntax: jira identify <email address>
+            desc: Associate your chat user with your email address
+          forget:
+            syntax: jira forget
+            desc: Remove your chat user / email association
+          whoami:
+            syntax: jira whoami
+            desc: Show your chat user / email association
+          comment:
+            syntax:
+            desc:
+          details:
+            syntax: jira details <issue>
+            desc: Shows detailed information for <issue>
+          summary:
+            syntax: jira <issue>
+            desc: Shows summary for <issue>
+        identify:
+          stored: "You have been identified as %{email} to JIRA"
+          deleted: You have been de-identified from JIRA
+          email: "You are identified with JIRA as %{email}"
         issue:
-          details: "%{key}: %{summary}, assigned to: %{assigned}, priority: %{priority}, status: %{status}"
+          details: "%{key}: %{summary}, assigned to: %{assigned}, priority: %{priority}, status: %{status}"
+        comment:
+          added: "Comment added to %{issue}"

data/spec/lita/handlers/jira_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Lita::Handlers::Jira, lita_handler: true do
-  let(:open_issue) do
+  let(:basic_issue) do
     double(summary: 'Some summary text',
            assignee: double(displayName: 'A Person'),
            priority: double(name: 'P0'),
@@ -9,184 +9,71 @@ describe Lita::Handlers::Jira, lita_handler: true do
            key: 'XYZ-987')
   end
 
-  def grab_issue_request(key, issue)
-    allow_any_instance_of(Lita::Handlers::Jira).to \
-      receive(:fetch_issue).with(key).and_return(issue)
+  let(:open_issue) do
+    r = double
+    expect(r).to receive_message_chain('Issue.find') { basic_issue }
+    r
   end
 
-  it { routes_command('todo some text').to(:todo) }
-  it { routes_command('jira issue assignee ABC-123').to(:issue_assignee_list) }
-  it { routes_command('jira issue assignee ABC-123 foo@example.com').to(:issue_assignee_set) }
-  it { routes_command('jira issue attachments ABC-123').to(:issue_attachments_list) }
-  it { routes_command('jira issue attachments ABC-123 http://example.com').to(:issue_attachments_set) }
-  it { routes_command('jira issue comments ABC-123').to(:issue_comments_list) }
-  it { routes_command('jira issue comments ABC-123 Some text').to(:issue_comments_add) }
-  it { routes_command('jira issue details ABC-123').to(:issue_details) }
-  it { routes_command('jira issue issuetype ABC-123').to(:issue_issuetype_list) }
-  it { routes_command('jira issue issuetype ABC-123 4').to(:issue_issuetype_set) }
-  it { routes_command('jira issue new ABC some:thing').to(:issue_new) }
-  it { routes_command('jira issue notify ABC-123').to(:issue_notify_list) }
-  it { routes_command('jira issue notify ABC-123 foo@example.com').to(:issue_notify_set) }
-  it { routes_command('jira issue priority ABC-123').to(:issue_priority_list) }
-  it { routes_command('jira issue priority ABC-123 9').to(:issue_priority_set) }
-  it { routes_command('jira issue summary ABC-123').to(:issue_summary_list) }
-  it { routes_command('jira issue summary ABC-123 Some text!').to(:issue_summary_set) }
-  it { routes_command('jira issue watchers ABC-123').to(:issue_watchers_list) }
-  it { routes_command('jira issue watchers ABC-123 foo@example.com').to(:issue_watchers_set) }
-  it { routes_command('jira issuetype list ABC').to(:issuetype_list) }
-  it { routes_command('jira search Some text').to(:search_full) }
-  it { routes_command('jira search ABC Some text').to(:search_project) }
-  it { routes_command('jira identify foo@example.com').to(:identify) }
-  it { routes_command('jira forget').to(:forget) }
-  it { routes_command('jira whoami').to(:whoami) }
-  it { routes_command('jira default project ABC').to(:default_project) }
-  it { routes_command('jira default priority 9').to(:default_priority) }
-
-  describe '.default_config' do
-    it 'sets username to nil' do
-      expect(Lita.config.handlers.jira.username).to be_nil
-    end
-
-    it 'sets password to nil' do
-      expect(Lita.config.handlers.jira.password).to be_nil
-    end
+  let(:failed_find) do
+    r = double
+    expect(r).to receive_message_chain('Issue.find').and_throw(JIRA::HTTPError)
+    r
+  end
 
-    it 'sets site to nil' do
-      expect(Lita.config.handlers.jira.site).to be_nil
-    end
+  let(:comment_issue) do
+    r = double
+    expect(r).to receive_message_chain('Issue.find') { basic_issue }
+    expect(r).to receive_message_chain('Issue.find.comments.build.save!') { basic_issue }
+    r
+  end
 
-    it 'sets context to nil' do
-      expect(Lita.config.handlers.jira.context).to be_nil
-    end
+  it do
+    is_expected.to route_command('jira ABC-123')
+    is_expected.to route_command('jira details ABC-123')
+    is_expected.to route_command('jira comment on ABC-123 "You just need a cat"')
   end
 
-  describe '#issue_summary' do
-    it 'with valid issue ID shows summary' do
-      grab_issue_request('XYZ-987', open_issue)
+  describe '#summary' do
+    it 'shows summary with a valid issue' do
+      grab_request(open_issue)
       send_command('jira XYZ-987')
       expect(replies.last).to eq('XYZ-987: Some summary text')
     end
 
-    it 'without valid issue ID shows an error' do
-      grab_issue_request('XYZ-987', nil)
+    it 'warns the user when the issue is not valid' do
+      grab_request(failed_find)
       send_command('jira XYZ-987')
       expect(replies.last).to eq('Error fetching JIRA issue')
     end
   end
 
-  describe '#issue_details' do
-    it 'with valid issue ID shows details' do
-      grab_issue_request('XYZ-987', open_issue)
-      send_command('jira XYZ-987 details')
+  describe '#details' do
+    it 'shows details with a valid issue' do
+      grab_request(open_issue)
+      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')
     end
 
-    it 'without valid issue ID shows an error' do
-      grab_issue_request('XYZ-987', nil)
-      send_command('jira XYZ-987 details')
+    it 'warns the user when the issue is not valid' do
+      grab_request(failed_find)
+      send_command('jira details XYZ-987')
       expect(replies.last).to eq('Error fetching JIRA issue')
     end
   end
 
-  describe '#todo' do
-  end
-
-  describe '#issue_assignee_list' do
-    it 'with valid issue ID shows the current assignees'
-
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_assignee_set' do
-    it 'with valid issue ID sets an assignee'
-
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_attachments_list' do
-    it 'with valid issue ID shows the current attachments'
-
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_attachments_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_comments_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_comments_add' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_issuetype_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_issuetype_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_new' do
-  end
-
-  describe '#issue_notify_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_notify_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_priority_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_priority_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_summary_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_summary_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_watchers_list' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issue_watchers_set' do
-    it 'without valid issue ID shows an error'
-  end
-
-  describe '#issuetype_list' do
-    it 'without valid issuetype shows an error'
-  end
-
-  describe '#search_full' do
-  end
-
-  describe '#search_project' do
-  end
-
-  describe '#identify' do
-  end
-
-  describe '#forget' do
-  end
-
-  describe '#whoami' do
-  end
-
-  describe '#default_project' do
-  end
+  describe '#comment' do
+    it 'updates the comment with a valid issue and comment text' do
+      grab_request(comment_issue)
+      send_command('jira comment on XYZ-987 "Testing"')
+      expect(replies.last).to eq('Comment added to XYZ-987')
+    end
 
-  describe '#default_priority' do
+    it 'warns the user when the issue is not valid' do
+      grab_request(failed_find)
+      send_command('jira comment on XYZ-987 "Testing"')
+      expect(replies.last).to eq('Error fetching JIRA issue')
+    end
   end
 end

data/spec/lita/handlers/jira_utility_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Lita::Handlers::JiraUtility, lita_handler: true do
+  it do
+    is_expected.to route_command('jira identify user@example.com').to(:identify)
+    is_expected.to route_command('jira forget').to(:forget)
+    is_expected.to route_command('jira whoami').to(:whoami)
+  end
+
+  describe '#identify' do
+    it 'remembers the user if they do not already have an email address stored' do
+      send_command('jira identify user@example.com')
+      expect(replies.last).to eq('You have been identified as user@example.com to JIRA')
+    end
+
+    it 'warns the user if they have already stored an email address' do
+      send_command('jira identify user@example.com')
+      send_command('jira identify otheruser@example.com')
+      expect(replies.last).to eq('You are already identified as user@example.com')
+    end
+  end
+
+  describe '#forget' do
+    it 'forgets the user if they have an email address stored' do
+      send_command('jira identify user@example.com')
+      send_command('jira forget')
+      expect(replies.last).to eq('You have been de-identified from JIRA')
+    end
+
+    it 'warns the user if they did not have a stored email address' do
+      send_command('jira forget')
+      expect(replies.last).to eq('You do not have an email address on record')
+    end
+  end
+
+  describe '#whoami' do
+    it 'shows the current stored email address if one exists' do
+      send_command('jira identify user@example.com')
+      send_command('jira whoami')
+      expect(replies.last).to eq('You are identified with JIRA as user@example.com')
+    end
+
+    it 'warns the user if there is no stored address' do
+      send_command('jira whoami')
+      expect(replies.last).to eq('You do not have an email address on record')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,3 +8,16 @@ SimpleCov.start { add_filter '/spec/' }
 
 require 'lita-jira'
 require 'lita/rspec'
+
+Lita.version_3_compatibility_mode = false
+
+RSpec.configure do |config|
+  config.before do
+    registry.register_handler(Lita::Handlers::Jira)
+    registry.register_handler(Lita::Handlers::JiraUtility)
+  end
+end
+
+def grab_request(result)
+  expect(JIRA::Client).to receive(:new) { result }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-jira
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: jira-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -137,11 +137,17 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/jirahelper/issue.rb
+- lib/jirahelper/misc.rb
+- lib/jirahelper/regex.rb
+- lib/jirahelper/utility.rb
 - lib/lita-jira.rb
 - lib/lita/handlers/jira.rb
+- lib/lita/handlers/jira_utility.rb
 - lita-jira.gemspec
 - locales/en.yml
 - spec/lita/handlers/jira_spec.rb
+- spec/lita/handlers/jira_utility_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/esigler/lita-jira
 licenses:
@@ -170,4 +176,5 @@ specification_version: 4
 summary: A Lita handler for interacting with a JIRA ticket tracker.
 test_files:
 - spec/lita/handlers/jira_spec.rb
+- spec/lita/handlers/jira_utility_spec.rb
 - spec/spec_helper.rb