logstash-filter-htmlentities 0.1.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eddd8290ea416c8d835a7477611c0e4e9560e787
+  data.tar.gz: 75ac596dc251d9520411cd729a68ea64ea6ca7fb
+SHA512:
+  metadata.gz: 0aa0969fcb4eb9f36e20ffad95315976de8ca783df14021145a55e32d148a4c91b77766f201ac5dfc630c1b62e51871d1606b608a2e4d1c447ff524494873d1b
+  data.tar.gz: 90582f1ae9ceb8f9ad916b5aa0df6250f5f7250740a7ca628649090fce16f5bf49b75ee0d133c6070891295436dd8af9ad192aa4c88a972c86a335a6d9fe4d3d

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+ - Initial version; simple decoding of (X)HTML entities of event fields

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash-filter-htmlentities along its way.
+
+Contributors:
+* David Robakowski (drobakowski)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+logstash-filter-htmlentities, and you aren't on the list above and want to be,
+please let us know and we'll make sure you're here. Contributions from folks
+like you are what make open source awesome.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'coveralls', require: false
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016, Synlay Technologies UG & Co. KG.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Logstash Filter HTMLEntities Plugin
+
+[![Travis Build Status](https://travis-ci.org/synlay/logstash-filter-htmlentities.svg)](https://travis-ci.org/synlay/logstash-filter-htmlentities)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is MIT, see [LICENSE](http://github.com/synlay/logstash-filter-htmlentities/LICENSE) for further infos.
+
+## Documentation
+
+This filter will decode (X)HTML entities from a given source field and store the result to the target field.
+
+### 1. Configuration
+
+```ruby
+filter {
+  htmlentities {
+    source => "test_source_field"
+    target => "test_target_field"
+  }
+}
+```
+
+This configuration will encode the source field `test_source_field` e.q. with data "Examples & Explanations" to "Examples & Explanations" and store the result to the field `test_target_field`.
+
+## Developing
+
+For further instructions on howto develop on logstash plugins, please see the documentation of the official [logstash-filter-example](https://github.com/logstash-plugins/logstash-filter-example#developing).

data/lib/logstash/filters/htmlentities.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "htmlentities"
+
+class LogStash::Filters::HTMLEntities < LogStash::Filters::Base
+    config_name "htmlentities"
+
+    # The field to perform filter
+    #
+    config :source, :validate => :string, :default => "message"
+
+    # The name of the container to put the result
+    #
+    config :target, :validate => :string, :default => "message"
+
+
+    public
+    def register
+      @coder = HTMLEntities.new
+    end # def register
+
+  public
+  def filter(event)
+
+    if @source
+      # Replace the event message with our message as configured in the
+      # config file.
+      event.set(@target, @coder.decode(event.get(@source)))
+      # correct debugging log statement for reference
+      # using the event.get API
+      @logger.debug? && @logger.debug("#{@target} is now: #{event.get(@target)}")
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::Example

data/logstash-filter-htmlentities.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-htmlentities'
+  s.version         = '0.1.0-alpha'
+  s.licenses        = ['MIT']
+  s.summary         = "Logstash filter for decoding (X)HTML entities from event fields"
+  s.description     = "A Logstash filter plugin for decoding (X)HTML entities from event fields. This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gem_name. This gem is not a stand-alone program."
+  s.authors         = ["David Robakowski"]
+  s.email           = 'david.robakowski@synlay.com'
+  s.homepage        = "https://github.com/synlay/logstash-filter-htmlentities"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'htmlentities', '~> 4.3', '>= 4.3.4'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/htmlentities_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'spec_helper'
+require "logstash/filters/htmlentities"
+
+describe LogStash::Filters::HTMLEntities do
+  describe "Simple HTML entity encoding of source field `test_source_field` while storing the result to field `test_target_field`" do
+    let(:config) do <<-CONFIG
+      filter {
+        htmlentities {
+          source => "test_source_field"
+          target => "test_target_field"
+        }
+      }
+    CONFIG
+    end
+
+    sample("test_source_field" => "Examples &amp; Explanations") do
+      expect(subject.get("test_target_field")).to eq("Examples & Explanations")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'coveralls'
+require "logstash/devutils/rspec/spec_helper"
+Coveralls.wear!

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-htmlentities
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha
+platform: ruby
+authors:
+- David Robakowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+  name: htmlentities
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+- !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: A Logstash filter plugin for decoding (X)HTML entities from event fields. This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gem_name. This gem is not a stand-alone program.
+email: david.robakowski@synlay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/htmlentities.rb
+- logstash-filter-htmlentities.gemspec
+- spec/filters/htmlentities_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/synlay/logstash-filter-htmlentities
+licenses:
+- MIT
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+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: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.5
+signing_key:
+specification_version: 4
+summary: Logstash filter for decoding (X)HTML entities from event fields
+test_files:
+- spec/filters/htmlentities_spec.rb
+- spec/spec_helper.rb