logstash-input-irc 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40fc37ec1f7ce6a5c7ca80b9c9c6ba2d6eb0ce3a
-  data.tar.gz: dcfd76081bb32869f2fa56fa4d00d43d2f7c8633
+  metadata.gz: cace7a5e1b01c9e4fa461ea71fed7fd49d8c86ae
+  data.tar.gz: 0c6ba7cf5fc467a41c8a1cf241e070e1ced10588
 SHA512:
-  metadata.gz: 8fda29ba672bc0caa64e481ebbd54e69420047e308e07c4cb8d2c80e87a0bb0b3647e9005e6ee9a4f7ad8b3e9411f3263cef83cf78450796c321ed63c580d848
-  data.tar.gz: b0bece388946e04d39c5d3d2fd9802df2423f93b508cc1e59d761451bc022d3c5860a3ec6353eb070947ca3ccd36277fe299c4e03e09352654aaaad6d89f3d34
+  metadata.gz: 0d674f160aff5a3ffa81075d5f2be4df25beb51c3f6a4ff98ebe9038a90f85347bf431c073dce673f9f32c93ac87a018e3852aa11ea1ff2cc1a764c75f6e09fa
+  data.tar.gz: c840297ce74132b6af4b48cb7fd43fca6b0f6cba136c12b784c186f348e933ecba0d859266de9ea8f42d61a3a482aa0d6911ae44cdc36dc2601e6a16276f4b40

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.1.0
+ - Add basic tests for the project
+ - Refactor the plugin to include the option to add an option to inject
+   a dummy bot.
+ - Refactor the plugin to have a cleaner shutdown methodology, so the
+   thread is not stuck waiting in the queue if there is no reason.

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/irc.rb

@@ -2,7 +2,8 @@
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "thread"
-
+require "stud/task"
+require "stud/interval"
 # Read events from an IRC Server.
 #
 class LogStash::Inputs::Irc < LogStash::Inputs::Base
@@ -52,6 +53,16 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
   config :channels, :validate => :array, :required => true
 
   public
+
+  def inject_bot(bot)
+    @bot = bot
+    self
+  end
+
+  def bot
+    @bot
+  end
+
   def register
     require "cinch"
     @user_stats = Hash.new
@@ -59,7 +70,7 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
     @catch_all = true if  @get_stats
     @logger.info("Connecting to irc server", :host => @host, :port => @port, :nick => @nick, :channels => @channels)
 
-    @bot = Cinch::Bot.new
+    @bot ||= Cinch::Bot.new
     @bot.loggers.clear
     @bot.configure do |c|
       c.server = @host
@@ -77,29 +88,34 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
           queue << m
         end
     else
-        @bot.on :channel  do |m|
-          queue << m
-        end
+      @bot.on :channel  do |m|
+        queue << m
+      end
     end
-
   end # def register
 
   public
   def run(output_queue)
     @bot_thread = Stud::Task.new(@bot) do |bot|
-        bot.start
+      bot.start
     end
     if @get_stats
       @request_names_thread = Stud::Task.new do
-        loop do
-          sleep (@stats_interval * 60)
+        while !stop?
+          Stud.stoppable_sleep (@stats_interval * 60) do
+            stop?
+          end
           request_names
         end
       end
     end
-    loop do
-      msg = @irc_queue.pop
-      handle_response(msg, output_queue)
+    while !stop?
+      begin
+        msg = @irc_queue.pop(true)
+        handle_response(msg, output_queue)
+      rescue ThreadError
+        # Empty queue
+      end
     end
   end # def run
 
@@ -150,8 +166,8 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
     end
   end
 
-  def teardown
-    @request_names_thread#stop!
-    @bot_thread#stop!
+  def stop
+    @request_names_thread.stop! if @request_names_thread
+    @bot_thread.stop!
   end
 end # class LogStash::Inputs::Irc

data/logstash-input-irc.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-irc'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read events from an IRC Server."
   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,8 +20,8 @@ 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 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'cinch'
 

data/spec/inputs/irc_spec.rb

@@ -1,3 +1,78 @@
 # encoding: utf-8
-require "logstash/devutils/rspec/spec_helper"
-require 'logstash/inputs/irc'
+require_relative "../spec_helper"
+require "logstash/plugin"
+require "logstash/event"
+require "cinch"
+
+describe LogStash::Inputs::Irc do
+
+  let(:properties) { {:name => "foo" } }
+  let(:event)      { LogStash::Event.new(properties) }
+
+  let(:host)       { "irc.freenode.org" }
+  let(:channels)   { ["foo", "bar"] }
+
+  it "should register without errors" do
+    plugin = LogStash::Plugin.lookup("input", "irc").new({ "host" => host, "channels" => channels })
+    expect { plugin.register }.to_not raise_error
+  end
+
+  context "when stopping the plugin" do
+    it_behaves_like "an interruptible input plugin" do
+      let(:host)       { "irc.freenode.org" }
+      let(:channels)   { ["foo", "bar"] }
+      let(:config) { {  "host" => host, "channels" => channels, "get_stats" => true } }
+    end
+  end
+
+  describe "receive" do
+
+    let(:config) { { "host" => host, "channels" => channels } }
+    subject      { LogStash::Inputs::Irc.new(config) }
+
+    let(:msg)    { double("message") }
+    let(:user)   { double("user") }
+
+    before(:each) do
+      allow(msg).to receive(:message).and_return("message")
+      allow(msg).to receive(:command).and_return("command")
+      allow(user).to receive(:host).and_return("host")
+      allow(user).to receive(:nick).and_return("nick")
+      allow(msg).to receive(:user).and_return(user)
+      allow(msg).to receive(:prefix).and_return("prefix")
+      allow(msg).to receive(:channel).and_return("channel")
+
+      subject.inject_bot(bot).register
+    end
+
+    let(:bot)     { Cinch::Bot.new }
+    let(:channel) { bot.handlers.find(:channel).first }
+    let(:nevents) { 1 }
+
+    let(:events) do
+      input(subject) do |queue|
+        nevents.times do
+          channel.call(msg, [], [])
+        end
+        result = nevents.times.inject([]) do |acc|
+          acc << queue.pop
+        end
+        result
+      end
+    end
+
+    let(:event) { events.first }
+
+    it "receive events from a channel" do
+      expect(event["channel"]).to eq("channel")
+    end
+
+    it "receive events with a command" do
+      expect(event["command"]).to eq("command")
+    end
+
+    it "receive events with nick information" do
+      expect(event["nick"]).to eq("nick")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/inputs/irc'
+
+module IrcHelpers
+
+  def input(plugin, &block)
+    queue = Queue.new
+
+    input_thread = Thread.new do
+      plugin.run(queue)
+    end
+    result = block.call(queue)
+
+    plugin.do_stop
+    input_thread.join
+    result
+  end
+
+end
+
+RSpec.configure do |c|
+  c.include IrcHelpers
+end

metadata

@@ -1,94 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-irc
 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
   name: logstash-core
+  prerelease: false
+  type: :runtime
   version_requirements: !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
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.0.22
+  name: stud
   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: 0.0.22
+- !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: cinch
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: cinch
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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/irc.rb
 - logstash-input-irc.gemspec
 - spec/inputs/irc_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -111,9 +118,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: Read events from an IRC Server.
 test_files:
 - spec/inputs/irc_spec.rb
+- spec/spec_helper.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"