fluent-plugin-ikachan 0.1.0 → 0.2.0

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -35,7 +35,26 @@ And then, configure out_ikachan::
       tag_key tag
     </match>
     
-You will got message like 'notice: alert.servicename [2012/05/10 18:51:59] alert message in attribute "msg"'.
+You will get a notice message like `notice: alert.servicename [2012/05/10 18:51:59] alert message in attribute "msg"`.
+
+In addition to notice, out_ikachan can send privmsg into specified channel by `privmesg_message` and `privmsg_out_keys`.
+
+    <match alert.**>
+      # ikachan host/port(default 4979)
+      host localhost
+      port 4979
+      # channel to notify (this means #morischan)
+      channel morischan
+      message notice: %s [%s] %s
+      out_keys tag,time,msg
+      privmsg_message [%s] morischan :D
+      privmsg_out_keys time
+      time_key time
+      time_format %Y/%m/%d %H:%M:%S
+      tag_key tag
+    </match>
+
+At least one of (`message` + `out_keys`) or (`privmsg_message` + `privmsg_out_keys`) must be specified.
 
 ## TODO
 
@@ -44,7 +63,8 @@ You will got message like 'notice: alert.servicename [2012/05/10 18:51:59] alert
 
 ## Copyright
 
-* Copyright
-  * Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+* Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+* Contributed by:
+  * @sonots
 * License
   * Apache License, Version 2.0

data/fluent-plugin-ikachan.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-ikachan"
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.0"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.summary       = %q{output plugin for IRC-HTTP gateway 'ikachan'}
@@ -14,5 +14,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency "fluentd"
+  gem.add_development_dependency "rake"
   gem.add_runtime_dependency "fluentd"
 end

data/lib/fluent/plugin/out_ikachan.rb

@@ -4,8 +4,10 @@ class Fluent::IkachanOutput < Fluent::Output
   config_param :host, :string
   config_param :port, :integer, :default => 4979
   config_param :channel, :string
-  config_param :message, :string
-  config_param :out_keys, :string
+  config_param :message, :string, :default => nil
+  config_param :out_keys, :string, :default => ""
+  config_param :privmsg_message, :string, :default => nil
+  config_param :privmsg_out_keys, :string, :default => ""
   config_param :time_key, :string, :default => nil
   config_param :time_format, :string, :default => nil
   config_param :tag_key, :string, :default => 'tag'
@@ -22,19 +24,31 @@ class Fluent::IkachanOutput < Fluent::Output
     @channel = '#' + @channel
     @join_uri = URI.parse "http://#{@host}:#{@port}/join"
     @notice_uri = URI.parse "http://#{@host}:#{@port}/notice"
+    @privmsg_uri = URI.parse "http://#{@host}:#{@port}/privmsg"
 
-    @out_keys = conf['out_keys'].split(',')
+    @out_keys = @out_keys.split(',')
+    @privmsg_out_keys = @privmsg_out_keys.split(',')
+
+    if @message.nil? and @privmsg_message.nil?
+      raise Fluent::ConfigError, "Either 'message' or 'privmsg_message' must be specifed."
+    end
 
     begin
-      @message % (['1'] * @out_keys.length)
+      @message % (['1'] * @out_keys.length) if @message
     rescue ArgumentError
       raise Fluent::ConfigError, "string specifier '%s' and out_keys specification mismatch"
     end
 
+    begin
+      @privmsg_message % (['1'] * @privmsg_out_keys.length) if @privmsg_message
+    rescue ArgumentError
+      raise Fluent::ConfigError, "string specifier '%s' of privmsg_message and privmsg_out_keys specification mismatch"
+    end
+
     if @time_key
       if @time_format
         f = @time_format
-        tf = Fluent::TimeFormatter.new(f, @localtime)
+        tf = Fluent::TimeFormatter.new(f, true) # IRC notification is formmatted as localtime only...
         @time_format_proc = tf.method(:format)
         @time_parse_proc = Proc.new {|str| Time.strptime(str, f).to_i }
       else
@@ -60,22 +74,11 @@ class Fluent::IkachanOutput < Fluent::Output
 
   def emit(tag, es, chain)
     messages = []
+    privmsg_messages = []
 
     es.each {|time,record|
-      values = []
-      last = @out_keys.length - 1
-
-      values = @out_keys.map do |key|
-        case key
-        when @time_key
-          @time_format_proc.call(time)
-        when @tag_key
-          tag
-        else
-          record[key].to_s
-        end
-      end
-      messages.push (@message % values)
+      messages << evaluate_message(@message, @out_keys, tag, time, record) if @message
+      privmsg_messages << evaluate_message(@privmsg_message, @privmsg_out_keys, tag, time, record) if @privmsg_message
     }
 
     messages.each do |msg|
@@ -86,7 +89,35 @@ class Fluent::IkachanOutput < Fluent::Output
       end
     end
 
+    privmsg_messages.each do |msg|
+      begin
+        res = Net::HTTP.post_form(@privmsg_uri, {'channel' => @channel, 'message' => msg})
+      rescue
+        $log.warn "out_ikachan: failed to send privmsg to #{@host}:#{@port}, #{@channel}, message: #{msg}"
+      end
+    end
+
     chain.next
   end
 
+  private
+
+  def evaluate_message(message, out_keys, tag, time, record)
+    values = []
+    last = out_keys.length - 1
+
+    values = out_keys.map do |key|
+      case key
+      when @time_key
+        @time_format_proc.call(time)
+      when @tag_key
+        tag
+      else
+        record[key].to_s
+      end
+    end
+
+    message % values
+  end
+
 end

data/test/helper.rb

@@ -26,3 +26,27 @@ require 'fluent/plugin/out_ikachan'
 
 class Test::Unit::TestCase
 end
+
+require 'webrick'
+
+# to handle POST/PUT/DELETE ...
+module WEBrick::HTTPServlet
+  class ProcHandler < AbstractServlet
+    alias do_POST   do_GET
+    alias do_PUT    do_GET
+    alias do_DELETE do_GET
+  end
+end
+
+def get_code(server, port, path, headers={})
+  require 'net/http'
+  Net::HTTP.start(server, port){|http|
+    http.get(path, headers).code
+  }
+end
+def get_content(server, port, path, headers={})
+  require 'net/http'
+  Net::HTTP.start(server, port){|http|
+    http.get(path, headers).body
+  }
+end

data/test/plugin/test_out_ikachan.rb

@@ -1,7 +1,22 @@
 require 'helper'
+require 'cgi'
 
 class IkachanOutputTest < Test::Unit::TestCase
+  IKACHAN_TEST_LISTEN_PORT = 4979
+
   CONFIG = %[
+    host localhost
+    channel morischan
+    message out_ikachan: %s [%s] %s
+    out_keys tag,time,msg
+    privmsg_message out_ikachan: %s [%s] %s
+    privmsg_out_keys tag,time,msg
+    time_key time
+    time_format %Y/%m/%d %H:%M:%S
+    tag_key tag
+  ]
+
+  CONFIG_NOTICE_ONLY = %[
     host localhost
     channel morischan
     message out_ikachan: %s [%s] %s
@@ -11,6 +26,16 @@ class IkachanOutputTest < Test::Unit::TestCase
     tag_key tag
   ]
 
+  CONFIG_PRIVMSG_ONLY = %[
+    host localhost
+    channel morischan
+    privmsg_message out_ikachan: %s [%s] %s
+    privmsg_out_keys tag,time,msg
+    time_key time
+    time_format %Y/%m/%d %H:%M:%S
+    tag_key tag
+  ]
+
   def create_driver(conf=CONFIG,tag='test')
     Fluent::Test::OutputTestDriver.new(Fluent::IkachanOutput, tag).configure(conf)
   end
@@ -18,16 +43,213 @@ class IkachanOutputTest < Test::Unit::TestCase
   def test_configure
     d = create_driver
     assert_equal '#morischan', d.instance.channel
+    d = create_driver(CONFIG_NOTICE_ONLY)
+    assert_equal '#morischan', d.instance.channel
+    d = create_driver(CONFIG_PRIVMSG_ONLY)
+    assert_equal '#morischan', d.instance.channel
   end
 
-  def test_notice
-    # To test this code, execute ikachan on your own host
+  # CONFIG = %[
+  #   host localhost
+  #   channel morischan
+  #   message out_ikachan: %s [%s] %s
+  #   out_keys tag,time,msg
+  #   privmsg_message out_ikachan: %s [%s] %s
+  #   privmsg_out_keys tag,time,msg
+  #   time_key time
+  #   time_format %Y/%m/%d %H:%M:%S
+  #   tag_key tag
+  # ]
+  def test_notice_and_privmsg
     d = create_driver
-    time = Time.now.to_i
+    t = Time.now
+    time = t.to_i
+    ts = t.strftime(d.instance.time_format)
     d.run do
-      d.emit({'msg' => "message from fluentd out_ikachan: testing now"}, time)
-      d.emit({'msg' => "message from fluentd out_ikachan: testing second line"}, time)
+      d.emit({'msg' => "both notice and privmsg message from fluentd out_ikachan: testing now"}, time)
+      d.emit({'msg' => "both notice and privmsg message from fluentd out_ikachan: testing second line"}, time)
     end
+
+    assert_equal 4, @posted.length
+
+    assert_equal 'notice', @posted[0][:method]
+    assert_equal '#morischan', @posted[0][:channel]
+    assert_equal "out_ikachan: test [#{ts}] both notice and privmsg message from fluentd out_ikachan: testing now", @posted[0][:message]
+
+    assert_equal 'privmsg', @posted[1][:method]
+    assert_equal '#morischan', @posted[1][:channel]
+    assert_equal "out_ikachan: test [#{ts}] both notice and privmsg message from fluentd out_ikachan: testing now", @posted[1][:message]
+
+    assert_equal 'notice', @posted[2][:method]
+    assert_equal '#morischan', @posted[2][:channel]
+    assert_equal "out_ikachan: test [#{ts}] both notice and privmsg message from fluentd out_ikachan: testing second line", @posted[2][:message]
+    assert_equal 'privmsg', @posted[3][:method]
+    assert_equal '#morischan', @posted[3][:channel]
+    assert_equal "out_ikachan: test [#{ts}] both notice and privmsg message from fluentd out_ikachan: testing second line", @posted[3][:message]
   end
 
+  # CONFIG_NOTICE_ONLY = %[
+  #   host localhost
+  #   channel morischan
+  #   message out_ikachan: %s [%s] %s
+  #   out_keys tag,time,msg
+  #   time_key time
+  #   time_format %Y/%m/%d %H:%M:%S
+  #   tag_key tag
+  # ]
+  def test_notice_only
+    d = create_driver(CONFIG_NOTICE_ONLY)
+    t = Time.now
+    time = t.to_i
+    ts = t.strftime(d.instance.time_format)
+    d.run do
+      d.emit({'msg' => "notice message from fluentd out_ikachan: testing now"}, time)
+      d.emit({'msg' => "notice message from fluentd out_ikachan: testing second line"}, time)
+    end
+
+    assert_equal 2, @posted.length
+
+    assert_equal 'notice', @posted[0][:method]
+    assert_equal '#morischan', @posted[0][:channel]
+    assert_equal "out_ikachan: test [#{ts}] notice message from fluentd out_ikachan: testing now", @posted[0][:message]
+
+    assert_equal 'notice', @posted[1][:method]
+    assert_equal '#morischan', @posted[1][:channel]
+    assert_equal "out_ikachan: test [#{ts}] notice message from fluentd out_ikachan: testing second line", @posted[1][:message]
+  end
+
+  # CONFIG_PRIVMSG_ONLY = %[
+  #   host localhost
+  #   channel morischan
+  #   privmsg_message out_ikachan: %s [%s] %s
+  #   privmsg_out_keys tag,time,msg
+  #   time_key time
+  #   time_format %Y/%m/%d %H:%M:%S
+  #   tag_key tag
+  # ]
+  def test_privmsg_only
+    d = create_driver(CONFIG_PRIVMSG_ONLY)
+    t = Time.now
+    time = t.to_i
+    ts = t.strftime(d.instance.time_format)
+    d.run do
+      d.emit({'msg' => "privmsg message from fluentd out_ikachan: testing now"}, time)
+      d.emit({'msg' => "privmsg message from fluentd out_ikachan: testing second line"}, time)
+    end
+
+    assert_equal 2, @posted.length
+
+    assert_equal 'privmsg', @posted[0][:method]
+    assert_equal '#morischan', @posted[0][:channel]
+    assert_equal "out_ikachan: test [#{ts}] privmsg message from fluentd out_ikachan: testing now", @posted[0][:message]
+
+    assert_equal 'privmsg', @posted[1][:method]
+    assert_equal '#morischan', @posted[1][:channel]
+    assert_equal "out_ikachan: test [#{ts}] privmsg message from fluentd out_ikachan: testing second line", @posted[1][:message]
+  end
+
+  # setup / teardown for servers
+  def setup
+    Fluent::Test.setup
+    @posted = []
+    @prohibited = 0
+    @auth = false
+    @dummy_server_thread = Thread.new do
+      srv = if ENV['VERBOSE']
+              WEBrick::HTTPServer.new({:BindAddress => '127.0.0.1', :Port => IKACHAN_TEST_LISTEN_PORT})
+            else
+              logger = WEBrick::Log.new('/dev/null', WEBrick::BasicLog::DEBUG)
+              WEBrick::HTTPServer.new({:BindAddress => '127.0.0.1', :Port => IKACHAN_TEST_LISTEN_PORT, :Logger => logger, :AccessLog => []})
+            end
+      begin
+        srv.mount_proc('/') { |req,res| # /join, /notice, /privmsg
+          # POST /join?channel=#channel&channel_keyword=keyword
+          # POST /notice?channel=#channel&message=your_message
+          # POST /privmsg?channel=#channel&message=your_message
+          unless req.request_method == 'POST'
+            res.status = 405
+            res.body = 'request method mismatch'
+            next
+          end
+          if @auth and req.header['authorization'][0] == 'Basic YWxpY2U6c2VjcmV0IQ==' # pattern of user='alice' passwd='secret!'    
+            # ok, authorized
+          elsif @auth
+            res.status = 403
+            @prohibited += 1
+            next
+          else
+            # ok, authorization not required
+          end
+
+          if req.path == '/'
+            res.status = 200
+            next
+          end
+
+          req.path =~ /^\/(join|notice|privmsg)$/
+          method = $1
+          post_param = CGI.parse(req.body)
+
+          if method == 'join'
+            res.status = 200
+            next
+          end
+
+          @posted.push({ :method => method, :channel => post_param['channel'].first, :message => post_param['message'].first})
+          res.status = 200
+        }
+        srv.start
+      ensure
+        srv.shutdown
+      end
+    end
+    # to wait completion of dummy server.start()
+    require 'thread'
+    cv = ConditionVariable.new
+    watcher = Thread.new {
+      connected = false
+      while not connected
+        begin
+          get_content('localhost', IKACHAN_TEST_LISTEN_PORT, '/')
+          connected = true
+        rescue Errno::ECONNREFUSED
+          sleep 0.1
+        rescue StandardError => e
+          p e
+          sleep 0.1
+        end
+      end
+      cv.signal
+    }
+    mutex = Mutex.new
+    mutex.synchronize {
+      cv.wait(mutex)
+    }
+  end
+
+  def test_dummy_server
+    d = create_driver
+    host = d.instance.host
+    port = d.instance.port
+    client = Net::HTTP.start(host, port)
+
+    assert_equal '200', client.request_post('/', '').code
+    assert_equal '200', client.request_post('/join', 'channel=#test').code
+
+    assert_equal 0, @posted.size
+
+    assert_equal '200', client.request_post('/notice', 'channel=#test&message=NOW TESTING').code
+    assert_equal '200', client.request_post('/privmsg', 'channel=#test&message=NOW TESTING 2').code
+
+    assert_equal 2, @posted.size
+
+    assert_equal 'notice', @posted[0][:method]
+    assert_equal '#test', @posted[0][:channel]
+    assert_equal 'NOW TESTING', @posted[0][:message]
+  end
+
+  def teardown
+    @dummy_server_thread.kill
+    @dummy_server_thread.join
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ikachan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +69,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - fluent-plugin-ikachan.gemspec

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2012 TAGOMORI Satoshi
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.