logstash-input-xmpp 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd677cb7751473d0fe2534f4d2e7ccc4de69841c
-  data.tar.gz: 34f45053e34da383501301246951c84f90dd99bb
+  metadata.gz: 5f7654171e6cb3907cc0d57643ce7d24f83c1e4a
+  data.tar.gz: 49aecec1d1f379eef0f10dadcb13f19190c8bf3a
 SHA512:
-  metadata.gz: 084074d5e7433d02e5a150d827c411a85f56667bc09183868c23d27624a36298a5d297517a81dd296bed27984a441ba6c9df17b7bcf28a73591fb6599ebf85b0
-  data.tar.gz: 89ad2641545e5bcb464d1d320c3e274ae2b0944282412fabf3526016952f6b71fbaa86b4b7968bb59e62979d587486c4f6da91a9257a3dab9b0680ee060f1037
+  metadata.gz: 926b87b06f2a7e0daedb56829ebeff1f9d260ea02c8377674ebbd559bff69d6e0fddfd32a05c146303c87a00f555562a0068552110f26b5c87c6184f8ef6365f
+  data.tar.gz: 3cb7146b33eb75210e7f0050e1a643c274fde15a832d9e6631bafb78ed3b40486ad2f2fbbaad49083f623fb61793d0d5d75ff0bee1b66b1d0f080b42367d5fe2

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/xmpp.rb

@@ -2,13 +2,17 @@
 require "logstash/inputs/base"
 require "logstash/namespace"
 
+require 'xmpp4r' # xmpp4r gem
+# load the MUC Client anyway, its mocked in testing
+require 'xmpp4r/muc/helper/simplemucclient'
+
 # This input allows you to receive events over XMPP/Jabber.
 #
 # This plugin can be used for accepting events from humans or applications
 # XMPP, or you can use it for PubSub or general message passing for logstash to
 # logstash.
 class LogStash::Inputs::Xmpp < LogStash::Inputs::Base
-  
+
   config_name "xmpp"
 
   default :codec, "plain"
@@ -32,26 +36,30 @@ class LogStash::Inputs::Xmpp < LogStash::Inputs::Base
   config :debug, :validate => :boolean, :default => false, :deprecated => "Use the logstash --debug flag for this instead."
 
   public
-  def register
-    require 'xmpp4r' # xmpp4r gem
-    Jabber::debug = true if @debug || @logger.debug?
 
+  def initialize(config)
+    super
     @client = Jabber::Client.new(Jabber::JID.new(@user))
-    @client.connect(@host) # it is ok if host is nil
-    @client.auth(@password.value)
-    @client.send(Jabber::Presence.new.set_type(:available))
+    @muc_clients = []
+  end
+
+  # and for testing access
+  attr_reader :client, :muc_clients
 
-    # load the MUC Client if we are joining rooms.
-    require 'xmpp4r/muc/helper/simplemucclient' if @rooms && !@rooms.empty?
+  def register
+    Jabber::debug = true if @debug || @logger.debug?
+    client.connect(@host) # it is ok if host is nil
+    client.auth(@password.value)
+    client.send(Jabber::Presence.new.set_type(:available))
   end # def register
 
-  public
+
   def run(queue)
-    if @rooms
+    if using_rooms?
       @rooms.each do |room| # handle muc messages in different rooms
-        @muc = Jabber::MUC::SimpleMUCClient.new(@client)
-        @muc.join(room)
-        @muc.on_message do |time,from,body|
+        muc = Jabber::MUC::SimpleMUCClient.new(client)
+        muc.join(room)
+        muc.on_message do |time, from, body|
           @codec.decode(body) do |event|
             decorate(event)
             event["room"] = room
@@ -59,22 +67,36 @@ class LogStash::Inputs::Xmpp < LogStash::Inputs::Base
             queue << event
           end
         end # @muc.on_message
+        # we need to hold a reference to the muc
+        # otherwise it will be GC'd
+        muc_clients.push(muc)
       end # @rooms.each
     end # if @rooms
 
-    @client.add_message_callback do |msg| # handle direct/private messages
+    client.add_message_callback do |msg| # handle direct/private messages
       # accept normal msgs (skip presence updates, etc)
       if msg.body != nil
         @codec.decode(msg.body) do |event|
           decorate(event)
-          # Maybe "from" should just be a hash: 
+          # Maybe "from" should just be a hash:
           # { "node" => ..., "domain" => ..., "resource" => ... }
           event["from"] = "#{msg.from.node}@#{msg.from.domain}/#{msg.from.resource}"
           queue << event
         end
       end
     end # @client.add_message_callback
-    sleep
+
+    # [GUY] the two clients: muc and client maintain their own threads
+    # and will call the blocks in those threads so this one should sleep
+    # this is how the xmpp4r examples do it (not saying it is correct)
+    Stud.stoppable_sleep(Float::INFINITY) { stop? }
+
+    client.close
   end # def run
 
+  private
+
+  def using_rooms?
+    @rooms && !@rooms.empty?
+  end
 end # class LogStash::Inputs::Xmpp

data/logstash-input-xmpp.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-xmpp'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This input allows you to receive events over XMPP/Jabber."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
 
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'xmpp4r', ['0.5']

data/spec/inputs/xmpp_spec.rb

@@ -1 +1,74 @@
+# encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require 'logstash/inputs/xmpp'
+require 'support/xmpp4r_mocks.rb'
+
+describe LogStash::Inputs::Xmpp do
+  let(:rooms) { ['logstash', 'kibana'] }
+  let(:config) do
+    {
+      'user' => 'foo@domain.org/chat',
+      'password' => 'bAr',
+      'rooms' => rooms
+    }
+  end
+
+  before do
+    allow(Jabber::Client).to receive(:new) do |jid|
+      Jabber::ClientMock.new(jid)
+    end
+
+    allow(Jabber::MUC::SimpleMUCClient).to receive(:new) do |client|
+      Jabber::MucClientMock.new(client)
+    end
+  end
+
+  context 'when running' do
+    let(:queue) { [] }
+    let(:msg)   { 'Hello Logstash'}
+    let(:inject_block) do
+      -> { subject.client.inject_message(Jabber::MessageMock.new(msg)) }
+    end
+
+    subject { LogStash::Inputs::Xmpp.new(config) }
+
+    before do
+      subject.register
+      plugin_thread = Thread.new(subject, queue) { |subj, que| subj.run(que) }
+      sleep 0.01 until plugin_thread.status == 'sleep'
+      inject_block.call
+      subject.stop
+    end
+
+    context "when using Client" do
+      it 'pushes normal events into a queue' do
+        event = queue.first
+        expect(event['message']).to eq(msg)
+        expect(event['from']).to eq('bar@domain.org/chat')
+      end
+    end
+
+    context "when using Rooms" do
+      let(:inject_block) do
+        -> do
+          subject.muc_clients.each do |muc|
+            muc.inject_message('now', 'bar', 'Hello Foo')
+          end
+        end
+      end
+
+      it 'pushes room events into a queue' do
+        rooms.each do |room|
+          event = queue.shift
+          expect(event['message']).to eq('Hello Foo')
+          expect(event['from']).to eq('bar')
+          expect(event['room']).to eq(room)
+        end
+      end
+    end
+  end
+
+  context 'when shutting down' do
+    it_behaves_like "an interruptible input plugin"
+  end
+end

data/spec/support/xmpp4r_mocks.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Jabber
+  class ClientMock
+    def initialize(jid)
+      @jid = jid
+      @message_block = ->(msg) { puts "!ERROR! ----> Should not see #{msg}"}
+    end
+    def connect(*) true; end
+    def auth(*) true; end
+    def send(*) true; end
+    def close(*) true; end
+    def add_presence_callback(*) true; end
+    def add_message_callback(*args, &block)
+      @message_block = block
+    end
+    def inject_message(msg)
+      @message_block.call(msg)
+    end
+  end
+
+  class MucClientMock
+    def initialize(client)
+      @message_block = ->(time, from, body) { puts "!!!!! ----> Should not see #{time}, #{from}, #{body}"}
+    end
+    def join(rm)
+    end
+    def on_message(&block)
+      @message_block = block
+    end
+    def inject_message(time, from, body)
+      @message_block.call(time, from, body)
+    end
+  end
+
+  class MessageMock
+    From = Struct.new(:node, :domain, :resource)
+    attr_reader :body, :from
+    def initialize(str)
+      @body = str
+      @from = From.new('bar','domain.org','chat')
+    end
+  end
+end

metadata

@@ -1,94 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-xmpp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.0.snapshot
+  name: logstash-core
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.snapshot
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: xmpp4r
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.5'
+  name: xmpp4r
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/xmpp.rb
 - logstash-input-xmpp.gemspec
 - spec/inputs/xmpp_spec.rb
+- spec/support/xmpp4r_mocks.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -111,9 +104,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: This input allows you to receive events over XMPP/Jabber.
 test_files:
 - spec/inputs/xmpp_spec.rb
+- spec/support/xmpp4r_mocks.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"