fluent-plugin-slack 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e923290cae0a22d361507caceed0cbd717effac
-  data.tar.gz: e91f21aec9e58b4a32ae9795273f66eba888dcbc
+  metadata.gz: 60f17d6deefe9660f802349100a06f0dbb52be82
+  data.tar.gz: 6be0620df5d0e4e573f2ecb315e5e5134a511587
 SHA512:
-  metadata.gz: de4ddc0641fa1c3d1249ea79869376866caceabf93901fb2b8c855d9de041e05009191c6c0fa63715136503fb5f8f0d55eb9ca389a0ceec85d2d22a12357f56b
-  data.tar.gz: dcabceb85494457fc1644da528257bc34275e164e6d3a1e5ae0326a011f3927f897320577f5c91aa45f8add882449461b97430934b1b1fc0cf195a37df490393
+  metadata.gz: 754e0d821c9d4a62e885bc0c48298edfc5a3d60b3780e9c5b1321d1a5ca46eb19569bf39abd072dd6535b865dba6c5471cfa427f50a4a891e68a9c2c98c16161
+  data.tar.gz: ca145ab4794d3610ad727453b0013ffe2e18544a6a12a0189bb6cfeb0a11fe58f25e321bad7bcffab33957c1f7b9be306ec44b2b717ff902639d6aed46c41243

data/CHANGELOG.md

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

data/README.md

@@ -63,6 +63,7 @@ fluent_logger.post('slack', {
 |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|
+|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.2
+0.5.3

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -18,6 +18,7 @@ module Fluent
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
+    config_param :https_proxy,          :string, default: nil
 
     config_param :channel,              :string
     config_param :channel_keys,         default: nil do |val|
@@ -72,6 +73,10 @@ module Fluent
       @slack.log = log
       @slack.debug_dev = log.out if log.level <= Fluent::Log::LEVEL_TRACE
 
+      if @https_proxy
+        @slack.https_proxy = @https_proxy
+      end
+
       begin
         @message % (['1'] * @message_keys.length)
       rescue ArgumentError

data/lib/fluent/plugin/out_slack.rb

@@ -18,6 +18,7 @@ module Fluent
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
+    config_param :https_proxy,          :string, default: nil
 
     config_param :channel,              :string
     config_param :channel_keys,         default: nil do |val|
@@ -72,6 +73,10 @@ module Fluent
       @slack.log = log
       @slack.debug_dev = log.out if log.level <= Fluent::Log::LEVEL_TRACE
 
+      if @https_proxy
+        @slack.https_proxy = @https_proxy
+      end
+
       begin
         @message % (['1'] * @message_keys.length)
       rescue ArgumentError

data/lib/fluent/plugin/slack_client.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'net/http'
+require 'net/https'
 require 'logger'
 require_relative 'slack_client/error'
 
@@ -8,13 +9,41 @@ module Fluent
     # The base framework of slack client
     class Base
       attr_accessor :log, :debug_dev
+      attr_reader   :endpoint, :https_proxy
 
-      def initialize
+      # @param [String] endpoint
+      #
+      #     (Incoming Webhook) required
+      #     https://hooks.slack.com/services/XXX/XXX/XXX
+      #
+      #     (Web API) optional and default to be
+      #     https://slack.com/api/
+      #
+      # @param [String] https_proxy (optional)
+      #
+      #     https://proxy.foo.bar:port
+      #
+      def initialize(endpoint = nil, https_proxy = nil)
+        self.endpoint    = endpoint    if endpoint
+        self.https_proxy = https_proxy if https_proxy
         @log = Logger.new('/dev/null')
       end
 
+      def endpoint=(endpoint)
+        @endpoint    = URI.parse(endpoint)
+      end
+
+      def https_proxy=(https_proxy)
+        @https_proxy = URI.parse(https_proxy)
+        @proxy_class = Net::HTTP.Proxy(@https_proxy.host, @https_proxy.port)
+      end
+
+      def proxy_class
+        @proxy_class ||= Net::HTTP
+      end
+
       def post(endpoint, params)
-        http = Net::HTTP.new(endpoint.host, endpoint.port)
+        http = proxy_class.new(endpoint.host, endpoint.port)
         http.use_ssl = (endpoint.scheme == 'https')
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         http.set_debug_output(debug_dev) if debug_dev
@@ -44,12 +73,9 @@ module Fluent
 
     # Slack client for Incoming Webhook
     class IncomingWebhook < Base
-      attr_accessor :endpoint
-
-      # @param [String] endpoint Configure Incoming Webhook endpoint
-      def initialize(endpoint)
-        super()
-        @endpoint = URI.parse(endpoint)
+      def endpoint
+        return @endpoint if @endpoint
+        raise ArgumentError, "Incoming Webhook endpoint is not configured"
       end
 
       def post_message(params = {}, opts = {})
@@ -75,12 +101,16 @@ module Fluent
     class WebApi < Base
       DEFAULT_ENDPOINT = "https://slack.com/api/".freeze
 
+      def endpoint
+        @endpoint ||= URI.parse(DEFAULT_ENDPOINT)
+      end
+
       def post_message_endpoint
-        @post_message_endpoint    ||= URI.join(DEFAULT_ENDPOINT, "chat.postMessage")
+        @post_message_endpoint    ||= URI.join(endpoint, "chat.postMessage")
       end
 
       def channels_create_endpoint
-        @channels_create_endpoint ||= URI.join(DEFAULT_ENDPOINT, "channels.create")
+        @channels_create_endpoint ||= URI.join(endpoint, "channels.create")
       end
 
       # Sends a message to a channel.

data/test/plugin/test_out_slack.rb

@@ -160,6 +160,18 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_equal @icon_url, d.instance.icon_url
   end
 
+  def test_https_proxy_configure
+    # default
+    d = create_driver(CONFIG)
+    assert_equal nil, d.instance.slack.https_proxy
+    assert_equal Net::HTTP, d.instance.slack.proxy_class
+
+    # https_proxy
+    d = create_driver(CONFIG + %[https_proxy https://proxy.foo.bar:443])
+    assert_equal URI.parse('https://proxy.foo.bar:443'), d.instance.slack.https_proxy
+    assert_not_equal Net::HTTP, d.instance.slack.proxy_class # Net::HTTP.Proxy
+  end
+
   def test_default_incoming_webhook
     d = create_driver(%[
       channel channel

data/test/plugin/test_slack_client.rb

@@ -2,6 +2,8 @@ require_relative '../test_helper'
 require 'fluent/plugin/slack_client'
 require 'time'
 require 'dotenv'
+require 'webrick'
+require 'webrick/httpproxy'
 
 # HOW TO RUN
 #
@@ -12,20 +14,60 @@ require 'dotenv'
 #
 Dotenv.load
 if ENV['WEBHOOK_URL'] and ENV['TOKEN']
+
+  class TestProxyServer
+    def initialize
+      @proxy = WEBrick::HTTPProxyServer.new(
+        :BindAddress => '127.0.0.1',
+        :Port => unused_port,
+      )
+    end
+
+    def proxy_url
+      "https://127.0.0.1:#{unused_port}"
+    end
+
+    def start
+      @thread = Thread.new do
+        @proxy.start
+      end
+    end
+
+    def shutdown
+      @proxy.shutdown
+    end
+
+    def unused_port
+      return @unused_port if @unused_port
+      s = TCPServer.open(0)
+      port = s.addr[1]
+      s.close
+      @unused_port = port
+    end
+  end
+
   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)
+
       @icon_url = 'http://www.google.com/s2/favicons?domain=www.google.de'
     end
 
+    def teardown
+      @proxy.shutdown
+    end
+
     def token(client)
-      client == @api ? {token: ENV['TOKEN']} : {}
+      client.is_a?(Fluent::SlackClient::WebApi) ? {token: ENV['TOKEN']} : {}
     end
 
     def test_post_message_text
-      [@incoming_webhook, @api].each do |slack|
+      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {
@@ -43,8 +85,36 @@ if ENV['WEBHOOK_URL'] and ENV['TOKEN']
       end
     end
 
+    def test_post_message_fields
+      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              icon_emoji:  ':question:',
+              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",
+                  },
+                ],
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+
     def test_post_message_icon_url
-      [@incoming_webhook, @api].each do |slack|
+      [@incoming_webhook, @api, @incoming_webhook_proxy, @api_proxy].each do |slack|
         assert_nothing_raised do
           slack.post_message(
             {

metadata

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