logstash-codec-json_lines 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313c69ada5cae85d4921a4bb4d40966784a34eb4
-  data.tar.gz: f6e4543df04605d602fd8df5bb296877ca792e43
+  metadata.gz: a1506140c8e501d6674a9240c5e0e943dbad0adc
+  data.tar.gz: 86a5df4679925793a96dd8d41093c2ca69b6dabc
 SHA512:
-  metadata.gz: 9c6cfe1bbd4c7683077f2f8819211a0a9c78ae2a16e43d787c3155dd3ab8a9c6ca6f7b8c280d5f67159c73b3553590fbc47ca03b4c91d91c083370aab7021ce8
-  data.tar.gz: 3aaa57ac5fa0adff86f2c1eeaef369904f7932eb16704c66d3da4563c3d0bb532c00be38c9fe6374826038acba83c19e40d482d0b20270b687e2f8e359019d1c
+  metadata.gz: c1f3ea023534e310a9b3215909118af6b0709f4e20ec34b450b556ac2c97f8f05ae830e46e4ada813ebb4d3b720d1fec3bce83351a9ec4eab2d307321c51084a
+  data.tar.gz: c97a1312cb5c1f89a0c8763e1da59f25ea2fa942a5da7008422920e51f85578ccc9981b3556bf1649d8699241b5f2b71cc5a36c310e77e2616b373ce9e483835

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.1.0
+ - Backward compatible support for `Event#from_json` method https://github.com/logstash-plugins/logstash-codec-json_lines/pull/19
+
 ## 2.0.5
  - Directly use buftok to avoid indirection through the line codec https://github.com/logstash-plugins/logstash-codec-json_lines/pull/18
 

data/lib/logstash/codecs/json_lines.rb

@@ -36,26 +36,34 @@ class LogStash::Codecs::JSONLines < LogStash::Codecs::Base
     @converter.logger = @logger
   end
 
-  def decode(data)
+  def decode(data, &block)
     @buffer.extract(data).each do |line|
-      yield guard(@converter.convert(line))
+      parse(@converter.convert(line), &block)
     end
-  end # def decode
+  end
 
   def encode(event)
     # Tack on a @delimiter for now because previously most of logstash's JSON
     # outputs emitted one per line, and whitespace is OK in json.
     @on_event.call(event, "#{event.to_json}#{@delimiter}")
-  end # def encode
+  end
 
   private
 
-  def guard(data)
-    begin
-      LogStash::Event.new(LogStash::Json.load(data))
-    rescue LogStash::Json::ParserError => e
-      LogStash::Event.new("message" => data, "tags" => ["_jsonparsefailure"])
-    end
+  # from_json_parse uses the Event#from_json method to deserialize and directly produce events
+  def from_json_parse(json, &block)
+    LogStash::Event.from_json(json).each { |event| yield event }
+  rescue LogStash::Json::ParserError
+    yield LogStash::Event.new("message" => json, "tags" => ["_jsonparsefailure"])
   end
 
+  # legacy_parse uses the LogStash::Json class to deserialize json
+  def legacy_parse(json, &block)
+    yield LogStash::Event.new(LogStash::Json.load(json))
+  rescue LogStash::Json::ParserError
+    yield LogStash::Event.new("message" => json, "tags" => ["_jsonparsefailure"])
+  end
+
+  alias_method :parse, LogStash::Event.respond_to?(:from_json) ? :from_json_parse : :legacy_parse
+
 end # class LogStash::Codecs::JSONLines

data/logstash-codec-json_lines.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-json_lines'
-  s.version         = '2.0.5'
+  s.version         = '2.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This codec will decode streamed JSON that is newline delimited."
   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.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
-  s.require_paths = ["lib"]
+  s.require_paths   = ["lib"]
 
   # Files
   s.files = Dir['lib/**/*','spec/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']

data/spec/codecs/json_lines_spec.rb

@@ -6,9 +6,10 @@ require "logstash/json"
 require "insist"
 
 describe LogStash::Codecs::JSONLines do
-  subject do
-    next LogStash::Codecs::JSONLines.new
-  end
+
+  let(:codec_options) { {} }
+
+  shared_examples :codec do
 
   context "#decode" do
     it "should return an event from json data" do
@@ -37,9 +38,7 @@ describe LogStash::Codecs::JSONLines do
     context "when using custom delimiter" do
       let(:delimiter) { "|" }
       let(:line) { "{\"hey\":1}|{\"hey\":2}|{\"hey\":3}|" }
-      subject do
-        next LogStash::Codecs::JSONLines.new("delimiter" => delimiter)
-      end
+      let(:codec_options) { { "delimiter" => delimiter } }
 
       it "should decode multiple lines separated by the delimiter" do
         result = []
@@ -122,9 +121,7 @@ describe LogStash::Codecs::JSONLines do
 
     context "when using custom delimiter" do
       let(:delimiter) { "|" }
-      subject do
-        next LogStash::Codecs::JSONLines.new("delimiter" => delimiter)
-      end
+      let(:codec_options) { { "delimiter" => delimiter } }
 
       it "should decode multiple lines separated by the delimiter" do
         subject.on_event do |e, d|
@@ -170,4 +167,35 @@ describe LogStash::Codecs::JSONLines do
       expect(collector.last['field']).to eq('value2')
     end
   end
+
+  end
+
+  context "forcing legacy parsing" do
+    it_behaves_like :codec do
+      subject do
+        # register method is called in the constructor
+        LogStash::Codecs::JSONLines.new(codec_options)
+      end
+
+      before(:each) do
+        # stub codec parse method to force use of the legacy parser.
+        # this is very implementation specific but I am not sure how
+        # this can be tested otherwise.
+        allow(subject).to receive(:parse) do |line, &block|
+          subject.send(:legacy_parse, line, &block)
+        end
+      end
+    end
+  end
+
+  context "default parser choice" do
+    # here we cannot force the use of the Event#from_json since if this test is run in the
+    # legacy context (no Java Event) it will fail but if in the new context, it will be picked up.
+    it_behaves_like :codec do
+      subject do
+        # register method is called in the constructor
+        LogStash::Codecs::JSONLines.new(codec_options)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-json_lines
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core