logstash-output-email 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0a68fd022674e4fd1d643538cdd2b6382234c0d
-  data.tar.gz: 5b9b5eb6e82ba496f6cc53a8861741f667a20ef7
+  metadata.gz: 9113b32924f9aa3aaf948a2def10f4de02e304a6
+  data.tar.gz: 685b26596c503699d5ab855720619cff6cb26075
 SHA512:
-  metadata.gz: 0932698618bfbc0d704a91af0bfaafa51aca69a554a482194b024b0f2f715dad95d536174eb990be69fafabc458e4429a3df67aef04aceb8531faf25e6fddf3a
-  data.tar.gz: 97120bbd6b5534c22c32fe8e62375ca03f4d67f3c3c45473fc230d74c90551b7589da86e14a1d77c35728554974ac168da3c67131f4e9cb9911fa9c405d982eb
+  metadata.gz: e29a2e50322bd6b9eef87bc9f786834b0f4f58ff4f1a2746c14282915e8635fc2ce948bb48f03b188d07d014f5cc3a238503f6b3616f05460c59f00d4c901dad
+  data.tar.gz: c9ac9d5fe22bbf02b1a57e2348b5d26b19fd6eb5709d7509ffb61fdc5958a314c74405784f136f17c623ba5103b39fd3461e343f0cd3eb77e57a36cc1ea61bf5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.1.0
+  - Make the delivery method more reliable to failure by catching and
+    logging exceptions when happen, like this LS is not going to break
+    if something wrong happen, but is going to log it. Fixes #26 and #7
+  - Randomize port in specs so they can run in parallel.

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/email.rb

@@ -247,7 +247,12 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
         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)
-      mail.deliver!
+      begin
+        mail.deliver!
+      rescue StandardError => e
+        @logger.error("Something happen while delivering an email", :exception => e)
+        @logger.debug? && @logger.debug("Processed event: ", :event => event)
+      end
     end # end if successful
   end # def receive
 

data/logstash-output-email.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-email'
-  s.version         = '1.0.0'
+  s.version         = '1.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send email when an 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/plugin install gemname. This gem is not a stand-alone program"

data/spec/outputs/email_spec.rb

@@ -5,10 +5,10 @@ require "message_observers"
 
 describe "outputs/email" do
 
-  port = 2525
-  let (:rumbster) { Rumbster.new(port) }
+  let (:port)             { rand(1024..65535) }
+  let (:rumbster)         { Rumbster.new(port) }
   let (:message_observer) { MailMessageObserver.new }
-  plugin = LogStash::Plugin.lookup("output", "email")
+  let(:plugin)            { LogStash::Plugin.lookup("output", "email") }
 
 
   before :each do
@@ -21,75 +21,91 @@ describe "outputs/email" do
     sleep 0.01 until rumbster.stopped?
   end
 
-  describe  "use a list of email as mail.to (LOGSTASH-827)" do
+  describe "send email" do
 
-    it "supports list of emails in to field" do
-      subject = plugin.new("to" => ["email1@host, email2@host"],
-                           "match" => ["mymatch", "dummy_match,ok"],
-                           "options" => ["port", port])
-      subject.register
-      subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
-      expect(message_observer.messages.size).to eq(1)
-      expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+    context  "use a list of email as mail.to (LOGSTASH-827)" do
+
+      it "supports list of emails in to field" do
+        subject = plugin.new("to" => ["email1@host, email2@host"],
+                             "match" => ["mymatch", "dummy_match,ok"],
+                             "options" => ["port", port])
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+      end
+
+      it "multiple *to* addresses in a field" do
+        subject = plugin.new("to" => "%{to_addr}",
+                             "match" => ["mymatch", "dummy_match,ok"],
+                             "options" => ["port", port])
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello",
+                                            "dummy_match" => "ok",
+                                            "to_addr" => ["email1@host", "email2@host"]))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+      end
     end
 
-    it "multiple *to* addresses in a field" do
-      subject = plugin.new("to" => "%{to_addr}",
-                           "match" => ["mymatch", "dummy_match,ok"],
-                           "options" => ["port", port])
-      subject.register
-      subject.receive(LogStash::Event.new("message" => "hello",
-                                          "dummy_match" => "ok",
-                                          "to_addr" => ["email1@host", "email2@host"]))
-      expect(message_observer.messages.size).to eq(1)
-      expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+    context  "multi-lined text body (LOGSTASH-841)" do
+      it "handles multiline messages" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "body" => "Line1\\nLine2\\nLine3",
+                             "match" => ["mymatch", "dummy_match,*"],
+                             "options" => ["port", port])
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+      end
     end
-  end
 
-  describe  "multi-lined text body (LOGSTASH-841)" do
-    it "handles multiline messages" do
-      subject = plugin.new("to" => "me@host",
-                           "subject" => "Hello World",
-                           "body" => "Line1\\nLine2\\nLine3",
-                           "match" => ["mymatch", "dummy_match,*"],
-                           "options" => ["port", port])
-      subject.register
-      subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
-      expect(message_observer.messages.size).to eq(1)
-      expect(message_observer.messages[0].subject).to eq("Hello World")
-      expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+    context  "use nil authenticationType (LOGSTASH-559)" do
+      it "reads messages correctly" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "body" => "Line1\\nLine2\\nLine3",
+                             "match" => ["mymatch", "dummy_match,*"],
+                             "options" => ["port", port, "authenticationType", "nil"])
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+      end
     end
-  end
 
-  describe  "use nil authenticationType (LOGSTASH-559)" do
-    it "reads messages correctly" do
-      subject = plugin.new("to" => "me@host",
-                           "subject" => "Hello World",
-                           "body" => "Line1\\nLine2\\nLine3",
-                           "match" => ["mymatch", "dummy_match,*"],
-                           "options" => ["port", port, "authenticationType", "nil"])
-      subject.register
-      subject.receive(LogStash::Event.new("message" => "hello", "dummy_match" => "ok"))
-      expect(message_observer.messages.size).to eq(1)
-      expect(message_observer.messages[0].subject).to eq("Hello World")
-      expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+    context  "match on source and message (LOGSTASH-826)" do
+      it "reads messages correctly" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "body" => "Mail body",
+                             "match" => [ "messageAndSourceMatch", "message,*hello,,and,type,*generator"],
+                             "options" => ["port", port, "authenticationType", "nil"])
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello world", "type" => "generator"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.raw_source).to eq("Mail body\r\n")
+      end
     end
-  end
 
-  describe  "match on source and message (LOGSTASH-826)" do
-    it "reads messages correctly" do
-      subject = plugin.new("to" => "me@host",
-                           "subject" => "Hello World",
-                           "body" => "Mail body",
-                           "match" => [ "messageAndSourceMatch", "message,*hello,,and,type,*generator"],
-                           "options" => ["port", port, "authenticationType", "nil"])
-      subject.register
-      subject.receive(LogStash::Event.new("message" => "hello world", "type" => "generator"))
-      expect(message_observer.messages.size).to eq(1)
-      expect(message_observer.messages[0].subject).to eq("Hello World")
-      expect(message_observer.messages[0].body.raw_source).to eq("Mail body\r\n")
+    context "having no connection to the email server" do
+
+      subject     { plugin.new("to" => "me@host") }
+      let(:event) { LogStash::Event.new("message" => "hello world") }
+
+      before(:each) do
+        subject.register
+      end
+
+      it "should send without throwing an error" do
+        expect { subject.receive(event) }.not_to raise_error
+      end
     end
+
   end
 end
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-email
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key:
 specification_version: 4
 summary: Send email when an output is received.