logstash-filter-alter 2.0.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8066ac94ac0cf9f47cad32a248976271fbe44f71
-  data.tar.gz: d79be6eef4295128a6ddb6608d3850d816d55d78
+  metadata.gz: 7eb8e237797006fe3fa7b4471f2be7e671361e21
+  data.tar.gz: 75613dcbc2d967bc9e8c7c4d36d4721a06e81904
 SHA512:
-  metadata.gz: 1edfd2a039e8bb4eafb6d1358c78af7be48ada70cf4e3066b6e59f27c1f2b80055e7dd11c02315063c740feb04803831bf7cffa1596511b3d91e16d1992ef471
-  data.tar.gz: ab41a47874b32bc9f9b5634cd72b0d9b23fffdd3bb991421cba9d75c452f743f61d44697605d4a660cd31a8f2d7030a0e88c7e7c1639da5bf5177f25596a5847
+  metadata.gz: e18ab1c0d2f31a260ea08899832c4863d6cd988f0ca6f785311740294a7e5a863fb12624d3e7ecb319c6674153fad0d325cf73adf026557f799de487a6dc14f2
+  data.tar.gz: dcb87d9b3b498df7a113610911e8f2e85ba4eb14fd9e68a92cdad1bd9ce3822d4fa084a56ef1144276cb4e505e369ce758de9856cf83c08361034b819a3af56d

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# 3.0.0
+  - bumped up logstash-core-plugin-api dependency, changed direct field references to event get and set methods
 # 2.0.5
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.0.4

data/CONTRIBUTORS

@@ -4,6 +4,7 @@ reports, or in general have helped logstash along its way.
 Contributors:
 * Aaron Mildenstein (untergeek)
 * Francesco Salbaroli (wathrog)
+* Jiening Wen (phill84)
 * Jordan Sissel (jordansissel)
 * Nagilum23
 * Philippe Weber (wiibaa)

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,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-alter-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-alter-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-alter.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-alter)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,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
@@ -74,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/alter.rb

@@ -21,7 +21,7 @@ class LogStash::Filters::Alter < LogStash::Filters::Base
   #       alter {
   #         condrewrite => [ 
   #              "field_name", "expected_value", "new_value",
-  #              "field_name2", "expected_value2, "new_value2",
+  #              "field_name2", "expected_value2", "new_value2",
   #              ....
   #            ]
   #       }
@@ -37,7 +37,7 @@ class LogStash::Filters::Alter < LogStash::Filters::Base
   #       alter {
   #         condrewriteother => [ 
   #              "field_name", "expected_value", "field_name_to_change", "value",
-  #              "field_name2", "expected_value2, "field_name_to_change2", "value2",
+  #              "field_name2", "expected_value2", "field_name_to_change2", "value2",
   #              ....
   #         ]
   #       }
@@ -117,20 +117,21 @@ class LogStash::Filters::Alter < LogStash::Filters::Base
       field = config[:field]
       expected = config[:expected]
       replacement = config[:replacement]
-      if event[field].is_a?(Array)
-        event[field] = event[field].map do |v|
+      if event.get(field).is_a?(Array)
+        new_array = event.get(field).map do |v|
           if v == event.sprintf(expected)
             v = event.sprintf(replacement)
           else
             v
           end
         end
+        event.set(field, new_array)
       else
-        if event[field] == event.sprintf(expected)
+        if event.get(field) == event.sprintf(expected)
           # The usage of encode(UTF-8) is a workarround here until the new
           # version of logstash-core is released and include the fix for this
           # after that, this should be removed.
-          event[field] = event.sprintf(replacement).encode(Encoding::UTF_8)
+          event.set(field, event.sprintf(replacement).encode(Encoding::UTF_8))
         end
       end
     end # @condrewrite_parsed.each
@@ -144,15 +145,15 @@ class LogStash::Filters::Alter < LogStash::Filters::Base
       replacement_field = config[:replacement_field]
       replacement_value = config[:replacement_value]
 
-      if event[field].is_a?(Array)
-        event[field].each do |v|
+      if event.get(field).is_a?(Array)
+        event.get(field).each do |v|
           if v == event.sprintf(expected)
-            event[replacement_field] = event.sprintf(replacement_value)
+            event.set(replacement_field, event.sprintf(replacement_value))
           end
         end
       else
-        if event[field] == event.sprintf(expected)
-          event[replacement_field] = event.sprintf(replacement_value)
+        if event.get(field) == event.sprintf(expected)
+          event.set(replacement_field, event.sprintf(replacement_value))
         end
       end
     end # @condrewriteother_parsed.each
@@ -167,7 +168,7 @@ class LogStash::Filters::Alter < LogStash::Filters::Base
       substitution_parsed = subst_array.map { |x| event.sprintf(x) }
       not_nul_index = substitution_parsed.find_index { |x| not x.nil? and not x.eql?("nil") and not (not x.index("%").nil? && x.match(/%\{[^}]\}/).nil?) }
       if not not_nul_index.nil?
-        event[field] = substitution_parsed[not_nul_index]
+        event.set(field, substitution_parsed[not_nul_index])
       end
     end # @coalesce_parsed.each
   end # def coalesce

data/logstash-filter-alter.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-alter'
-  s.version         = '2.0.5'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The alter filter allows you to do general alterations to fields that are not included in the normal mutate filter"
-  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,8 +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", ">= 1.60", "<= 2.99"
 
   s.add_development_dependency 'logstash-devutils'
 end
-

data/spec/filters/alter_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "logstash/devutils/rspec/spec_helper"
+require_relative '../spec_helper'
 require "logstash/filters/alter"
 
 describe LogStash::Filters::Alter do
@@ -15,11 +15,11 @@ describe LogStash::Filters::Alter do
     CONFIG
 
     sample("rewrite-me"  => "hello") do
-      insist { subject["rewrite-me"] } == "goodbye"
+      insist { subject.get("rewrite-me") } == "goodbye"
     end
 
     sample("rewrite-me"  => "greetings") do
-      insist { subject["rewrite-me"] } == "greetings"
+      insist { subject.get("rewrite-me") } == "greetings"
     end
   end
 
@@ -34,23 +34,23 @@ describe LogStash::Filters::Alter do
 
     sample("rewrite-me"  => "hello", "test" => "hello",
            "rewrite-value" => "goodbye") do
-      insist { subject["rewrite-me"] } == "goodbye"
+      insist { subject.get("rewrite-me") } == "goodbye"
     end
 
     sample("rewrite-me"  => "hello") do
-      insist { subject["rewrite-me"] } == "hello"
+      insist { subject.get("rewrite-me") } == "hello"
     end
 
     sample("rewrite-me"  => "%{test}") do
-      insist { subject["rewrite-me"] } == "%{rewrite-value}"
+      insist { subject.get("rewrite-me") } == "%{rewrite-value}"
     end
 
     sample("rewrite-me"  => "hello", "test" => "hello") do
-      insist { subject["rewrite-me"] } == "%{rewrite-value}"
+      insist { subject.get("rewrite-me") } == "%{rewrite-value}"
     end
 
     sample("rewrite-me"  => "greetings", "test" => "hello") do
-      insist { subject["rewrite-me"] } == "greetings"
+      insist { subject.get("rewrite-me") } == "greetings"
     end
   end
 
@@ -64,20 +64,20 @@ describe LogStash::Filters::Alter do
     CONFIG
 
     sample("test-me"  => "hello") do
-      insist { subject["rewrite-me"] } == "goodbye"
+      insist { subject.get("rewrite-me") } == "goodbye"
     end
 
     sample("test-me"  => "hello", "rewrite-me"  => "hello2") do
-      insist { subject["rewrite-me"] } == "goodbye"
+      insist { subject.get("rewrite-me") } == "goodbye"
     end
 
     sample("test-me"  => "greetings") do
-      insist { subject["rewrite-me"] }.nil?
+      insist { subject.get("rewrite-me") }.nil?
     end
 
     sample("test-me"  => "greetings",
       "rewrite-me"  => "hello2") do
-      insist { subject["rewrite-me"] } == "hello2"
+      insist { subject.get("rewrite-me") } == "hello2"
     end
   end
 
@@ -91,7 +91,7 @@ describe LogStash::Filters::Alter do
     CONFIG
 
     sample("coalesce-me"  => "Hello") do
-      insist { subject["coalesce-me"] } == "mydefault" 
+      insist { subject.get("coalesce-me") } == "mydefault" 
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-alter
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.99'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -38,7 +44,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: []
@@ -53,6 +59,7 @@ files:
 - lib/logstash/filters/alter.rb
 - logstash-filter-alter.gemspec
 - spec/filters/alter_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -81,3 +88,4 @@ specification_version: 4
 summary: The alter filter allows you to do general alterations to fields that are not included in the normal mutate filter
 test_files:
 - spec/filters/alter_spec.rb
+- spec/spec_helper.rb