logstash-filter-esquerystring 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f2e7609d982d3e5e6061e7045f099acab855995a9094ead59264464d5c10da5
-  data.tar.gz: 526113a947f5e5ee7becedaa3133d418ce6ac38a47d8d11db174a2c33cfd6d5d
+  metadata.gz: '0608e5bf3e3a027b7ebfcbd6eb83fdef7de8caea701c20add1d4cccfa62a5c92'
+  data.tar.gz: d7bdabec91119b6ed833fe789f0c2413d31faa616fcea8e4c3d87ef55dc011f8
 SHA512:
-  metadata.gz: 010e960574ef6776432aca3281e3aa7306b45990f7464f58ab18a149e61b24948cbea7d069c431a599cd99df6e48ce7935dd8d0cefcd1fc5f89a7bbfea8773ce
-  data.tar.gz: 5536154e93d0792c8cde70517638d4e40fef0b76a1b7d4c730d2084b4aa7b04474d445eb0da38ede972abda43d3dcdd57049c8e31786f270ca09760ea7dc7162
+  metadata.gz: 3ad22fc8ece75dcceeacfa366a5777f76c1280b5a180e5676c3dc619e5e9fc19771c53c0727fa71a80695fc9cb5e7c836ca96b63c30ca6de51fc907d5b821651
+  data.tar.gz: 8dbe2b99216417fba9080ded313b3d7702ba50588b21828b97cbc9ca4489eaed9db1943eac4ca0f9f4bf9d3db0dfc85d3271b420c0a142070befb492404ff42d

data/lib/logstash/filters/esquerystring.rb

@@ -5,7 +5,7 @@ require "logstash/namespace"
 class LogStash::Filters::Esquerystring < LogStash::Filters::Base
   config_name "esquerystring"
 
-  config :source, :validate => :string, :required => true
+  config :source, :validate => :array, :required => true
   config :target, :validate => :string, :required => true
 
   public
@@ -15,14 +15,20 @@ class LogStash::Filters::Esquerystring < LogStash::Filters::Base
 
   public
   def filter(event)
-    return unless event.include?(@source)
+    values = []
 
-    value = event.get(@source)
-    if value.is_a?(Array)
-      value = "(" + value.uniq.join(" OR ") + ")"
+    @source.each do |field|
+      next unless event.include?(field)
+      value = event.get(field)
+      next if value.nil?
+      value = [value] unless value.is_a?(Array)
+      next if value.length == 0
+      values += value
     end
 
-    event.set(@target, value)
+    return if values.length == 0
+    values = "(" + values.uniq.map { |x| '"' + x + '"' }.join(" OR ") + ")"
+    event.set(@target, values)
   end # def filter
 
 end # class LogStash::Filters::Esquerystring

data/logstash-filter-esquerystring.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-esquerystring'
-  s.version         = '1.0.1'
+  s.version         = '1.2.0'
   s.licenses        = ['Apache-2.0']
   s.summary         = "This filter converts values of source field to elasticsearch query string"
   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"

data/spec/filters/esquerystring_spec.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/esquerystring"
+
+describe LogStash::Filters::Esquerystring do
+
+  describe "esquerystring with single value" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => "src"
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src" => "arg1") do
+      insist { subject.get("dst") } == '("arg1")'
+    end
+  end
+
+  describe "esquerystring string with array" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => "src"
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src" => ["arg1", "arg2"]) do
+      insist { subject.get("dst") } == '("arg1" OR "arg2")'
+    end
+  end
+
+  describe "esquerystring string with non unique array" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => "src"
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src" => ["arg1", "arg2", "arg2", "arg3"]) do
+      insist { subject.get("dst") } == '("arg1" OR "arg2" OR "arg3")'
+    end
+  end
+
+  describe "esquerystring with multiple source fields" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => ["src1", "src2"]
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src1" => "arg1", "src2" => "arg2") do
+      insist { subject.get("dst") } == '("arg1" OR "arg2")'
+    end
+  end
+
+  describe "esquerystring with multiple source fields but only one non empty" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => ["src1", "src2"]
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src1" => [], "src2" => "arg2") do
+      insist { subject.get("dst") } == '("arg2")'
+    end
+  end
+
+  describe "esquerystring with multiple source fields and not all present in record" do
+    config <<-CONFIG
+      filter {
+        esquerystring {
+          source => ["src1", "src2", "src3"]
+          target => "dst"
+        }
+      }
+    CONFIG
+
+    sample("src1" => ["arg1"], "src2" => "arg2") do
+      insist { subject.get("dst") } == '("arg1" OR "arg2")'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-esquerystring
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,7 @@ files:
 - docs/index.asciidoc
 - lib/logstash/filters/esquerystring.rb
 - logstash-filter-esquerystring.gemspec
-- spec/filters/anonymize_spec.rb
+- spec/filters/esquerystring_spec.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache-2.0
@@ -89,4 +89,4 @@ signing_key:
 specification_version: 4
 summary: This filter converts values of source field to elasticsearch query string
 test_files:
-- spec/filters/anonymize_spec.rb
+- spec/filters/esquerystring_spec.rb

data/spec/filters/anonymize_spec.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-
-require "logstash/devutils/rspec/spec_helper"
-require "logstash/filters/esquerystring"
-
-describe LogStash::Filters::Esquerystring do
-
-  describe "esquerystring with single value" do
-    # The logstash config goes here.
-    # At this time, only filters are supported.
-    config <<-CONFIG
-      filter {
-        esquerystring {
-          source => "src"
-          target => "dst"
-        }
-      }
-    CONFIG
-
-    sample("src" => "arg1") do
-      insist { subject.get("dst") } == "arg1"
-    end
-  end
-
-  describe "esquerystring string with array" do
-    config <<-CONFIG
-      filter {
-        esquerystring {
-          source => "src"
-          target => "dst"
-        }
-      }
-    CONFIG
-
-    sample("src" => ["arg1", "arg2"]) do
-      insist { subject.get("dst") } == "(arg1 OR arg2)"
-    end
-  end
-
-  describe "esquerystring string with non unique array" do
-    config <<-CONFIG
-      filter {
-        esquerystring {
-          source => "src"
-          target => "dst"
-        }
-      }
-    CONFIG
-
-    sample("src" => ["arg1", "arg2", "arg2", "arg3"]) do
-      insist { subject.get("dst") } == "(arg1 OR arg2 OR arg3)"
-    end
-  end
-
-end