logstash-output-email 4.0.6 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 796bc0c80400fcd45375ea26449505f08d81d038
-  data.tar.gz: a5c5434cfa5c1151c45d5360e3e7ed0733344303
+SHA256:
+  metadata.gz: fba3309aa6431187a31571b6db5ffeb5efd80c988b0a6ddf04c81b0646b6d46f
+  data.tar.gz: e0be2186cdb511b14a10a8d0489583a09d3262d5cc36b13c01eb7466b508d6f9
 SHA512:
-  metadata.gz: 529802062bddd74474e4ac650325f11b4a3faf9c761cb12650fafe75893c829b3eaa228e81733d8591cae27508633101f362d88d7896408d208efce2663d9faf
-  data.tar.gz: 59d87114214f143c85ca720a8f7e74395ef29729a1cf81cb975c0f5e317552cbabfa16b391512cc1412a444f5dfa1df4e7522dece82d8aea14415ed4fc5533c9
+  metadata.gz: ce3eeebfcc341aa54ae7f4b6345884e98f220c95f92c45d0f15c88ac281711aaf5bb8812265ac9f91a3d2560e3cdaf595fbfee0665581710844f4843f22cbfa0
+  data.tar.gz: 6fc5516f97137e2d5030ae08021fcb3d3e18186167ce767764710ef40e91dcf093eac0c3346e8e6211aceb4ef1494395418f1bcc252f1a2bfc88826ef567227e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.1.0
+  - Update gemspec summary
+  - Add bcc suport #55
+  - Add mustache templating #51
+
 ## 4.0.6
   - Fix some documentation issues
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/docs/index.asciidoc

@@ -33,6 +33,7 @@ output {
       from => 'monitor@example.com'
       subject => 'Alert - %{title}'
       body => "Tags: %{tags}\\n\\Content:\\n%{message}"
+      template_file => "/tmp/email_template.mustache"
       domain => 'mail.example.com'
       port => 25
     }
@@ -53,6 +54,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-authentication>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-body>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-cc>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-bcc>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-contenttype>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-debug>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-domain>> |<<string,string>>|No
@@ -66,6 +68,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-use_tls>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-via>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-template_file>> |<<path,path>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -116,6 +119,16 @@ The fully-qualified email address(es) to include as cc: address(es).
 This field also accepts a comma-separated string of addresses, for example:
 `"me@example.com, you@example.com"`
 
+[id="plugins-{type}s-{plugin}-bcc"]
+===== `bcc` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The fully-qualified email address(es) to include as bcc: address(es).
+
+This field accepts several addresses like cc.
+
 [id="plugins-{type}s-{plugin}-contenttype"]
 ===== `contenttype` 
 
@@ -229,6 +242,14 @@ Username to authenticate with the server
 
 How Logstash should send the email, either via SMTP or by invoking sendmail.
 
+[id="plugins-{type}s-{plugin}-template_file"]
+===== `template_file` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+Path of a [Mustache templating](https://mustache.github.io/) file used for email templating. See example in test fixture.
+Can be used with `body` to send multi-part emails. Takes precedence over `htmlBody`.
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

data/lib/logstash/outputs/email.rb

@@ -46,6 +46,9 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # This field also accepts a comma-separated string of addresses, for example:
   # `"me@example.com, you@example.com"`
   config :cc, :validate => :string
+ 
+  # Same as cc but in blind carbon
+  config :bcc, :validate => :string
 
   # How Logstash should send the email, either via SMTP or by invoking sendmail.
   config :via, :validate => :string, :default => "smtp"
@@ -80,6 +83,9 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # Body for the email - plain text only.
   config :body, :validate => :string, :default => ""
 
+  # Email template file to be used - as mustache template.
+  config :template_file, :validate => :path
+
   # HTML Body for the email, which may contain HTML markup.
   config :htmlbody, :validate => :string, :default => ""
 
@@ -93,6 +99,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   public
   def register
     require "mail"
+    require "mustache"
 
     options = {
       :address              => @address,
@@ -118,6 +125,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
         delivery_method :@via, options
       end
     end # @via tests
+    @htmlTemplate = File.open(@template_file, "r").read unless @template_file.nil?
     @logger.debug("Email Output Registered!", :config => options, :via => @via)
   end # def register
 
@@ -125,10 +133,11 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   def receive(event)
 
 
-      @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments, :to => to, :to => to)
+      @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :bcc => @bcc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments)
       formatedSubject = event.sprintf(@subject)
       formattedBody = event.sprintf(@body)
       formattedHtmlBody = event.sprintf(@htmlbody)
+      
       mail = Mail.new
       mail.from = event.sprintf(@from)
       mail.to = event.sprintf(@to)
@@ -136,25 +145,38 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
         mail.reply_to = event.sprintf(@replyto)
       end
       mail.cc = event.sprintf(@cc)
+      mail.bcc = event.sprintf(@bcc)
       mail.subject = formatedSubject
-      if @htmlbody.empty?
+
+      if @htmlbody.empty? and @template_file.nil?
         formattedBody.gsub!(/\\n/, "\n") # Take new line in the email
         mail.body = formattedBody
       else
+        # This handles multipart emails
+        # cf: https://github.com/mikel/mail/#writing-and-sending-a-multipartalternative-html-and-text-email
         mail.text_part = Mail::Part.new do
           content_type "text/plain; charset=UTF-8"
           formattedBody.gsub!(/\\n/, "\n") # Take new line in the email
           body formattedBody
         end
-        mail.html_part = Mail::Part.new do
-          content_type "text/html; charset=UTF-8"
-          body formattedHtmlBody
+        
+        if @template_file.nil?
+          mail.html_part = Mail::Part.new do
+            content_type "text/html; charset=UTF-8"
+            body formattedHtmlBody
+          end
+        else
+          templatedHtmlBody = Mustache.render(@htmlTemplate, event.to_hash)
+          mail.html_part = Mail::Part.new do
+            content_type "text/html; charset=UTF-8"
+            body templatedHtmlBody
+          end
         end
       end
       @attachments.each do |fileLocation|
         mail.add_file(fileLocation)
       end # end @attachments.each
-      @logger.debug? and @logger.debug("Sending mail with these values : ", :from => mail.from, :to => mail.to, :cc => mail.cc, :subject => mail.subject)
+      @logger.debug? and @logger.debug("Sending mail with these values : ", :from => mail.from, :to => mail.to, :cc => mail.cc, :bcc => mail.bcc, :subject => mail.subject)
       begin
         mail.deliver!
       rescue StandardError => e

data/logstash-output-email.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-email'
-  s.version         = '4.0.6'
+  s.version         = '4.1.0'
   s.licenses        = ['Apache License (2.0)']
-  s.summary         = "Send email when an output is received."
+  s.summary         = "Sends email to a specified address when output is received"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
@@ -26,9 +26,12 @@ Gem::Specification.new do |s|
   # mime-types >= 3 require ruby 2.0 support
   s.add_runtime_dependency 'mime-types', '< 3'
 
+  s.add_runtime_dependency 'mustache', '>= 0.99.8'
+
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'rumbster'
   s.add_development_dependency 'logstash-input-generator'
+  s.add_development_dependency 'gserver'
 
 end
 

data/spec/fixtures/template.mustache

@@ -0,0 +1 @@
+<h1>{{message}}</h1>

data/spec/outputs/email_spec.rb

@@ -89,5 +89,20 @@ describe "outputs/email" do
 
       end
     end
+
+    context  "mustache template for email body" do
+      it "uses the template file" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "template_file" => File.dirname(__FILE__) + "/../fixtures/template.mustache",
+                             "port" => port)
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello"))
+
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.decoded).to eq(craft_multi_part_email('', '<h1>hello</h1>', message_observer.messages[0].content_type))
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -12,3 +12,17 @@ class LogStash::Filters::NOOP < LogStash::Filters::Base
     filter_matched(event)
   end
 end
+
+def craft_multi_part_email(body, htmlbody, content_type)
+  charset = "charset=UTF-8"
+  content_encoding = "Content-Transfer-Encoding: 7bit"
+ 
+  # Have to get the generated part of the header, eg:
+  # --==_mimepart_5a462a1fda04b_efe7d032127
+  mimetype = content_type.split('; ')[1][10..-2]
+
+  plain_header = "\n--#{mimetype}\nContent-Type: text/plain;\n #{charset}\n#{content_encoding}\n\n"
+  html_header = "\n--#{mimetype}\nContent-Type: text/html;\n #{charset}\n#{content_encoding}\n\n"
+
+  "#{plain_header}#{body}#{html_header}#{htmlbody}\n\n--#{mimetype}--\n"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-email
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.8
+  name: mustache
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.8
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -100,7 +114,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: gserver
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
@@ -115,6 +145,7 @@ files:
 - docs/index.asciidoc
 - lib/logstash/outputs/email.rb
 - logstash-output-email.gemspec
+- spec/fixtures/template.mustache
 - spec/outputs/email_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
@@ -139,10 +170,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
-summary: Send email when an output is received.
+summary: Sends email to a specified address when output is received
 test_files:
+- spec/fixtures/template.mustache
 - spec/outputs/email_spec.rb
 - spec/spec_helper.rb