logstash-input-twitter 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c922a98eed84cc4f486e62cf74ec0ccfe3877788503cc6de18cde82b7ce59d70
-  data.tar.gz: db40a663d45c6fb8b395c6f12af58d57bccc08ab7e9fd8e534513defd6aef6cd
+  metadata.gz: 35aa088d3d7f0ebcecf9ea2e00ea9009dacf682b99ca57f544ca25201cf70744
+  data.tar.gz: 5e740cbcabb04ba97a218324d8d5c56aa20f992382347e3aaae29bf4ff6260b8
 SHA512:
-  metadata.gz: 4fd2bbfd624db48d8c572cd1faa8a4be34035093929b3ce663b5c38bd228fdbafcdf6b0de81c3c6af98299022795e380573451e93f92b8d3dc91db8f5869c5d6
-  data.tar.gz: f215a53f05f8490ac7e612719095dc0ea53be10f38b984d48e29c30e2b75f1b300deeb412d64f03d8ea035058dafdc59741aad2f24f4e0700ff37efb325ebf6e
+  metadata.gz: 61c1343445e3dca087247221044d41feb05c660d17682cb47bf0499f31f19a5206f636128f67c4d1c34295db29bd45c305344d63cef09ed10b7a5cf9dbc9514d
+  data.tar.gz: 2dbb9da7f8097ec766bf2ad0a2ae3745e7e811b31f5e8dded9b8fac413edffd014eaadc247895373d1260ee0a690a6b961fe17a50ec3a01d882d02c859643f97

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 4.1.0
+ - Feat: optional target + ecs_compatibility [#72](https://github.com/logstash-plugins/logstash-input-twitter/pull/72)
+
+## 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
 

data/Gemfile

@@ -9,7 +9,3 @@ 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
-
-if RUBY_VERSION == "1.9.3"
-  gem 'rake', '12.2.1'
-end

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 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/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-twitter.svg)](https://travis-ci.org/logstash-plugins/logstash-input-twitter)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-twitter.svg)](https://travis-ci.com/logstash-plugins/logstash-input-twitter)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -23,6 +23,46 @@ include::{include_path}/plugin_header.asciidoc[]
 
 Ingest events from the Twitter Streaming API.
 
+Example:
+[source,ruby]
+    input {
+      twitter {
+        consumer_key => '...'
+        consumer_secret => '...'
+        oauth_token => '...'
+        oauth_token_secret => '...'
+        keywords => [ 'logstash' ]
+      }
+    }
+
+Sample event fields generated:
+
+[source,ruby]
+-----
+    {
+        "@timestamp" => 2019-09-23T16:41:53.000Z,
+        "message" => "I forgot how fun it is to write @logstash configs !!! Thank you @jordansissel and @elastic !!!"
+        "user" => "missnebun",
+        "in-reply-to" => nil,
+        "retweeted" => false,
+        "source" => "http://twitter.com/missnebun/status/1176174859833004037",
+        "user_mentions" => [
+            { "screen_name"=>"logstash", "name"=>"logstash", "id"=>217155915 },
+            { "screen_name"=>"jordansissel", "name"=>"@jordansissel", "id"=>15782607 },
+            { "screen_name"=>"elastic", "name"=>"Elastic", "id"=>84512601 }],
+        "symbols" => [],
+        "hashtags" => [],
+        "client" => "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>"
+    }
+-----
+
+[id="plugins-{type}s-{plugin}-ecs"]
+==== Compatibility with the Elastic Common Schema (ECS)
+
+Twitter streams are very specific and do not map easily to the {ecs-ref}[Elastic Common Schema (ECS)].
+We recommend setting a <<plugins-{type}s-{plugin}-target>> when <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is enabled.
+The plugin issues a warning in the log when a `target` isn't set.
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== Twitter Input Configuration Options
 
@@ -33,6 +73,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-consumer_key>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-consumer_secret>> |<<password,password>>|Yes
+| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-follows>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-full_tweet>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-ignore_retweets>> |<<boolean,boolean>>|No
@@ -46,6 +87,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-rate_limit_reset_in>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-use_proxy>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-use_samples>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -78,6 +120,19 @@ If you don't have one of these, you can create one by
 registering a new application with Twitter:
 <https://dev.twitter.com/apps/new>
 
+[id="plugins-{type}s-{plugin}-ecs_compatibility"]
+===== `ecs_compatibility`
+
+  * Value type is <<string,string>>
+  * Supported values are:
+    ** `disabled`: does not use ECS-compatible field names (fields might be set at the root of the event)
+    ** `v1`, `v8`: avoids field names that might conflict with Elastic Common Schema (for example, Twitter specific properties)
+  * Default value depends on which version of Logstash is running:
+    ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
+    ** Otherwise, the default value is `disabled`.
+
+Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
+
 [id="plugins-{type}s-{plugin}-follows"]
 ===== `follows` 
 
@@ -221,6 +276,17 @@ by the default access level are the same, so if two different clients connect
 to this endpoint, they will see the same tweets. If set to true, the keywords, 
 follows, locations, and languages options will be ignored. Default => false
 
+[id="plugins-{type}s-{plugin}-target"]
+===== `target`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Without a `target`, events are created from tweets at the root level.
+When the `target` is set to a field reference, the tweet data is placed in the target field instead.
+
+This option can be useful to avoid populating unknown fields when a downstream schema such as ECS is enforced.
+
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

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/lib/logstash/inputs/twitter.rb

@@ -5,11 +5,22 @@ require "logstash/timestamp"
 require "logstash/util"
 require "logstash/json"
 require "stud/interval"
+require "twitter"
 require "logstash/inputs/twitter/patches"
+require 'logstash/plugin_mixins/ecs_compatibility_support'
+require 'logstash/plugin_mixins/ecs_compatibility_support/target_check'
+require 'logstash/plugin_mixins/event_support/event_factory_adapter'
+require 'logstash/plugin_mixins/validator_support/field_reference_validation_adapter'
 
 # Ingest events from the Twitter Streaming API.
 class LogStash::Inputs::Twitter < LogStash::Inputs::Base
 
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+  include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
+  include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
+
+  extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
+
   attr_reader :filter_options, :event_generation_error_count
 
   config_name "twitter"
@@ -103,9 +114,12 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
   # is nil. If this occurs then we use the integer specified here. The default is 5 minutes.
   config :rate_limit_reset_in, :validate => :number, :default => 300
 
-  def register
-    require "twitter"
+  # Defines a target field for placing fields.
+  # If this setting is omitted, data gets stored at the root (top level) of the event.
+  # The target is only relevant while decoding data into a new event.
+  config :target, :validate => :field_reference
 
+  def register
     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 +143,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 +151,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 +193,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
@@ -185,48 +204,48 @@ class LogStash::Inputs::Twitter < LogStash::Inputs::Base
 
   def from_tweet(tweet)
     @logger.debug? && @logger.debug("Got tweet", :user => tweet.user.screen_name, :text => tweet.text)
+
     if @full_tweet
-      event = LogStash::Event.new(LogStash::Util.stringify_symbols(tweet.to_hash))
-      event.timestamp = LogStash::Timestamp.new(tweet.created_at)
+      attributes = LogStash::Util.stringify_symbols(tweet.to_hash)
     else
-
       attributes = {
-        LogStash::Event::TIMESTAMP => LogStash::Timestamp.new(tweet.created_at),
         "message" => tweet.full_text,
         "user" => tweet.user.screen_name,
         "client" => tweet.source,
         "retweeted" => tweet.retweeted?,
-        "source" => "http://twitter.com/#{tweet.user.screen_name}/status/#{tweet.id}"
+        "source" => "http://twitter.com/#{tweet.user.screen_name}/status/#{tweet.id}",
+        "hashtags" => tweet.hashtags.map(&:attrs),
+        "symbols" => tweet.symbols.map(&:attrs),
+        "user_mentions" => tweet.user_mentions.map(&:attrs),
       }
 
-      attributes["hashtags"] = tweet.hashtags.map{|ht| ht.attrs}
-      attributes["symbols"]  = tweet.symbols.map{|sym| sym.attrs}
-      attributes["user_mentions"]  = tweet.user_mentions.map{|um| um.attrs}
-      event = LogStash::Event.new(attributes)
       if tweet.reply? && !tweet.in_reply_to_status_id.nil?
-        event.set("in-reply-to", tweet.in_reply_to_status_id)
+        attributes["in-reply-to"] = tweet.in_reply_to_status_id
       end
       unless tweet.urls.empty?
-        event.set("urls", tweet.urls.map(&:expanded_url).map(&:to_s))
+        attributes["urls"] = tweet.urls.map(&:expanded_url).map(&:to_s)
       end
     end
 
     # Work around bugs in JrJackson. The standard serializer won't work till we upgrade
     # event.set("in-reply-to", nil) if event.get("in-reply-to").is_a?(Twitter::NullObject)
 
+    event = targeted_event_factory.new_event(attributes)
+    event.timestamp = LogStash::Timestamp.new(tweet.created_at)
     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 +256,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/logstash-input-twitter.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
-
   s.name            = 'logstash-input-twitter'
-  s.version         = '4.0.0'
+  s.version         = '4.1.0'
   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,9 +18,16 @@ 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 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
+  s.add_runtime_dependency "logstash-mixin-event_support", '~> 1.0'
+  s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
+  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'

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
       {
@@ -72,6 +97,58 @@ describe LogStash::Inputs::Twitter do
 
   end
 
+  let(:tweet) do
+    Twitter::Tweet.new(id: 1234567890123456789,
+                       id_str: '1234567890123456789',
+                       created_at: 'Thu Nov 11 10:00:00 +0000 2021',
+                       text: 'Hello World! 🥰',
+                       source: "<a href=\"http://twitter.com/download/android\" rel=\"nofollow\">Twitter for Android</a>",
+                       truncated: false,
+                       user: {
+                           id: 1182909005012345600,
+                           name: "Foo Bar",
+                           screen_name: "foo001",
+                           location: nil,
+                       })
+  end
+
+  describe "from tweet" do
+
+    before(:each) do
+      plugin.register
+      @event = plugin.send :from_tweet, tweet
+    end
+
+    it "generated an event" do
+      expect(@event.get('message')).to eql "Hello World! 🥰"
+      expect(@event.get('user')).to eql "foo001"
+      expect(@event.timestamp.to_s).to match /2021-11-11T10:00:00(.000)?Z/
+    end
+
+    context 'with full_tweet' do
+      let(:config) { super().merge 'full_tweet' => true }
+
+      it "generated an event" do
+        expect(@event.get('text')).to eql "Hello World! 🥰"
+        expect(@event.get('user')['screen_name']).to eql "foo001"
+        expect(@event.timestamp.to_s).to match /2021-11-11T10:00:00(.000)?Z/
+      end
+    end
+
+    context 'with target' do
+      let(:config) { super().merge 'target' => '[twitter]' }
+
+      it "generated an event" do
+        expect(@event.include?('message')).to be false
+        expect(@event.include?('user')).to be false
+
+        expect(@event.get('[twitter][message]')).to eql "Hello World! 🥰"
+        expect(@event.get('[twitter][user]')).to eql "foo001"
+        expect(@event.timestamp.to_s).to match /2021-11-11T10:00:00(.000)?Z/
+      end
+    end
+  end
+
   describe "stream filter" do
 
     describe "options parsing" do
@@ -118,8 +195,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
@@ -138,8 +213,6 @@ describe LogStash::Inputs::Twitter do
 
       context "when not filtering retweets" do
 
-        let(:tweet) { Twitter::Tweet.new(id: 1) }
-
         let(:config) do
           {
             'consumer_key' => 'foo',
@@ -164,8 +237,6 @@ describe LogStash::Inputs::Twitter do
 
       context "when filtering retweets" do
 
-        let(:tweet) { Twitter::Tweet.new(id: 1) }
-
         let(:config) do
           {
             'consumer_key' => 'foo',
@@ -188,5 +259,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: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -30,12 +30,54 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: logstash-mixin-ecs_compatibility_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-event_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-validator_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 6.2.0
   name: twitter
   prerelease: false
   type: :runtime
@@ -43,7 +85,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -172,15 +214,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Reads events from the Twitter Streaming API