fluent-plugin-slack 0.2.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b835ec9f32cc25b75bd4e0a18d7aa52097ff61e
+  data.tar.gz: 21a5be237380dc845f1ead2dad7e547500d88c19
+SHA512:
+  metadata.gz: 7e36906812d93f8887a0994209c7efecf432b71e85e75cbc3b0fa9e7660c2dea8f04fc0eba411a35a11671d28c9d55ed646e153e408e71f5b9ffe79934b42578
+  data.tar.gz: 7090cf28cbf42af855170144a1c9b446837704f3f84d5c6340a9e9b1d3d86b9dce7f50a76c90d3773da22dbfa9cc68491404b86f94f35c5aebb2afc3738e79c2

data/README.rdoc

@@ -8,11 +8,32 @@
 
     <match slack>
       type buffered_slack
-      api_key XXX
+      webhook_url https://hooks.slack.com/services/XXX/XXX/XXX
+      team sowa
       channel %23general # You should use %23 in return for #
       username sowasowa
       color good
       icon_emoji :ghost:
+      buffer_path /path/to/tmp
+      flush_interval 60s
+    </match>
+
+    fluent_logger.post('buffered_slack', {
+      :message  => 'Hello<br>World!'
+    })
+
+= Usage(rtm)
+
+    <match slack>
+      type buffered_slack
+      rtm true
+      token xoxb-XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXX
+      channel %23general # You should use %23 in return for #
+      username sowasowa
+      color good
+      icon_emoji :ghost:
+      buffer_path /path/to/tmp
+      flush_interval 60s
     </match>
 
     fluent_logger.post('buffered_slack', {

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.4.0

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -2,13 +2,16 @@ module Fluent
   class BufferedSlackOutputError < StandardError; end
   class BufferedSlackOutput < Fluent::TimeSlicedOutput
     Fluent::Plugin.register_output('buffered_slack', self)
-    config_param :api_key,    :string
-    config_param :team,       :string
+    config_param :api_key,    :string, default: nil
+    config_param :token,      :string, default: nil
+    config_param :team,       :string, default: nil
     config_param :channel,    :string
     config_param :username,   :string
     config_param :color,      :string
     config_param :icon_emoji, :string
     config_param :timezone,   :string, default: nil
+    config_param :rtm,        :bool  , default: false
+    config_param :webhook_url,:string, default: nil
 
     attr_reader :slack
 
@@ -23,18 +26,35 @@ module Fluent
         messages[tag] << "[#{Time.at(time).in_time_zone(@timezone).strftime("%H:%M:%S")}] #{record['message']}\n"
       end
       begin
-        payload = {
-          channel:      @channel,
-            username:   @username,
-            icon_emoji: @icon_emoji,
-            attachments: [{
-              fallback: messages.keys.join(','),
-              color:    @color,
-              fields:   messages.map{|k,v| {title: k, value: v} }
-            }]}
-        post_request(
-          payload: payload.to_json
-        )
+
+        # https://api.slack.com/rtm
+        if @rtm
+          params = {
+            :token       => @token,
+            :channel     => @channel,
+            :text        => messages.values,
+            :username    => @username,
+            :icon_emoji  => @icon_emoji,
+            :attachments => [{
+              :color  => @color,
+              :text   => messages.values
+            }].to_json
+          }
+          get_request(params)
+        else
+          payload = {
+            channel:      @channel,
+              username:   @username,
+              icon_emoji: @icon_emoji,
+              attachments: [{
+                fallback: messages.keys.join(','),
+                color:    @color,
+                fields:   messages.map{|k,v| {title: k, value: v} }
+              }]}
+          post_request(
+            payload: payload.to_json
+          )
+        end
       rescue => e
         $log.error("Slack Error: #{e.backtrace[0]} / #{e.message}")
       end
@@ -49,18 +69,41 @@ module Fluent
 
     def configure(conf)
       super
-      @channel  = URI.unescape(conf['channel'])
-      @username = conf['username'] || 'fluentd'
-      @color    = conf['color'] || 'good'
+
+      @channel    = URI.unescape(conf['channel'])
+      @username   = conf['username']   || 'fluentd'
+      @color      = conf['color']      || 'good'
       @icon_emoji = conf['icon_emoji'] || ':question:'
-      @timezone   = conf['timezone'] || 'UTC'
-      @team       = conf['team']
-      @api_key    = conf['api_key']
+
+      if @rtm
+        @token      = conf['token']
+      else
+        @timezone   = conf['timezone'] || 'UTC'
+        @team       = conf['team']
+        @api_key    = conf['api_key']
+        @webhook_url= conf['webhook_url']
+      end
     end
 
     private
+    def response_check(res)
+      if res.code != "200"
+        raise BufferedSlackOutputError, "Slack.com - #{res.code} - #{res.body}"
+      end
+    end
+
+    def get_request(params)
+      query = URI.encode_www_form(params)
+      uri = URI.parse("https://slack.com/api/chat.postMessage?#{query}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.get(uri.request_uri)
+      response_check(res)
+    end
+
     def endpoint
-      URI.parse "https://#{@team}.slack.com/services/hooks/incoming-webhook?token=#{@api_key}"
+      URI.parse @webhook_url || "https://#{@team}.slack.com/services/hooks/incoming-webhook?token=#{@api_key}"
     end
 
     def post_request(data)
@@ -69,9 +112,7 @@ module Fluent
       http = Net::HTTP.new endpoint.host, endpoint.port
       http.use_ssl = (endpoint.scheme == "https")
       res = http.request(req)
-      if res.code != "200"
-        raise BufferedSlackOutputError, "Slack.com - #{res.code} - #{res.body}"
-      end
+      response_check(res)
     end
   end
 end

data/test/plugin/test_out_buffered_slack.rb

@@ -8,7 +8,7 @@ class BufferedSlackOutputTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  CONFIG = %[
+  CONFIG1 = %[
     type buffered_slack
     api_key testtoken
     team    sowasowa
@@ -22,7 +22,7 @@ class BufferedSlackOutputTest < Test::Unit::TestCase
     utc
   ]
 
-  def create_driver(conf = CONFIG)
+  def create_driver(conf = CONFIG1)
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::BufferedSlackOutput).configure(conf)
   end
 

data/test/plugin/test_out_buffered_slack_rtm.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+require 'time'
+
+class BufferedSlackOutputTest < Test::Unit::TestCase
+
+  def setup
+    super
+    Fluent::Test.setup
+  end
+
+  CONFIG2 = %[
+    type buffered_slack
+    rtm true
+    token testtoken
+    channel C01234567
+    username testuser
+    color good
+    icon_emoji :ghost:
+    buffer_path ./test/tmp
+  ]
+
+  def create_driver(conf = CONFIG2)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::BufferedSlackOutput).configure(conf)
+  end
+
+  def test_format_rtm
+    d = create_driver
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag = 'test'
+    stub(d.instance.slack).ping(
+      nil,
+      channel:    'C01234567',
+      username:   'testuser',
+      icon_emoji: ':ghost:',
+      attachments: [{
+        color:    'good',
+        text: "[#{Time.at(time).in_time_zone('Tokyo')}] sowawa\n"
+      }]
+    )
+    d.emit({message: 'sowawa'}, time)
+    d.expect_format %[#{['test', time, {message: 'sowawa'}].to_msgpack}]
+    d.run
+  end
+
+  def test_write_rtm
+    d = create_driver
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    stub(d.instance.slack).ping(
+      nil,
+      channel:    'C01234567',
+      username:   'testuser',
+      icon_emoji: ':ghost:',
+      attachments: [{
+        color:    'good',
+        text: "[#{Time.at(time).in_time_zone('Tokyo')}] sowawa\n"
+      }]
+    )
+    d.emit({message: 'sowawa1'}, time)
+    d.emit({message: 'sowawa2'}, time)
+    d.run
+  end
+end

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Keisuke SOGAWA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.8
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.38
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.38
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.1.1
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description: fluent Slack plugin
@@ -129,7 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - AUTHORS
 - Gemfile
 - README.rdoc
@@ -138,37 +123,32 @@ files:
 - fluent-plugin-slack.gemspec
 - lib/fluent/plugin/out_buffered_slack.rb
 - test/plugin/test_out_buffered_slack.rb
+- test/plugin/test_out_buffered_slack_rtm.rb
 - test/test_helper.rb
 homepage: https://github.com/sowawa/fluent-plugin-slack
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2798180410085788285
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2798180410085788285
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: fluent Slack plugin
 test_files:
 - test/plugin/test_out_buffered_slack.rb
+- test/plugin/test_out_buffered_slack_rtm.rb
 - test/test_helper.rb