logstash-filter-ruby 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d10fa6e20d7158adc2c37c887e3f57648a5c5b2
-  data.tar.gz: e8994128a58e45a0745ec166d50b11aa950aa5ca
+  metadata.gz: d37b548007d87f94ac0e0d9d3826f08d861e70ee
+  data.tar.gz: 8fdf8080f42d9ac002cc2253496969ef5e6a8ae2
 SHA512:
-  metadata.gz: 81e29423e65065579d911be67dcdabf2c633052e4693b85c5a566be587ca428c168faaaf6c71ee5762663369af9e13bd801e8db622e3310d65512bc0a18868f3
-  data.tar.gz: 76ffc07f01c1d9cd3345c8006ef62dbf3675e5242bc75861ddb976b4558e5f47bac804578f7a1698eecc1dccacb7fdbced7616ed6fdcd127addd0075f2273ed3
+  metadata.gz: c5b474c54c025b3d43fb8cfe1b67f6ea83a82bc787b56d6d304dcc9f8bc43e0f712bd569a091b69e751c63f97aae7a256d2be9f6fa38aed943de3665daf98bc4
+  data.tar.gz: 160597360b990a703014ad66c5ee7c21b8be5b12ff32244678535bbe9919b0b48ed58e6c74061fcf1fdbfdcb6c4341491a625ed0756b62be5a85814fea5e6e9f

data/CHANGELOG.md

@@ -1,16 +1,23 @@
+## 3.0.2
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
 ## 3.0.1
-  - Republish all the gems under jruby.
+ - internal: Republish all the gems under jruby.
+
 ## 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.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
-  - New dependency requirements for logstash-core for the 5.0 release
+ - internal,deps: 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.5
+ - internal,deps: 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
+ - internal,deps: New dependency requirements for logstash-core for the 5.0 release
+
 ## 2.0.3
- - Code cleanup and fixed json order verification is specs
+ - internal,test,cleanup: Code cleanup and fixed json order verification is specs
 
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
+ - internal: Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
- - Dependency on logstash-core update to 2.0
+ - internal,deps: Dependency on logstash-core update to 2.0
 

data/lib/logstash/filters/ruby.rb

@@ -13,6 +13,15 @@ require "logstash/namespace"
 #       }
 #     }
 #
+# If you need to create additional events, it cannot be done as in other filters where you would use `yield`,
+# you must use a specific syntax `new_event_block.call(event)` like in this example duplicating the input event
+# [source,ruby]
+# filter {
+#   ruby {
+#     code => "new_event_block.call(event.clone)"
+#   }
+# }
+#
 class LogStash::Filters::Ruby < LogStash::Filters::Base
   config_name "ruby"
 
@@ -26,12 +35,12 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
   def register
     # TODO(sissel): Compile the ruby code
     eval(@init, binding, "(ruby filter init)") if @init
-    eval("@codeblock = lambda { |event| #{@code} }", binding, "(ruby filter code)")
-  end
+    eval("@codeblock = lambda { |event, &new_event_block| #{@code} }", binding, "(ruby filter code)")
+  end # def register
 
-  def filter(event)
+  def filter(event,&block)
     begin
-      @codeblock.call(event)
+      @codeblock.call(event,&block)
       filter_matched(event)
     rescue Exception => e
       @logger.error("Ruby exception occurred: #{e}")

data/logstash-filter-ruby.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ruby'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Filter for executing ruby code on the event"
   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"
@@ -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", "~> 2.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency 'logstash-filter-date'
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/filters/ruby_spec.rb

@@ -85,5 +85,37 @@ describe LogStash::Filters::Ruby do
     end
   end
 
+  describe "allow to create new event inside the ruby filter" do
+    config <<-CONFIG
+      filter {
+        ruby {
+          code => "new_event_block.call(event.clone)"
+        }
+      }
+    CONFIG
+
+    sample("message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800") do
+      expect(subject).to be_a Array
+      expect(subject[0]).not_to eq(subject[1])
+      expect(subject[0].to_hash).to eq(subject[1].to_hash)
+    end
+  end
+
+  describe "allow to replace event by another one" do
+    config <<-CONFIG
+      filter {
+        ruby {
+          code => "new_event_block.call(event.clone);
+                   event.cancel;"
+          add_tag => ["ok"]
+        }
+      }
+    CONFIG
+
+    sample("message" => "hello world", "mydate" => "2014-09-23T00:00:00-0800") do
+      expect(subject.get("message")).to eq("hello world");
+      expect(subject.get("mydate")).to eq("2014-09-23T00:00:00-0800");
+    end
+  end
 end
 

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-07-14 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: '2.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: '2.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -89,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.3
 signing_key:
 specification_version: 4
 summary: Filter for executing ruby code on the event