fluent-plugin-slack 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abca37bc729bcbae33c6550af3a6a271f979e70d
-  data.tar.gz: d7124e7eed5b0c920bdf0125324683668ff938b2
+  metadata.gz: 184b33be08e986aed0759111ca47da646a170b4d
+  data.tar.gz: 72fb479769709a04b749d4cf6391f4d1fe86b3c9
 SHA512:
-  metadata.gz: b7380082aca202039dee0eef3c69a4c6ee80752245be769c182de7e35dc994967b960c4555cd5658d4b93a53aa5f412d5a75e8f2a8288835a1e7f1f867fc8f49
-  data.tar.gz: c73f180c32d084c5d7d91434b56a94b189ec19722327d7008a406abe5825eb507be84c2c3e149db86640cfce083e56a4001c07534418796b8e541c6e46105e01
+  metadata.gz: ab882482f1f5735a837444220f96ecbc5c68b4b9ff660007c3b4189ef0da812598e2dc8bab147c810a5ff6e2a3724709d95e49f6449ae6a00fb34382d985d7ec
+  data.tar.gz: 2b2f9de2865c86ee853a67a512b998d8e29e39081d95385472511f3303e42f8f7940d31c6d14b63945f8055e0d44b02757f711402def1358e96c3cb9d46c78a7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.6 (2017/05/23)
+
+Enhancements:
+
+* Make channel config optional on webhook because webhook has its defaul channel setting (thanks to @hirakiuc)
+
 ## 0.6.5 (2017/05/20)
 
 Enhancements:

data/VERSION

@@ -1 +1 @@
-0.6.5
+0.6.6

data/example.conf

@@ -1,9 +1,9 @@
 <source>
-  type forward
+  @type forward
 </source>
 
 <match tag> 
-  type slack
+  @type slack
   token "#{ENV['TOKEN']}"
   username fluentd
   color good

data/lib/fluent/plugin/out_slack.rb

@@ -86,7 +86,7 @@ DESC
     config_param :https_proxy,          :string, default: nil
 
     desc "channel to send messages (without first '#')."
-    config_param :channel,              :string
+    config_param :channel,              :string, default: nil
     desc <<-DESC
 Keys used to format channel.
 %s will be replaced with value specified by channel_keys if this option is used.
@@ -130,11 +130,13 @@ DESC
     def configure(conf)
       conf['time_format'] ||= '%H:%M:%S' # old version compatiblity
       conf['localtime'] ||= true unless conf['utc']
- 
+
       super
 
-      @channel = URI.unescape(@channel) # old version compatibility
-      @channel = '#' + @channel unless @channel.start_with?('#')
+      if @channel
+        @channel = URI.unescape(@channel) # old version compatibility
+        @channel = '#' + @channel unless @channel.start_with?('#')
+      end
 
       if @webhook_url
         if @webhook_url.empty?
@@ -148,6 +150,10 @@ DESC
         if @slackbot_url.empty?
           raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
         end
+        if @channel.nil?
+          raise Fluent::ConfigError.new("`channel` parameter required for Slackbot Remote Control")
+        end
+
         if @username or @color or @icon_emoji or @icon_url
           log.warn "out_slack: `username`, `color`, `icon_emoji`, `icon_url` parameters are not available for Slackbot Remote Control"
         end
@@ -159,6 +165,10 @@ DESC
         if @token.empty?
           raise Fluent::ConfigError.new("`token` is an empty string")
         end
+        if @channel.nil?
+          raise Fluent::ConfigError.new("`channel` parameter required for Slack WebApi")
+        end
+
         @slack = Fluent::SlackClient::WebApi.new
       else
         raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
@@ -184,7 +194,7 @@ DESC
           raise Fluent::ConfigError, "string specifier '%s' for `title` and `title_keys` specification mismatch"
         end
       end
-      if @channel_keys
+      if @channel && @channel_keys
         begin
           @channel % (['1'] * @channel_keys.length)
         rescue ArgumentError
@@ -288,13 +298,14 @@ DESC
                           fields.values.map(&:title).join(' ')
                         end
 
-        {
-          channel: channel,
+        msg = {
           attachments: [{
             :fallback => fallback_text, # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
           }.merge(common_attachment)],
-        }.merge(common_payload)
+        }
+        msg.merge!(channel: channel) if channel
+        msg.merge!(common_payload)
       end
     end
 
@@ -306,13 +317,14 @@ DESC
         messages[channel] << "#{build_message(record)}\n"
       end
       messages.map do |channel, text|
-        {
-          channel: channel,
+        msg = {
           attachments: [{
             :fallback => text,
             :text     => text,
           }.merge(common_attachment)],
-        }.merge(common_payload)
+        }
+        msg.merge!(channel: channel) if channel
+        msg.merge!(common_payload)
       end
     end
 
@@ -324,10 +336,9 @@ DESC
         messages[channel] << "#{build_message(record)}\n"
       end
       messages.map do |channel, text|
-        {
-          channel: channel,
-          text:    text,
-        }.merge(common_payload)
+        msg = {text: text}
+        msg.merge!(channel: channel) if channel
+        msg.merge!(common_payload)
       end
     end
 
@@ -344,6 +355,7 @@ DESC
     end
 
     def build_channel(record)
+      return nil if @channel.nil?
       return @channel unless @channel_keys
 
       values = fetch_keys(record, @channel_keys)

data/test/plugin/test_out_slack.rb

@@ -114,15 +114,30 @@ class SlackOutputTest < Test::Unit::TestCase
       create_driver(%[channel foo\nwebhook_url])
     end
 
-    # webhook_url is an empty string
+    # webhook without channel (it works because webhook has a default channel)
+    assert_nothing_raised do
+      create_driver(%[webhook_url https://example.com/path/to/webhook])
+    end
+
+    # slackbot_url is an empty string
     assert_raise(Fluent::ConfigError) do
       create_driver(%[channel foo\nslackbot_url])
     end
 
+    # slackbot without channel
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[slackbot_url https://example.com/path/to/slackbot])
+    end
+
     # token is an empty string
     assert_raise(Fluent::ConfigError) do
       create_driver(%[channel foo\ntoken])
     end
+
+    # slack webapi token without channel
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[token some_token])
+    end
   end
 
   def test_timezone_configure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd