fluent-plugin-irc 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af5ed88db24d18583875f6882b7b9d4ef794a944
+  data.tar.gz: 0384195c283d6d18d4a62534b3ea9909134351f5
+SHA512:
+  metadata.gz: ec009deb6f1f6b60c253a200803442a109d0f59f8b415528471e984676681250c4d529b70ff91f868211347f24181e5de7c1a463a46331eec8c454160919fac6
+  data.tar.gz: 4150d2d06239c7aa689c438d78b89f3e0f0430d3e77f8e25d9b9a50c43dba0649386adb1c038094493bd079e3ab4871cc0f26a48de783e48a981d12bfb54f1a1

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - 2.2
+
+os:
+  - linux
+
+branches:
+  only:
+    - master
+
+gemfile:
+  - Gemfile
+
+script: bundle exec rake

data/README.md

@@ -1,4 +1,6 @@
-# Fluent::Plugin::Irc
+# Fluent::Plugin::Irc, a plugin for [Fluentd](http://fluentd.org)
+
+[![Build Status](https://travis-ci.org/choplin/fluent-plugin-irc.svg)](https://travis-ci.org/choplin/fluent-plugin-irc)
 
 Fluent plugin to send messages to IRC server
 
@@ -42,10 +44,12 @@ Fluent plugin to send messages to IRC server
 |time_key|key name for time|time|
 |time_format|time format. This will be formatted with Time#strftime.|%Y/%m/%d %H:%M:%S|
 |tag_key|key name for tag|tag|
+|command|irc command. `priv_msg` or `notice`|priv_msg|
+|channel_keys|keys used to format channel. %s will be replaced with value specified by channel_keys if this option is used|nil|
 
 ## Copyright
 
 <table>
-<tr><td>Copyright</td><td>Copyright (c) 2013 OKUNO Akihiro</td></tr>
+<tr><td>Copyright</td><td>Copyright (c) 2015 OKUNO Akihiro</td></tr>
 <tr><td>License</td><td>Apache License, Version 2.0</td></tr>
 </table>

data/example.conf

@@ -16,4 +16,5 @@
   time_key time
   time_format %Y/%m/%d %H:%M:%S
   tag_key tag
+  command priv_msg
 </match>

data/fluent-plugin-irc.gemspec

@@ -3,12 +3,13 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-irc"
-  s.version     = "0.0.5"
+  s.version     = "0.0.6"
   s.authors     = ["OKUNO Akihiro"]
   s.email       = ["choplin.choplin@gmail.com"]
   s.homepage    = "https://github.com/choplin/fluent-plugin-irc"
   s.summary     = %q{Output plugin for IRC}
   s.description = %q{Output plugin for IRC}
+  s.license     = "Apache-2.0"
 
   s.rubyforge_project = "fluent-plugin-irc"
 
@@ -19,4 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency "fluentd"
   s.add_runtime_dependency "irc_parser"
+
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "rake"
 end

data/lib/fluent/plugin/out_irc.rb

@@ -11,6 +11,9 @@ module Fluent
     config_param :host        , :string  , :default => 'localhost'
     config_param :port        , :integer , :default => 6667
     config_param :channel     , :string
+    config_param :channel_keys, :default => nil do |val|
+      val.split(',')
+    end
     config_param :nick        , :string  , :default => 'fluentd'
     config_param :user        , :string  , :default => 'fluentd'
     config_param :real        , :string  , :default => 'fluentd'
@@ -22,7 +25,16 @@ module Fluent
     config_param :time_key    , :string  , :default => 'time'
     config_param :time_format , :string  , :default => '%Y/%m/%d %H:%M:%S'
     config_param :tag_key     , :string  , :default => 'tag'
+    config_param :command     , :string  , :default => 'priv_msg'
+
+    config_param :blocking_timeout, :time, :default => 0.5
 
+    COMMAND_LIST = %w[priv_msg notice]
+
+    # To support log_level option implemented by Fluentd v0.10.43
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
 
     def initialize
       super
@@ -31,40 +43,67 @@ module Fluent
 
     def configure(conf)
       super
+
       begin
         @message % (['1'] * @out_keys.length)
       rescue ArgumentError
         raise Fluent::ConfigError, "string specifier '%s' and out_keys specification mismatch"
       end
+
+      if @channel_keys
+        begin
+          @channel % (['1'] * @channel_keys.length)
+        rescue ArgumentError
+          raise Fluent::ConfigError, "string specifier '%s' and channel_keys specification mismatch"
+        end
+      end
+      @channel = '#'+@channel
+
+      unless COMMAND_LIST.include?(@command)
+        raise Fluent::ConfigError, "command must be one of #{COMMAND_LIST.join(', ')}"
+      end
+
     end
 
     def start
       super
 
       begin
-        @loop = Coolio::Loop.default
+        @loop = Coolio::Loop.new
         @conn = create_connection
-      rescue
-        raise Fluent::ConfigError, "failto connect IRC server #{@host}:#{@port}"
+        @thread = Thread.new(&method(:run))
+      rescue => e
+        puts e
+        raise Fluent::ConfigError, "failed to connect IRC server #{@host}:#{@port}"
       end
     end
 
     def shutdown
       super
-      @conn.close unless @conn.closed?
+      @loop.watchers.each { |w| w.detach }
+      @loop.stop
+      @conn.close
+      @thread.join
+    end
+
+    def run
+      @loop.run(@blocking_timeout)
+    rescue => e
+      log.error "unexpected error", :error => e, :error_class => e.class
+      log.error_backtrace
     end
 
     def emit(tag, es, chain)
       chain.next
 
       if @conn.closed?
-        $log.warn "out_irc: connection is closed. try to reconnect"
+        log.warn "out_irc: connection is closed. try to reconnect"
         @conn = create_connection
       end
 
       es.each do |time,record|
         filter_record(tag, time, record)
-        @conn.send_message(build_message(record))
+        @conn.send_message(build_message(record), build_channel(record))
       end
     end
 
@@ -72,6 +111,7 @@ module Fluent
 
     def create_connection
       conn = IRCConnection.connect(@host, @port)
+      conn.command = @command
       conn.channel = '#'+@channel
       conn.nick = @nick
       conn.user = @user
@@ -86,7 +126,7 @@ module Fluent
         begin
           record.fetch(key).to_s
         rescue KeyError
-          $log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
+          log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
           ''
         end
       end
@@ -94,8 +134,28 @@ module Fluent
       @message % values
     end
 
+    def build_channel(record)
+      return @channel unless @channel_keys
+
+      values = @channel_keys.map do |key|
+        begin
+          record.fetch(key).to_s
+        rescue KeyError
+          $log.warn "out_irc: the specified key '#{key}' not found in record. [#{record}]"
+          ''
+        end
+      end
+
+      @channel % values
+    end
+
     class IRCConnection < Cool.io::TCPSocket
-      attr_accessor :channel, :nick, :user, :real, :password
+      attr_accessor :command, :channel, :nick, :user, :real, :password
+
+      def initialize(*args)
+        super
+        @joined = {}
+      end
 
       def on_connect
         if @password
@@ -120,11 +180,6 @@ module Fluent
           begin
             msg = IRCParser.parse(line)
             case msg.class.to_sym
-            when :rpl_welcome
-              IRCParser.message(:join) do |m|
-                m.channels = @channel
-                write m
-              end
             when :ping
               IRCParser.message(:pong) do |m|
                 m.target = msg.target
@@ -132,7 +187,7 @@ module Fluent
                 write m
               end
             when :error
-              $log.warn "out_irc: an error occured. \"#{msg.error_message}\""
+              log.warn "out_irc: an error occured. \"#{msg.error_message}\""
             end
           rescue
             #TODO
@@ -140,9 +195,22 @@ module Fluent
         end
       end
 
-      def send_message(msg)
-        IRCParser.message(:priv_msg) do |m|
-          m.target = @channel
+      def joined?(channel)
+        @joined[channel]
+      end
+
+      def join(channel)
+        IRCParser.message(:join) do |m|
+          m.channels = channel
+          write m
+        end
+        @joined[channel] = true
+      end
+
+      def send_message(msg, channel)
+        join(channel) unless joined?(channel)
+        IRCParser.message(@command) do |m|
+          m.target = channel
           m.body = msg
           write m
         end

data/test/plugin/test_out_irc.rb

@@ -1,46 +1,164 @@
 require 'helper'
+require 'socket'
 
 class IRCOutputTest < Test::Unit::TestCase
+  TAG = "test"
+  PORT = 6667
+  CHANNEL = "fluentd"
+  NICK = "fluentd"
+  USER = "fluentd"
+  REAL = "fluentd"
+  COMMAND = :notice
+  MESSAGE = "notice: %s [%s] %s"
+  TIME_FORMAT = "%Y/%m/%d %H:%M:%S"
+
   def setup
     Fluent::Test.setup
+    Fluent::Engine.now = Time.now
+  end
+
+  def config(
+    port: PORT,
+    channel: CHANNEL,
+    channel_keys: ""
+  )
+    %[
+      type irc
+      host localhost
+      port #{port}
+      channel #{channel}
+      channel_keys #{channel_keys}
+      nick #{NICK}
+      user #{USER}
+      real #{REAL}
+      command #{COMMAND.to_s}
+      message #{MESSAGE}
+      out_keys tag,time,msg
+      time_key time
+      time_format #{TIME_FORMAT}
+      tag_key tag
+    ]
   end
 
-  CONFIG = %[
-    type irc
-    host localhost
-    port 6667
-    channel fluentd
-    nick fluentd
-    user fluentd
-    real fluentd
-    message notice: %s [%s] %s
-    out_keys tag,time,msg
-    time_key time
-    time_format %Y/%m/%d %H:%M:%S
-    tag_key tag
-  ]
 
-  def create_driver(conf = CONFIG)
-    Fluent::Test::OutputTestDriver.new(Fluent::IRCOutput).configure(conf)
+  def create_driver(conf = config)
+    Fluent::Test::OutputTestDriver.new(Fluent::IRCOutput, TAG).configure(conf)
   end
 
   def test_configure
     d = create_driver
 
     assert_equal "localhost", d.instance.host
-    assert_equal 6667, d.instance.port
-    assert_equal "fluentd", d.instance.channel
-    assert_equal "fluentd", d.instance.nick
-    assert_equal "fluentd", d.instance.user
-    assert_equal "fluentd", d.instance.real
-    assert_equal "notice: %s [%s] %s", d.instance.message
+    assert_equal PORT, d.instance.port
+    assert_equal "##{CHANNEL}", d.instance.channel
+    assert_equal NICK, d.instance.nick
+    assert_equal USER, d.instance.user
+    assert_equal REAL, d.instance.real
+    assert_equal COMMAND.to_s, d.instance.command
+    assert_equal MESSAGE, d.instance.message
     assert_equal ["tag","time","msg"], d.instance.out_keys
     assert_equal "time", d.instance.time_key
-    assert_equal "%Y/%m/%d %H:%M:%S", d.instance.time_format
+    assert_equal TIME_FORMAT, d.instance.time_format
     assert_equal "tag", d.instance.tag_key
   end
 
-  #def test_emit
-    #TODO
-  #end
+  def test_configure_channel_keys
+    d = create_driver(config(channel:"%s", channel_keys:"channel"))
+    assert_equal "#%s", d.instance.channel
+    assert_equal ["channel"], d.instance.channel_keys
+  end
+
+  def test_emit
+    msg = "test"
+    msgs = [{"msg" => msg}]
+    body = MESSAGE % [TAG, Time.at(Fluent::Engine.now).utc.strftime(TIME_FORMAT), msg]
+
+    emit_test(msgs) do |socket|
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, :nick
+      assert_equal m.nick, NICK
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, :user
+      assert_equal m.user, USER
+      assert_equal m.postfix, REAL
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, :join
+      assert_equal m.channels, ["##{CHANNEL}"]
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, COMMAND
+      assert_equal m.target, "##{CHANNEL}"
+      assert_equal m.body, body
+
+      assert_nil socket.gets # expects EOF
+    end
+  end
+
+  def test_dynamic_channel
+    msgs = [
+      {"msg" => "test", "channel" => "chan1"},
+      {"msg" => "test", "channel" => "chan2"},
+      {"msg" => "test", "channel" => "chan1"},
+    ]
+
+    extra_config = {
+      channel: "%s",
+      channel_keys: "channel",
+    }
+
+    emit_test(msgs, extra_config: extra_config) do |socket|
+      socket.gets # ignore NICK
+      socket.gets # ignore USER
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, :join
+      assert_equal m.channels, ["#chan1"]
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, COMMAND
+      assert_equal m.target, "#chan1"
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, :join
+      assert_equal m.channels, ["#chan2"]
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, COMMAND
+      assert_equal m.target, "#chan2"
+
+      m = IRCParser.parse(socket.gets)
+      assert_equal m.class.to_sym, COMMAND
+      assert_equal m.target, "#chan1"
+
+      assert_nil socket.gets # expects EOF
+    end
+  end
+
+  private
+
+  def emit_test(msgs, extra_config: {}, &block)
+    TCPServer.open(0) do |serv|
+      port = serv.addr[1]
+      d = create_driver(config({port: port}.merge(extra_config)))
+
+      thread = Thread.new do
+        s = serv.accept
+        block.call(s)
+        s.close
+      end
+
+      d.run do
+        msgs.each do |m|
+          d.emit(m, Fluent::Engine.now)
+        end
+        # How to remove sleep?
+        # It is necessary to ensure that no data remains in Cool.io write buffer before detach.
+        sleep 1
+      end
+
+      thread.join
+    end
+  end
 end

metadata

@@ -1,46 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-irc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - OKUNO Akihiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2015-03-18 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: irc_parser
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Output plugin for IRC
@@ -50,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -61,30 +85,29 @@ files:
 - test/helper.rb
 - test/plugin/test_out_irc.rb
 homepage: https://github.com/choplin/fluent-plugin-irc
-licenses: []
+licenses:
+- Apache-2.0
+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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: fluent-plugin-irc
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Output plugin for IRC
 test_files:
 - test/helper.rb
 - test/plugin/test_out_irc.rb
-has_rdoc: