fluent-plugin-jabber 0.1.1 → 0.3.0

data/README.md

@@ -40,8 +40,13 @@ See source for details.
       # To prevent it, specify unique nickname per plugin definition.
       room test@conference.localhost/unique_nickname
 
+      # Required, plain text message format.
       format Hello!\n${user.name} # ${user.name} replaced with record['user']['name']
 
+	  # Optional, XHTML message format.
+      # NOTE: Use '\{sharp}' instead of '#' due to fluentd treat '#' to 'Begin of comment'
+	  xhtml_format <span style="color:\{sharp}FF0000">Hello!<strong>${user.name}</strong></span>
+
       # Enable detailed log of XMPP4R
       jabber_debug_log true
       jabber_warnings_log true
@@ -63,6 +68,16 @@ If 'body' field not set, the plugin raises error.
 
 ## Changes
 
+### 0.3.0
+
+* Add filter: br
+* Fix xhtml message building
+* Fix xhtml message encoding error
+
+### 0.2.0
+
+* Add xhtml_format option
+
 ### 0.1.1
 
 * Fix Encoding::CompatibilityError while parsing XMPP messages caused by default_internal is ASCII_8BIT.

data/fluent-plugin-jabber.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-jabber"
-  gem.version       = "0.1.1"
+  gem.version       = "0.3.0"
   gem.authors       = ["todesking"]
   gem.email         = ["discommunicative@gmail.com"]
   gem.summary       = %q{Fluentd output plugin for XMPP(Jabber) protocol}

data/lib/fluent/plugin/out_jabber.rb

@@ -27,7 +27,9 @@ class Fluent::JabberOutput < Fluent::Output
   # Currently, output target is group chat only.
   config_param :room, :string
 
+  # Plain text/XHTML format. These options are exclusive.
   config_param :format, :string
+  config_param :xhtml_format, :string, default: nil
 
   # Enable error/warning logs of XMPP4R
   # This configuration is global
@@ -73,16 +75,67 @@ class Fluent::JabberOutput < Fluent::Output
 
   def emit(tag, es, chain)
     es.each do|time, record|
-      send_message create_message(time, record)
+      send_message plain_text_format(time, record), xhtml_format(time, record)
     end
     chain.next
   end
 
-  def create_message(time, record)
-    message = @format.gsub(/\\n/, "\n").gsub(/\${([\w.]+)}/) { $1.split('.').inject(record) {|r,k| (r||{})[k]} }
+  def plain_text_format(time, record)
+    format_with(@format, time, record, false)
   end
 
-  def send_message(message)
-    @muc_client.send Jabber::Message.new(@room, message)
+  def xhtml_format(time, record)
+    format_with(@xhtml_format, time, record, true)
+  end
+
+  def format_with(format_string, time, record, need_escape)
+    return nil unless format_string
+    format_string.gsub(/\\n/, "\n").gsub(/\\{sharp}/,'#').gsub(/\${([\w.]+)(?:\|([\w]+))?}/) {
+      data = $1.split('.').inject(record) {|r,k| (r||{})[k]}
+      filter = $2
+      case filter
+      when nil
+        data = escape_xhtml(data) if need_escape
+      when 'br'
+        data = escape_xhtml(data).gsub(/\n/, '<br />')
+      else
+        raise "Unknown filter: #{filter}"
+      end
+      data
+    }
+  end
+
+  def escape_xhtml(data)
+    REXML::Text.new(data.to_s, true, nil, false).to_s
+  end
+
+  def send_message(plain_text, xhtml_text)
+    message = Jabber::Message.new(@room, plain_text.force_encoding(Encoding::UTF_8))
+    set_xhtml_message(message, xhtml_text) if xhtml_text
+
+    @muc_client.send message
+  end
+
+  def set_xhtml_message(message, xhtml_text)
+    # http://devblog.famundo.com/articles/2006/10/18/ruby-and-xmpp-jabber-part-3-adding-html-to-the-messages
+    # Create the html part
+    h = REXML::Element::new("html")
+    h.add_namespace('http://jabber.org/protocol/xhtml-im')
+
+    # The body part with the correct namespace
+    b = REXML::Element::new("body")
+    b.add_namespace('http://www.w3.org/1999/xhtml')
+
+    # This suggested method not works for me:
+    #   REXML::Text.new( message, false, nil, true, nil, %r/.^/ )
+    # So I try alternative.
+    REXML::Document.new("<div>#{xhtml_text}</div>").children.each do|c|
+      b.add c
+    end
+
+    h.add(b)
+
+    # Add the html element to the message
+    message.add_element(h)
   end
 end

data/spec/out_jabber_spec.rb

@@ -66,6 +66,15 @@ describe Fluent::JabberOutput do
     end
   end
 
+  context 'config not contains format' do
+    it 'should raise ConfigError' do
+      config_hash = default_config.reject{|k,v| [:format].include? k}
+      config = create_fluent_config(config_hash)
+
+      expect { subject.configure config }.to raise_error Fluent::ConfigError
+    end
+  end
+
   context 'connecting' do
     it 'should connect with configured parameters' do
       Pit.stub(:get).with('jabber', anything).and_return('jid' => 'jabber@example.com', 'password' => 'pa55w0rd')
@@ -96,7 +105,7 @@ describe Fluent::JabberOutput do
     end
 
     it 'should send message to jabber conference room' do
-      subject.should_receive(:send_message).with('hello!').twice
+      subject.should_receive(:send_message).with('hello!', nil).twice
       chain.should_receive(:next).once
 
       subject.emit('tag', [[0, {}], [1, {'a'=>'b'}]], chain)
@@ -106,12 +115,57 @@ describe Fluent::JabberOutput do
       let(:format) { 'a=${a}, x.y=${x.y}' }
 
       it 'should format message with received record' do
-        subject.should_receive(:send_message).with('a=1, x.y=2').ordered
-        subject.should_receive(:send_message).with('a=1, x.y=').ordered
+        subject.should_receive(:send_message).with('a=1, x.y=2', nil).ordered
+        subject.should_receive(:send_message).with('a=1, x.y=', nil).ordered
         chain.should_receive(:next).once
 
         subject.emit('tag', [[0, {'a'=>1, 'x'=>{'y'=>2}}], [1, {'a'=>1}]], chain)
       end
     end
+
+    context 'special notations' do
+      let(:format) { 'a\n\{sharp}' }
+
+      it 'should handle some special notations' do
+        subject.should_receive(:send_message).with("a\n#", nil)
+        chain.should_receive(:next).once
+
+        subject.emit('tag', [[0, {}]], chain)
+      end
+    end
+  end
+
+  context 'filter' do
+    context '|br' do
+      it 'should convert CR to <br />' do
+        subject.format_with('${a|br}', 0, {'a'=>"a\nb"}, false).should == "a<br />b"
+      end
+      it 'should convert CR to <br />, after xhtml_escape' do
+        subject.format_with('${a|br}', 0, {'a'=>"<>\n"}, false).should == "&lt;&gt;<br />"
+      end
+    end
+  end
+
+  context 'xhtml_format' do
+    let(:xhtml_format) { '<p>${message}</p>' }
+    let(:format) { '${message}' }
+    before :each do
+      config_hash = default_config.merge(
+        xhtml_format: xhtml_format,
+        format: format,
+      )
+      config = create_fluent_config(config_hash)
+
+      Pit.stub(:get).with('jabber', anything).and_return('jid' => 'jabber@example.com', 'password' => 'pa55w0rd')
+
+      subject.configure(config)
+    end
+
+    it 'should send xml-escaped record data to jabber' do
+      subject.should_receive(:send_message).with('><', '<p>&gt;&lt;</p>')
+      chain.should_receive(:next).once
+
+      subject.emit('tag', [[0, {'message' => '><'}]], chain)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-jabber
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,10 +109,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Fluentd output plugin for XMPP(Jabber) protocol
 test_files:
 - spec/out_jabber_spec.rb
-has_rdoc: