logstash-filter-translate 2.1.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc9d748a0e3154c355b43202c3583de6852f192
-  data.tar.gz: 505b2845b2a50e11f7fb6318fa36e4f82f7485d0
+  metadata.gz: acfc6640bfba3a33d089e25dabcb4e80af6225f4
+  data.tar.gz: 220ed14bfd31c28b5084ae926ffc9f54667bbd52
 SHA512:
-  metadata.gz: 773183d1b34ab1b5ec10c925c85c77e4f43bc992b4a1a15d501449c52d62d8b2d3512b722cbe241ade0ed6d174c5a83e0e359bba0db3fb304415ae702f7482eb
-  data.tar.gz: 77c37788a42fd3e4d174e56600de8fb988d5a950c8f0022be6c903ba15641a40631f78236c64745dbccfab819e7ca1e1e91f9791e145835dd58ec128c25aed26
+  metadata.gz: e536664483feac265b01e0dd723d5cf8de7a8fef4a64a2fd782211c399aeba0e2d7bcc5c086a1161ee03b004be7cecde9a907a4fee11b61706db4c66d53f7937
+  data.tar.gz: 3c43650e40ea637c743306d4204b7b2d70772eafd97fe0443a1972b90f59f7e186d59af9b0d348ae3ee85924cb12e692208e20c5912c4c8682e7f129c274828e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 3.0.0
+  - Breaking: Updated plugin to use new Java Event APIs
+
 # 2.1.4
   - Fix threadsafety issues by adding in a read/write lock
 

data/lib/logstash/filters/translate.rb

@@ -128,6 +128,15 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
     @read_lock = rw_lock.readLock
     @write_lock = rw_lock.writeLock
     
+    if @dictionary_path && !@dictionary.empty?
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "translate",
+        :error => "The configuration options 'dictionary' and 'dictionary_path' are mutually exclusive"
+      )
+    end
+
     if @dictionary_path
       @next_refresh = Time.now + @refresh_interval
       raise_exception = true
@@ -178,30 +187,30 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
 
     begin
       #If source field is array use first value and make sure source value is string
-      source = event[@field].is_a?(Array) ? event[@field].first.to_s : event[@field].to_s
+      source = event.get(@field).is_a?(Array) ? event.get(@field).first.to_s : event.get(@field).to_s
       matched = false
       if @exact
         if @regex
           key = @dictionary.keys.detect{|k| source.match(Regexp.new(k))}
           if key
-            event[@destination] = lock_for_read { @dictionary[key] }
+            event.set(@destination, lock_for_read { @dictionary[key] })
             matched = true
           end
         elsif @dictionary.include?(source)
-          event[@destination] = lock_for_read { @dictionary[source] }
+          event.set(@destination, lock_for_read { @dictionary[source] })
           matched = true
         end
       else
         translation = lock_for_read { source.gsub(Regexp.union(@dictionary.keys), @dictionary) }
         
         if source != translation
-          event[@destination] = translation.force_encoding(Encoding::UTF_8)
+          event.set(@destination, translation.force_encoding(Encoding::UTF_8))
           matched = true
         end
       end
 
       if not matched and @fallback
-        event[@destination] = event.sprintf(@fallback)
+        event.set(@destination, event.sprintf(@fallback))
         matched = true
       end
       filter_matched(event) if matched or @field == @destination

data/logstash-filter-translate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-translate'
-  s.version         = '2.1.4'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values."
   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", "~> 1.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/filters/translate_spec.rb

@@ -27,7 +27,7 @@ describe LogStash::Filters::Translate do
     it "return the exact translation" do
       subject.register
       subject.filter(event)
-      expect(event["translation"]).to eq("OK")
+      expect(event.get("translation")).to eq("OK")
     end
   end
 
@@ -52,7 +52,7 @@ describe LogStash::Filters::Translate do
     it "return the exact translation" do
       subject.register
       subject.filter(event)
-      expect(event["translation"]).to eq("OK & Server Error")
+      expect(event.get("translation")).to eq("OK & Server Error")
     end
 
   end
@@ -77,7 +77,7 @@ describe LogStash::Filters::Translate do
     it "return the exact translation" do
       subject.register
       subject.filter(event)
-      expect(event["translation"]).to eq("OK")
+      expect(event.get("translation")).to eq("OK")
     end
   end
 
@@ -97,7 +97,7 @@ describe LogStash::Filters::Translate do
       it "return the exact translation" do
         subject.register
         subject.filter(event)
-        expect(event["translation"]).to eq("no match")
+        expect(event.get("translation")).to eq("no match")
       end
     end
 
@@ -115,7 +115,7 @@ describe LogStash::Filters::Translate do
       it "return the exact translation" do
         subject.register
         subject.filter(event)
-        expect(event["translation"]).to eq("missing no match")
+        expect(event.get("translation")).to eq("missing no match")
       end
     end
   end
@@ -146,7 +146,7 @@ describe LogStash::Filters::Translate do
       it "return the exact translation" do
         subject.register
         subject.filter(event)
-        expect(event["translation"]).to eq(1)
+        expect(event.get("translation")).to eq(1)
       end
     end
 
@@ -157,7 +157,7 @@ describe LogStash::Filters::Translate do
       it "return the exact translation" do
         subject.register
         subject.filter(event)
-        expect(event["translation"]).to eq(20)
+        expect(event.get("translation")).to eq(20)
       end
     end
 
@@ -168,7 +168,7 @@ describe LogStash::Filters::Translate do
       it "return the exact translation" do
         subject.register
         subject.filter(event)
-        expect(event["translation"]).to eq("300")
+        expect(event.get("translation")).to eq("300")
       end
     end
 
@@ -180,4 +180,19 @@ describe LogStash::Filters::Translate do
       end
     end
   end
+
+  describe "general configuration" do
+    let(:dictionary_path)  { File.join(File.dirname(__FILE__), "..", "fixtures", "dict.yml") }
+    let(:config) do
+      {
+        "field"            => "random field",
+        "dictionary"       => { "a" => "b" },
+        "dictionary_path"  => dictionary_path,
+      }
+    end
+
+    it "raises an exception if both 'dictionary' and 'dictionary_path' are set" do
+      expect { subject.register }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-translate
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core-plugin-api
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-devutils
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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/logstash-plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
@@ -70,12 +76,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []