logstash-input-rss 0.1.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17bd99754667eeb1a14e5644c9bbee42b36f7662
-  data.tar.gz: 4234132155000c65aad31aae2b2e0bffd6225e7a
+  metadata.gz: 3052f6479914280e303878361fb7b0e2d8aba99b
+  data.tar.gz: fce5d598d3b75be9e043bc13287d116df35e5bc4
 SHA512:
-  metadata.gz: 058123631f8790cf09782ef85728bc3cb193fbacd069e0904f52580ef8914eb53b2247ccab732cdef215bdd23a6f54f03533dad7eece2f9a9f5c38eb1f93df12
-  data.tar.gz: 119f51991290cc49118b3bae85185427c4f7a768f767f554321378792ed8470a1d62b3352d0277e8b61559a18da388d15a01ad1a08b15a72ab36d1491f590544
+  metadata.gz: b69f1ca6e81488667aa9e2fc82ba73067cde200392d71f8c10ec9f24cdfc9bce29bc7ba3206ff345ad8697c240b9506caab04cdd380b8e0f620e3e52772cab61
+  data.tar.gz: 239bd0fc9ec8098e94847ef84fd5b50058b480a8e57547702c3f0370d5a72e5beb969d0583a1f49fb609ba1eb0d75c5939bfbd2b8ec5313b7da8d385204e3f72

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -1,19 +1,19 @@
 # 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?
 
-Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 
@@ -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/rss.rb

@@ -2,6 +2,9 @@
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket" # for Socket.gethostname
+require "stud/interval"
+require "faraday"
+require "rss"
 
 # Run command line tools and capture the whole output as an event.
 #
@@ -25,57 +28,20 @@ class LogStash::Inputs::Rss < LogStash::Inputs::Base
 
   public
   def register
-    require "faraday"
-    require "rss"
     @logger.info("Registering RSS Input", :url => @url, :interval => @interval)
   end # def register
 
   public
   def run(queue)
-    loop do
+    @run_thread = Thread.current
+    while !stop?
       start = Time.now
       @logger.info? && @logger.info("Polling RSS", :url => @url)
 
       # Pull down the RSS feed using FTW so we can make use of future cache functions
       response = Faraday.get @url
-      body = response.body
-      # @logger.debug("Body", :body => body)
-      # Parse the RSS feed
-      feed = RSS::Parser.parse(body)
-      feed.items.each do |item|
-        # Put each item into an event
-        @logger.debug("Item", :item => item.author)
-        case feed.feed_type
-          when 'rss'
-            @codec.decode(item.description) do |event|
-              event["Feed"] = @url
-	      event["published"] = item.pubDate
-	      event["title"] = item.title
-	      event["link"] = item.link
-	      event["author"] = item.author
-              decorate(event)
-              queue << event
-            end
-	  when 'atom'
-	    if ! item.content.nil?
-		content = item.content.content
-	    else
-		content = item.summary.content
-	    end
-            @codec.decode(content) do |event|
-              event["Feed"] = @url
-	      event["updated"] = item.updated.content
-	      event["title"] = item.title.content
-	      event["link"] = item.link.href
-	      event["author"] = item.author.name.content
-	      unless item.published.nil?
-	          event["published"] = item.published.content
-	      end
-              decorate(event)
-              queue << event
-            end
-        end
-      end
+      handle_response(response)
+
       duration = Time.now - start
       @logger.info? && @logger.info("Command completed", :command => @command,
                                     :duration => duration)
@@ -88,8 +54,53 @@ class LogStash::Inputs::Rss < LogStash::Inputs::Base
                      :command => @command, :duration => duration,
                      :interval => @interval)
       else
-        sleep(sleeptime)
+        Stud.stoppable_sleep(sleeptime) { stop? }
       end
     end # loop
-  end # def run
+  end
+
+  def handle_response(response)
+    body = response.body
+    # @logger.debug("Body", :body => body)
+    # Parse the RSS feed
+    feed = RSS::Parser.parse(body)
+    feed.items.each do |item|
+      # Put each item into an event
+      @logger.debug("Item", :item => item.author)
+      case feed.feed_type
+        when 'rss'
+          @codec.decode(item.description) do |event|
+            event["Feed"] = @url
+            event["published"] = item.pubDate
+            event["title"] = item.title
+            event["link"] = item.link
+            event["author"] = item.author
+            decorate(event)
+            queue << event
+          end
+        when 'atom'
+          if ! item.content.nil?
+            content = item.content.content
+          else
+            content = item.summary.content
+          end
+          @codec.decode(content) do |event|
+            event["Feed"] = @url
+            event["updated"] = item.updated.content
+            event["title"] = item.title.content
+            event["link"] = item.link.href
+            event["author"] = item.author.name.content
+            unless item.published.nil?
+              event["published"] = item.published.content
+            end
+            decorate(event)
+            queue << event
+          end
+      end
+    end
+  end
+
+  def stop
+    Stud.stop!(@run_thread) if @run_thread
+  end
 end # class LogStash::Inputs::Exec

data/logstash-input-rss.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-rss'
-  s.version         = '0.1.4'
+  s.version         = '2.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Poll an RSS/Atom feed."
   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,10 +20,11 @@ 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", "< 3.0.0"
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'addressable'
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'stud', "~> 0.0.22"
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/inputs/rss_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/rss"
+
+describe LogStash::Inputs::Rss do
+  describe "stopping" do
+    let(:config) { {"url" => "localhost", "interval" => 10} }
+    before do
+      allow(Faraday).to receive(:get)
+      allow(subject).to receive(:handle_response)
+    end
+    it_behaves_like "an interruptible input plugin"
+  end
+end

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-rss
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   name: logstash-core
   prerelease: false
   type: :runtime
@@ -26,10 +26,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -58,6 +58,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: faraday
+  prerelease: false
+  type: :runtime
+  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.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.22
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -78,11 +106,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/rss.rb
 - logstash-input-rss.gemspec
 - spec/inputs/rss_spec.rb
@@ -108,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Poll an RSS/Atom feed.

data/Rakefile

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