fluent-plugin-irc 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-irc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2012 OKUNO Akihiro
+
+Apache License, Version 2.0

data/README.md

@@ -0,0 +1,59 @@
+# Fluent::Plugin::Irc
+
+Fluent plugin to send messages to IRC server
+
+## Installation
+
+`$ fluent-gem install fluent-plugin-mongo`
+
+## Configuration
+
+### Example
+
+```
+<match **>
+  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
+</match>
+```
+
+### Parameter
+
+* host
+  * IRC server host
+* port
+  * IRC server port number
+* channel
+  * channel to send messages (without first '#')
+* nick
+  * nickname registerd of IRC
+* user
+  * user name registerd of IRC
+* real
+  * real name registerd of IRC
+* message
+  * message format. %s will be replaced with value specified by out_keys
+* out_keys
+  * keys used to format messages
+* time_key
+  * key name for time
+* time_format
+  * time format. This will be formatted with Time#strftime.
+* tag_key
+  * key name for tag
+
+## Copyright
+* Copyright
+  * Copyright (c) 2012 OKUNO Akihiro
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/example.conf

@@ -0,0 +1,18 @@
+<source>
+  type forward
+</source>
+
+<match **>
+  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
+</match>

data/fluent-plugin-irc.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-irc"
+  s.version     = "0.0.1"
+  s.authors     = ["OKUNO Akihiro"]
+  s.email       = ["okuno.akihiro@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.rubyforge_project = "fluent-plugin-irc"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "irc_parser"
+end

data/lib/fluent/plugin/out_irc.rb

@@ -0,0 +1,133 @@
+module Fluent
+  class IRCOutput < Fluent::Output
+    Fluent::Plugin.register_output('irc', self)
+
+    include SetTimeKeyMixin
+    include SetTagKeyMixin
+
+    config_set_default :include_time_key, true
+    config_set_default :include_tag_key, true
+
+    config_param :host        , :string  , :default => 'localhost'
+    config_param :port        , :integer , :default => 6667
+    config_param :channel     , :string
+    config_param :nick        , :string  , :default => 'fluentd'
+    config_param :user        , :string  , :default => 'fluentd'
+    config_param :real        , :string  , :default => 'fluentd'
+    config_param :message     , :string
+    config_param :out_keys do |val|
+      val.split(',')
+    end
+    config_param :time_key    , :string  , :default => nil
+    config_param :time_format , :string  , :default => nil
+    config_param :tag_key     , :string  , :default => 'tag'
+
+
+    def initialize
+      super
+      require 'irc_parser'
+    end
+
+    def configure(conf)
+      super
+      begin
+        @message % (['1'] * @out_keys.length)
+      rescue ArgumentError
+        raise Fluent::ConfigError, "string specifier '%s' and out_keys specification mismatch"
+      end
+    end
+
+    def start
+      super
+      begin
+        @client = IRCConnection.connect(@host, @port)
+      rescue
+        raise Fluent::ConfigError, "failto connect IRC server #{@host}:#{@port}"
+      end
+
+      @client.channel = '#'+@channel
+      @client.nick = @nick
+      @client.user = @user
+      @client.real = @real
+      @client.attach(Coolio::Loop.default)
+    end
+
+    def shutdown
+      super
+      @client.close
+    end
+
+    def emit(tag, es, chain)
+      chain.next
+      es.each do |time,record|
+        filter_record(tag, time, record)
+        IRCParser.message(:priv_msg) do |m|
+          m.target = @client.channel
+          m.body = build_message(record)
+          @client.send m
+        end
+      end
+    end
+
+    private
+    def build_message(record)
+      values = @out_keys.map {|key| record[key].to_s}
+      @message % values
+    end
+
+    class IRCConnection < Cool.io::TCPSocket
+      attr_accessor :channel, :nick, :user, :real
+
+      def on_connect
+        IRCParser.message(:nick) do |m|
+          m.nick   = @nick
+          write m
+        end
+        IRCParser.message(:user) do |m|
+          m.user = @user
+          m.postfix = @real
+          write m
+        end
+      end
+
+      def on_close
+        #TODO
+      end
+
+      def on_read(data)
+        data.each_line do |line|
+          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
+                m.body = msg.body
+                write m
+              end
+            end
+          rescue
+            #TODO
+          end
+        end
+      end
+
+      def on_resolve_failed
+        #TODO
+      end
+
+      def on_connect_failed
+        #TODO
+      end
+
+      def send(msg)
+        write msg
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+require 'fluent/plugin/out_irc'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_irc.rb

@@ -0,0 +1,46 @@
+require 'helper'
+
+class IRCOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  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)
+  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 ["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 "tag", d.instance.tag_key
+  end
+
+  #def test_emit
+    #TODO
+  #end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-irc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- OKUNO Akihiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-27 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'
+description: Output plugin for IRC
+email:
+- okuno.akihiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.conf
+- fluent-plugin-irc.gemspec
+- lib/fluent/plugin/out_irc.rb
+- test/helper.rb
+- test/plugin/test_out_irc.rb
+homepage: https://github.com/choplin/fluent-plugin-irc
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Output plugin for IRC
+test_files:
+- test/helper.rb
+- test/plugin/test_out_irc.rb