fluent-plugin-slack 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63fd1c619f76e7bb3df9b2ff11e69af43e23f810
-  data.tar.gz: 8fd2eb0e8790c71c8689ae88e42f8a4bae3f1d3b
+  metadata.gz: 1e923290cae0a22d361507caceed0cbd717effac
+  data.tar.gz: e91f21aec9e58b4a32ae9795273f66eba888dcbc
 SHA512:
-  metadata.gz: bf331ec94a09e572f2aa1c958842634195dad9078cc7fbf86813c121d88ddeb69568617663cf2012151646c52c6ec64203f95b3738348937bc0b8a417c6da976
-  data.tar.gz: c16e8a479300bc03539232a4d76d172d7eaa8c0d0e640612424fa483f2b7abd4510de6a3fee5b55d0eb2b70a395cc1a65d2425e3eb62c0e7a1058d9be3418d66
+  metadata.gz: de4ddc0641fa1c3d1249ea79869376866caceabf93901fb2b8c855d9de041e05009191c6c0fa63715136503fb5f8f0d55eb9ca389a0ceec85d2d22a12357f56b
+  data.tar.gz: dcabceb85494457fc1644da528257bc34275e164e6d3a1e5ae0326a011f3927f897320577f5c91aa45f8add882449461b97430934b1b1fc0cf195a37df490393

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.2 (2015/03/29)
+
+Enhancements:
+
+* Support `icon_url` option (thanks to @jwyjoy)
+
 ## 0.5.1 (2015/03/27)
 
 Enhancements:

data/README.md

@@ -54,7 +54,8 @@ fluent_logger.post('slack', {
 |token|Token for Web API (Required for Web API mode)||
 |username|name of bot|fluentd|
 |color|color to use|good|
-|icon_emoji|emoji to use as the icon|`:question:`|
+|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|
 |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.1
+0.5.2

data/example.conf

@@ -7,7 +7,8 @@
   token "#{ENV['TOKEN']}"
   username fluentd
   color good
-  icon_emoji :ghost:
+  icon_emoji :ghost: # if you want to use icon_url, delete this param.
+  #icon_url http://www.google.com/s2/favicons?domain=www.google.de
   channel general
   message %s %s
   message_keys tag,message

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -15,7 +15,8 @@ module Fluent
     config_param :token,                :string, default: nil # api token
     config_param :username,             :string, default: 'fluentd'
     config_param :color,                :string, default: 'good'
-    config_param :icon_emoji,           :string, default: ':question:'
+    config_param :icon_emoji,           :string, default: nil
+    config_param :icon_url,             :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
 
     config_param :channel,              :string
@@ -91,6 +92,11 @@ module Fluent
         end
       end
 
+      if @icon_emoji and @icon_url
+        raise Fluent::ConfigError, "either of `icon_emoji` or `icon_url` can be specified"
+      end
+      @icon_emoji ||= ':question:' unless @icon_url
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -124,11 +130,11 @@ module Fluent
 
     def common_payload
       return @common_payload if @common_payload
-      @common_payload = {
-        username:   @username,
-        icon_emoji: @icon_emoji,
-      }
-      @common_payload[:token] = @token if @token
+      @common_payload = {}
+      @common_payload[:username]   = @username
+      @common_payload[:icon_emoji] = @icon_emoji if @icon_emoji
+      @common_payload[:icon_url]   = @icon_url   if @icon_url
+      @common_payload[:token]      = @token      if @token
       @common_payload
     end
 

data/lib/fluent/plugin/out_slack.rb

@@ -15,7 +15,8 @@ module Fluent
     config_param :token,                :string, default: nil # api token
     config_param :username,             :string, default: 'fluentd'
     config_param :color,                :string, default: 'good'
-    config_param :icon_emoji,           :string, default: ':question:'
+    config_param :icon_emoji,           :string, default: nil
+    config_param :icon_url,             :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
 
     config_param :channel,              :string
@@ -91,6 +92,11 @@ module Fluent
         end
       end
 
+      if @icon_emoji and @icon_url
+        raise Fluent::ConfigError, "either of `icon_emoji` or `icon_url` can be specified"
+      end
+      @icon_emoji ||= ':question:' unless @icon_url
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -124,11 +130,11 @@ module Fluent
 
     def common_payload
       return @common_payload if @common_payload
-      @common_payload = {
-        username:   @username,
-        icon_emoji: @icon_emoji,
-      }
-      @common_payload[:token] = @token if @token
+      @common_payload = {}
+      @common_payload[:username]   = @username
+      @common_payload[:icon_emoji] = @icon_emoji if @icon_emoji
+      @common_payload[:icon_url]   = @icon_url   if @icon_url
+      @common_payload[:token]      = @token      if @token
       @common_payload
     end
 

data/test/plugin/test_out_slack.rb

@@ -7,6 +7,7 @@ class SlackOutputTest < Test::Unit::TestCase
   def setup
     super
     Fluent::Test.setup
+    @icon_url = 'http://www.google.com/s2/favicons?domain=www.google.de'
   end
 
   CONFIG = %[
@@ -137,6 +138,28 @@ class SlackOutputTest < Test::Unit::TestCase
     end
   end
 
+  def test_icon_configure
+    # default
+    d = create_driver(CONFIG)
+    assert_equal ':question:', d.instance.icon_emoji
+    assert_equal nil, d.instance.icon_url
+
+    # either of icon_emoji or icon_url can be specified
+    assert_raise(Fluent::ConfigError) do
+      d = create_driver(CONFIG + %[icon_emoji :ghost:\nicon_url #{@icon_url}])
+    end
+
+    # icon_emoji
+    d = create_driver(CONFIG + %[icon_emoji :ghost:])
+    assert_equal ':ghost:', d.instance.icon_emoji
+    assert_equal nil, d.instance.icon_url
+
+    # icon_url
+    d = create_driver(CONFIG + %[icon_url #{@icon_url}])
+    assert_equal nil, d.instance.icon_emoji
+    assert_equal @icon_url, d.instance.icon_url
+  end
+
   def test_default_incoming_webhook
     d = create_driver(%[
       channel channel
@@ -271,4 +294,46 @@ class SlackOutputTest < Test::Unit::TestCase
       d.run
     end
   end
+
+  def test_icon_emoji
+    d = create_driver(CONFIG + %[icon_emoji :ghost:])
+    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:  ':ghost:',
+      attachments: [{
+        color:    'good',
+        fallback: "foo\n",
+        text:     "foo\n",
+      }]
+    }, {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
+
+  def test_icon_url
+    d = create_driver(CONFIG + %[icon_url #{@icon_url}])
+    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_url:    @icon_url,
+      attachments: [{
+        color:    'good',
+        fallback: "foo\n",
+        text:     "foo\n",
+      }]
+    }, {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
 end

data/test/plugin/test_slack_client.rb

@@ -17,6 +17,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       super
       @incoming_webhook = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'])
       @api = Fluent::SlackClient::WebApi.new
+      @icon_url = 'http://www.google.com/s2/favicons?domain=www.google.de'
     end
 
     def token(client)
@@ -42,27 +43,18 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       end
     end
 
-    def test_post_message_fields
+    def test_post_message_icon_url
       [@incoming_webhook, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
               channel:     '#general',
               username:    'fluentd',
-              icon_emoji:  ':question:',
+              icon_url:    @icon_url,
               attachments: [{
                 color:    'good',
-                fallback: 'test1 test2',
-                fields:   [
-                  {
-                    title: 'test1',
-                    value: "[07:00:00] sowawa1\n[07:00:00] sowawa2\n",
-                  },
-                  {
-                    title: 'test2',
-                    value: "[07:00:00] sowawa1\n[07:00:00] sowawa2\n",
-                  },
-                ],
+                fallback: "sowawa1\nsowawa2\n",
+                text:     "sowawa1\nsowawa2\n",
               }]
             }.merge(token(slack))
           )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd