sensu-plugins-mailer 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecef112172596b50f7a2c8d6e28aad96fcc93abf
-  data.tar.gz: ca05e61e1f7eab6196d8aee1e7215f5f83ebc9dc
+  metadata.gz: 60f0a156a68477698c96e7697f9eaf5743d65dbb
+  data.tar.gz: bab7b53712fe7e5421d9546f26f73eea0df821c7
 SHA512:
-  metadata.gz: c89aacc88b4bee442d20b3f553d7cf80f4d2bfe17dc9023e11493c0c2ed255f34540405e8597ae1062741fcf0ac83be54a515afff7bad42e387d003b7c8aa582
-  data.tar.gz: 901e8d3bc1daefb70d3c0b2d2cd99fb348d3e8c6ef97cf371b64a495bc47b03771ca739d7f4b98cb5c744a779a5480a04213e875e80f56f85f0b2b3504f2a595
+  metadata.gz: 05fa0bf017df15111a9951ab030e3d3cb8a9dd01a5266c163517b1d6fd4df5fdfbd9adc39b7de722627fca579604cc7bc957de16745ce1b2deecf22adc6b56bf
+  data.tar.gz: 3d5991a161fbc56721a781d30accc430814e929a05f14c6ef969dcda8ec7dcf927115863f66145750d00570eb68b522c75268d2f6c5b5254c9c0395fd896397b

data/CHANGELOG.md

@@ -3,15 +3,29 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-## Unreleased][unreleased]
+## Unreleased
 
-## [0.0.3] - 2015-07-14
+## 0.1.0 - 2015-11-17
+### Added
+- Ability to use custom ERB template for mail message
+- Ability to specify a custom timeout interval for sending mail
+- Content type option
+- Add essential information to headers
+
+### Fixed
+- Use correct mailgun gem
+- Correct password replacement
+
+### Changed
+- Upgraded to rubocop 0.32.1
+
+## [0.0.2] - [2015-07-14]
 ### Changed
 - updated sensu-plugin gem to 1.2.0
 - updated documentation links in the README and CONTRIBUTING
 - puts deps in alpha order in the gemspec and rakefile
 
-## 0.0.1 - 2015-06-04
+## [0.0.1] - [2015-06-04]
 
 ### Added
 - initial release

data/README.md

@@ -1,6 +1,6 @@
 ## Sensu-Plugins-mailer
 
-[ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-mailer.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-mailer)
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-mailer.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-mailer)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-mailer.svg)](http://badge.fury.io/rb/sensu-plugins-mailer)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mailer/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mailer)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mailer/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-mailer)
@@ -24,6 +24,10 @@ The following three configuration variables must be set if you want mailer to us
 
 There is an optional subscriptions hash which can be added to your mailer.json file.  This subscriptions hash allows you to define individual mail_to addresses for a given subscription.  When the mailer handler runs it will check the clients subscriptions and build a mail_to string with the default mailer.mail_to address as well as any subscriptions the client subscribes to where a mail_to address is found.  There can be N number of hashes inside of subscriptions but the key for a given hash inside of subscriptions must match a subscription name. 
 
+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.
+
 ```json
 {
   "mailer": {
@@ -32,9 +36,11 @@ There is an optional subscriptions hash which can be added to your mailer.json f
     "smtp_address": "smtp.example.org",
     "smtp_port": "25",
     "smtp_domain": "example.org",
+    "template": "/optional/path/to/template.erb",
     "subscriptions": {
-        "subscription_name": {
-            "mail_to": "teamemail@example.com"
+      "subscription_name": {
+        "mail_to": "teamemail@example.com"
+      }
     }
   }
 }

data/bin/handler-mailer-mailgun.rb

@@ -29,7 +29,7 @@
 #   for details.
 
 require 'sensu-handler'
-require 'mailgun'
+require 'mailgun-ruby'
 require 'timeout'
 
 class Mailer < Sensu::Handler

data/bin/handler-mailer.rb

@@ -17,6 +17,7 @@
 require 'sensu-handler'
 require 'mail'
 require 'timeout'
+require 'erubis'
 
 # patch to fix Exim delivery_method: https://github.com/mikel/mail/pull/546
 # #YELLOW
@@ -36,6 +37,19 @@ class Mailer < Sensu::Handler
          description: 'Config Name',
          short: '-j JsonConfig',
          long: '--json_config JsonConfig',
+         required: false,
+         default: 'mailer'
+
+  option :template,
+         description: 'Message template to use',
+         short: '-t TemplateFile',
+         long: '--template TemplateFile',
+         required: false
+
+  option :content_type,
+         description: 'Content-type of message',
+         short: '-c ContentType',
+         long: '--content_type ContentType',
          required: false
 
   def short_name
@@ -59,8 +73,26 @@ class Mailer < Sensu::Handler
     end
   end
 
+  def parse_content_type
+    if config[:content_type]
+      use = config[:content_type]
+    elsif @event['check']['content_type']
+      use = @event['check']['content_type']
+    elsif settings[config[:json_config]]['content_type']
+      use = settings[config[:json_config]]['content_type']
+    else
+      use = 'plain'
+    end
+
+    if use.downcase == 'html'
+      'text/html; charset=UTF-8'
+    else
+      'text/plain; charset=ISO-8859-1'
+    end
+  end
+
   def build_mail_to_list
-    json_config = config[:json_config] || 'mailer'
+    json_config = config[:json_config]
     mail_to = @event['client']['mail_to'] || settings[json_config]['mail_to']
     if settings[json_config].key?('subscriptions') && @event['check']['subscribers']
       @event['check']['subscribers'].each do |sub|
@@ -72,9 +104,45 @@ class Mailer < Sensu::Handler
     mail_to
   end
 
-  def handle # rubocop:disable all
-    json_config = config[:json_config] || 'mailer'
+  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']
+    nil
+  end
+
+  def build_body
+    json_config = config[:json_config]
     admin_gui = settings[json_config]['admin_gui'] || 'http://localhost:8080/'
+    # try to redact passwords from output and command
+    output = "#{@event['check']['output']}".gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
+    command = "#{@event['check']['command']}".gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
+    playbook = "Playbook:  #{@event['check']['playbook']}" if @event['check']['playbook']
+
+    if message_template && File.readable?(message_template)
+      template = File.read(message_template)
+    else
+      template = <<-BODY.gsub(/^\s+/, '')
+        <%= @output %>
+        Admin GUI: <%= admin_gui %>
+        Host: <%= @event['client']['name'] %>
+        Timestamp: <%= Time.at(@event['check']['issued']) %>
+        Address:  <%= @event['client']['address'] %>
+        Check Name:  <%= @event['check']['name'] %>
+        Command:  <%= command %>
+        Status:  <%= status_to_string %>
+        Occurrences:  <%= @event['occurrences'] %>
+        <%= playbook %>
+      BODY
+    end
+    eruby = Erubis::Eruby.new(template)
+    eruby.result(binding)
+  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
@@ -88,23 +156,18 @@ class Mailer < Sensu::Handler
     smtp_password = settings[json_config]['smtp_password'] || nil
     smtp_authentication = settings[json_config]['smtp_authentication'] || :plain
     smtp_enable_starttls_auto = settings[json_config]['smtp_enable_starttls_auto'] == 'false' ? false : true
-    # try to redact passwords from output and command
-    output = "#{@event['check']['output']}".gsub(/(-p|-P|--password)\s*\S+/, '\1 <password redacted>')
-    command = "#{@event['check']['command']}".gsub(/(-p|-P|--password)\s*\S+/, '\1 <password redacted>')
 
-    playbook = "Playbook:  #{@event['check']['playbook']}" if @event['check']['playbook']
-    body = <<-BODY.gsub(/^\s+/, '')
-            #{output}
-            Admin GUI: #{admin_gui}
-            Host: #{@event['client']['name']}
-            Timestamp: #{Time.at(@event['check']['issued'])}
-            Address:  #{@event['client']['address']}
-            Check Name:  #{@event['check']['name']}
-            Command:  #{command}
-            Status:  #{status_to_string}
-            Occurrences:  #{@event['occurrences']}
-            #{playbook}
-          BODY
+    timeout_interval = settings[json_config]['timeout'] || 10
+
+    headers = {
+      'X-Sensu-Host'        => "#{@event['client']['name']}",
+      'X-Sensu-Timestamp'   => "#{Time.at(@event['check']['issued'])}",
+      'X-Sensu-Address'     => "#{@event['client']['address']}",
+      'X-Sensu-Check-Name'  => "#{@event['check']['name']}",
+      'X-Sensu-Status'      => "#{status_to_string}",
+      'X-Sensu-Occurrences' => "#{@event['occurrences']}"
+    }
+
     if @event['check']['notification'].nil?
       subject = "#{action_to_string} - #{short_name}: #{status_to_string}"
     else
@@ -133,13 +196,15 @@ class Mailer < Sensu::Handler
     end
 
     begin
-      timeout 10 do
+      timeout timeout_interval do
         Mail.deliver do
           to mail_to
           from mail_from
           reply_to reply_to
           subject subject
           body body
+          headers headers
+          content_type content_type
         end
 
         puts 'mail -- sent alert for ' + short_name + ' to ' + mail_to.to_s

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

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

data.tar.gz.sig

@@ -1,2 +1,2 @@
-_�k4K7��a0��E�ܢ�J�0<U��,(U�w(B�cwؽk]K�(��
ŀ������4E1��a�Gmj���4tI��*�`H�3y�ؐ��O��~
��@�W���x��4�iC�"�~\�\ZL��;F@j�J�/j��FK%��,�{��O�3�ô_�Sˠ��ߤ@���Tﰨa��]�H�q�}��$#%T����"�K��:r
-�5��Xu��^�\6����-�h��T�������VO
+���H�a5�h���{]���%�����K�J;�[�8wI�ǡd{��d����~��	��ܦx|��<��4�T��TA�R����ζ��>�����E�i;���� �ܲ���_�0P�Z^��X�r�
+22�s�G���F����G�F�i<C�k��bm}��Jr�CԿ����"M<�(�_)Y�^�_əa��}@|P����̳\�VV�����B�ͦ1oC(5���ub�15[/i$u�-T�~GoP����

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws
@@ -61,19 +61,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.6.3
 - !ruby/object:Gem::Dependency
-  name: mailgun
+  name: mailgun-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,14 +192,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for mailer