lita-jira-issues 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41460e79444d88c618386fb02fbe9057ccb36736
-  data.tar.gz: ff8facb4607f63e1c04ba7911afdc515a207b550
+  metadata.gz: 35aac2c646137a72b605110012083c2d97750f3f
+  data.tar.gz: fe01278b2923c44cd638ae6d3ded73fc3a1a087b
 SHA512:
-  metadata.gz: b68cbc5e9d3e15b90b494e5462ba183d452d321bee94edc5d852f046d5064606dee4810e657a214ee760eb85b19595beddde5ac7e79289f63633250a66ce79ca
-  data.tar.gz: e3d58d93cec5707754a9ece3177c4cceb648cda08e8eae2d08ccfcf68fdc839e945527c8bf5e137613c243417731cfa34b9530f833d68aff1b4c403378ab338a
+  metadata.gz: 1f0496574cadd911e313cd13eb77a053ebfdb0092faa3644b933654353eacf2861c6e71231c386cbfd2042157456474ca961b51f59adc39669081f4fc9becc9b
+  data.tar.gz: 7c057167cd2cbaaec896e6f9990187685405af33cbf867bd88aa986e50ef9feea9e4f2b5918aa17706b59083426c88d4d6e8c86fc699cec74f117d061b2743d5

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [0.2.3] - 2015-04-29
+### Added
+- Optional TTL feature for silencing the same JIRA for a period of time. Thanks
+to @johntdyer for the contribution.
+
 ## [0.2.2] - 2015-04-11
 ### Added
 - A mechanism to ignore a list of users. Thanks to @jlambert121 for contributing.
@@ -24,7 +29,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   https://github.com/github/hubot-scripts/blob/master/src/scripts/jira-issues.coffee)
 
 
-[unreleased]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.2...HEAD
+[unreleased]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.3...HEAD
+[0.2.3]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/amaltson/lita-jira-issues/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/amaltson/lita-jira-issues/compare/v0.1.0...v0.2.0

data/README.md

@@ -30,6 +30,7 @@ the following configurations to your `lita_config.rb`.
 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'
+config.handlers.jira_issues.issue_ttl = 0 #optional
 ```
 
 As in the example above, you can always use environment variables for sensitive
@@ -42,6 +43,14 @@ configuration parameter
 config.handlers.jira_issues.ignore = [ 'Jira', 'Github' ]
 ```
 
+Optionally you can set a timer for how long to sleep prior to posting an issue to chat again.  This is accomplished by setting an expiring key in Redis. That timeout is governed by the following config
+
+```ruby
+config.handlers.jira_issues.issue_ttl = 120
+```
+
+The default for this config is 0 which serves to disables the feature entirely.
+
 ## Usage
 
 Simply mention any JIRA valid key in upper or lower case, eg. JIRA-123, proj-8,

data/lib/lita/handlers/jira_issues.rb

@@ -9,6 +9,7 @@ module Lita
       config :username, required: true, type: String
       config :password, required: true, type: String
       config :ignore, default: [], type: Array
+      config :issue_ttl, default: 0, type: Integer
 
       route /[a-zA-Z]+-\d+/, :jira_message, help: {
         "KEY-123" => "Replies with information about the given JIRA key"
@@ -25,6 +26,7 @@ module Lita
       def handle_key(response, key)
         data = @jira.data_for_issue(key)
         return if data.empty?
+        return if silenced?(key)
         issue = issue_details(data)
         response.reply issue
       end
@@ -80,6 +82,26 @@ module Lita
       def issue_link(key)
         "\n#{config.url}/browse/#{key}"
       end
+
+      def silenced?(key)
+
+        if config.issue_ttl == 0
+          log.debug("JiraIssues: issue_ttl is set to 0, will post every matched issue to chat")
+          return false
+        end
+
+        current_ttl = redis.ttl(key).to_i
+
+        if current_ttl > 0
+          log.debug("JiraIssues: Key expiration not met for #{key}, will not reprompt for #{current_ttl} seconds")
+          true
+        else
+          redis.setex(key, config.issue_ttl, key)
+          log.debug("JiraIssues: Setting expiring key in redis for JIRA issue: #{key}. Key is configured to expire in #{config.issue_ttl} seconds")
+          false
+        end
+      end
+
     end
 
     Lita.register_handler(JiraIssues)

data/lita-jira-issues.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-jira-issues"
-  spec.version       = "0.2.2"
+  spec.version       = "0.2.3"
   spec.authors       = ["Arthur Maltson"]
   spec.email         = ["arthur@maltson.com"]
   spec.description   = "Lita handler to show JIRA issue details"
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "fakeredis"
 end

data/spec/lita/handlers/jira_issues_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Lita::Handlers::JiraIssues, lita_handler: true do
 
@@ -7,7 +7,33 @@ describe Lita::Handlers::JiraIssues, lita_handler: true do
 
   describe 'Looking up keys' do
 
+    context 'Test silenced handler' do
+
+      let(:redis) { Redis::Namespace }
+
+      it 'should return false when issue ttl is set to 0, which is default' do
+        Lita.config.handlers.jira_issues.issue_ttl = 0
+        expect(Lita::Handlers::JiraIssues.new.silenced?('KEY-123')).to eql false
+      end
+
+      context 'configured ttl of 10 seconds' do
+        before(:each) { Lita.config.handlers.jira_issues.issue_ttl = 10 }
+
+        it 'should return true with redis ttl is 10' do
+          allow_any_instance_of(redis).to receive(:ttl).with('KEY-424').and_return('10')
+          expect(Lita::Handlers::JiraIssues.new.silenced?('KEY-424')).to eql true
+        end
+
+        it 'should return true for silenced when redis ttl is -2' do
+          allow_any_instance_of(redis).to receive(:ttl).with('KEY-424').and_return('-2')
+          expect(Lita::Handlers::JiraIssues.new.silenced?('KEY-424')).to eql false
+        end
+      end
+
+    end
+
     before(:each) do
+      Lita.test_mode = true
       Lita.config.handlers.jira_issues.url = 'http://jira.local'
       Lita.config.handlers.jira_issues.username = 'user'
       Lita.config.handlers.jira_issues.password = 'pass'
@@ -87,8 +113,8 @@ http://jira.local/browse/PROJ-9872
         }
       })
 
-      bob = Lita::User.create(123, name: "Bob Smith")
-      fred = Lita::User.create(123, name: "Fred Smith")
+      bob = Lita::User.create(123, name: 'Bob Smith')
+      fred = Lita::User.create(123, name: 'Fred Smith')
 
       send_message('Some message KEY-424 more text', as: bob)
       expect(replies.last).not_to match('KEY-424')

data/spec/spec_helper.rb

@@ -8,5 +8,5 @@ SimpleCov.start { add_filter "/spec/" }
 
 require "lita-jira-issues"
 require "lita/rspec"
-
+require "fakeredis/rspec"
 Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-jira-issues
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Arthur Maltson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-11 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  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