logstash-output-slack 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0897c3faaa18a89fce7646142a13c0188280a934
-  data.tar.gz: d301820d07c3157c2da4420f36df84395c903e8b
+SHA256:
+  metadata.gz: 7e2dae06476ae2f501462eb76832aa5d2b24e6686bfe0bacc64a422a6b3676c7
+  data.tar.gz: 8115f85427fe509cfc28bf6812a77af90054530514ca511c84572c0ec8046df1
 SHA512:
-  metadata.gz: 86c8fe1525a38d591e5d2131f0e70b98a51cc9376d23534f8a86f7d1947ed1bab528c524bb7dd8d88914b46c54d907c67e99f446a20b814604e3095dda681b79
-  data.tar.gz: 6437a6cc6a846de24ffd713429c3ffcd6d4e8b076428165e077257e1a567ea5e7976928601d739f550035d877f41629c55bc97fb10446c9ce9c7b3db29fa0247
+  metadata.gz: f0c28f6a9714e3b1f39ef046c3583b5601c359ca72cd2f13c760472e4ce33c83a1584add02538d87153acb184f5410cd083da0820ae68e1ebd051a7221a3a515
+  data.tar.gz: def643b508f11e9859b4257da6ff193bd8e92f3c5717e9d5f5f0224283bd20c6606a0277cff16d96e17c3b8923a0d47f749452c81347cc9e6d63fc18ed676f6f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.1.0
+  - allow interpolation of event fields in url [#11](https://github.com/logstash-plugins/logstash-output-slack/pull/11)
+
 ## 2.0.2
   - Enable event based data in attachments 
 

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/cyli/logstash-output-slack.svg?branch=master)](https://travis-ci.org/cyli/logstash-output-slack)
+[![Build Status](https://travis-ci.org/logstash-plugins/logstash-output-slack.svg?branch=master)](https://travis-ci.org/logstash-plugins/logstash-output-slack)
 
 Reviews of the code/contributions are very welcome (particularly with testing!), since I don't really know Ruby.
 

data/docs/index.asciidoc

@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Slack output plugin
 

data/lib/logstash/outputs/slack.rb

@@ -42,6 +42,7 @@ class LogStash::Outputs::Slack < LogStash::Outputs::Base
 
     payload_json = Hash.new
     payload_json['text'] = event.sprintf(@format)
+    url = event.sprintf(@url)
 
     if not @channel.nil?
       payload_json['channel'] = event.sprintf(@channel)
@@ -75,7 +76,7 @@ class LogStash::Outputs::Slack < LogStash::Outputs::Base
 
     begin
       RestClient.post(
-        @url,
+        url,
         "payload=#{CGI.escape(JSON.dump(payload_json))}",
         :accept => "application/json",
         :'User-Agent' => "logstash-output-slack",

data/logstash-output-slack.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-slack'
-  s.version         = '2.0.3'
+  s.version         = '2.1.0'
   s.licenses        = ['MIT','Apache License (2.0)']
   s.summary         = "Write events to Slack"
   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/slack_spec.rb

@@ -2,17 +2,22 @@ require_relative "../spec_helper"
 
 describe LogStash::Outputs::Slack do
 
+  subject { described_class.new(config) }
+  let(:config) { { } }
+  let(:event) { LogStash::Event.new(data) }
+  let(:data) { {} }
+
   # Actually do most of the boiler plate by stubbing out the request, running
   # the logstash pipeline, and asserting that a request was made with the
   # expected JSON.
-  def test_one_event(logstash_config, expected_json)
+  def test_one_event(event, expected_json, expected_url = "http://requestb.in/r9lkbzr9")
     stub_request(:post, "requestb.in").
       to_return(:body => "", :status => 200,
                 :headers => { 'Content-Length' => 0 })
 
-    LogStash::Pipeline.new(logstash_config).run
+    subject.receive(event)
 
-    expect(a_request(:post, "http://requestb.in/r9lkbzr9").
+    expect(a_request(:post, expected_url).
            with(:body => "payload=#{CGI.escape(JSON.dump(expected_json))}",
                 :headers => {
                   'Content-Type' => 'application/x-www-form-urlencoded',
@@ -22,275 +27,231 @@ describe LogStash::Outputs::Slack do
            to have_been_made.once
   end
 
-  before do
+  before(:each) do
+    subject.register
     WebMock.disable_net_connect!
   end
 
-  after do
+  after(:each) do
     WebMock.reset!
     WebMock.allow_net_connect!
   end
 
-  context "passes the right payload to slack and" do
-    it "uses all default values" do
-      expected_json = {
-        :text => "This message should show in slack"
-      }
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-            }
-          }
-      CONFIG
+  context "passes the right payload to slack" do
+    context "simple" do
+      let(:data) { { "message" => "This message should show in slack" } }
+      let(:config) { { "url" => "http://requestb.in/r9lkbzr9" } }
 
-      test_one_event(logstash_config, expected_json)
+      it "uses all default values" do
+        expected_json = { :text => "This message should show in slack" }
+        test_one_event(event, expected_json)
+      end
     end
 
-    it "uses and formats all provided values" do
-      expected_json = {
-        :text => "This message should show in slack 3",
-        :channel => "mychannel",
-        :username => "slackbot",
-        :icon_emoji => ":chart_with_upwards_trend:",
-        :icon_url => "http://lorempixel.com/48/48"
-      }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              add_field => {"x" => "3"
-                            "channelname" => "mychannel"
-                            "username" => "slackbot"}
-              count => 1
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              format => "%{message} %{x}"
-              channel => "%{channelname}"
-              username => "%{username}"
-              icon_emoji => ":chart_with_upwards_trend:"
-              icon_url => "http://lorempixel.com/48/48"
-            }
-          }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+    context "with multiple interpolations" do
+      let(:data) { {
+        "message" => "This message should show in slack",
+        "x" => "3",
+        "channelname" => "mychannel",
+        "username" => "slackbot"
+      } }
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "format" => "%{message} %{x}",
+        "channel" => "%{channelname}",
+        "username" => "%{username}",
+        "icon_emoji" => ":chart_with_upwards_trend:",
+        "icon_url" => "http://lorempixel.com/48/48",
+      } }
+
+      it "uses and formats all provided values" do
+        expected_json = {
+          :text => "This message should show in slack 3",
+          :channel => "mychannel",
+          :username => "slackbot",
+          :icon_emoji => ":chart_with_upwards_trend:",
+          :icon_url => "http://lorempixel.com/48/48"
+        }
+        test_one_event(event, expected_json)
+      end
     end
 
-    it "uses and formats all provided values" do
-      expected_json = {
-        :text => "Unformatted message",
-        :channel => "mychannel",
-        :username => "slackbot",
-        :icon_emoji => ":chart_with_upwards_trend:",
-        :icon_url => "http://lorempixel.com/48/48"
-      }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              format => "Unformatted message"
-              channel => "mychannel"
-              username => "slackbot"
-              icon_emoji => ":chart_with_upwards_trend:"
-              icon_url => "http://lorempixel.com/48/48"
-            }
-          }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+    context "if the message contains no interpolations" do
+
+      let(:data) { {
+        "message" => "This message should show in slack"
+      } }
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "format" => "Unformatted message",
+        "channel" => "mychannel",
+        "username" => "slackbot",
+        "icon_emoji" => ":chart_with_upwards_trend:",
+        "icon_url" => "http://lorempixel.com/48/48"
+      } }
+
+      it "uses and formats all provided values" do
+        expected_json = {
+          :text => "Unformatted message",
+          :channel => "mychannel",
+          :username => "slackbot",
+          :icon_emoji => ":chart_with_upwards_trend:",
+          :icon_url => "http://lorempixel.com/48/48"
+        }
+        test_one_event(event, expected_json)
+      end
     end
 
-    it "uses the default attachments if none are in the event" do
-      expected_json = {
-        :text => "This message should show in slack",
-        :attachments => [{:image_url => "http://example.com/image.png"}]
-      }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-            }
+    describe "default attachements" do
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "attachments" => [{ "image_url" => "http://example.com/image.png" }]
+      } }
+
+      context "when none are in the event" do
+        let(:data) { { "message" => "This message should show in slack" } }
+        it "uses the default" do
+          expected_json = {
+            :text => "This message should show in slack",
+            :attachments => [{:image_url => "http://example.com/image.png"}]
           }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => [
-                {image_url => "http://example.com/image.png"}
-              ]
-            }
+          test_one_event(event, expected_json)
+        end
+      end
+
+      context "when using multiple attachments" do
+        let(:data) { { "message" => "This message should show in slack" } }
+        let(:config) { {
+          "url" => "http://requestb.in/r9lkbzr9",
+          "attachments" => [
+            {"image_url" => "http://example.com/image1.png"},
+            {"image_url" => "http://example.com/image2.png"}
+          ]
+        } }
+        it "sends them" do
+          expected_json = {
+            :text => "This message should show in slack",
+            :attachments => [{:image_url => "http://example.com/image1.png"},
+                             {:image_url => "http://example.com/image2.png"}]
           }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+          test_one_event(event, expected_json)
+        end
+      end
     end
 
-    it "supports multiple default attachments" do
-      expected_json = {
-        :text => "This message should show in slack",
-        :attachments => [{:image_url => "http://example.com/image1.png"},
-                         {:image_url => "http://example.com/image2.png"}]
-      }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => [
-                {image_url => "http://example.com/image1.png"},
-                {image_url => "http://example.com/image2.png"}
-              ]
-            }
-          }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+    context "empty default attachments" do
+      let(:data) { {
+        "message" => "This message should show in slack"
+      }}
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "attachments" => []
+      }}
+
+      it "are ignored" do
+        expected_json = {
+          :text => "This message should show in slack"
+        }
+        test_one_event(event, expected_json)
+      end
     end
 
-    it "ignores empty default attachments" do
-      expected_json = {
-        :text => "This message should show in slack"
-      }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => []
-            }
-          }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+    context "when both event attachments and default attachments are set" do
+
+      let(:data) { {
+        "message" => "This message should show in slack",
+        "attachments" => [{"thumb_url" => "http://other.com/thumb.png"}]
+      } }
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "attachments" => [
+          {"image_url" => "http://example.com/image1.png"},
+          {"image_url" => "http://example.com/image2.png"}
+        ]
+      } }
+
+      it "event attachements prevail" do
+        expected_json = {
+          :text => "This message should show in slack",
+          :attachments => [{:thumb_url => "http://other.com/thumb.png"}]
+        }
+        test_one_event(event, expected_json)
+      end
     end
 
-    it "uses event attachments over default attachments" do
-      expected_json = {
-        :text => "This message should show in slack",
-        :attachments => [{:thumb_url => "http://other.com/thumb.png"}]
-      }
-
-      # add_field only takes string values, so we'll have to mutate to JSON
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-              add_field => {
-                attachments => '[{"thumb_url": "http://other.com/thumb.png"}]'
-              }
-            }
-          }
-          filter {
-            json {
-              source => "attachments"
-              target => "attachments"
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => [
-                {image_url => "http://example.com/image1.png"},
-                {image_url => "http://example.com/image2.png"}
-              ]
-            }
-          }
-      CONFIG
+    context "if event attachments empty" do
+
+      let(:data) { {
+        "message" => "This message should show in slack",
+        "attachments" => []
+      } }
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "attachments" => [
+          {"image_url" => "http://example.com/image1.png"},
+          {"image_url" => "http://example.com/image2.png"}
+        ]
+      } }
+
+      it "erases default attachments" do
+        expected_json = {
+          :text => "This message should show in slack"
+        }
+        test_one_event(event, expected_json)
+      end
+    end
 
-      test_one_event(logstash_config, expected_json)
+    context "when event attachements field isn't an array" do
+      let(:data) { {
+        "message" => "This message should show in slack",
+        "attachments" => "baddata"
+      } }
+
+      let(:config) { {
+        "url" => "http://requestb.in/r9lkbzr9",
+        "attachments" => [
+          {"image_url" => "http://example.com/image.png"}
+        ]
+      } }
+
+
+      it "is ignored" do
+        expected_json = {
+          :text => "This message should show in slack",
+          :attachments => [{:image_url => "http://example.com/image.png"}]
+        }
+        test_one_event(event, expected_json)
+      end
     end
+  end
 
-    it "erases default attachments if event attachments empty" do
-      expected_json = {
-        :text => "This message should show in slack"
-      }
+  describe "interpolation in url field" do
+    let(:expected_url) { "http://incoming-webhook.example.com" }
 
-      # add_field only takes string values, so we'll have to mutate to JSON
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-              add_field => {attachments => '[]'}
-            }
-          }
-          filter {
-            json {
-              source => "attachments"
-              target => "attachments"
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => [
-                {image_url => "http://example.com/image1.png"},
-                {image_url => "http://example.com/image2.png"}
-              ]
-            }
-          }
-      CONFIG
+    let(:event) {
+      event = LogStash::Event.new("message" => "This message should show in slack")
+      event.set("[@metadata][slack_url]", "#{expected_url}")
+      event
+    }
 
-      test_one_event(logstash_config, expected_json)
-    end
+    let(:config) { {
+      "url" => "%{[@metadata][slack_url]}",
+      "attachments" => [
+        {"image_url" => "http://example.com/image.png"}
+      ]
+    } }
 
-    it "ignores event attachment if not array" do
+    it "allows interpolation in url field" do
       expected_json = {
         :text => "This message should show in slack",
         :attachments => [{:image_url => "http://example.com/image.png"}]
       }
-
-      logstash_config = <<-CONFIG
-          input {
-            generator {
-              message => "This message should show in slack"
-              count => 1
-              add_field => {attachments => "baddata"}
-            }
-          }
-          output {
-            slack {
-              url => "http://requestb.in/r9lkbzr9"
-              attachments => [
-                {image_url => "http://example.com/image.png"}
-              ]
-            }
-          }
-      CONFIG
-
-      test_one_event(logstash_config, expected_json)
+      test_one_event(event, expected_json, expected_url)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-slack
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Ying Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.21.0
-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
+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
 email: cyli@ying.com
 executables: []
 extensions: []
@@ -178,7 +180,7 @@ 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: Write events to Slack