logstash-input-twitter 3.0.7 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed491f3d9eceda7647d5a61910429aee7b24398c25d86657236c5071912f01f
-  data.tar.gz: 3216fc1c1a75d715b8ef5c77cc09539aab03b9091da8e3c3e2aa0cd28440abfb
+  metadata.gz: 90a556dabd75cd5e9260c327a7bdffa6bfe5e7fe4f80457901505953d7dc31f2
+  data.tar.gz: c83225608136218ea6b950f158fcd1983b3455c533f37a4f01d768b1e6dc03e2
 SHA512:
-  metadata.gz: 84305d5732003098a51659489fb3b93c05a664cc53734143de2512ccca04be6f542b8d3122c13b9b29a285e1b49688c37d7ae8426570be42466f936ba7aa268e
-  data.tar.gz: 87ea22afa88f4d5e9978a4b3e0e9edae0188e800f4ee244561aa1efc9bd25eac77309754b1820785137347fa886e8dc168bcafb35244ce6000e3856ee8065735
+  metadata.gz: cced602c79e40db401fb8a2547fc2a4756a9680b62ce31852f953bcc7a17942076378e04e403505403152f8d751b9a61f90d643ff406aa3cbc90e23438291fbe
+  data.tar.gz: 7e2cef7a66efcd33566dab11d6e293b07a6a3458d22c66372b28f63dcec676dcba2fff6e63c5aec7f41836109afda8d4233f1a4c7e76625c4bbbd8fff71c8900

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 4.0.3
+ - Fix: broken proxy configuration [#69](https://github.com/logstash-plugins/logstash-input-twitter/pull/69)
+
+## 4.0.2
+
+  - Fix: user rest api call + proxy configuration [#68](https://github.com/logstash-plugins/logstash-input-twitter/pull/68)
+
+## 4.0.1
+  - Updated Twitter gem to v6.2.0, cleaned up obsolete monkey patches, fixed integration tests [#63](https://github.com/logstash-plugins/logstash-input-twitter/pull/63)
+
+## 4.0.0
+  - Update http-form_data to ~> 2 and public_suffix to ~> 3
+
+## 3.0.8
+  - Docs: Set the default_codec doc attribute.
+
 ## 3.0.7
   - Update gemspec summary
 

data/Gemfile

@@ -2,9 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
-logstash_path = "../../logstash"
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
 
-if Dir.exist?(logstash_path) && ENV["LOGSTASH_SOURCE"] == 1
+if Dir.exist?(logstash_path) && use_logstash_source
   gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
   gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
 end

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/index.asciidoc

@@ -1,5 +1,6 @@
 :plugin: twitter
 :type: input
+:default_codec: plain
 
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
@@ -85,7 +86,7 @@ registering a new application with Twitter:
 
 A comma separated list of user IDs, indicating the users to
 return statuses for in the Twitter stream.
-See https://dev.twitter.com/streaming/overview/request-parameters#follow
+See https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters
 for more details.
 
 [id="plugins-{type}s-{plugin}-full_tweet"]
@@ -224,3 +225,5 @@ follows, locations, and languages options will be ignored. Default => false
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

data/lib/logstash/inputs/twitter.rb

@@ -5,6 +5,7 @@ require "logstash/timestamp"
 require "logstash/util"
 require "logstash/json"
 require "stud/interval"
+require "twitter"
 require "logstash/inputs/twitter/patches"
 
 # Ingest events from the Twitter Streaming API.
@@ -104,8 +105,6 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
   config :rate_limit_reset_in, :validate => :number, :default => 300
 
   def register
-    require "twitter"
-
     if !@use_samples && ( @keywords.nil? && @follows.nil? && @locations.nil? )
       raise LogStash::ConfigurationError.new("At least one parameter (follows, locations or keywords) must be specified.")
     end
@@ -129,17 +128,7 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
     @event_generation_error_count = 0
 
     begin
-      if @use_samples
-        @stream_client.sample do |tweet|
-          return if stop?
-          tweet_processor(queue, tweet)
-        end
-      else
-        @stream_client.filter(twitter_options) do |tweet|
-          return if stop?
-          tweet_processor(queue, tweet)
-        end
-      end
+      do_run(queue)
     rescue Twitter::Error::TooManyRequests => e
       sleep_for = e.rate_limit.reset_in || @rate_limit_reset_in # 5 minutes default value from config
       @logger.warn("Twitter too many requests error, sleeping for #{sleep_for}s")
@@ -147,11 +136,26 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
       retry
     rescue => e
       # if a lot of these errors begin to occur, the repeated retry will result in TooManyRequests errors trapped above.
-      @logger.warn("Twitter client error", :message => e.message, :exception => e.class.name, :backtrace => e.backtrace, :options => @filter_options)
+      @logger.warn("Twitter client error", :message => e.message, :exception => e.class, :backtrace => e.backtrace, :options => @filter_options)
       retry
     end
   end # def run
 
+  def do_run(queue)
+    if @use_samples
+      @stream_client.sample do |tweet|
+        return if stop?
+        tweet_processor(queue, tweet)
+      end
+    else
+      @stream_client.filter(twitter_options) do |tweet|
+        return if stop?
+        tweet_processor(queue, tweet)
+      end
+    end
+  end
+  private :do_run
+
   def stop
     @stream_client = nil
   end
@@ -174,7 +178,7 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
         queue << event
       rescue => e
         @event_generation_error_count = @event_generation_error_count.next
-        @logger.error("Event generation error", :message => e.message, :exception => e.class.name, :backtrace => e.backtrace.take(10))
+        @logger.error("Event generation error", :message => e.message, :exception => e.class, :backtrace => e.backtrace)
       end
     end
   end
@@ -217,16 +221,17 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
     event
   end
 
-  def configure(c)
-    c.consumer_key = @consumer_key
-    c.consumer_secret = @consumer_secret.value
-    c.access_token = @oauth_token
-    c.access_token_secret = @oauth_token_secret.value
+  def configure(client)
+    client.consumer_key = @consumer_key
+    client.consumer_secret = @consumer_secret.value
+    client.access_token = @oauth_token
+    client.access_token_secret = @oauth_token_secret.value
     if @use_proxy
-      c.proxy =  {
-        proxy_address: @proxy_address,
-        proxy_port: @proxy_port,
-      }
+      if client.is_a?(Twitter::REST::Client)
+        client.proxy = { host: @proxy_address, port: @proxy_port }
+      else
+        client.proxy = { proxy_address: @proxy_address, proxy_port: @proxy_port }
+      end
     end
   end
 
@@ -237,15 +242,18 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
     build_options[:language]  = @languages.join(",") if @languages && !@languages.empty?
 
     if @follows && @follows.length > 0
-      build_options[:follow]    = @follows.map do |username|
-        (  !is_number?(username) ? find_user(username) : username )
+      build_options[:follow] = @follows.map do |username|
+        is_number?(username) ? username : find_user_id(username).to_s
       end.join(",")
     end
     build_options
   end
 
-  def find_user(username)
-    @rest_client.user(:user => username)
+  # @return [Integer] user id
+  # @raise [Twitter::Error::NotFound]
+  def find_user_id(username)
+    @logger.debug? && @logger.debug("Looking up twitter user identifier for", :user => username)
+    @rest_client.user(:screen_name => username).id # Twitter::User#id
   end
 
   def is_number?(string)

data/lib/logstash/inputs/twitter/patches.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
-require 'twitter/streaming/connection'
 require 'twitter/streaming/response'
-require 'twitter/streaming/message_parser'
 
 module LogStash
   module Inputs
@@ -10,58 +8,23 @@ module LogStash
       def self.patch
         verify_version
         patch_json
-        patch_connection_stream
-        patch_request
+        patch_http_request
       end
 
       private
 
       def self.verify_version
-        raise("Incompatible Twitter gem version and the LogStash::Json.load") unless ::Twitter::Version.to_s == "5.15.0"
-      end
-
-      def self.patch_connection_stream
-        ::Twitter::Streaming::Connection.class_eval do
-          def stream(request, response)
-            socket = @tcp_socket_class.new(Resolv.getaddress(request.socket_host), request.socket_port)
-            socket = ssl_stream(socket) if !request.using_proxy?
-
-            request.stream(socket)
-            while body = socket.readpartial(1024) # rubocop:disable AssignmentInCondition
-              response << body
-            end
-          end
-
-          def ssl_stream(client)
-            client_context = OpenSSL::SSL::SSLContext.new
-            ssl_client     = @ssl_socket_class.new(client, client_context)
-            ssl_client.connect
-          end
-
-          def normalized_port(scheme)
-            HTTP::URI.port_mapping[scheme]
-          end
-        end
-      end
-
-      def self.patch_request
-        ::Twitter::Streaming::Client.class_eval do
-          def request(method, uri, params)
-            before_request.call
-            headers = ::Twitter::Headers.new(self, method, uri, params).request_headers
-            request = ::HTTP::Request.new(method, uri + '?' + to_url_params(params), headers, proxy)
-            response = ::Twitter::Streaming::Response.new do |data|
-              if item = ::Twitter::Streaming::MessageParser.parse(data) # rubocop:disable AssignmentInCondition
-                yield(item)
-              end
-            end
-            @connection.stream(request, response)
-          end
-        end
+        raise("Incompatible Twitter gem version and the LogStash::Json.load") unless ::Twitter::Version.to_s == "6.2.0"
+        # NOTE: we're also known to work with twitter gem version 7.0 which uses http 4.x
+        raise("Incompatible HTTP gem version: #{HTTP::VERSION}") if HTTP::VERSION >= '5.0' || HTTP::VERSION < '3.0'
+        # after a major upgrade, unless CI is running integration specs, please run integration specs manually
       end
 
       def self.patch_json
         ::Twitter::Streaming::Response.module_eval do
+          unless method_defined? :on_body
+            raise "::Twitter::Streaming::Response#on_body not defined!" # patch bellow needs a review
+          end
           def on_body(data)
             @tokenizer.extract(data).each do |line|
               next if line.empty?
@@ -75,6 +38,27 @@ module LogStash
         end
       end
 
+      def self.patch_http_request
+        # NOTE: we might decide to drop the patch at some point, for now proxies such as squid
+        # are opinionated about having full URIs in the http head-line (having only /path fails
+        # with 400 Bad Request in Squid 4.10).
+        ::HTTP::Request.class_eval do
+          unless method_defined? :headline
+            raise "::HTTP::Request#headline not defined!" # patch bellow needs a review
+          end
+          def headline
+            request_uri =
+                if using_proxy? #&& !uri.https?
+                  uri.omit(:fragment)
+                else
+                  uri.request_uri
+                end
+
+            "#{verb.to_s.upcase} #{request_uri} HTTP/#{version}"
+          end
+        end
+      end
+
     end
   end
 end

data/logstash-input-twitter.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
-
   s.name            = 'logstash-input-twitter'
-  s.version         = '3.0.7'
+  s.version         = '4.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events from the Twitter Streaming API"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -19,11 +18,15 @@ Gem::Specification.new do |s|
   # Special flag to let us know this is actually a logstash plugin
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
+  # public_suffix 3.x+ includes ruby syntax from 2.1
+  # This effectively requires Logstash >= 6.x
+  s.required_ruby_version = '>= 2.1.0'
+
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency 'twitter', '5.15.0'
-  s.add_runtime_dependency 'http-form_data', '<= 1.0.1'
-  s.add_runtime_dependency 'public_suffix', '<= 1.4.6'
+  s.add_runtime_dependency 'twitter', '6.2.0'
+  s.add_runtime_dependency 'http-form_data', '~> 2'
+  s.add_runtime_dependency 'public_suffix', '~> 3'
   s.add_runtime_dependency 'stud', '>= 0.0.22', '< 0.1'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/twitter_spec.rb

@@ -1,4 +1,5 @@
 require_relative "../spec_helper"
+require "logstash/devutils/rspec/shared_examples"
 
 describe LogStash::Inputs::Twitter do
 
@@ -14,10 +15,12 @@ describe LogStash::Inputs::Twitter do
 
   let(:plugin) { LogStash::Inputs::Twitter.new(config) }
 
+  let(:queue) { Queue.new }
+
   describe "registration" do
 
     it "not raise error" do
-      expect {plugin.register}.to_not raise_error
+      expect { plugin.register }.to_not raise_error
     end
 
     context "with no required configuration fields" do
@@ -31,7 +34,30 @@ describe LogStash::Inputs::Twitter do
       end
 
       it "raise an error if no required fields are specified" do
-        expect {plugin.register}.to raise_error(LogStash::ConfigurationError)
+        expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
+      end
+    end
+
+    context "with follows" do
+
+      let(:user) { Twitter::User.new(id: 11111111) }
+
+      let(:config) do
+        {
+            'consumer_key' => 'foo',
+            'consumer_secret' => 'foo',
+            'oauth_token' => 'foo',
+            'oauth_token_secret' => 'foo',
+            'keywords' => ['bar'],
+            'follows' => ['12345678', 'theborg']
+        }
+      end
+
+      it "looks up user name" do
+        allow_any_instance_of(Twitter::REST::Client).
+            to receive(:user).with(screen_name: 'theborg').and_return user
+        plugin.register
+        expect(plugin.send(:build_options)).to include(follow: '12345678,11111111')
       end
     end
   end
@@ -46,7 +72,6 @@ describe LogStash::Inputs::Twitter do
   describe "fetching from sample" do
 
     let(:input) { LogStash::Inputs::Twitter.new(config) }
-    let(:queue) { Queue.new }
 
     let(:config) do
       {
@@ -118,8 +143,6 @@ describe LogStash::Inputs::Twitter do
 
       let(:input) { LogStash::Inputs::Twitter.new(config) }
 
-      let(:queue) { Queue.new }
-
       let(:stream_client)       { double("stream-client") }
 
       let(:options) do
@@ -188,5 +211,29 @@ describe LogStash::Inputs::Twitter do
       end
 
     end
+
+    describe "proxy" do
+
+      before(:each) do
+        plugin.register
+      end
+
+      let(:config) do
+        super.merge( 'use_proxy' => true, 'proxy_address' => '127.0.0.1', 'proxy_port' => 12345 )
+      end
+
+      let(:proxy_socket) { double('proxy-socket') }
+
+      it "sends full URI requests" do
+        allow_any_instance_of(Twitter::Streaming::Connection).
+            to receive(:new_tcp_socket).with('127.0.0.1', 12345).and_return(proxy_socket)
+        header_line = 'POST https://stream.twitter.com/1.1/statuses/filter.json?track=foo%2Cbar HTTP/1.1'
+        expect(proxy_socket).to receive(:write).with(/^#{Regexp.escape(header_line)}/).
+            and_return(3000) # let the stack assume all content sent was consumed
+        # NOTE: this is just bogus - we're really just testing the HTTP header line ...
+        expect(proxy_socket).to receive(:readpartial).and_return nil
+        plugin.send(:do_run, queue)
+      end
+    end
   end
 end

data/spec/integration/twitter_pubsub_spec.rb

@@ -45,7 +45,7 @@ describe LogStash::Inputs::Twitter do
         RSpec::Sequencing.run_after(1, "update tweet status") do
           twt = "logstash_ci_publish partial tweet test #{Time.now} #{SecureRandom.hex(6)} $AAPL #lscipub @logstash https://www.elastic.co/downloads/logstash"
           publisher.update_with_media(twt, File.open(LogstashTwitterInput.fixture("small_smile.png")))
-        end.then_after(3, "stop plugin") do
+        end.then_after(10, "stop plugin") do
           plugin.stop
           true
         end.value
@@ -64,10 +64,10 @@ describe LogStash::Inputs::Twitter do
       let(:full_tweets) { true }
 
       it "receives an event from the twitter stream" do
-        RSpec::Sequencing.run_after(0.1, "update tweet status") do
+        RSpec::Sequencing.run_after(1, "update tweet status") do
           twt = "logstash_ci_publish full tweet test #{Time.now} #{SecureRandom.hex(6)} $AAPL #lscipub @logstash https://www.elastic.co/downloads/logstash"
           publisher.update_with_media(twt, File.open(LogstashTwitterInput.fixture("small_smile.png")))
-        end.then_after(3, "stop plugin") do
+        end.then_after(10, "stop plugin") do
           plugin.stop
           true
         end.value

data/spec/integration/twitter_spec.rb

@@ -5,6 +5,16 @@ require_relative "../spec_helper"
 
 describe LogStash::Inputs::Twitter do
 
+  let(:events) do
+    input(config) do |_, queue|
+      event_count.times.collect { queue.pop }
+    end
+  end
+
+  let(:event_count) { 3 }
+
+  let(:event) { events.first }
+
   describe "#receive [integration]", :integration => true do
 
     context "keyword search" do
@@ -23,12 +33,6 @@ describe LogStash::Inputs::Twitter do
         CONFIG
       end
 
-      let(:events) do
-        input(config) do |pipeline, queue|
-          3.times.collect { queue.pop }
-        end
-      end
-
       it "receive a list of events from the twitter stream" do
         expect(events.count).to eq(3)
       end
@@ -49,28 +53,14 @@ describe LogStash::Inputs::Twitter do
         CONFIG
       end
 
-      let(:events) do
-        input(config) do |pipeline, queue|
-          3.times.collect { queue.pop }
-        end
-      end
-
-      let(:event) { events.first }
-
       it "receive a list of events from the twitter stream" do
         expect(events.count).to eq(3)
-      end
-
-      it "contains the hashtags" do
-        expect(event["hashtags"]).to be_truthy
-      end
 
-      it "contains the symbols" do
-        expect(event["symbols"]).to be_truthy
-      end
+        event.tap { |event| puts "sample event: #{event.to_hash}" } if $VERBOSE
 
-      it "contains the user_mentions" do
-        expect(event["user_mentions"]).to be_truthy
+        expect(event.get("hashtags")).to be_truthy
+        expect(event.get("symbols")).to be_truthy
+        expect(event.get("user_mentions")).to be_truthy
       end
 
     end
@@ -88,20 +78,15 @@ describe LogStash::Inputs::Twitter do
             full_tweet => true
             use_proxy => true
             proxy_address => '127.0.0.1'
-            proxy_port => 8123
+            proxy_port => 3128
         }
       }
         CONFIG
       end
 
-      let(:events) do
-        input(config) do |pipeline, queue|
-          3.times.collect { queue.pop }
-        end
-      end
-
       it "receive a list of events from the twitter stream" do
         expect(events.count).to eq(3)
+        event.tap { |event| puts "sample event (using proxy): #{event.to_hash}" } if $VERBOSE
       end
     end
   end

data/spec/spec_helper.rb

@@ -26,8 +26,7 @@ module LogstashTwitterInput
     t = Thread.new(input, queue) do |_input, _queue|
       _input.run(_queue)
     end
-    sleep 0.1
-    t.kill
+    t.kill unless t.join(1.5) # due CI
   end
 
   def self.fixture_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-twitter
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 4.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 6.2.0
   name: twitter
   prerelease: false
   type: :runtime
@@ -43,35 +43,35 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2'
   name: http-form_data
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '3'
   name: public_suffix
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Reads events from the Twitter Streaming API