bender-bot 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c7feb7ff451b53acb7ea0171573c05e0658a217
-  data.tar.gz: f337922a2e8310c05de4ad7ab7e44bb743a22a6a
+  metadata.gz: ba655e7af625e66dc7c4b9ddea408d69d9c87061
+  data.tar.gz: 63f6f815bd1b6bb72873b0caebe2c2b7f6c612be
 SHA512:
-  metadata.gz: 15069ef3e4408d5166023b7031bbbf7e810350687c77738fff83c3cbe8430717a1eb6f7f0095a0c8e47e29e7ae8b92a62059845e89b2d66dbe5416585c07e853
-  data.tar.gz: 6782aa69d9109eb06b92299f9246a552e80eef81f8cb5f80660ccb12c48fd6fac80d19d27116e362598d04e3af8509db59c48dcf877a7b17176a0a45d37dc3e6
+  metadata.gz: 61b6aefef6785b768ec92b534b962263dd02f2a3e80b167d97c2e89c23b2fba88149af9efd594e3f7c1bed72a785a24cd61e380f34aebe8848561648e5856538
+  data.tar.gz: 21af57fe2c566d1978817b2e41c0a97400f50854c0d7f651a8d1fa3bda00901ddbb9d46184275ff9246604f613d11fa3c995e9c8797a947650bb2de1c2e00daf

data/Readme.md

@@ -1,3 +1,55 @@
 # Bender ![Version](https://img.shields.io/gem/v/bender-bot.svg?style=flat-square)
 
-Yet another HipChat bot.
+Yet another HipChat bot.
+
+Bender hooks into both HipChat and JIRA to report and manage incidents. It uses
+quite a number of different APIs, and the workflow is is pretty rigid, so the
+configuration is quite painful:
+
+    {
+      // NB: You actually can't use comments in your JSON. Such is life.
+      "hipchat_token": "asdaf98dfas89fdsa8", // Set HipChat v1 API token
+      "hipchat_v2_token": "afiadsaf98fdsa890da908", // Set HipChat v2 API token
+      "primary_room_id": "12341234", // Set HipChat primary room ID
+      "jid": "1234934_213434@chat.hipchat.com", // Set HipChat JID
+      "password": "asd12353521fasfda1243dfs", // Set HipChat password
+      "nick": "bender",  // Set HipChat nick name (short)
+      "mention": "Bender Rodríguez", // Set HipChat mention name (long)
+      "rooms": [ "12341_frys_room@chat.hipchat.com" ], // Set HipChat rooms (comma-separated)
+      "database": "/var/data/bender.db", // Set path to application database
+      "jira_user": "bender, // Set JIRA username
+      "jira_pass": "1dkjasdflhkjaiyuwewqmnqew", // Set JIRA password
+      "jira_site": "http://jira", // Set JIRA site
+      "jira_project": "INC", // Set JIRA project
+      "jira_group": "ops", // Set JIRA group for write mode
+      "jira_type": "Incident", // Set JIRA issue type
+      "user_refresh": 300, // Set JIRA user refresh rate (seconds)
+      "issue_refresh": 5, // Set JIRA issue refresh rate (seconds)
+      "group_refresh": 60, // Set JIRA group refresh rate (seconds)
+      "room_base_name": "Incidents", // Base name for the primary room
+      "prefix": "inc", // Command prefix for bot interactions
+      "resolved_transitions": [ "51" ], // State IDs for resolution
+      "resolved_state": "(?i-mx:resolve)", // State name regex for resolution
+      "closed_transitions": [ "61", "71" ], // State IDs for close
+      "closed_state": "(?i-mx:close)", // State name regex for close
+      "severities": { // Severities (low to high): short number -> ID
+        "1": "1234124",
+        "2": "1324564",
+        "3": "0393103",
+        "4": "1092394",
+        "5": "1034937"
+      },
+      "show_fields": { // JIRA fields to show: ID -> human name
+        "summary": "Summary",
+        "description": "Description",
+        "customfield_12259": "Severity",
+        "customfield_12251": "Impact Started",
+        "customfield_12232": "Impact Ended",
+        "customfield_12253": "Reported By",
+        "customfield_12354": "Services Affected",
+        "customfield_11255": "Cause",
+        "status": "Status",
+        "created": "Created",
+        "updated": "Updated"
+      }
+    }

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/lib/bender/bot.rb

@@ -36,8 +36,8 @@ class BenderBot
 
   JARO = FuzzyStringMatch::JaroWinkler.create :native
 
-  def self.set_commands
-    BenderBot.const_set :COMMANDS, {
+  def self.set_commands without
+    commands = {
       help: {
         desc: 'Display this help text',
       },
@@ -70,10 +70,11 @@ class BenderBot
         desc: 'Add a comment to an incident'
       }
     }
+    without.each { |wo| commands.delete wo.to_sym }
+    BenderBot.const_set :COMMANDS, commands
   end
 
 
-
   def reply_html message, color=:yellow
     tries ||= 3
     @@hipchat[@this_room.name].send(nick, message, color: color)
@@ -94,7 +95,7 @@ class BenderBot
       opts[:cmd]   = opts[:cmd].to_s.insert(0, ' ') if opts[:cmd]
       opts[:fmt] ||= ''
       opts[:fmt]   = opts[:fmt].to_s.insert(0, ' ') if opts[:fmt]
-      '<code>/inc%{cmd}%{fmt}</code> - %{desc}' % opts
+      "<code>/#{prefix}%{cmd}%{fmt}</code> - %{desc}" % opts
     end.join('<br />')
 
     reply_html help
@@ -123,12 +124,12 @@ class BenderBot
     severities = Hash.new { |h,k| h[k] = [] }
 
 
-    case message
+    case message.strip
 
-    when /^\s*\/bender\s*$/
+    when /^\/#{config[:jira_user]}$/
       reply_html QUOTES.sample(1).first, :red
 
-    when /^\s*\/whoami\s*$/
+    when /^\/whoami$/
       u = user_where name: sender
       if u
         m = '<b>%{nick}</b>: %{name} (<a href="mailto:%{email}">%{email}</a>)' % u
@@ -137,7 +138,7 @@ class BenderBot
         reply_html "Couldn't find the associated user in JIRA", :red
       end
 
-    when /^\s*\/lookup\s+(.+)\s*$/
+    when /^\/lookup\s+(.+)$/
       u = user_where(name: $1) || user_where(nick: $1)
       if u
         m = '<b>%{nick}</b>: %{name} (<a href="mailto:%{email}">%{email}</a>)' % u
@@ -146,12 +147,12 @@ class BenderBot
         reply_html "Couldn't find the associated user in JIRA", :red
       end
 
-    # /inc help - This help text
-    when /^\s*(\?inc|\/inc\s+help)\s*$/
+    # /prefix help - This help text
+    when /^(\?#{prefix}|\/#{prefix}\s+help)$/
       reply_with_help
 
-    # /inc - List open incidents
-    when /^\s*\/inc\s*$/
+    # /prefix - List open incidents
+    when /^\/#{prefix}$/
       refresh_incidents
 
       is = store['incidents'].reverse.map do |i|
@@ -173,8 +174,8 @@ class BenderBot
         reply_html is
       end
 
-    # /inc summary - Summarize recent incidents
-    when /^\s*\/inc\s+summary\s*$/
+    # /prefix summary - Summarize recent incidents
+    when /^\/#{prefix}\s+summary$/
       refresh_incidents
 
       statuses = Hash.new { |h,k| h[k] = 0 }
@@ -222,8 +223,8 @@ class BenderBot
       end
 
 
-    # /inc NUM - Show incident details
-    when /^\s*\/inc\s+(\d+)\s*$/
+    # /prefix NUM - Show incident details
+    when /^\/#{prefix}\s+(\d+)$/
       incident = select_incident $1
 
       if incident.nil?
@@ -247,8 +248,8 @@ class BenderBot
         ]
       end
 
-    # /inc resolve NUM - Resolve an incident
-    when /^\s*\/inc\s+resolve\s+(\d+)\s*$/
+    # /prefix resolve NUM - Resolve an incident
+    when /^\/#{prefix}\s+resolve\s+(\d+)$/
       unless allowed?
         reply_html "You're not allowed to do that!", :red
       else
@@ -260,8 +261,8 @@ class BenderBot
         end
       end
 
-    # /inc close NUM - Close an incident
-    when /^\s*\/inc\s+close\s+(\d+)\s*$/
+    # /prefix close NUM - Close an incident
+    when /^\/#{prefix}\s+close\s+(\d+)$/
       unless allowed?
         reply_html "You're not allowed to do that!", :red
       else
@@ -273,8 +274,8 @@ class BenderBot
         end
       end
 
-    # /inc open SEVERITY SUMMARY - File a new incident
-    when /^\s*\/inc\s+open\s+(severity|sev|s|p)?(\d+)\s+(.*)/im
+    # /prefix open SEVERITY SUMMARY - File a new incident
+    when /^\/#{prefix}\s+open\s+(severity|sev|s|p)?(\d+)\s+(.*)/im
       unless allowed?
         reply_html "You're not allowed to do that!", :red
       else
@@ -285,7 +286,7 @@ class BenderBot
             issuetype: { name: config[:jira_type] },
             reporter: { name: user[:nick] },
             summary: $3,
-            SHOW_FIELDS.key('Severity') => {
+            SEVERITY_FIELD => {
               id: SEVERITIES[$2.to_i]
             }
           }
@@ -295,8 +296,8 @@ class BenderBot
       end
 
 
-    # /inc comment [INCIDENT_NUMBER] [COMMENT_TEXT]
-    when /^\s*\/inc\s+comment\s+(\d+)\s+(.*)/im
+    # /prefix comment [INCIDENT_NUMBER] [COMMENT_TEXT]
+    when /^\/#{prefix}\s+comment\s+(\d+)\s+(.*)/im
       incident = select_incident $1
       comment  = $2
       user     = user_where name: sender
@@ -310,7 +311,7 @@ class BenderBot
       end
 
 
-    when /^\s*\/inc/i
+    when /^\/#{prefix}/i
       reply_html 'Invalid usage', :red
       reply_with_help
     end
@@ -498,4 +499,7 @@ private
     user && store['group'].include?(user[:name])
   end
 
+
+  def prefix ; config[:prefix] end
+
 end

data/lib/bender/helpers.rb

@@ -16,10 +16,37 @@ module Helpers
     jira_group: nil,
     jira_type: nil,
     user_refresh: 300,
-    issue_refresh: 5,
+    issue_refresh: 10,
     group_refresh: 60,
     room_base_name: nil,
-    order: false
+    order: false,
+    prefix: 'inc',
+    resolved_transitions: %w[ 51 ],
+    resolved_state: /resolve/i.to_s,
+    closed_transitions: %w[ 61 71 ],
+    closed_state: /close/i.to_s,
+    severities: {
+      1 => '10480',
+      2 => '10481',
+      3 => '10482',
+      4 => '10483',
+      5 => '10484'
+    },
+    show_fields: {
+      summary: 'Summary',
+      description: 'Description',
+      customfield_11250: 'Severity',
+      customfield_11251: 'Impact Started',
+      customfield_11252: 'Impact Ended',
+      customfield_11253: 'Reported By',
+      customfield_11254: 'Services Affected',
+      customfield_11255: 'Cause',
+      status: 'Status',
+      created: 'Created',
+      updated: 'Updated'
+    },
+    severity_field: 'customfield_11250',
+    without_commands: []
   }
 
   QUOTES = [
@@ -114,7 +141,7 @@ module Helpers
 
 
   def short_severity s
-    s.split(' - ', 2).first
+    s && s.include?(' - ') ? s.split(' - ', 2).first : s
   end
 
 

data/lib/bender/main.rb

@@ -41,53 +41,41 @@ module Bender
       raw_config = JSON.parse File.read(options.config), symbolize_names: true
       @config = DEFAULT_CONFIG.merge! raw_config
 
-      BenderBot.const_set :RESOLVED_TRANSITIONS, %w[ 51 ]
+      BenderBot.const_set :RESOLVED_TRANSITIONS, config[:resolved_transitions]
       Bender.const_set :RESOLVED_TRANSITIONS, BenderBot::RESOLVED_TRANSITIONS
       Helpers.const_set :RESOLVED_TRANSITIONS, BenderBot::RESOLVED_TRANSITIONS
 
-      BenderBot.const_set :RESOLVED_STATE, /resolve/i
+      BenderBot.const_set :RESOLVED_STATE, Regexp.new(config[:resolved_state])
       Bender.const_set :RESOLVED_STATE, BenderBot::RESOLVED_STATE
       Helpers.const_set :RESOLVED_STATE, BenderBot::RESOLVED_STATE
 
-      BenderBot.const_set :CLOSED_TRANSITIONS, %w[ 61 71 ]
+      BenderBot.const_set :CLOSED_TRANSITIONS, config[:closed_transitions]
       Bender.const_set :CLOSED_TRANSITIONS, BenderBot::CLOSED_TRANSITIONS
       Helpers.const_set :CLOSED_TRANSITIONS, BenderBot::CLOSED_TRANSITIONS
 
-      BenderBot.const_set :CLOSED_STATE, /close/i
+      BenderBot.const_set :CLOSED_STATE, Regexp.new(config[:closed_state])
       Bender.const_set :CLOSED_STATE, BenderBot::CLOSED_STATE
       Helpers.const_set :CLOSED_STATE, BenderBot::CLOSED_STATE
 
-      BenderBot.const_set :SEVERITIES, {
-        1 => '10480',
-        2 => '10481',
-        3 => '10482',
-        4 => '10483',
-        5 => '10484'
-      }
+      # Integerify keys
+      severities = config[:severities].inject({}) { |h,(k,v)| h[k.to_s.to_i] = v ; h }
+
+      BenderBot.const_set :SEVERITIES, severities
       Bender.const_set :SEVERITIES, BenderBot::SEVERITIES
       Helpers.const_set :SEVERITIES, BenderBot::SEVERITIES
 
-      BenderBot.const_set :SHOW_FIELDS, {
-        'summary' => 'Summary',
-        'description' => 'Description',
-        'customfield_11250' => 'Severity',
-        'customfield_11251' => 'Impact Started',
-        'customfield_11252' => 'Impact Ended',
-        'customfield_11253' => 'Reported By',
-        'customfield_11254' => 'Services Affected',
-        'customfield_11255' => 'Cause',
-        'status' => 'Status',
-        'created' => 'Created',
-        'updated' => 'Updated'
-      }
+      # Stringify keys
+      show_fields = config[:show_fields].inject({}) { |h,(k,v)| h[k.to_s] = v ; h }
+
+      BenderBot.const_set :SHOW_FIELDS, show_fields
       Bender.const_set :SHOW_FIELDS, BenderBot::SHOW_FIELDS
       Helpers.const_set :SHOW_FIELDS, BenderBot::SHOW_FIELDS
 
-      BenderBot.const_set :SEVERITY_FIELD, SHOW_FIELDS.key('Severity')
+      BenderBot.const_set :SEVERITY_FIELD, config[:severity_field]
       Bender.const_set :SEVERITY_FIELD, BenderBot::SEVERITY_FIELD
       Helpers.const_set :SEVERITY_FIELD, BenderBot::SEVERITY_FIELD
 
-      BenderBot.set_commands
+      BenderBot.set_commands config[:without_commands]
 
       bot = start_bot
       ts  = []
@@ -124,8 +112,17 @@ module Bender
 
 
     def set_room_name_and_topic room_id, incidents, hipchat, bot
-      room = hipchat[room_id]
-      new_room = room.get_room
+      begin
+        room = hipchat[room_id]
+        new_room = room.get_room
+      rescue HipChat::UnknownResponseCode
+        log.error \
+          error: 'Cannot get room name and topic',
+          reason: 'HipChat returned an unknown response code',
+          room_id: room_id
+        sleep 10
+        return
+      end
 
       if incidents.nil?
         log.error \

data/test/reports/TEST-TestBender.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="TestBender" tests="1" time="0.000726" failures="1" errors="0" skipped="0" assertions="1" timestamp="2016-02-18T11:16:28-08:00">
+  <testcase name="test_fails" time="2.5335990358144045e-05" assertions="1">
+    <failure type="Minitest::Assertion" message="Failed assertion, no message given.">
+Failed assertion, no message given. (Minitest::Assertion)
+/Users/sclemmer/Projects/bender/test/test_bender.rb:17    </failure>
+  </testcase>
+</testsuite>

data/test/test_bender.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+
+require_relative 'test_helper'
+require_relative '../lib/bender'
+
+Thread.abort_on_exception = true
+
+
+class TestBender < MiniTest::Test
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_fails
+    assert false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+require 'simplecov-cobertura'
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::CoberturaFormatter
+]
+SimpleCov.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bender-bot
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Sean Clemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -153,6 +153,9 @@ files:
 - lib/bender/main.rb
 - lib/bender/metadata.rb
 - lib/bender/mjolnir.rb
+- test/reports/TEST-TestBender.xml
+- test/test_bender.rb
+- test/test_helper.rb
 homepage: https://github.com/sczizzo/bender
 licenses:
 - ISC
@@ -177,4 +180,7 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Yet another HipChat bot
-test_files: []
+test_files:
+- test/reports/TEST-TestBender.xml
+- test/test_bender.rb
+- test/test_helper.rb