lita-jira-issues 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a8031619193c513be736c5ab30c7a042f8e7904
+  data.tar.gz: f5cafa72ed70367ffe54ff72bb4aecc1f194e8e3
+SHA512:
+  metadata.gz: af14129f93d13f70895fb58193572b748e068db7c18d4330819442f80867be97705234510b1d0e4fb19158a621ae86aabf0e91b29f2fd02c2d56a0a895be9f83
+  data.tar.gz: e886bd47ca666e7c2024f231eccbe1b1e0396a246b19143f0500571d4427c4848e74d46b7235c8ad12a763d33fd2b8226c36617c3c74b9f8d880a4133c127a5e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Arthur Maltson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# lita-jira-issues
+
+[![Build Status](http://img.shields.io/travis/amaltson/lita-jira-issues.svg)](https://travis-ci.org/amaltson/lita-jira-issues)
+[![Code Climate](http://img.shields.io/codeclimate/github/amaltson/lita-jira-issues.svg)](https://codeclimate.com/github/amaltson/lita-jira-issues)
+[![Coverage Status](http://img.shields.io/coveralls/amaltson/lita-jira-issues.svg)](https://coveralls.io/r/amaltson/lita-jira-issues)
+
+Lita handler for showing JIRA issue details when a JIRA issue key is mentioned in
+chat. Inspired by the [Hubot jira-issue
+plugin](https://github.com/github/hubot-scripts/blob/master/src/scripts/jira-issues.coffee)
+
+## Installation
+
+Add lita-jira-issues to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-jira-issues"
+```
+
+
+## Configuration
+
+The `jira_issues` handler needs to be configured with your JIRA instance. Add
+the following configurations to your `lita_config.rb`.
+
+```ruby
+config.handlers.jira_issues.url = 'http://jira.local'
+config.handlers.jira_issues.username = ENV['JIRA_USER'] || 'user'
+config.handlers.jira_issues.password = ENV['JIRA_PASSWORD'] || 'password'
+```
+
+As in the example above, you can always use environment variables for sensitive
+information like the JIRA user's password.
+
+## Usage
+
+Simply mention any JIRA valid key in upper or lower case, eg. JIRA-123, proj-8,
+and Lita will respond with the issue details.
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-jira-issues.rb

@@ -0,0 +1,7 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/jira_issues"

data/lib/lita/handlers/jira_gateway.rb

@@ -0,0 +1,17 @@
+class JiraGateway
+
+  attr_reader :http, :config
+
+  def initialize(http, config)
+    @http = http
+    @config = config
+  end
+
+  def data_for_issue(key)
+    http.basic_auth(config.username, config.password)
+    response = http.get(config.url + '/rest/api/2/issue/' + key)
+    return MultiJson.load(response.body, symbolize_keys: true) if response.success?
+    {}
+  end
+
+end

data/lib/lita/handlers/jira_issues.rb

@@ -0,0 +1,96 @@
+require_relative 'jira_gateway'
+
+module Lita
+  module Handlers
+    class JiraIssues < Handler
+
+      def initialize(*args)
+        super(args)
+        @jira = JiraGateway.new(http, config)
+      end
+
+      def self.default_config(config)
+        config.enabled = true
+      end
+
+      route /[a-zA-Z]+-\d+/, :jira_message, help: {
+        "KEY-123" => "Replies with information about the given JIRA key"
+      }
+
+      def jira_message(response)
+        unless configured?
+          raise 'Need to configure url, username, password for jira_issues ' \
+            'to work'
+        end
+        response.matches.each do | key |
+          handle_key(response, key)
+        end
+      end
+
+      def configured?
+        config.url && config.username && config.password
+      end
+
+      def handle_key(response, key)
+        data = @jira.data_for_issue(key)
+        return if data.empty?
+        issue = issue_details(data)
+        response.reply issue
+      end
+
+      def issue_details(data)
+        key = data[:key]
+        data = data[:fields]
+        issue = summary(key, data)
+        issue << status(data)
+        issue << assignee(data)
+        issue << reporter(data)
+        issue << fix_version(data)
+        issue << priority(data)
+        issue << issue_link(key)
+      end
+
+      def summary(key, data)
+        "[#{key}] #{data[:summary]}"
+      end
+
+      def status(data)
+        "\nStatus: #{data[:status][:name]}"
+      end
+
+      def assignee(data)
+        if assigned_to = data[:assignee]
+          return ", assigned to #{assigned_to[:displayName]}"
+        end
+        ', unassigned'
+      end
+
+      def reporter(data)
+        ", rep. by #{data[:reporter][:displayName]}"
+      end
+
+      def fix_version(data)
+        fix_versions = data[:fixVersions]
+        if fix_versions and fix_versions.first
+          ", fixVersion: #{fix_versions.first[:name]}"
+        else
+          ', fixVersion: NONE'
+        end
+      end
+
+      def priority(data)
+        if data[:priority]
+          ", priority: #{data[:priority][:name]}" 
+        else
+          ""
+        end
+      end
+
+      def issue_link(key)
+        "\n#{config.url}/browse/#{key}"
+      end
+    end
+
+    Lita.register_handler(JiraIssues)
+  end
+end

data/lita-jira-issues.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-jira-issues"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Arthur Maltson"]
+  spec.email         = ["arthur@maltson.com"]
+  spec.description   = "Lita handler to show JIRA issue details"
+  spec.summary       = %q{Lita handler that looks for JIRA issue keys and
+  helpfully inserts details into the chat conversation.}
+  spec.homepage      = "https://github.com/amaltson/lita-jira-issues"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 3.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lita_config.rb

@@ -0,0 +1,6 @@
+Lita.configure do |config|
+  config.robot.name = 'Jira Lita'
+  config.handlers.jira_issues.url = 'http://jira.local'
+  config.handlers.jira_issues.username = ENV['JIRA_USER'] || 'user'
+  config.handlers.jira_issues.password = ENV['JIRA_PASSWORD'] || 'password'
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      jira_issues:

data/spec/lita/handlers/jira_gateway_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe JiraGateway do
+
+  User = Struct.new(:url, :username, :password)
+  Response = Struct.new(:body, :success?)
+
+  let(:http_mock) { spy('http') }
+  subject do
+    JiraGateway.new(http_mock,
+                    User.new('http://jira.local', 'user', 'password'))
+  end
+
+  it 'should return symbolized hash for JSON result' do
+    expect(http_mock).to receive(:basic_auth).with('user', 'password')
+    expect(http_mock).to receive(:get)
+      .with('http://jira.local/rest/api/2/issue/PRO-98')
+      .and_return(Response.new('{"key":"PRO-98"}', true))
+    expect(subject.data_for_issue('PRO-98')).to eq({key: 'PRO-98'})
+  end
+
+  it 'should return empty hash when response fails' do
+    expect(http_mock).to receive(:get)
+      .and_return(Response.new('{"key":"NOT_USED"}', false))
+    expect(subject.data_for_issue('some key')).to eq({})
+  end
+end

data/spec/lita/handlers/jira_issues_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Lita::Handlers::JiraIssues, lita_handler: true do
+
+  it 'should fail to start without configuration' do
+    send_message('Trying to use JIRA_123 not configured')
+  end
+
+  it { routes('JIRA-123').to(:jira_message) }
+  it { routes('user talking about something JIRA-123 had key').to(:jira_message) }
+
+  describe 'Looking up keys' do
+
+    before(:each) do
+      Lita.config.handlers.jira_issues.url = 'http://jira.local'
+      Lita.config.handlers.jira_issues.username = 'user'
+      Lita.config.handlers.jira_issues.password = 'pass'
+    end
+
+    it 'should reply with JIRA description if one seen' do
+      mock_jira('KEY-424', {
+        key:'KEY-424',
+        fields: {
+          summary: 'Another issue',
+          status: {
+            name: 'Fixed'
+          },
+          assignee: {
+            displayName: 'User'
+          },
+          reporter: {
+            displayName: 'Reporter'
+          },
+          fixVersions: [ { name: 'Sprint 2' } ],
+          priority: { name: 'Undecided' }
+        }
+      })
+      send_message('Some message KEY-424 more text')
+      expect(replies.last).to eq(<<-EOS.chomp
+[KEY-424] Another issue
+Status: Fixed, assigned to User, rep. by Reporter, fixVersion: Sprint 2, priority: Undecided
+http://jira.local/browse/KEY-424
+                                 EOS
+                                )
+    end
+
+    it 'it should reply with multiple JIRA descriptions if many seen' do
+      mock_jira('PROJ-9872',
+                {key:'PROJ-9872',
+                 fields: {
+                  summary: 'Too many bugs',
+                  status: {
+                    name: 'Resolved'
+                  },
+                  assignee: nil,
+                  reporter: {
+                    displayName: 'User'
+                  }
+                }})
+      mock_jira('nEw-1',
+                {key:'NEW-1',
+                 fields: {
+                  summary: 'New 1',
+                  status: {
+                    name: 'Open'
+                  },
+                  reporter: {
+                    displayName: 'User2'
+                  },
+                  fixVersions: [],
+                  priority: { name: 'High' }
+                }})
+
+      send_message('Some PROJ-9872 message nEw-1 more text')
+      expect(replies.pop).to eq(<<-EOS.chomp
+[NEW-1] New 1
+Status: Open, unassigned, rep. by User2, fixVersion: NONE, priority: High
+http://jira.local/browse/NEW-1
+                                EOS
+                               )
+      expect(replies.pop).to eq(<<-EOS.chomp
+[PROJ-9872] Too many bugs
+Status: Resolved, unassigned, rep. by User, fixVersion: NONE
+http://jira.local/browse/PROJ-9872
+                                EOS
+                               )
+    end
+
+    def mock_jira(key, result)
+      allow_any_instance_of(JiraGateway).to receive(:data_for_issue)
+        .with(key)
+        .and_return(result)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-jira-issues"
+require "lita/rspec"

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: lita-jira-issues
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arthur Maltson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lita handler to show JIRA issue details
+email:
+- arthur@maltson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-jira-issues.rb
+- lib/lita/handlers/jira_gateway.rb
+- lib/lita/handlers/jira_issues.rb
+- lita-jira-issues.gemspec
+- lita_config.rb
+- locales/en.yml
+- spec/lita/handlers/jira_gateway_spec.rb
+- spec/lita/handlers/jira_issues_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/amaltson/lita-jira-issues
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lita handler that looks for JIRA issue keys and helpfully inserts details
+  into the chat conversation.
+test_files:
+- spec/lita/handlers/jira_gateway_spec.rb
+- spec/lita/handlers/jira_issues_spec.rb
+- spec/spec_helper.rb