fluent-plugin-ikachan 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17a12295f863b0eaf2929b9960cb39a81eb0f07a
-  data.tar.gz: 2d7db2044e51662c99d90b6038da20b11aafb651
+  metadata.gz: d43020695dd6a279bbdcc08d3cada12b6b3e3bf4
+  data.tar.gz: e8d7e2dceb0deb652a09ce715d25583878598adc
 SHA512:
-  metadata.gz: f587d9841e0010a9f253364b1039e65f17c50473f4e57d1d67c3acdfd2c7795443d05de6cd09800af2e2d1eb1571f3a8aa5032a6e1c5038c04cfa45a2fa81a23
-  data.tar.gz: 27845cd4329f57f992b6e4d5bd7c07f16d93120831103fc02fafb8ccc3419685284645eef9455927f67b242a902dadd2d96a8a5c7db262817408a7cc5773c4b1
+  metadata.gz: 77309807ea3cabdaaada3b0c4f92b17991916289771d0ba938375618e90a8b514ce5d019ea51d128b1c710a542f3e3c03913898b4e3f6055638dc1513f5095c9
+  data.tar.gz: fb86e66f311175eaa8dc3fc204b010fa84a0c943314bc7a229eb35c3e878a61af65c5d07da1727ec11f3794cad3a01dc244a5fe37fa61b3441cd05940bb50294

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/fluent-plugin-ikachan.gemspec

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-ikachan"
-  gem.version       = "0.2.2"
+  gem.version       = "0.2.3"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.summary       = %q{output plugin for IRC-HTTP gateway 'ikachan'}
   gem.description   = %q{output plugin for IRC-HTTP gateway 'ikachan' (see: https://metacpan.org/module/ikachan and (jpn) http://blog.yappo.jp/yappo/archives/000760.html)}
   gem.homepage      = "https://github.com/tagomoris/fluent-plugin-ikachan"
+  gem.license       = "APLv2"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/fluent/plugin/out_ikachan.rb

@@ -1,8 +1,11 @@
 class Fluent::IkachanOutput < Fluent::Output
   Fluent::Plugin.register_output('ikachan', self)
 
-  config_param :host, :string
+  config_param :host, :string, :default => nil
   config_param :port, :integer, :default => 4979
+  config_param :base_uri, :string, :default => nil
+  config_param :ssl, :bool, :default => nil
+  config_param :verify_ssl, :bool, :default => false
   config_param :channel, :string
   config_param :message, :string, :default => nil
   config_param :out_keys, :string, :default => ""
@@ -21,10 +24,33 @@ class Fluent::IkachanOutput < Fluent::Output
   def configure(conf)
     super
 
+    if @base_uri.nil?
+      if @host.nil? or @port.nil?
+        raise Fluent::ConfigError, 'If `base_uri is nil, both `host` and `port` must be specifed'
+      end
+      # if only specifed "ssl true", scheme is https
+      scheme = @ssl == true ? "https" : "http"
+      @base_uri = "#{scheme}://#{@host}:#{@port}/"
+    end
+
+    unless @base_uri =~ /\/$/
+      raise Fluent::ConfigError, '`base_uri` must be end `/`'
+    end
+
+    # auto enable ssl option by base_uri scheme if ssl is not specifed
+    if @ssl.nil?
+      @ssl = @base_uri =~ /^https:/ ? true : false
+    end
+
+    if ( @base_uri =~ /^https:/ and @ssl == false ) || ( @base_uri =~ /^http:/ and @ssl == true )
+      raise Fluent::ConfigError, 'conflict `base_uri` scheme and `ssl`'
+    end
+
     @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"
+
+    @join_uri = URI.join(@base_uri, "join")
+    @notice_uri = URI.join(@base_uri, "notice")
+    @privmsg_uri = URI.join(@base_uri, "privmsg")
 
     @out_keys = @out_keys.split(',')
     @privmsg_out_keys = @privmsg_out_keys.split(',')
@@ -59,7 +85,7 @@ class Fluent::IkachanOutput < Fluent::Output
   end
 
   def start
-    res = Net::HTTP.post_form(@join_uri, {'channel' => @channel})
+    res = http_post_request(@join_uri, {'channel' => @channel})
     if res.code.to_i == 200
       # ok
     elsif res.code.to_i == 403 and res.body == "joinned channel: #{@channel}"
@@ -84,7 +110,7 @@ class Fluent::IkachanOutput < Fluent::Output
     messages.each do |msg|
       begin
         msg.split("\n").each do |m|
-          res = Net::HTTP.post_form(@notice_uri, {'channel' => @channel, 'message' => m})
+          res = http_post_request(@notice_uri, {'channel' => @channel, 'message' => m})
         end
       rescue
         $log.warn "out_ikachan: failed to send notice to #{@host}:#{@port}, #{@channel}, message: #{msg}"
@@ -94,7 +120,7 @@ class Fluent::IkachanOutput < Fluent::Output
     privmsg_messages.each do |msg|
       begin
         msg.split("\n").each do |m|
-          res = Net::HTTP.post_form(@privmsg_uri, {'channel' => @channel, 'message' => m})
+          res = http_post_request(@privmsg_uri, {'channel' => @channel, 'message' => m})
         end
       rescue
         $log.warn "out_ikachan: failed to send privmsg to #{@host}:#{@port}, #{@channel}, message: #{msg}"
@@ -124,4 +150,17 @@ class Fluent::IkachanOutput < Fluent::Output
     (message % values).gsub(/\\n/, "\n")
   end
 
+  def http_post_request(uri, params)
+    http = Net::HTTP.new(uri.host, uri.port)
+    if @ssl
+      http.use_ssl = true
+      unless @verify_ssl
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+    req = Net::HTTP::Post.new(uri.path)
+    req.set_form_data(params)
+    http.request req
+  end
+
 end

data/test/helper.rb

@@ -50,3 +50,9 @@ def get_content(server, port, path, headers={})
     http.get(path, headers).body
   }
 end
+
+def with_base_path(path)
+  prev_mount,@mount = @mount,path
+  yield
+  @mount = prev_mount
+end

data/test/plugin/test_out_ikachan.rb

@@ -1,5 +1,6 @@
 require 'helper'
 require 'cgi'
+require 'uri'
 
 class IkachanOutputTest < Test::Unit::TestCase
   IKACHAN_TEST_LISTEN_PORT = 4979
@@ -49,6 +50,81 @@ class IkachanOutputTest < Test::Unit::TestCase
     tag_key tag
   ]
 
+  CONFIG_HOST_NIL = %[
+    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
+  ]
+
+  CONFIG_INVALID_BASE_URI = %[
+    base_uri http://localhost:4979/ikachan
+    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
+  ]
+
+  CONFIG_BASE_URI = %[
+    base_uri http://localhost:4979/ikachan/
+    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
+  ]
+
+  CONFIG_BASIC_SSL = %[
+    host localhost
+    ssl true
+    verify_ssl false
+    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
+  ]
+
+  # base_uri starts with http, but ssl option is true
+  CONFIG_INVALID_SSL_1 = %[
+    base_uri http://localhost/
+    ssl true
+    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
+  ]
+
+  # base_uri starts with https, but ssl option is false
+  CONFIG_INVALID_SSL_2 = %[
+    base_uri https://localhost/
+    ssl false
+    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
+  ]
+
+  CONFIG_AUTO_ENABLE_SSL = %[
+    base_uri https://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 create_driver(conf=CONFIG,tag='test')
     Fluent::Test::OutputTestDriver.new(Fluent::IkachanOutput, tag).configure(conf)
   end
@@ -56,12 +132,34 @@ class IkachanOutputTest < Test::Unit::TestCase
   def test_configure
     d = create_driver
     assert_equal '#morischan', d.instance.channel
+    assert_equal 'http://localhost:4979/', d.instance.base_uri
+    assert_equal false, d.instance.ssl
     d = create_driver(CONFIG_NOTICE_ONLY)
     assert_equal '#morischan', d.instance.channel
     d = create_driver(CONFIG_PRIVMSG_ONLY)
     assert_equal '#morischan', d.instance.channel
     d = create_driver(CONFIG_LINE_FEED)
     assert_equal '#morischan', d.instance.channel
+    assert_raise Fluent::ConfigError do
+      create_driver(CONFIG_HOST_NIL)
+    end
+    assert_raise Fluent::ConfigError do
+      create_driver(CONFIG_INVALID_BASE_URI)
+    end
+    d = create_driver(CONFIG_BASE_URI)
+    assert_equal '#morischan', d.instance.channel
+    assert_equal 'http://localhost:4979/ikachan/', d.instance.base_uri
+    d = create_driver(CONFIG_BASIC_SSL)
+    assert_equal '#morischan', d.instance.channel
+    assert_raise Fluent::ConfigError do
+      create_driver(CONFIG_INVALID_SSL_1)
+    end
+    assert_raise Fluent::ConfigError do
+      create_driver(CONFIG_INVALID_SSL_2)
+    end
+    d = create_driver(CONFIG_AUTO_ENABLE_SSL)
+    assert_equal '#morischan', d.instance.channel
+    assert_equal true, d.instance.ssl
   end
 
   # CONFIG = %[
@@ -216,12 +314,45 @@ class IkachanOutputTest < Test::Unit::TestCase
     assert_equal "RETURN", @posted[i][:message]
   end
 
+  # CONFIG_BASE_URI = %[
+  #   base_uri http://localhost:4979/ikachan/
+  #   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_base_uri
+    with_base_path('/ikachan/') do
+      d = create_driver(CONFIG_BASE_URI)
+      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
+  end
+
   # setup / teardown for servers
   def setup
     Fluent::Test.setup
     @posted = []
     @prohibited = 0
     @auth = false
+    @mount = '/' # @mount 's first and last char should be '/'. it is for dummy server path handling
     @dummy_server_thread = Thread.new do
       srv = if ENV['VERBOSE']
               WEBrick::HTTPServer.new({:BindAddress => '127.0.0.1', :Port => IKACHAN_TEST_LISTEN_PORT})
@@ -231,6 +362,11 @@ class IkachanOutputTest < Test::Unit::TestCase
             end
       begin
         srv.mount_proc('/') { |req,res| # /join, /notice, /privmsg
+          # setup called before each test method. so @mount can not use for mount_proc.
+          unless req.path =~ /^#{@mount}/
+            res.status = 404
+            next
+          end
           # POST /join?channel=#channel&channel_keyword=keyword
           # POST /notice?channel=#channel&message=your_message
           # POST /privmsg?channel=#channel&message=your_message
@@ -249,12 +385,16 @@ class IkachanOutputTest < Test::Unit::TestCase
             # ok, authorization not required
           end
 
-          if req.path == '/'
+          if req.path == @mount
             res.status = 200
             next
           end
 
-          req.path =~ /^\/(join|notice|privmsg)$/
+          unless req.path =~ /^#{@mount}(join|notice|privmsg)$/
+            res.status = 404
+            next
+          end
+
           method = $1
           post_param = CGI.parse(req.body)
 
@@ -314,6 +454,14 @@ class IkachanOutputTest < Test::Unit::TestCase
     assert_equal 'notice', @posted[0][:method]
     assert_equal '#test', @posted[0][:channel]
     assert_equal 'NOW TESTING', @posted[0][:message]
+
+    @mount = '/ikachan/'
+    assert_equal '404', client.request_post('/', '').code
+    assert_equal '404', client.request_post('/join', 'channel=#test').code
+
+    assert_equal '200', client.request_post('/ikachan/', '').code
+    assert_equal '404', client.request_post('/ikachan/test', 'channel=#test').code
+    assert_equal '200', client.request_post('/ikachan/join', 'channel=#test').code
   end
 
   def teardown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ikachan
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,7 +57,8 @@ files:
 - test/helper.rb
 - test/plugin/test_out_ikachan.rb
 homepage: https://github.com/tagomoris/fluent-plugin-ikachan
-licenses: []
+licenses:
+- APLv2
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -74,10 +76,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: output plugin for IRC-HTTP gateway 'ikachan'
 test_files:
 - test/helper.rb
 - test/plugin/test_out_ikachan.rb
+has_rdoc: