logstash-filter-useragent 2.0.8 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 191fb843494af5cd723d3fd0eac22361e8ad75b4
-  data.tar.gz: 8151e35d06866286783c90508e65952b912cb23b
+  metadata.gz: 598bbd9355cf951cd710c2b09fadc85853f26522
+  data.tar.gz: 767669dbe7e9824374f47c99d24a4e776d0dc96c
 SHA512:
-  metadata.gz: 0af80cfb030c6c36e2e80c97f35141124ec9d334675639762a75ed124b005e7a722993f772ed1beb4ca3f8ac0605797b6a5d5300f9a07658db5934df213e512c
-  data.tar.gz: 4ab2b64d9b46e29209e1540bc4ab8f591da93b780ba8ffde43d78d6b45ffe862dbdba4799f1af016ba7973a37394bf2ea0d4e3ac5f8a1a5a74f9b911a117555c
+  metadata.gz: aecb151986072624ead48ca4fd894a5161ad9513a3c36751fe97db8347129ef3f889a9902bcdcdc25230182890ae4c9499ebae08e2b776120609abf1abe8cab2
+  data.tar.gz: 6d4af28f0a412d5765a6723689d02f760f5a2aa4e649ae1acc0a2f2064884612a93250572a322e5e405a6bea6cb6d577cf1bd8660d180deba9b23f789defff0c

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 3.0.0
+  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
 # 2.0.8
   - Revert addition of Mutex. This plugin now depends on jruby having threadsafe regexps
 # 2.0.7

data/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
-gemspec
+
+# Specify your gem's dependencies in logstash-mass_effect.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+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.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-useragent.svg?branch=master)](https://travis-ci.org/logstash-plugins/logstash-filter-useragent)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-useragent.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-useragent)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -55,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
 bin/plugin install --no-verify
+
 ```
 - Run Logstash with your plugin
 ```sh
@@ -73,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

data/lib/logstash/filters/useragent.rb

@@ -93,7 +93,7 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
   end
 
   def filter(event)
-    useragent = event[@source]
+    useragent = event.get(@source)
     useragent = useragent.first if useragent.is_a?(Array)
 
     return if useragent.nil? || useragent.empty?
@@ -135,7 +135,7 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
   def set_fields(event, ua_data)
     # UserAgentParser outputs as US-ASCII.
 
-    event[@prefixed_name] = ua_data.name.dup.force_encoding(Encoding::UTF_8)
+    event.set(@prefixed_name, ua_data.name.dup.force_encoding(Encoding::UTF_8))
 
     #OSX, Andriod and maybe iOS parse correctly, ua-agent parsing for Windows does not provide this level of detail
 
@@ -143,23 +143,23 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
     # and corrupt the cache. See uap source here for details https://github.com/ua-parser/uap-ruby/tree/master/lib/user_agent_parser
     if (os = ua_data.os)
       # The OS is a rich object
-      event[@prefixed_os] = ua_data.os.to_s.dup.force_encoding(Encoding::UTF_8)
-      event[@prefixed_os_name] = os.name.dup.force_encoding(Encoding::UTF_8) if os.name
+      event.set(@prefixed_os, ua_data.os.to_s.dup.force_encoding(Encoding::UTF_8))
+      event.set(@prefixed_os_name, os.name.dup.force_encoding(Encoding::UTF_8)) if os.name
 
       # These are all strings
       if (os_version = os.version)
-        event[@prefixed_os_major] = os_version.major.dup.force_encoding(Encoding::UTF_8) if os_version.major
-        event[@prefixed_os_minor] = os_version.minor.dup.force_encoding(Encoding::UTF_8) if os_version.minor
+        event.set(@prefixed_os_major, os_version.major.dup.force_encoding(Encoding::UTF_8)) if os_version.major
+        event.set(@prefixed_os_minor, os_version.minor.dup.force_encoding(Encoding::UTF_8)) if os_version.minor
       end
     end
 
-    event[@prefixed_device] = ua_data.device.to_s.dup.force_encoding(Encoding::UTF_8) if ua_data.device
+    event.set(@prefixed_device, ua_data.device.to_s.dup.force_encoding(Encoding::UTF_8)) if ua_data.device
 
     if (ua_version = ua_data.version)
-      event[@prefixed_major] = ua_version.major.dup.force_encoding(Encoding::UTF_8) if ua_version.major
-      event[@prefixed_minor] = ua_version.minor.dup.force_encoding(Encoding::UTF_8) if ua_version.minor
-      event[@prefixed_patch] = ua_version.patch.dup.force_encoding(Encoding::UTF_8) if ua_version.patch
-      event[@prefixed_build] = ua_version.patch_minor.dup.force_encoding(Encoding::UTF_8) if ua_version.patch_minor
+      event.set(@prefixed_major, ua_version.major.dup.force_encoding(Encoding::UTF_8)) if ua_version.major
+      event.set(@prefixed_minor, ua_version.minor.dup.force_encoding(Encoding::UTF_8)) if ua_version.minor
+      event.set(@prefixed_patch, ua_version.patch.dup.force_encoding(Encoding::UTF_8)) if ua_version.patch
+      event.set(@prefixed_build, ua_version.patch_minor.dup.force_encoding(Encoding::UTF_8)) if ua_version.patch_minor
     end
   end
 end

data/logstash-filter-useragent.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-useragent'
-  s.version         = '2.0.8'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parse user agent strings into structured data based on BrowserScope data"
-  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"
+  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"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
 
   s.add_runtime_dependency 'user_agent_parser', ['>= 2.0.0']
   s.add_runtime_dependency 'lru_redux', "~> 1.1.0"

data/spec/filters/useragent_spec.rb

@@ -17,10 +17,10 @@ describe LogStash::Filters::UserAgent do
 
     sample "Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.63 Safari/537.31" do
       insist { subject }.include?("ua")
-      insist { subject["ua"]["name"] } == "Chrome"
-      insist { subject["ua"]["os"] } == "Linux"
-      insist { subject["ua"]["major"] } == "26"
-      insist { subject["ua"]["minor"] } == "0"
+      insist { subject.get("[ua][name]") } == "Chrome"
+      insist { subject.get("[ua][os]") } == "Linux"
+      insist { subject.get("[ua][major]") } == "26"
+      insist { subject.get("[ua][minor]") } == "0"
     end
   end
 
@@ -34,10 +34,10 @@ describe LogStash::Filters::UserAgent do
     CONFIG
 
     sample "Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.63 Safari/537.31" do
-      insist { subject["name"] } == "Chrome"
-      insist { subject["os"] } == "Linux"
-      insist { subject["major"] } == "26"
-      insist { subject["minor"] } == "0"
+      insist { subject.get("name") } == "Chrome"
+      insist { subject.get("os") } == "Linux"
+      insist { subject.get("major") } == "26"
+      insist { subject.get("minor") } == "0"
     end
   end
 
@@ -91,7 +91,7 @@ describe LogStash::Filters::UserAgent do
     }.each do |field, uad_getter|
       context "for the #{field} field" do
         let(:value) {uad_getter.call(ua_data)}
-        let(:target_field) { target[field]}
+        let(:target_field) { target.get(field)}
 
         it "should not have a nil value" do
           expect(target_field).to be_truthy
@@ -120,10 +120,10 @@ describe LogStash::Filters::UserAgent do
 
     sample "Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.63 Safari/537.31" do
       insist { subject.to_hash }.include?("message")
-      insist { subject["message"]["name"] } == "Chrome"
-      insist { subject["message"]["os"] } == "Linux"
-      insist { subject["message"]["major"] } == "26"
-      insist { subject["message"]["minor"] } == "0"
+      insist { subject.get("[message][name]") } == "Chrome"
+      insist { subject.get("[message][os]") } == "Linux"
+      insist { subject.get("[message][major]") } == "26"
+      insist { subject.get("[message][minor]") } == "0"
     end
   end
 end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-useragent
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
@@ -23,7 +23,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !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
+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
 email: info@elastic.co
 executables: []
 extensions: []