logstash-codec-form 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00bad5d41ade7457f0b0dc3b085e93ed430b52d1
-  data.tar.gz: 4751fda129d80c4afe4ea463f325f838da97e00e
+  metadata.gz: bfcf038963d59e55a83ea30b52c96b5bfbb6a9ea
+  data.tar.gz: 056c57a5f14af66f7b8eef42af690abce74c5e91
 SHA512:
-  metadata.gz: c1d737ee02bf967d2123457450479f097e88c633b8c2ec4added347d4c452296c5f95966d3d7de8cc191ed69b6b4afe4f6c0f055eef60327b896dc8598c2f104
-  data.tar.gz: 9bca7fbf432c81c7526e663d7eac93e4beb6dfc520c39a9866f84a3e9c12b11f7dd4593ba590ea81ba8aa26504b4c2940aeebbe03f19cf75bff3527ab55e4906
+  metadata.gz: 5d653f3053739345765d5a243cc43282a8e375c6e3d0ac6916ad6876e275a09695208aca4b186f5677cccfc535a1a3cff3d8634b700646c6352679eaacd8343d
+  data.tar.gz: f5fa54a7d428fb12c58571d5144b3bc76404b95d2f58aaf819307f7dedccf2586e878cfbed40e9846397d5782db4785fd254740e825b842fe5ede6e789d84639

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.1.0 - January 21 2016
+
+* Replace `LogStash::Codecs::Line` with `LogStash::Util::Charset` for initial
+  handling of the message.
+* Add logging and error handling around form parsing.
+
+## 1.0.0 - January 21 2016
+
+* Initial release

data/lib/logstash/codecs/form.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'logstash/codecs/base'
-require 'logstash/codecs/line'
+require 'logstash/util/charset'
 require 'uri'
 
 class LogStash::Codecs::Form < LogStash::Codecs::Base
@@ -29,10 +29,13 @@ class LogStash::Codecs::Form < LogStash::Codecs::Base
   #     }
   config_name 'form'
 
+  # The character encoding used in this codec. Defaults to "UTF-8".
+  config :charset, validate: ::Encoding.name_list, default: "UTF-8"
+
   private
-  def parse(line)
+  def parse(payload)
     event = {}
-    keypairs = URI.decode_www_form(line['message'])
+    keypairs = URI.decode_www_form payload
     keypairs.each do |keypair|
       if event.has_key? keypair[0]
         event[keypair[0]] << keypair[1]
@@ -45,19 +48,31 @@ class LogStash::Codecs::Form < LogStash::Codecs::Base
 
   private
   def dump(event)
-    URI.encode_www_form(event.to_hash) + NL
+    URI.encode_www_form event.to_hash
   end
 
   public
   def register
-    @lines = LogStash::Codecs::Line.new
-    @lines.charset = 'UTF-8'
+    @converter = LogStash::Util::Charset.new @charset
+    @converter.logger = @logger
   end
 
   public
   def decode(payload)
-    @lines.decode(payload) do |line|
-      yield LogStash::Event.new(parse(line))
+    payload = @converter.convert payload
+    begin
+      yield LogStash::Event.new(parse(payload))
+    rescue StandardError => e
+      @logger.warn(
+        "An unexpected error occurred",
+        message: e.message,
+        backtrace: e.backtrace,
+        input: payload
+      )
+      yield LogStash::Event.new(
+        "message" => payload,
+        "tags" => ["_formparsefailure"]
+      )
     end
   end
 

data/logstash-codec-form.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-codec-form'
-  s.version         = '1.0.0'
+  s.version         = '1.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read or write events in a application/x-www-form-urlencoded format."
   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."
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
-  s.add_runtime_dependency "logstash-codec-line", "~> 2.0", ">= 2.0.2"
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/codecs/form_spec.rb

@@ -17,7 +17,7 @@ describe LogStash::Codecs::Form do
     it 'should return an application/x-www-form-urlencoded formatted line' do
       expect(subject).to receive(:on_event).once.and_call_original
       subject.on_event do |e, d|
-        insist {d} == "message=hello+world&host=test&%40version=1&%40timestamp=#{URI.encode_www_form_component(event.timestamp)}\n"
+        insist {d} == "message=hello+world&host=test&%40version=1&%40timestamp=#{URI.encode_www_form_component(event.timestamp)}"
       end
       subject.encode(event)
     end
@@ -26,7 +26,7 @@ describe LogStash::Codecs::Form do
   context '#decode' do
     it 'should return an event from an application/x-www-form-urlencoded string' do
       decoded = false
-      subject.decode("message=hello+world&host=test\n") do |e|
+      subject.decode("message=hello+world&host=test") do |e|
         decoded = true
         insist { e.is_a?(LogStash::Event) }
         insist { e['message'] } == ['hello world']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-form
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brendan ODonnell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -30,26 +30,6 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-  name: logstash-codec-line
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.2
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -70,6 +50,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - NOTICE.TXT