logstash-filter-urldecode 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6491119f22ace1156122a895195fb7011e29eb2
-  data.tar.gz: 175d7d0ea848c22a09bc3e9287a0869b20e14732
+  metadata.gz: 489cfc844fa459e5fe25e2dcb134657faa8fc6f1
+  data.tar.gz: 5ebaef11ad403ef90147d63fc3e241545076c2b0
 SHA512:
-  metadata.gz: 4946824bebdd97a16df7cbefc07b9d6a8690880258c8c891590d058bb5fe69650592f5b606483f5429d3e10926297e37238a50bafbaf00dc6cb97cedbfe305cc
-  data.tar.gz: aa30dc26dd77b61e537b8b003f5ef21977c5c6a3b9b6b7df6471b2566b6bff5916ce49c86d751aef68b0cc575266c15a6f53da6bee9a49277f77008ba3b35fcb
+  metadata.gz: e4041ffec8b2ac004d0274138754833b289d56b43c8a8d6763a61650e1113d86a37b3412e598f9bf73f26ca82050c564af46e6ed73f4734e6bb470731c1b72fa
+  data.tar.gz: 872cc43b30abd074c78d425387d27ec9fd782cd1070202bd5442e91d346be1fcb4daad5413e9135ff1ce5389a8dc88e91c7660c28a8ef220b89fdabf912cae9d

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/urldecode.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
+require "logstash/util/charset"
 require "uri"
 
 # The urldecode filter is for decoding fields that are urlencoded.
 class LogStash::Filters::Urldecode < LogStash::Filters::Base
   config_name "urldecode"
-  milestone 2
 
   # The field which value is urldecoded
   config :field, :validate => :string, :default => "message"
@@ -14,9 +14,17 @@ class LogStash::Filters::Urldecode < LogStash::Filters::Base
   # Urldecode all fields
   config :all_fields, :validate => :boolean, :default => false
 
+  # Thel character encoding used in this filter. Examples include `UTF-8`
+  # and `cp1252`
+  #
+  # This setting is useful if your url decoded string are in `Latin-1` (aka `cp1252`)
+  # or in another character set other than `UTF-8`.
+  config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
+
   public
   def register
-    # Nothing to do
+    @converter = LogStash::Util::Charset.new(@charset)
+    @converter.logger = logger
   end #def register
 
   public
@@ -25,9 +33,7 @@ class LogStash::Filters::Urldecode < LogStash::Filters::Base
 
     # If all_fields is true then try to decode them all
     if @all_fields
-      event.to_hash.each do |name, value|
-        event[name] = urldecode(value)
-      end
+      event.to_hash.each { |name, value| event[name] = urldecode(value) }
     # Else decode the specified field
     else
       event[@field] = urldecode(event[@field])
@@ -41,7 +47,8 @@ class LogStash::Filters::Urldecode < LogStash::Filters::Base
   def urldecode(value)
     case value
     when String
-      return URI.unescape(value)
+      escaped = URI.unescape(value)
+      return @converter.convert(escaped)
     when Array
       ret_values = []
       value.each { |v| ret_values << urldecode(v) }

data/logstash-filter-urldecode.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-urldecode'
-  s.version         = '0.1.2'
+  s.version         = '0.1.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The urldecode filter is for decoding fields that are urlencoded."
   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"

data/spec/filters/urldecode_spec.rb

@@ -4,7 +4,6 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/urldecode"
 
 describe LogStash::Filters::Urldecode do
-
   describe "urldecode of correct urlencoded data" do
     # The logstash config goes here.
     # At this time, only filters are supported.
@@ -48,7 +47,16 @@ describe LogStash::Filters::Urldecode do
       insist { subject["message"] } == "http://logstash.net/docs/1.3.2/filters/urldecode"
       insist { subject["nonencoded"] } == "http://logstash.net/docs/1.3.2/filters/urldecode"
     end
-
   end
 
+   describe "urldecode should replace invalid UTF-8" do
+     config <<-CONFIG
+      filter {
+        urldecode {}
+      }
+     CONFIG
+     sample("message" => "/a/sa/search?rgu=0;+%C3%BB%D3%D0%D5%D2%B5%BD=;+%B7%A2%CB%CD=") do
+      insist { subject["message"] } == "/a/sa/search?rgu=0;+û\\xD3\\xD0\\xD5ҵ\\xBD=;+\\xB7\\xA2\\xCB\\xCD="
+     end
+   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-urldecode
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash
@@ -53,6 +53,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - lib/logstash/filters/urldecode.rb
 - logstash-filter-urldecode.gemspec
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.4
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: The urldecode filter is for decoding fields that are urlencoded.