fluent-plugin-slack 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad20f86b455e8ca489fe6ed2be1aea310505174d
-  data.tar.gz: 6a8410c533109fd41cc92c8ee3008841536264f9
+  metadata.gz: f75a082b3fc4e977a269cd78744064139e102945
+  data.tar.gz: c9a28cc8cfafa9b4bb80522b2b6261de9b4af55a
 SHA512:
-  metadata.gz: 132d099d24bfe70cb2aa297f2a63ec987981b120e27328d51137896ec2f3b685d7074cefefdcd3ac042fa44ca72ff9a01ba90b6899d0d3f81c3b49a30023d243
-  data.tar.gz: d8a789673b0f0c8e68c39abe231a313366c8f1f8e2cd8d24eb26c8022160b72041c83c0b584ba9f2b361f52a56444bd0e43e7cad8ade9fdd760671756607b84c
+  metadata.gz: fc23d99226fe190408dbbb144325a90de7d19af07d67ab54544170059124cb1c6e03b68610aa4e976abeeca47cafc12b4d5120e8c67ff8f7301157d199911114
+  data.tar.gz: 1eca5ba6bac83f01942b4aec43a24327b5c50d04cdf964c0478dec2d0ce2afbcecea49d492bfc0061a1478186f33aabbad3512afdd43984020fb82e80c818561

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.5 (2015/04/01)
+
+Enhancements:
+
+* Support Slackbot Remote Control API
+
 ## 0.5.4 (2015/03/31)
 
 Enhancements:

data/README.md

@@ -26,6 +26,23 @@ fluent_logger.post('slack', {
 })
 ```
 
+# Usage (Slackbot)
+
+```apache
+<match slack>
+  type slack
+  slackbot_url https://xxxx.slack.com/services/hooks/slackbot?token=XXXXXXXXX
+  channel general
+  flush_interval 60s
+</match>
+```
+
+```ruby
+fluent_logger.post('slack', {
+  :message  => 'Hello<br>World!'
+})
+```
+
 # Usage (Web API)
 
 ```apache
@@ -50,8 +67,9 @@ fluent_logger.post('slack', {
 
 |parameter|description|default|
 |---|---|---|
-|webhook_url|Incoming Webhook URI (Required for Incoming Webhook mode)||
-|token|Token for Web API (Required for Web API mode)||
+|webhook_url|Incoming Webhook URI (Required for Incoming Webhook mode). See https://api.slack.com/incoming-webhooks||
+|slackbot_url|Slackbot URI (Required for Slackbot mode). See https://api.slack.com/slackbot. `username`, `color`, `icon_emoji`, `icon_url` are not available for this mode, but Desktop Notification via Highlight Words works with only this mode (Notification via Mentions works from Incoming Webhook and Web API with link_names=1, but Notification via Highlight Words does not)||
+|token|Token for Web API (Required for Web API mode). See https://api.slack.com/web||
 |username|name of bot|fluentd|
 |color|color to use|good|
 |icon_emoji|emoji to use as the icon. either of icon_emoji or icon_url can be specified|`:question:`|
@@ -63,7 +81,7 @@ fluent_logger.post('slack', {
 |title_keys|keys used to format the title|nil|
 |message|message format. %s will be replaced with value specified by message_keys|%s|
 |message_keys|keys used to format messages|message|
-|auto_channels_create|Create channels if not exist. Available only with Web API mode, and a token for Normal User is required (Bot User can not create channels. See https://api.slack.com/bot-users)|false|
+|auto_channels_create|Create channels if not exist. Not available for Incoming Webhook mode (since Incoming Webhook is specific to a channel). A web api `token` for Normal User is required (Bot User can not create channels. See https://api.slack.com/bot-users)|false|
 |https_proxy|https proxy url such as `https://proxy.foo.bar:443`|nil|
 
 `fluent-plugin-slack` uses `SetTimeKeyMixin` and `SetTagKeyMixin`, so you can also use:

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.5.5

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -12,6 +12,7 @@ module Fluent
     config_set_default :include_tag_key, true
    
     config_param :webhook_url,          :string, default: nil # incoming webhook
+    config_param :slackbot_url,         :string, default: nil # slackbot
     config_param :token,                :string, default: nil # api token
     config_param :username,             :string, default: 'fluentd'
     config_param :color,                :string, default: 'good'
@@ -61,6 +62,13 @@ module Fluent
         @message       ||= '[%s] %s'
         @message_keys  ||= %w[time message]
         @slack = Fluent::SlackClient::IncomingWebhook.new(@webhook_url)
+      elsif @slackbot_url
+        if @slackbot_url.empty?
+          raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
+        end
+        @message      ||= '%s'
+        @message_keys ||= %w[message]
+        @slack = Fluent::SlackClient::Slackbot.new(@slackbot_url)
       elsif @token
         if @token.empty?
           raise Fluent::ConfigError.new("`token` is an empty string")
@@ -69,7 +77,7 @@ module Fluent
         @message_keys ||= %w[message]
         @slack = Fluent::SlackClient::WebApi.new
       else
-        raise Fluent::ConfigError.new("Either of `webhook_url` or `token` is required")
+        raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
       end
       @slack.log = log
       @slack.debug_dev = log.out if log.level <= Fluent::Log::LEVEL_TRACE

data/lib/fluent/plugin/out_slack.rb

@@ -12,6 +12,7 @@ module Fluent
     config_set_default :include_tag_key, true
    
     config_param :webhook_url,          :string, default: nil # incoming webhook
+    config_param :slackbot_url,         :string, default: nil # slackbot
     config_param :token,                :string, default: nil # api token
     config_param :username,             :string, default: 'fluentd'
     config_param :color,                :string, default: 'good'
@@ -61,6 +62,13 @@ module Fluent
         @message       ||= '[%s] %s'
         @message_keys  ||= %w[time message]
         @slack = Fluent::SlackClient::IncomingWebhook.new(@webhook_url)
+      elsif @slackbot_url
+        if @slackbot_url.empty?
+          raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
+        end
+        @message      ||= '%s'
+        @message_keys ||= %w[message]
+        @slack = Fluent::SlackClient::Slackbot.new(@slackbot_url)
       elsif @token
         if @token.empty?
           raise Fluent::ConfigError.new("`token` is an empty string")
@@ -69,7 +77,7 @@ module Fluent
         @message_keys ||= %w[message]
         @slack = Fluent::SlackClient::WebApi.new
       else
-        raise Fluent::ConfigError.new("Either of `webhook_url` or `token` is required")
+        raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
       end
       @slack.log = log
       @slack.debug_dev = log.out if log.level <= Fluent::Log::LEVEL_TRACE

data/lib/fluent/plugin/slack_client.rb

@@ -16,6 +16,9 @@ module Fluent
       #     (Incoming Webhook) required
       #     https://hooks.slack.com/services/XXX/XXX/XXX
       #
+      #     (Slackbot) required
+      #     https://xxxx.slack.com/services/hooks/slackbot?token=XXXXX
+      #
       #     (Web API) optional and default to be
       #     https://slack.com/api/
       #
@@ -48,7 +51,7 @@ module Fluent
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         http.set_debug_output(debug_dev) if debug_dev
 
-        req = Net::HTTP::Post.new(endpoint.path)
+        req = Net::HTTP::Post.new(endpoint)
         req['Host'] = endpoint.host
         req['Accept'] = 'application/json; charset=utf-8'
         req['User-Agent'] = 'fluent-plugin-slack'
@@ -69,13 +72,38 @@ module Fluent
           raise Error.new(res, params)
         end
       end
+
+      def filter_params(params)
+        params.dup.tap {|p| p[:token] = '[FILTERED]' if p[:token] }
+      end
+
+      # Required to implement to use #with_channels_create
+      # channels.create API is available from only Slack Web API
+      def api
+        raise NotImplementedError
+      end
+
+      def with_channels_create(params = {}, opts = {})
+        retries = 1
+        begin
+          yield
+        rescue ChannelNotFoundError => e
+          if params[:token] and opts[:auto_channels_create]
+            log.warn "out_slack: channel \"#{params[:channel]}\" is not found. try to create the channel, and then retry to post the message."
+            api.channels_create({name: params[:channel], token: params[:token]})
+            retry if (retries -= 1) >= 0 # one time retry
+          else
+            raise e
+          end
+        end
+      end
     end
 
     # Slack client for Incoming Webhook
+    # https://api.slack.com/incoming-webhooks
     class IncomingWebhook < Base
-      def endpoint
-        return @endpoint if @endpoint
-        raise ArgumentError, "Incoming Webhook endpoint is not configured"
+      def initialize(endpoint, https_proxy = nil)
+        super
       end
 
       def post_message(params = {}, opts = {})
@@ -97,10 +125,71 @@ module Fluent
       end
     end
 
+    # Slack client for Slackbot Remote Control
+    # https://api.slack.com/slackbot
+    class Slackbot < Base
+      def initialize(endpoint, https_proxy = nil)
+        super
+      end
+
+      def api
+        @api ||= WebApi.new(nil, https_proxy)
+      end
+
+      def post_message(params = {}, opts = {})
+        raise ArgumentError, "channel parameter is required" unless params[:channel]
+        with_channels_create(params, opts) do
+          log.info { "out_slack: post_message #{filter_params(params)}" }
+          post(slackbot_endpoint(params), params)
+        end
+      end
+
+      private
+
+      def slackbot_endpoint(params)
+        endpoint.dup.tap {|e| e.query += "&channel=#{URI.encode(params[:channel])}" }
+      end
+
+      def encode_body(params = {})
+        raise ArgumentError, 'params[:attachments] is required' unless params[:attachments]
+        attachment = Array(params[:attachments]).first # let me see only the first for now
+        # {
+        #   attachments: [{
+        #     text: "HERE",
+        #   }]
+        # }
+        text = attachment[:text]
+        # {
+        #   attachments: [{
+        #     fields: [{
+        #       title: "title",
+        #       value: "HERE",
+        #     }]
+        #   }]
+        # }
+        if text.nil? and attachment[:fields]
+          text = Array(attachment[:fields]).first[:value] # let me see only the first for now
+        end
+        text
+      end
+
+      def response_check(res, params)
+        if res.body == 'channel_not_found'
+          raise ChannelNotFoundError.new(res, params)
+        elsif res.body != 'ok'
+          raise Error.new(res, params)
+        end
+      end
+    end
+
     # Slack client for Web API
     class WebApi < Base
       DEFAULT_ENDPOINT = "https://slack.com/api/".freeze
 
+      def api
+        self
+      end
+
       def endpoint
         @endpoint ||= URI.parse(DEFAULT_ENDPOINT)
       end
@@ -119,18 +208,9 @@ module Fluent
       # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.md
       # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.json
       def post_message(params = {}, opts = {})
-        retries = 1
-        begin
-          log.info { "out_slack: post_message #{params.dup.tap {|p| p[:token] = '[FILTERED]' if p[:token] }}" }
+        with_channels_create(params, opts) do
+          log.info { "out_slack: post_message #{filter_params(params)}" }
           post(post_message_endpoint, params)
-        rescue ChannelNotFoundError => e
-          if opts[:auto_channels_create]
-            log.warn "out_slack: channel \"#{params[:channel]}\" is not found. try to create the channel, and then retry to post the message."
-            channels_create({name: params[:channel], token: params[:token]})
-            retry if (retries -= 1) >= 0 # one time retry
-          else
-            raise e
-          end
         end
       end
 
@@ -143,7 +223,7 @@ module Fluent
       # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.md
       # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.json
       def channels_create(params = {}, opts = {})
-        log.info { "out_slack: channels_create #{params.dup.tap {|p| p[:token] = '[FILTERED]' if p[:token] }}" }
+        log.info { "out_slack: channels_create #{filter_params(params)}" }
         post(channels_create_endpoint, params)
       end
 

data/test/plugin/test_out_slack.rb

@@ -85,7 +85,7 @@ class SlackOutputTest < Test::Unit::TestCase
       create_driver(CONFIG + %[channel %s %s\nchannel_keys foo])
     end
 
-    # Either of webhook_url or token is required
+    # One of webhook_url or slackbot_url, or token is required
     assert_raise(Fluent::ConfigError) do
       create_driver(%[channel foo])
     end
@@ -95,6 +95,11 @@ class SlackOutputTest < Test::Unit::TestCase
       create_driver(%[channel foo\nwebhook_url])
     end
 
+    # webhook_url is an empty string
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[channel foo\nslackbot_url])
+    end
+
     # token is an empty string
     assert_raise(Fluent::ConfigError) do
       create_driver(%[channel foo\ntoken])
@@ -189,6 +194,7 @@ class SlackOutputTest < Test::Unit::TestCase
       channel channel
       webhook_url https://hooks.slack.com/services/XXX/XXX/XXX
     ])
+    assert_equal Fluent::SlackClient::IncomingWebhook, d.instance.slack.class
     time = Time.parse("2014-01-01 22:00:00 UTC").to_i
     d.tag  = 'test'
     mock(d.instance.slack).post_message({
@@ -211,11 +217,37 @@ class SlackOutputTest < Test::Unit::TestCase
     end
   end
 
+  def test_default_slackbot
+    d = create_driver(%[
+      channel channel
+      slackbot_url https://xxxxx.slack.com/services/hooks/slackbot?token=XXXXXXX
+    ])
+    assert_equal Fluent::SlackClient::Slackbot, d.instance.slack.class
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message({
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "sowawa1\nsowawa2\n",
+        text:     "sowawa1\nsowawa2\n",
+      }]
+    }, {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
   def test_default_slack_api
     d = create_driver(%[
       channel channel
       token   XX-XX-XX
     ])
+    assert_equal Fluent::SlackClient::WebApi, d.instance.slack.class
     time = Time.parse("2014-01-01 22:00:00 UTC").to_i
     d.tag  = 'test'
     mock(d.instance.slack).post_message({

data/test/plugin/test_slack_client.rb

@@ -13,7 +13,7 @@ require 'webrick/httpproxy'
 #     TOKEN=XXXXX
 #
 Dotenv.load
-if ENV['WEBHOOK_URL'] and ENV['TOKEN']
+if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
 
   class TestProxyServer
     def initialize
@@ -49,11 +49,14 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
   class SlackClientTest < Test::Unit::TestCase
     def setup
       super
-      @proxy = TestProxyServer.new.tap {|proxy| proxy.start }
-      @incoming_webhook = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'])
-      @api = Fluent::SlackClient::WebApi.new
-      @incoming_webhook_proxy = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'], @proxy.proxy_url)
-      @api_proxy = Fluent::SlackClient::WebApi.new(nil, @proxy.proxy_url)
+      @incoming       = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'])
+      @slackbot       = Fluent::SlackClient::Slackbot.new(ENV['SLACKBOT_URL'])
+      @api            = Fluent::SlackClient::WebApi.new
+
+      @proxy          = TestProxyServer.new.tap {|proxy| proxy.start }
+      @incoming_proxy = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'], @proxy.proxy_url)
+      @slackbot_proxy = Fluent::SlackClient::Slackbot.new(ENV['SLACKBOT_URL'], @proxy.proxy_url)
+      @api_proxy      = Fluent::SlackClient::WebApi.new(nil, @proxy.proxy_url)
 
       @icon_url = 'http://www.google.com/s2/favicons?domain=www.google.de'
     end
@@ -63,11 +66,11 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
     end
 
     def token(client)
-      client.is_a?(Fluent::SlackClient::WebApi) ? {token: ENV['TOKEN']} : {}
+      client.is_a?(Fluent::SlackClient::IncomingWebhook) ? {} : {token: ENV['TOKEN']}
     end
 
     def test_post_message_text
-      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
+      [@incoming, @slackbot, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -86,7 +89,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
     end
 
     def test_post_message_fields
-      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
+      [@incoming, @slackbot, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -113,8 +116,27 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       end
     end
 
+    def test_post_via_proxy
+      [@incoming_proxy, @slackbot_proxy, @api_proxy].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              icon_emoji:  ':question:',
+              attachments: [{
+                color:    'good',
+                fallback: "sowawa1\nsowawa2\n",
+                text:     "sowawa1\nsowawa2\n",
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+
     def test_post_message_icon_url
-      [@incoming_webhook, @api].each do |slack|
+      [@incoming, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -133,7 +155,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
     end
 
     def test_post_message_text_mrkdwn
-      [@incoming_webhook, @api].each do |slack|
+      [@incoming, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -152,7 +174,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
     end
 
     def test_post_message_fields_mrkdwn
-      [@incoming_webhook, @api].each do |slack|
+      [@incoming, @api].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -181,7 +203,7 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       begin
         @api.channels_create(
           {
-            name: '#foo',
+            name: '#test_channels_create',
           }.merge(token(@api))
         )
       rescue Fluent::SlackClient::NameTakenError
@@ -194,7 +216,25 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       assert_nothing_raised do
         @api.post_message(
           {
-            channel:     '#bar',
+            channel:     '#test_auto_api',
+            username:    'fluentd',
+            icon_emoji:  ':question:',
+            attachments: [{
+              color:    'good',
+              fallback: "bar\n",
+              text:     "bar\n",
+            }]
+          }.merge(token(@api)),
+          {
+            auto_channels_create: true,
+          }
+        )
+      end
+
+      assert_nothing_raised do
+        @slackbot.post_message(
+          {
+            channel:     '#test_auto_slackbot',
             username:    'fluentd',
             icon_emoji:  ':question:',
             attachments: [{

metadata

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