lita-nagios 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede4f56d168a547caf8b99d56291d290d0cbe62e
-  data.tar.gz: 9d0cb06ea65d68ed1717cd9ca49e2314ad5ffec1
+  metadata.gz: 47c44656f16b7da317f21677ea42f7b8e60c77d6
+  data.tar.gz: 4a39170f725faf85d8cd3400c8f5a2c7dd55ee3d
 SHA512:
-  metadata.gz: efd57d34c435a25b6309d10d1330e7b6e4fd3f2f34a84ff044550f18df0d110a1f03c1736bc2543a90a015ea973b6c8012fcf5bff3d478758d178105ab7a81eb
-  data.tar.gz: bc329db209e663fb2cd243e1b5740aeb8c0f10df94a3abc0505c118d61c73c1d6ced4ca61496334746967dc4481fb9a4b61f81b06231641fc26f4bf9900546b9
+  metadata.gz: 9bcb83b3f12db66c0902748793df671583c16f7802e608ab145d4425fde3c2615210f29adb139c57714b42f46b407b85400c902117049d676d13957205b50773
+  data.tar.gz: a039c8f62ddd61175db75d81380f0ccbf73434a2ec336214c6ae0438bea52d971fba6484eba07a92d9a2bcc0f69224f45cc8b1d6f872f5bce99d8a1d16c605d4

data/README.md

@@ -1,6 +1,12 @@
 # lita-nagios
 
-TODO: Add a description of the plugin.
+[![Build Status](https://travis-ci.org/josqu4red/lita-nagios.png?branch=master)](https://travis-ci.org/josqu4red/lita-nagios)
+[![Coverage Status](https://coveralls.io/repos/josqu4red/lita-nagios/badge.png)](https://coveralls.io/r/josqu4red/lita-nagios)
+
+**lita-nagios** is a handler for [Lita](https://github.com/jimmycuadra/lita) that allows interaction with Nagios monitoring solution.
+It listens for notifications on a HTTP endpoint and uses [nagiosharder](https://github.com/railsmachine/nagiosharder) to send commands to the Nagios instance.
+
+Note: Colors in notifications are not enabled yet, because it relies completely on the adapter and no abstraction layer is implemented nor designed as of now.
 
 ## Installation
 
@@ -12,11 +18,60 @@ gem "lita-nagios"
 
 ## Configuration
 
-TODO: Describe any configuration attributes the plugin exposes.
+### HTTP interface
+* `default_room` (String) - Default chat room for notifications
+
+### Nagios commands (`nagiosharder` config)
+* `cgi` - Nagios CGI URL
+* `user` - Nagios user with system commands authorization
+* `pass` - User password
+* `version` - Nagios version, default: 3
+* `time_format` - default: "iso8601"
+* `verify_ssl` - default: `true`
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.nagios.default_room = "#admin_room"
+  config.handlers.nagios.cgi = "http://nagios.example.com/cgi-bin/nagios3"
+  config.handlers.nagios.user = "lita"
+  config.handlers.nagios.pass = "xxxx"
+  config.handlers.nagios.version = 3
+  config.handlers.nagios.time_format = "iso8601"
+  config.handlers.nagios.verify_ssl = true
+end
+```
 
 ## Usage
 
-TODO: Describe the plugin's features and how to use them.
+### Display notifications in channel
+
+lita-nagios provides a HTTP endpoint to receive Nagios notifications:
+
+```
+POST /nagios/notifications
+```
+Request parameters must include those fields:
+* `type` - `host` or `service`
+* `room` - notifications destination (see `default_room` in configuration section)
+* `host` - Nagios' $HOSTNAME$ or $HOSTALIAS$
+* `output` - Nagios' $HOSTOUTPUT$ or $SERVICEOUTPUT$
+* `state` - Nagios' $HOSTSTATE$ or $SERVICESTATE$
+* `notificationtype` - Nagios' $NOTIFICATIONTYPE$
+* `description` - Nagios' $SERVICEDESC$ (only for `service` type)
+
+An example Nagios configuration (contact, commands) to send alerts to channels is provided in [contrib](contrib/nagios_config.txt) folder
+
+### Send commands to Nagios
+
+```
+lita: nagios enable notif(ication(s)) <-h | --host HOST> [-s | --service SERVICE] - Enable notifications for given host/service
+lita: nagios disable notif(ication(s)) <-h | --host HOST> [-s | --service SERVICE] - Disable notifications for given host/service
+lita: nagios recheck <-h | --host HOST> [-s | --service SERVICE] - Reschedule check for given host/service
+lita: nagios ack(nowledge) <-h | --host HOST> [-s | --service SERVICE] [-m | --message MESSAGE] - Acknowledge host/service problem with optional message
+lita: nagios (fixed|flexible) downtime <-d | --duration DURATION > <-h | --host HOST> [-s | --service SERVICE] - Schedule downtime for a host/service with duration units in (m, h, d, default to seconds)
+```
 
 ## License
 

data/contrib/nagios_config.txt

@@ -30,5 +30,5 @@ define contact{
   host_notification_options     d,r
   service_notification_commands notify-service-by-bot
   host_notification_commands    notify-host-by-bot
-  address1                      http://lita.example.com:8080/nagios
+  address1                      http://lita.example.com/nagios/notifications
 }

data/lib/lita-nagios.rb

@@ -1 +1,4 @@
+require "lita"
+require "nagiosharder"
+require "lita-keyword-arguments"
 require "lita/handlers/nagios"

data/lib/lita/handlers/nagios.rb

@@ -1,14 +1,160 @@
-require "lita"
-
 module Lita
   module Handlers
     class Nagios < Handler
 
       def self.default_config(config)
         config.default_room = nil
+        config.cgi = nil
+        config.user = nil
+        config.pass = nil
+        config.version = 3
+        config.time_format = "iso8601"
+        config.verify_ssl = true
+      end
+
+      def initialize(robot)
+        @site = NagiosHarder::Site.new(
+          config.cgi,
+          config.user,
+          config.pass,
+          config.version,
+          config.time_format,
+          config.verify_ssl
+        )
+        super(robot)
+      end
+
+      ##
+      # Chat routes
+      ##
+
+      route /^nagios\s+(?<action>enable|disable)\s+notif(ication(s)?)?/, :toggle_notifications,
+        command: true,
+        restrict_to: ["admins"],
+        kwargs: {
+          host: { short: "h" },
+          service: { short: "s" }
+        },
+        help: {
+          "nagios enable notif(ication(s)) <-h | --host HOST> [-s | --service SERVICE]" => "Enable notifications for given host/service",
+          "nagios disable notif(ication(s)) <-h | --host HOST> [-s | --service SERVICE]" => "Disable notifications for given host/service",
+        }
+
+      def toggle_notifications(response)
+        args = response.extensions[:kwargs]
+        return response.reply("Missing 'host' argument") unless args[:host]
+
+        action = response.match_data[:action]
+
+        reply = @site.send("#{action}_service_notifications", args[:host], args[:service])
+        response.reply(reply)
       end
 
-      http.post "/nagios", :receive
+      route /^nagios\s+recheck/, :recheck,
+        command: true,
+        restrict_to: ["admins"],
+        kwargs: {
+          host: { short: "h" },
+          service: { short: "s" }
+        },
+        help: {
+          "nagios recheck <-h | --host HOST> [-s | --service SERVICE]" => "Reschedule check for given host/service"
+        }
+
+      def recheck(response)
+        args = response.extensions[:kwargs]
+        return response.reply("Missing 'host' argument") unless args[:host]
+
+        if args[:service]
+          method_w_params = [ :schedule_service_check, args[:host], args[:service] ]
+          reply = "#{args[:service]} on #{args[:host]}"
+        else
+          method_w_params = [ :schedule_host_check, args[:host] ]
+          reply = args[:host]
+        end
+
+        reply = @site.send(*method_w_params) ? "Check scheduled for #{reply}" : "Failed to schedule check for #{reply}"
+        response.reply(reply)
+      end
+
+      route /^nagios\s+ack(nowledge)?/, :acknowledge,
+        command: true,
+        restrict_to: ["admins"],
+        kwargs: {
+          host: { short: "h" },
+          service: { short: "s" },
+          message: { short: "m" }
+        },
+        help: {
+          "nagios ack(nowledge) <-h | --host HOST> [-s | --service SERVICE] [-m | --message MESSAGE]" => "Acknowledge host/service problem with optional message",
+        }
+
+      def acknowledge(response)
+        args = response.extensions[:kwargs]
+        return response.reply("Missing 'host' argument") unless args[:host]
+
+        user = response.message.source.user.name
+        message =  args[:message] ? "#{args[:message]} (#{user})" : "acked by #{user}"
+
+        if args[:service]
+          method_w_params = [ :acknowledge_service, args[:host], args[:service], message ]
+          reply = "#{args[:service]} on #{args[:host]}"
+        else
+          method_w_params = [ :acknowledge_host, args[:host], message ]
+          reply = args[:host]
+        end
+
+        reply = @site.send(*method_w_params) ? "Acknowledgment set for #{reply}" : "Failed to acknowledge #{reply}"
+        response.reply(reply)
+      end
+
+      route /^nagios(\s+(?<type>fixed|flexible))?\s+downtime/, :schedule_downtime,
+        command: true,
+        restrict_to: ["admins"],
+        kwargs: {
+          host: { short: "h" },
+          service: { short: "s" },
+          duration: { short: "d" }
+        },
+        help: {
+          "nagios (fixed|flexible) downtime <-d | --duration DURATION > <-h | --host HOST> [-s | --service SERVICE]" => "Schedule downtime for a host/service with duration units in (m, h, d, default to seconds)"
+        }
+
+      def schedule_downtime(response)
+        args = response.extensions[:kwargs]
+        return response.reply("Missing 'host' argument") unless args[:host]
+
+        units = { "m" => :minutes, "h" => :hours, "d" => :days }
+        match = /^(?<value>\d+)(?<unit>[#{units.keys.join}])?$/.match(args[:duration])
+        return response.reply("Invalid downtime duration") unless (match and match[:value])
+
+        duration = match[:unit] ? match[:value].to_i.send(units[match[:unit]]) : match[:value].to_i
+
+        options = case response.match_data[:type]
+        when "fixed"
+          { type: :fixed, start_time: Time.now, end_time: Time.now + duration }
+        when "flexible"
+          { type: :flexible, hours: (duration / 3600), minutes: (duration % 3600 / 60) }
+        end.merge({ author: "#{response.message.source.user.name} via Lita" })
+
+        if args[:service]
+          method_w_params = [ :schedule_service_downtime, args[:host], args[:service], options ]
+          reply = "#{args[:service]} on #{args[:host]}"
+        else
+          method_w_params = [ :schedule_host_downtime, args[:host], options ]
+          reply = args[:host]
+        end
+
+        reply = @site.send(*method_w_params) ? "#{options[:type].capitalize} downtime set for #{reply}" : "Failed to schedule downtime for #{reply}"
+        response.reply(reply)
+      end
+
+
+      ##
+      # HTTP endpoints
+      ##
+
+      http.post "/nagios/notifications", :receive
 
       def receive(request, response)
         if request.params.has_key?("type")
@@ -22,18 +168,16 @@ module Lita
 
         if request.params.has_key?("room")
           room = request.params["room"]
-        elsif Lita.config.handlers.nagios.default_room
-          room = Lita.config.handlers.nagios.default_room
+        elsif config.default_room
+          room = config.default_room
         else
           raise "Room must be defined. Either fix your command or specify a default room ('config.handlers.nagios.default_room')"
         end
 
         message = send(notif_type, request.params)
 
-        ack = request.params["notificationtype"] == "ACKNOWLEDGEMENT" ? "[ACK] " : ""
-
         target = Source.new(room: room)
-        robot.send_message(target, "nagios: #{ack}#{message}")
+        robot.send_message(target, "nagios: #{message}")
       rescue Exception => e
         Lita.logger.error(e)
       end

data/lita-nagios.gemspec

@@ -1,21 +1,26 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-nagios"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Jonathan Amiez"]
   spec.email         = ["jonathan.amiez@gmail.com"]
   spec.description   = "Nagios interaction with Lita"
   spec.summary       = "Receive notification and send ACK/recheck, etc. to Nagios"
   spec.homepage      = "https://github.com/josqu4red/lita-nagios"
   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.0"
+  spec.add_runtime_dependency "lita", ">= 3.2"
+  spec.add_runtime_dependency "lita-keyword-arguments"
+  spec.add_runtime_dependency "nagiosharder", ">= 0.5.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: lita-nagios
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonathan Amiez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: lita-keyword-arguments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nagiosharder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !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: Nagios interaction with Lita
 email:
 - jonathan.amiez@gmail.com
@@ -87,7 +143,8 @@ files:
 homepage: https://github.com/josqu4red/lita-nagios
 licenses:
 - MIT
-metadata: {}
+metadata:
+  lita_plugin_type: handler
 post_install_message: 
 rdoc_options: []
 require_paths: