fluent-plugin-jabber 0.0.1 → 0.1.0

data/Gemfile

@@ -1 +1,2 @@
+source :rubygems
 gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 todesking
+
+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.

data/README.md

@@ -29,6 +29,10 @@ See source for details.
       # Need 'jid' and 'password' field.
       pit_id jabber
 
+      # Or, put JID/password directly(exclusive for pit_id)
+      jid name@example.com
+      password pa55w0rd
+
       # Output target JID. Currently multi user chat only.
       room test@conference.localhost/test
     </match>
@@ -49,6 +53,15 @@ If 'body' field not set, the plugin raises error.
 
 ## Changes
 
+### 0.1.0
+
+* Add license
+* Updated Gemfile
+* Change file location to fluent plugin standard.
+* Add format option
+* Add test
+* Add jid/password option
+
 ### 0.0.1
 
-Initial release.
+* Initial release.

data/fluent-plugin-jabber.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-jabber"
-  gem.version       = "0.0.1"
+  gem.version       = "0.1.0"
   gem.authors       = ["todesking"]
   gem.email         = ["discommunicative@gmail.com"]
   gem.summary       = %q{Fluentd output plugin for XMPP(Jabber) protocol}
@@ -11,8 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "fluentd"
+  gem.add_development_dependency "rspec"
 
   gem.add_runtime_dependency "xmpp4r"
   gem.add_runtime_dependency "fluentd"

data/lib/fluent/plugin/out_jabber.rb

@@ -0,0 +1,70 @@
+require 'fluent/plugin'
+require 'fluent/config'
+require 'fluent/output'
+
+require 'xmpp4r'
+require 'xmpp4r/muc'
+
+require 'pit'
+
+class Fluent::JabberOutput < Fluent::Output
+  Fluent::Plugin.register_output('jabber', self)
+
+  config_param :pit_id, :string, default: nil
+  config_param :jid, :string, default: nil
+  config_param :password, :string, default: nil
+
+  # Currently, output target is group chat only.
+  config_param :room, :string
+
+  config_param :format, :string
+
+  attr_reader :jid
+  attr_reader :password
+
+  def configure(conf)
+    super
+
+    raise Fluent::ConfigError, "jid/password and pit_id is exclusive!!" if (@jid || @password) && @pit_id
+
+    if @pit_id
+      user_info = Pit.get(@pit_id, require: {
+        'jid' => 'jid',
+        'password' => 'password',
+      })
+      @jid = user_info['jid']
+      @password = user_info['password']
+    end
+  end
+
+  def start
+    jid = Jabber::JID.new(@jid)
+    @client = Jabber::Client.new(jid)
+    @client.connect
+    @client.auth(@password)
+
+    @muc_client = Jabber::MUC::MUCClient.new(@client)
+    @muc_client.join(@room)
+
+    $log.info("out_jabber plugin initialized(jid: #{self.jid}, room: #{self.room})")
+  end
+
+  def shutdown
+    @client.close
+  end
+
+  def emit(tag, es, chain)
+    es.each do|time, record|
+      send_message create_message(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]} }
+  end
+
+  def send_message(message)
+    @muc_client.send Jabber::Message.new(@room, message)
+  end
+end

data/spec/out_jabber_spec.rb

@@ -0,0 +1,117 @@
+require 'fluent/log'
+$log = Fluent::Log.new(STDERR, Fluent::Log::LEVEL_FATAL)
+
+require 'fluent/plugin/out_jabber'
+
+def create_fluent_config(hash, root = Fluent::Config.new)
+  hash.each do|k,v|
+    case v
+    when String
+      root[k.to_s] = v
+    when Hash
+      child = root.add_element(k.to_s, v[:__arg__] || nil)
+      create_fluent_config(v.dup.delete(:__arg__), child)
+    else
+      raise "Invalid value: #{v.inspect}"
+    end
+  end
+  root
+end
+
+describe Fluent::JabberOutput do
+  let(:default_config) {
+    {
+      pit_id: 'jabber',
+      room: 'the_room@conference.example.com',
+      format: 'message: ${message}',
+    }
+  }
+
+  let(:chain) { double('chain') }
+
+  context 'configuring(with pit)' do
+    before :each do
+      config = create_fluent_config(default_config)
+
+      Pit.stub(:get).with('jabber', anything).and_return('jid' => 'jabber@example.com', 'password' => 'pa55w0rd')
+
+      subject.configure(config)
+    end
+
+    its(:jid) { should == 'jabber@example.com' }
+    its(:password) { should == 'pa55w0rd' }
+    its(:room) { should == 'the_room@conference.example.com' }
+  end
+
+  context 'configureing(with jid/password)' do
+    before :each do
+      config_hash = default_config.merge(jid: 'jabber@example.com', password: 'pa55w0rd')
+      config_hash.delete :pit_id
+      config = create_fluent_config(config_hash)
+
+      subject.configure(config)
+    end
+
+    its(:jid) { should == 'jabber@example.com' }
+    its(:password) { should == 'pa55w0rd' }
+    its(:room) { should == 'the_room@conference.example.com' }
+  end
+
+  context 'config contains jid and pit_id' do
+    it 'should error' do
+      config_hash = default_config.merge(jid: 'jabber@example.com', password: 'pa55w0rd')
+      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')
+
+      jabber_client = double('jabber_client')
+      muc_client = double('muc_client')
+
+      Jabber::Client.stub(:new).with(Jabber::JID.new('jabber@example.com')).ordered.and_return(jabber_client)
+      jabber_client.should_receive(:connect).ordered
+      jabber_client.should_receive(:auth).with('pa55w0rd').ordered
+
+      Jabber::MUC::MUCClient.stub(:new).with(jabber_client).ordered.and_return(muc_client)
+      muc_client.should_receive(:join).with('the_room@conference.example.com')
+
+      subject.configure create_fluent_config(default_config)
+      subject.start
+    end
+  end
+
+  context 'emitting' do
+    let(:format) { 'hello!' }
+    before :each do
+      config = create_fluent_config(default_config.merge format: format)
+
+      Pit.stub(:get).with('jabber', anything).and_return('jid' => 'jabber@example.com', 'password' => 'pa55w0rd')
+
+      subject.configure(config)
+    end
+
+    it 'should send message to jabber conference room' do
+      subject.should_receive(:send_message).with('hello!').twice
+      chain.should_receive(:next).once
+
+      subject.emit('tag', [[0, {}], [1, {'a'=>'b'}]], chain)
+    end
+
+    context :format 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
+        chain.should_receive(:next).once
+
+        subject.emit('tag', [[0, {'a'=>1, 'x'=>{'y'=>2}}], [1, {'a'=>1}]], chain)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-jabber
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -100,9 +84,11 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - fluent-plugin-jabber.gemspec
-- lib/fluent/plugin/jabber.rb
+- lib/fluent/plugin/out_jabber.rb
+- spec/out_jabber_spec.rb
 homepage: https://github.com/todesking/fluent-plugin-jabber
 licenses: []
 post_install_message: 
@@ -127,4 +113,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Fluentd output plugin for XMPP(Jabber) protocol
-test_files: []
+test_files:
+- spec/out_jabber_spec.rb

data/lib/fluent/plugin/jabber.rb

@@ -1,54 +0,0 @@
-require 'fluent/plugin'
-require 'fluent/config'
-require 'fluent/output'
-
-require 'xmpp4r'
-require 'xmpp4r/muc'
-
-require 'pit'
-
-class Fluent::JabberOutput < Fluent::Output
-  Fluent::Plugin.register_output('jabber', self)
-
-  config_param :pit_id, :string
-
-  # Currently, output target is group chat only.
-  config_param :room, :string
-
-  def configure(conf)
-    super
-  end
-
-  def start
-    user_info = Pit.get(@pit_id, require: {
-      'jid' => 'jid',
-      'password' => 'password',
-    })
-
-    jid = Jabber::JID.new(user_info['jid'])
-    @client = Jabber::Client.new(jid)
-    @client.connect
-    @client.auth(user_info['password'])
-
-    @muc_client = Jabber::MUC::MUCClient.new(@client)
-    @muc_client.join(@room)
-
-    $log.info("out_jabber plugin initialized(jid: #{user_info['jid']}, room: #{@room})")
-  end
-
-  def shutdown
-    @client.close
-  end
-
-  def emit(tag, es, chain)
-    es.each do|time, record|
-      @muc_client.send create_message(time, record)
-    end
-    chain.next
-  end
-
-  def create_message(time, record)
-    raise "record['body'] is empty" unless record['body']
-    Jabber::Message.new(@room, record['body'])
-  end
-end