sensu-plugins-mailer 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8ad181e78c5e2610cd7e1c71df58c691abfd61a79d6a5a0d204be3c9f2678ef3
-  data.tar.gz: d553fba10bcb51805773fbc93a0403b4b020cf39850b35265886d13e2bf44c4f
+SHA1:
+  metadata.gz: d530c35c2b3418da88c519c84bc2e1004b950408
+  data.tar.gz: 81e19d4ca9159681bd0795ee179a5c0a083bcb62
 SHA512:
-  metadata.gz: 57cf094ec41772b4299865f4ecc5bcf15b9d5ba9a57820511c559516b92b89a975fe03a8b635651a0b1e738f17d87d1e38e7e821d8e0e2ff30baf4bdad3d0fee
-  data.tar.gz: 14a247af62a6d06a6dcfd3e2d9c217246b1315cbe99fdd373903f30e9c1c2105d0760f42b2d7f3c8e5476592f548e7239598376f07a22eb08557d84ce5f1e14e
+  metadata.gz: 5367e78f2db13246bf4f0b50d2cac2dd77d538f91d5f891b8fa351963f06684c049692e62cb344bc971ccc7d073a5cf99346c8aaf9a7dd84d683db41fb06ca13
+  data.tar.gz: 0f53a2cc839508e4601444f025655de9e22b28ea168fcbff13ea86f0788075b4e7226d02085249ebb09d1d8cce81223fe42227826b489b3d9a0edf240a673c47

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [2.1.0] - 2018-11-01
+### Added
+- handler-mailer.rb: add subject_template feature. With this option to can change the default subject with a template.
+
 ## [2.0.1] - 2018-01-31
 ### Fixed
 - handler-mailer.rb: emit an `unknown` with a helpful message when receiving an event `@event['contact']` with multiple objects in an array. This helps avoid confusion over using `contact` when you meant `contacts`. (@majormoses)
@@ -106,6 +110,7 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 - initial release
 
 [Unreleased]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/2.0.1...HEAD
+[2.1.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/1.2.0...2.0.0
 [1.2.0]: https://github.com/sensu-plugins/sensu-plugins-mailer/compare/1.1.0...1.2.0

data/README.md

@@ -27,6 +27,10 @@ Optionally, you can specify your own ERB template file to use for the message
 body.  The order of precedence for templates is: command-line argument (-t),
 client config called "template", the mailer handler config, default.
 
+Optionally, you can specify your own ERB template file to use for the message
+subject.  The order of precedence for templates is: command-line argument (-T),
+client config called "subject_template", the mailer handler config, default.
+
 ```json
 {
   "mailer": {
@@ -36,6 +40,7 @@ client config called "template", the mailer handler config, default.
     "smtp_port": "25",
     "smtp_domain": "example.org",
     "template": "/optional/path/to/template.erb",
+    "subject_template": "/optional/path/to/subject_template.erb",
     "subscriptions": {
       "subscription_name": {
         "mail_to": "teamemail@example.com"

data/bin/handler-mailer.rb

@@ -48,6 +48,12 @@ class Mailer < Sensu::Handler
          long: '--template TemplateFile',
          required: false
 
+  option :subject_template,
+         description: 'Subject template to use',
+         short: '-T TemplateFile',
+         long: '--subject_template TemplateFile',
+         required: false
+
   option :content_type,
          description: 'Content-type of message',
          short: '-c ContentType',
@@ -176,6 +182,26 @@ class Mailer < Sensu::Handler
     mail_to.to_a.join(', ')
   end
 
+  def subject_template
+    return config[:subject_template] if config[:subject_template]
+    return @event['check']['subject_template'] if @event['check']['subject_template']
+    return json_config_settings['subject_template'] if json_config_settings['subject_template']
+    nil
+  end
+
+  def build_subject
+    template = if subject_template && File.readable?(subject_template)
+                 File.read(subject_template)
+               else
+                 <<-SUBJECT.gsub(/^\s+/, '')
+        <%= action_to_string %> - <%= short_name %>: <% if (@event['check']['notification'] != nil) then %><%= @event['check']['notification'] %><% else %><%= status_to_string %><% end %>
+      SUBJECT
+               end
+
+    eruby = Erubis::Eruby.new(template)
+    eruby.result(binding)
+  end
+
   def message_template
     return config[:template] if config[:template]
     return @event['check']['template'] if @event['check']['template']
@@ -212,6 +238,8 @@ class Mailer < Sensu::Handler
 
   def handle
     body = build_body
+    subject = "#{prefix_subject}#{build_subject}"
+
     content_type = parse_content_type
     mail_to = build_mail_to_list
     mail_from = json_config_settings['mail_from']
@@ -239,12 +267,6 @@ class Mailer < Sensu::Handler
       'X-Sensu-Occurrences' => (@event['occurrences']).to_s
     }
 
-    subject = if @event['check']['notification'].nil?
-                "#{prefix_subject}#{action_to_string} - #{short_name}: #{status_to_string}"
-              else
-                "#{prefix_subject}#{action_to_string} - #{short_name}: #{@event['check']['notification']}"
-              end
-
     Mail.defaults do
       delivery_options = {
         address: smtp_address,

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-mailer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-ses
@@ -223,8 +223,8 @@ dependencies:
 description: Provides mail output for Sensu
 email: "<sensu-users@googlegroups.com>"
 executables:
-- handler-mailer-mailgun.rb
 - handler-mailer-ses.rb
+- handler-mailer-mailgun.rb
 - handler-mailer.rb
 extensions: []
 extra_rdoc_files: []
@@ -263,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for mailer