fluent-plugin-slack 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60f17d6deefe9660f802349100a06f0dbb52be82
-  data.tar.gz: 6be0620df5d0e4e573f2ecb315e5e5134a511587
+  metadata.gz: ad20f86b455e8ca489fe6ed2be1aea310505174d
+  data.tar.gz: 6a8410c533109fd41cc92c8ee3008841536264f9
 SHA512:
-  metadata.gz: 754e0d821c9d4a62e885bc0c48298edfc5a3d60b3780e9c5b1321d1a5ca46eb19569bf39abd072dd6535b865dba6c5471cfa427f50a4a891e68a9c2c98c16161
-  data.tar.gz: ca145ab4794d3610ad727453b0013ffe2e18544a6a12a0189bb6cfeb0a11fe58f25e321bad7bcffab33957c1f7b9be306ec44b2b717ff902639d6aed46c41243
+  metadata.gz: 132d099d24bfe70cb2aa297f2a63ec987981b120e27328d51137896ec2f3b685d7074cefefdcd3ac042fa44ca72ff9a01ba90b6899d0d3f81c3b49a30023d243
+  data.tar.gz: d8a789673b0f0c8e68c39abe231a313366c8f1f8e2cd8d24eb26c8022160b72041c83c0b584ba9f2b361f52a56444bd0e43e7cad8ade9fdd760671756607b84c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.4 (2015/03/31)
+
+Enhancements:
+
+* Support `mrkdwn` option
+
 ## 0.5.3 (2015/03/29)
 
 Enhancements:

data/README.md

@@ -56,6 +56,7 @@ fluent_logger.post('slack', {
 |color|color to use|good|
 |icon_emoji|emoji to use as the icon. either of icon_emoji or icon_url can be specified|`:question:`|
 |icon_url|url to an image to use as the icon. either of icon_emoji or icon_url can be specified|nil|
+|mrkdwn|enable formatting. see https://api.slack.com/docs/formatting|false|
 |channel|channel to send messages (without first '#')||
 |channel_keys|keys used to format channel. %s will be replaced with value specified by channel_keys if this option is used|nil|
 |title|title format. %s will be replaced with value specified by title_keys. title is created from the first appeared record on each tag|nil|

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -17,6 +17,7 @@ module Fluent
     config_param :color,                :string, default: 'good'
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
+    config_param :mrkdwn,               :bool,   default: false
     config_param :auto_channels_create, :bool,   default: false
     config_param :https_proxy,          :string, default: nil
 
@@ -34,7 +35,7 @@ module Fluent
     end
 
     # for test
-    attr_reader :slack, :time_format, :localtime, :timef
+    attr_reader :slack, :time_format, :localtime, :timef, :mrkdwn_in
 
     def initialize
       super
@@ -102,6 +103,11 @@ module Fluent
       end
       @icon_emoji ||= ':question:' unless @icon_url
 
+      if @mrkdwn
+        # Enable markdown for attachments. See https://api.slack.com/docs/formatting
+        @mrkdwn_in = %w[text fields]
+      end
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -143,6 +149,13 @@ module Fluent
       @common_payload
     end
 
+    def common_attachment
+      return @common_attachment if @common_attachment
+      @common_attachment = {}
+      @common_attachment[:mrkdwn_in]  = @mrkdwn_in  if @mrkdwn_in
+      @common_attachment
+    end
+
     Field = Struct.new("Field", :title, :value)
 
     def build_title_payloads(chunk)
@@ -161,7 +174,7 @@ module Fluent
             :color    => @color,
             :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
-          }],
+          }.merge(common_attachment)],
         }.merge(common_payload)
       end
     end
@@ -180,7 +193,7 @@ module Fluent
             :color    => @color,
             :fallback => text,
             :text     => text,
-          }],
+          }.merge(common_attachment)],
         }.merge(common_payload)
       end
     end

data/lib/fluent/plugin/out_slack.rb

@@ -17,6 +17,7 @@ module Fluent
     config_param :color,                :string, default: 'good'
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
+    config_param :mrkdwn,               :bool,   default: false
     config_param :auto_channels_create, :bool,   default: false
     config_param :https_proxy,          :string, default: nil
 
@@ -34,7 +35,7 @@ module Fluent
     end
 
     # for test
-    attr_reader :slack, :time_format, :localtime, :timef
+    attr_reader :slack, :time_format, :localtime, :timef, :mrkdwn_in
 
     def initialize
       super
@@ -102,6 +103,11 @@ module Fluent
       end
       @icon_emoji ||= ':question:' unless @icon_url
 
+      if @mrkdwn
+        # Enable markdown for attachments. See https://api.slack.com/docs/formatting
+        @mrkdwn_in = %w[text fields]
+      end
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -143,6 +149,13 @@ module Fluent
       @common_payload
     end
 
+    def common_attachment
+      return @common_attachment if @common_attachment
+      @common_attachment = {}
+      @common_attachment[:mrkdwn_in]  = @mrkdwn_in  if @mrkdwn_in
+      @common_attachment
+    end
+
     Field = Struct.new("Field", :title, :value)
 
     def build_title_payloads(chunk)
@@ -161,7 +174,7 @@ module Fluent
             :color    => @color,
             :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
-          }],
+          }.merge(common_attachment)],
         }.merge(common_payload)
       end
     end
@@ -180,7 +193,7 @@ module Fluent
             :color    => @color,
             :fallback => text,
             :text     => text,
-          }],
+          }.merge(common_attachment)],
         }.merge(common_payload)
       end
     end

data/test/plugin/test_out_slack.rb

@@ -172,6 +172,18 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_not_equal Net::HTTP, d.instance.slack.proxy_class # Net::HTTP.Proxy
   end
 
+  def test_mrkwn_configure
+    # default
+    d = create_driver(CONFIG)
+    assert_equal false, d.instance.mrkdwn
+    assert_equal nil, d.instance.mrkdwn_in
+
+    # mrkdwn
+    d = create_driver(CONFIG + %[mrkdwn true])
+    assert_equal true, d.instance.mrkdwn
+    assert_equal %w[text fields], d.instance.mrkdwn_in
+  end
+
   def test_default_incoming_webhook
     d = create_driver(%[
       channel channel
@@ -242,7 +254,7 @@ class SlackOutputTest < Test::Unit::TestCase
             title: d.tag,
             value: "sowawa1\nsowawa2\n",
           }
-        ]
+        ],
       }]
     }, {})
     with_timezone('Asia/Tokyo') do
@@ -348,4 +360,26 @@ class SlackOutputTest < Test::Unit::TestCase
       d.run
     end
   end
+
+  def test_mrkdwn
+    d = create_driver(CONFIG + %[mrkdwn true])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message({
+      token:       'XXX-XXX-XXX',
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "foo\n",
+        text:     "foo\n",
+        mrkdwn_in: ["text", "fields"],
+      }]
+    }, {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
 end

data/test/plugin/test_slack_client.rb

@@ -114,7 +114,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
     end
 
     def test_post_message_icon_url
-      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
+      [@incoming_webhook, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -132,6 +132,49 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       end
     end
 
+    def test_post_message_text_mrkdwn
+      [@incoming_webhook, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              attachments: [{
+                color:    'good',
+                fallback: "plain *bold* _italic_ `preformat`\n", # mrkdwn not work
+                text:     "plain *bold* _italic_ `preformat`\n",
+                mrkdwn_in: ['text', 'fields'],
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+
+    def test_post_message_fields_mrkdwn
+      [@incoming_webhook, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              attachments: [{
+                color:    'good',
+                fallback: "plain *bold* _italic_ `preformat`\n", # mrkdwn not work
+                fields:   [
+                  {
+                    title: 'plain *bold* _italic* `preformat`', # mrkdwn not work
+                    value: "plain *bold* _italic* `preformat`\n",
+                  },
+                ],
+                mrkdwn_in: ['text', 'fields'],
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+
     # Hmm, I need to delete channels to test repeatedly,
     # but slack does not provide channels.delete API
     def test_channels_create

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: fluent Slack plugin