sensu-plugins-mailer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06c5e384471722d7c338d98fcde9c61f3255f0c
-  data.tar.gz: 5ddf68c6d934fa6a65efa8ceebe1967cb4f30816
+  metadata.gz: 914ffd464cbc0cca8d351da9a48c9d09fb81e061
+  data.tar.gz: 93f37933624d9923666492a9084c9a3f270d9868
 SHA512:
-  metadata.gz: e208de9a67fb9c5239c92a60e8d1148365b7317da845615e9ddbb8d2904adbd609fb014a1cf9af092862a94ec8777ef8a64f13aae6c5fb6545a519555319bb7d
-  data.tar.gz: 1b4fa18f200b0d072d8dbb7b3a0acbc5706fb7fc51af93e4612ee53a12b8ccac14de4ecaf2e861c01f1b81fe322a808e7bc585e1e0cc67486a7f7cd2ed1ffc70
+  metadata.gz: 3e03b487e6b264cab942d39b78b989908430ab3ff724b1cee7a6925cb43fe55ec8eb93896e14278c8e7e3a3dea21de26ec1c0bafaee1bec4e1c56a2115d464df
+  data.tar.gz: 32021357210d7be11fee1348f7fba666119379535595dd4b9eca90d3b7267428e9b6c1c06adba1ae9e59d1677f3d18e6d200374a5418b7642a0116ca044cfc19

data/CHANGELOG.md

@@ -4,11 +4,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+## [1.1.0] - 2017-06-01
+### Fixed
+- handler-mailer.rb - revert the commit which makes email go to wrong addresses
+- handler-mailer.rb - change `json_config` to `json_config_name` for clarity
+  and add documentation
 
 ## [1.0.0] - 2016-06-23
 ### Fixed
-- fixing timeout deprecation for ruby 2.3.0
-- handler-mailer-mailgun.rb/handler-mailer-ses.rb: fixing undefined local variable or method params error
+- fix timeout deprecation for ruby 2.3.0
+- handler-mailer-mailgun.rb/handler-mailer-ses.rb: fix undefined local variable or method params error
 
 ### Removed
 - Support for Ruby 1.9.3; Added support for Ruby 2.3.0
@@ -79,7 +84,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.3.1...1.0.0
 [0.3.1]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.3.0...0.3.1
 [0.3.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.2.0...0.3.0
@@ -91,4 +97,3 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 [0.1.1]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.0.2...0.1.0
 [0.0.2]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/0.0.1...0.0.2
-

data/README.md

@@ -83,9 +83,35 @@ client config called "template", the mailer handler config, default.
   }
 }
 ```
+By default, the handler will use `plain` as the SMTP authentication type, but you may also specify `"smtp_authentication": "ntlm"` for compatible servers, e.g. Microsoft Exchange.
 
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
+Create a handler file in `/etc/sensu/conf.d` with the following content, replacing with your own configuration:
+
+```json
+{
+    "mailer" :  {
+        "admin_gui" : "http://localhost:3000",
+        "mail_from": "from@email.com",
+        "mail_to": "to@email.com",
+        "delivery_method": "smtp",
+        "smtp_address": "localhost",
+        "smtp_port": "25",
+        "smtp_domain": "localhost.local_domain",
+        "smtp_enable_starttls_auto": "true",
+        "smtp_username" : "username",
+        "smtp_password" : "XXXXXXXX"
+    },
+    "handlers": {
+        "mailer": {
+            "type": "pipe",
+            "command": "/opt/sensu/embedded/bin/handler-mailer.rb"
+        }
+    }
+}
+```
+
 ## Notes

data/bin/handler-mailer-mailgun.rb

@@ -33,6 +33,17 @@ require 'mailgun'
 require 'timeout'
 
 class Mailer < Sensu::Handler
+  option :json_config,
+         description: 'Config Name',
+         short: '-j JsonConfig',
+         long: '--json_config JsonConfig',
+         required: false,
+         default: 'mailer-mailgun'
+
+  def json_config
+    @json_config ||= config[:json_config]
+  end
+
   def short_name
     @event['client']['name'] + '/' + @event['check']['name']
   end
@@ -43,11 +54,11 @@ class Mailer < Sensu::Handler
 
   def handle
     params = {
-      mail_to: settings['mailer-mailgun']['mail_to'],
-      mail_from: settings['mailer-mailgun']['mail_from'],
-      mg_apikey: settings['mailer-mailgun']['mg_apikey'],
-      mg_domain: settings['mailer-mailgun']['mg_domain'],
-      subject_prefix: settings['mailer-mailgun']['subject_prefix']
+      mail_to: settings[json_config]['mail_to'],
+      mail_from: settings[json_config]['mail_from'],
+      mg_apikey: settings[json_config]['mg_apikey'],
+      mg_domain: settings[json_config]['mg_domain'],
+      subject_prefix: settings[json_config]['subject_prefix']
     }
 
     body = <<-BODY.gsub(/^ {14}/, '')

data/bin/handler-mailer-ses.rb

@@ -16,6 +16,17 @@ require 'aws/ses'
 require 'timeout'
 
 class Mailer < Sensu::Handler
+  option :json_config,
+         description: 'Config Name',
+         short: '-j JsonConfig',
+         long: '--json_config JsonConfig',
+         required: false,
+         default: 'mailer-ses'
+
+  def json_config
+    @json_config ||= config[:json_config]
+  end
+
   def short_name
     @event['client']['name'] + '/' + @event['check']['name']
   end
@@ -26,12 +37,12 @@ class Mailer < Sensu::Handler
 
   def handle
     params = {
-      mail_to: settings['mailer-ses']['mail_to'],
-      mail_from: settings['mailer-ses']['mail_from'],
-      aws_access_key: settings['mailer-ses']['aws_access_key'],
-      aws_secret_key: settings['mailer-ses']['aws_secret_key'],
-      aws_ses_endpoint: settings['mailer-ses']['aws_ses_endpoint'],
-      subject_prefix: settings['mailer-ses']['subject_prefix']
+      mail_to: settings[json_config]['mail_to'],
+      mail_from: settings[json_config]['mail_from'],
+      aws_access_key: settings[json_config]['aws_access_key'],
+      aws_secret_key: settings[json_config]['aws_secret_key'],
+      aws_ses_endpoint: settings[json_config]['aws_ses_endpoint'],
+      subject_prefix: settings[json_config]['subject_prefix']
     }
 
     body = <<-BODY.gsub(/^ {14}/, '')

data/bin/handler-mailer.rb

@@ -10,7 +10,7 @@
 # for details.
 
 # Note: The default mailer config is fetched from the predefined json config file which is "mailer.json" or any other
-#       file defiend using the "json_config" command line option. The mailing list could also be configured on a per client basis
+#       file defined using the "json_config" command line option. The mailing list could also be configured on a per client basis
 #       by defining the "mail_to" attribute in the client config file. This will override the default mailing list where the
 #       alerts are being routed to for that particular client.
 
@@ -18,6 +18,8 @@ require 'sensu-handler'
 require 'mail'
 require 'timeout'
 require 'erubis'
+require 'set'
+require 'ntlm/smtp'
 
 # patch to fix Exim delivery_method: https://github.com/mikel/mail/pull/546
 # #YELLOW
@@ -33,8 +35,8 @@ module ::Mail # rubocop:disable Style/ClassAndModuleChildren
 end
 
 class Mailer < Sensu::Handler
-  option :json_config,
-         description: 'Config Name',
+  option :json_config_name,
+         description: 'Name of the JSON Configuration block in Sensu',
          short: '-j JsonConfig',
          long: '--json_config JsonConfig',
          required: false,
@@ -58,6 +60,32 @@ class Mailer < Sensu::Handler
          long: '--subject_prefix prefix',
          required: false
 
+  # JSON configuration settings typically defined in the handler
+  # file for mailer. JSON Config Name defaultly looks for a block
+  # named 'mailer', as seen in the Installation step of the README
+  #
+  # @example
+  #
+  # ```json
+  # {
+  #   "admin_gui":                 "http://localhost:3000",
+  #   "mail_from":                 "from@email.com",
+  #   "mail_to":                   "to@email.com",
+  #   "delivery_method":           "smtp",
+  #   "smtp_address":              "localhost",
+  #   "smtp_port":                 "25",
+  #   "smtp_domain":               "localhost.local_domain",
+  #   "smtp_enable_starttls_auto": "true",
+  #   "smtp_username":             "username",
+  #   "smtp_password":             "XXXXXXXX"
+  # }
+  # ```
+  #
+  # @return [Hash]
+  def json_config_settings
+    settings[config[:json_config_name]]
+  end
+
   def short_name
     @event['client']['name'] + '/' + @event['check']['name']
   end
@@ -69,8 +97,8 @@ class Mailer < Sensu::Handler
   def prefix_subject
     if config[:subject_prefix]
       config[:subject_prefix] + ' '
-    elsif settings[config[:json_config]]['subject_prefix']
-      settings[config[:json_config]]['subject_prefix'] + ' '
+    elsif json_config_settings['subject_prefix']
+      json_config_settings['subject_prefix'] + ' '
     else
       ''
     end
@@ -94,13 +122,13 @@ class Mailer < Sensu::Handler
             config[:content_type]
           elsif @event['check']['content_type']
             @event['check']['content_type']
-          elsif settings[config[:json_config]]['content_type']
-            settings[config[:json_config]]['content_type']
+          elsif json_config_settings['content_type']
+            json_config_settings['content_type']
           else
             'plain'
           end
 
-    if use.casecmp('html') == 0
+    if use.casecmp('html').zero?
       'text/html; charset=UTF-8'
     else
       'text/plain; charset=ISO-8859-1'
@@ -108,37 +136,27 @@ class Mailer < Sensu::Handler
   end
 
   def build_mail_to_list
-    json_config = config[:json_config]
-    mail_to = @event['client']['mail_to'] || settings[json_config]['mail_to']
-    if settings[json_config].key?('subscriptions')
-      if @event['check']['subscribers']
-        @event['check']['subscribers'].each do |sub|
-          if settings[json_config]['subscriptions'].key?(sub)
-            mail_to << ", #{settings[json_config]['subscriptions'][sub]['mail_to']}"
-          end
-        end
-      end
-      if @event['client']['subscriptions']
-        @event['client']['subscriptions'].each do |sub|
-          if settings[json_config]['subscriptions'].key?(sub)
-            mail_to << ", #{settings[json_config]['subscriptions'][sub]['mail_to']}"
-          end
+    mail_to = Set.new
+    mail_to.add(@event['client']['mail_to'] || json_config_settings['mail_to'])
+    if json_config_settings.key?('subscriptions') && @event['check']['subscribers']
+      @event['check']['subscribers'].each do |sub|
+        if json_config_settings['subscriptions'].key?(sub)
+          mail_to.add(json_config_settings['subscriptions'][sub]['mail_to'].to_s)
         end
       end
     end
-    mail_to
+    mail_to.to_a.join(', ')
   end
 
   def message_template
     return config[:template] if config[:template]
     return @event['check']['template'] if @event['check']['template']
-    return settings[config[:json_config]]['template'] if settings[config[:json_config]]['template']
+    return json_config_settings['template'] if json_config_settings['template']
     nil
   end
 
   def build_body
-    json_config = config[:json_config]
-    admin_gui = settings[json_config]['admin_gui'] || 'http://localhost:8080/'
+    admin_gui = json_config_settings['admin_gui'] || 'http://localhost:8080/'
     # try to redact passwords from output and command
     output = (@event['check']['output']).to_s.gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
     command = (@event['check']['command']).to_s.gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
@@ -165,25 +183,24 @@ class Mailer < Sensu::Handler
   end
 
   def handle
-    json_config = config[:json_config]
     body = build_body
     content_type = parse_content_type
     mail_to = build_mail_to_list
-    mail_from = settings[json_config]['mail_from']
-    reply_to = settings[json_config]['reply_to'] || mail_from
+    mail_from = json_config_settings['mail_from']
+    reply_to = json_config_settings['reply_to'] || mail_from
 
-    delivery_method = settings[json_config]['delivery_method'] || 'smtp'
-    smtp_address = settings[json_config]['smtp_address'] || 'localhost'
-    smtp_port = settings[json_config]['smtp_port'] || '25'
-    smtp_domain = settings[json_config]['smtp_domain'] || 'localhost.localdomain'
+    delivery_method = json_config_settings['delivery_method'] || 'smtp'
+    smtp_address = json_config_settings['smtp_address'] || 'localhost'
+    smtp_port = json_config_settings['smtp_port'] || '25'
+    smtp_domain = json_config_settings['smtp_domain'] || 'localhost.localdomain'
 
-    smtp_username = settings[json_config]['smtp_username'] || nil
-    smtp_password = settings[json_config]['smtp_password'] || nil
-    smtp_authentication = settings[json_config]['smtp_authentication'] || :plain
-    smtp_use_tls = settings[json_config]['smtp_use_tls'] || nil
-    smtp_enable_starttls_auto = settings[json_config]['smtp_enable_starttls_auto'] == 'false' ? false : true
+    smtp_username = json_config_settings['smtp_username'] || nil
+    smtp_password = json_config_settings['smtp_password'] || nil
+    smtp_authentication = json_config_settings['smtp_authentication'] || :plain
+    smtp_use_tls = json_config_settings['smtp_use_tls'] || nil
+    smtp_enable_starttls_auto = json_config_settings['smtp_enable_starttls_auto'] == 'false' ? false : true
 
-    timeout_interval = settings[json_config]['timeout'] || 10
+    timeout_interval = json_config_settings['timeout'] || 10
 
     headers = {
       'X-Sensu-Host'        => (@event['client']['name']).to_s,

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

@@ -1,7 +1,7 @@
 module SensuPluginsMailer
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-mailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-ses
@@ -80,6 +80,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: ruby-ntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Sensu mailer plugins
+description: Provides mail output for Sensu
 email: "<sensu-users@googlegroups.com>"
 executables:
 - handler-mailer-mailgun.rb
@@ -249,9 +263,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for mailer
 test_files: []
-has_rdoc: