sensu-plugins-rocket-chat 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 907a6317875acb87e033e8c46fe88f61ba8de161
+  data.tar.gz: 85b93fbb5d86fbbeea387370b8dbfbe7664e6054
+SHA512:
+  metadata.gz: 8d1eeae7a405e018fab67e1e5f5aed984d2c30c4609e491b3c0ba753e3f80a5ef08c05f6da746452823577bf76319e52460974b794001787e5b96e75c6151c4f
+  data.tar.gz: ff42064a664074cd28709558911c57d0735fd35d41e4bc07fde163c11e9f59733d1567319a63e1a37fe36d2f84517eed114a9f2474d7f0b6f474b83dbe62b947

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows [this format](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md).
+
+## [Unreleased]
+
+## 1.0.1 - 2018-11-20
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hernan Schmidt
+
+MIT License
+
+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,146 @@
+## Sensu-Plugins-RocketChat
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-rocket-chat.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-rocket-chat)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-rocket-chat.svg)](http://badge.fury.io/rb/sensu-plugins-rocket-chat)
+
+## Functionality
+
+This plugin provides a handler to send notifications to a RocketChat chat.
+
+## Files
+ * bin/handler-rocketchat.rb
+
+## Usage
+
+After installation, you have to set up a `pipe` type handler, like so:
+
+```json
+{
+  "handlers": {
+    "rocketchat": {
+      "type": "pipe",
+      "command": "handler-rocketchat.rb",
+      "filter": "occurrences"
+    }
+  }
+}
+```
+
+This gem also expects a JSON configuration file with the following contents:
+
+```json
+{
+  "rocketchat": {
+    "server_url": "SERVER_URL",
+    "username": "YOUR_USERNAME",
+    "password": "YOUR_PASSWORD",
+    "room_id": "ROOM_ID",
+    "error_file_location": "/tmp/rocketchat_handler_error"
+  }
+}
+```
+
+### Parameters:
+- `server_url`: The URL of the RocketChat instance (e.g.
+  `https://chat.yourcompany.com`).
+- `ssl_ca_file` (optional): The path to the certificate file used by the
+  RocketChat server.
+- `ssl_verify_mode` (optional): Value `1` will try to verify the SSL certificate
+  of the RocketChat server (default), while `0` will skip verification (not
+  recommended).
+- `username`: The username of the RocketChat account that will be used to send
+  the messages. You probably want to use a special "bot" account for this.
+- `password`: The password of the RocketChat account that will be used to send
+  the messages.
+- `room_id`: The room to which the error message is to be sent. To send the
+  message to a user, `room_id` should look like `@username`. For a channel,
+  `channel-name`.
+- `error_file_location` (optional): in case there is a failure sending the
+  message to RocketChat (ie. connectivity issues), the exception message will
+  be written to a file in this location. You can then monitor this
+  location to detect any errors with the RocketChat handler.
+- `message_template` (optional): An ERB template in Markdown to use to format
+  messages instead of the default. Supports the following variables:
+  - `action_name`
+  - `action_icon`
+  - `client_name`
+  - `check_name`
+  - `status`
+  - `status_icon`
+  - `output`
+- `message_template_file` (optional): A file to read an ERB template in Markdown
+  from to format messages. Supports the same variables as `message_template`.
+
+
+### Advanced configuration
+
+By default, the handler assumes that the config parameters are specified in the
+`rocketchat` top-level key of the JSON, as shown above. You also have the option
+to make the handler fetch the config from a different key. To do this, pass the
+`-j` option to the handler with the name of the desired key You can define
+multiple handlers, and each handler can send notifications to a different room
+and from a different bot. You could, for example, have critical and non-critical
+RocketChat rooms, and send the notifications to one or the other depending on the
+check. For example:
+
+```json
+{
+  "handlers": {
+    "critical_rocketchat": {
+      "type": "pipe",
+      "command": "handler-rocketchat.rb -j critical_rocketchat_options"
+    },
+    "non_critical_rocketchat": {
+      "type": "pipe",
+      "command": "handler-rocketchat.rb -j non_critical_rocketchat_options"
+    }
+  }
+}
+```
+
+This example will fetch the options from a JSON like this:
+
+```json
+{
+  "rocketchat": {
+    "server_url": "SERVER_URL",
+    "username": "YOUR_USERNAME",
+    "password": "YOUR_PASSWORD"
+  },
+  "critical_rocketchat_options": {
+    "room_id": "emergency-alerts"
+  },
+  "non_critical_rocketchat_options": {
+    "room_id": "non-critical-alerts"
+  }
+}
+```
+
+As you can see, you can specify the default config in the `rocketchat` key, and
+the rest of the config in their own custom keys.
+
+You can also directly add the configuration parameters to the event data using a
+mutator. For example:
+
+```ruby
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'json'
+event = JSON.parse(STDIN.read, symbolize_names: true)
+event.merge!(room_id: 'emergency-alerts')
+puts JSON.dump(event)
+```
+
+### Configuration precedence
+
+The handler will load the config as follows (from least to most priority):
+
+* Default `rocketchat` key
+* Custom config keys
+* Event data
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

data/bin/handler-rocketchat.rb

@@ -0,0 +1,219 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+#   handler-rocketchat
+#
+# DESCRIPTION:
+#   This handler sends messages to a given RocketChat room (user or channel).
+#
+# OUTPUT:
+#   Plain text
+#
+# PLATFORMS:
+#   Linux, BSD, Windows, OS X
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rocketchat
+#
+# USAGE:
+#   This gem requires a JSON configuration file with the following contents:
+#     {
+#       "rocketchat": {
+#         "server_url": "SERVER_URL"
+#         "username": "YOUR_USERNAME",
+#         "password": "YOUR_PASSWORD",
+#         "room_id": "ROOM_ID",
+#         "error_file_location": "/tmp/rocketchat_handler_error"
+#       }
+#     }
+#   For more details, please see the README.
+#
+# NOTES:
+#
+# LICENSE:
+#
+#   Copyright 2018 Hernan Schmidt <hschmidt@suse.de>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+
+require 'sensu-handler'
+require 'rocketchat'
+require 'cgi'
+require 'erb'
+
+class RocketChatHandler < Sensu::Handler
+  option :json_config,
+         description: 'Config name',
+         short: '-j config_key',
+         long: '--json_config config_key',
+         required: false
+
+  def handle
+    print 'Sending to RocketChat: ' + params.inspect
+
+    rocket_server = RocketChat::Server.new(server_url, server_settings)
+    session = rocket_server.login(username, password)
+    session.chat.post_message(room_id: room_id,
+                              text: build_message)
+    session.logout
+
+    puts '... done.'
+    clear_error
+  rescue StandardError => e
+    handle_error(e)
+    puts "... RocketChat handler error '#{e.inspect}' while attempting to report an incident: #{event_name} #{action_name}"
+  end
+
+  def room_id
+    fetch_setting 'room_id'
+  end
+
+  def username
+    fetch_setting 'username'
+  end
+
+  def password
+    fetch_setting 'password'
+  end
+
+  def error_file
+    fetch_setting 'error_file_location'
+  end
+
+  def server_url
+    fetch_setting 'server_url'
+  end
+
+  def ssl_ca_file
+    fetch_setting('ssl_ca_file')
+  end
+
+  def ssl_verify_mode
+    fetch_setting('ssl_verify_mode')
+  end
+
+  def server_settings
+    settings = {}
+    settings[:ssl_ca_file] = ssl_ca_file if ssl_ca_file
+    settings[:ssl_verify_mode] = ssl_verify_mode if ssl_verify_mode
+    settings
+  end
+
+  def fetch_setting(setting_key)
+    config_key = config[:json_config]
+
+    value = @event[setting_key]
+    value ||= settings[config_key][setting_key] if config_key
+    value || settings['rocketchat'][setting_key]
+  end
+
+  def event_name
+    client_name + '/' + check_name
+  end
+
+  def action_name
+    actions = {
+      'create' => 'Created',
+      'resolve' => 'Resolved',
+      'flapping' => 'Flapping'
+    }
+    actions[@event['action']]
+  end
+
+  def action_icon
+    icons = {
+      'create' => "\xF0\x9F\x98\xB1",
+      'resolve' => "\xF0\x9F\x98\x8D",
+      'flapping' => "\xF0\x9F\x90\x9D"
+    }
+    icons[@event['action']]
+  end
+
+  def client_name
+    escape_html @event['client']['name']
+  end
+
+  def check_name
+    escape_html @event['check']['name']
+  end
+
+  def output
+    escape_html @event['check']['output']
+  end
+
+  def escape_html(string)
+    CGI.escapeHTML(string)
+  end
+
+  def build_message
+    template_file = fetch_setting 'message_template_file'
+    if !template_file.nil?
+      template = File.read(template_file)
+    else
+      template = fetch_setting 'message_template'
+      template ||= default_message
+    end
+
+    message = ERB.new(template).result(binding)
+
+    message
+  end
+
+  def default_message
+    [
+      '**Alert <%= action_name %>** <%= action_icon %>',
+      '**Host:** <%= client_name %>',
+      '**Check:** <%= check_name %>',
+      '**Status:** <%= status %> <%= status_icon %>',
+      '**Output:** `<%= output %>`'
+    ].join("\n")
+  end
+
+  def params
+    {
+      server_url: server_url,
+      server_settings: server_settings,
+      room_id: room_id,
+      text: build_message
+    }
+  end
+
+  def handle_error(exception)
+    return unless error_file
+
+    File.open(error_file, 'w') do |f|
+      f.puts 'Params: ' + params.inspect
+      f.puts 'Exception: ' + exception.inspect
+    end
+  end
+
+  def clear_error
+    File.delete(error_file) if error_file && File.exist?(error_file)
+  end
+
+  def check_status
+    @event['check']['status']
+  end
+
+  def status
+    status = {
+      0 => 'OK',
+      1 => 'Warning',
+      2 => 'Critical',
+      3 => 'Unknown'
+    }
+    status[check_status.to_i]
+  end
+
+  def status_icon
+    icons = {
+      0 => "\xF0\x9F\x91\x8D",
+      1 => "\xE2\x9A\xA1",
+      2 => "\xF0\x9F\x9A\xA8",
+      3 => "\xF0\x9F\x8C\x80"
+    }
+    icons[check_status.to_i]
+  end
+end

data/lib/sensu-plugins-rocketchat.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-rocketchat/version'

data/lib/sensu-plugins-rocketchat/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsRocketChat
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-rocket-chat
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Hernan Schmidt
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rocketchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Sensu plugin for interfacing with RocketChat
+email:
+- hschmidt@suse.de
+- sensu-users@googlegroups.com
+executables:
+- handler-rocketchat.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/handler-rocketchat.rb
+- lib/sensu-plugins-rocketchat.rb
+- lib/sensu-plugins-rocketchat/version.rb
+homepage: https://github.com/lagartoflojo/sensu-plugins-rocket-chat
+licenses:
+- MIT
+metadata:
+  maintainer: lagartoflojo
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Sensu handler for RocketChat
+test_files: []