fluent-plugin-filter-urldecode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dfbd61c04e1ce198de4b342a02ad9ae81302a5f
+  data.tar.gz: 0c230fdaaee56ff2bd5c25f5a6433ea8619e4859
+SHA512:
+  metadata.gz: c78d25e6ff4ef67dc9b5478ac0053a56ac5419501ba3bd6f6ab2e82f8e90b40d339e77ead692b8b07ef5ccccf5c32373e6270f170eb91dbfc346b17eebea9148
+  data.tar.gz: 2c3e57b56d0eb51dba71700f2ac1d2b1603d9e8227d0992c020aa3b52ae8631bf11894821cc0793a7c0f2d72bca3ea5694b7b81465d0eea0e7e70622a2ab01b7

data/.gitignore

@@ -0,0 +1,11 @@
+~*
+#*
+*~
+[._]*.s[a-w][a-z]
+.DS_Store
+
+*.gem
+.bundle
+Gemfile.lock
+vendor
+.ruby-version

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2.2
+  - 2.3.3
+  - 2.4.0
+
+gemfile:
+  - Gemfile
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Daniel Malon
+
+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,29 @@
+# fluent-plugin-filter-urldecode
+
+[![Build Status](https://travis-ci.org/MerlinDMC/fluent-plugin-filter-urldecode.svg?branch=master)](https://travis-ci.org/MerlinDMC/fluent-plugin-filter-urldecode)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-filter-urldecode.svg)](http://badge.fury.io/rb/fluent-plugin-filter-urldecode)
+
+## Overview
+
+A percent decode filter for [Fluentd](http://www.fluentd.org/).
+
+### Configuration
+
+Decode percent encoded fields
+
+```
+<source>
+  @type dummy
+  tag example
+  dummy {"message": "1%202%203"}
+</source>
+
+<filter example>
+  @type urldecode
+  fields message
+</filter>
+
+<match **>
+  @type stdout
+</match>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/test_*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]

data/fluent-plugin-filter-urldecode.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-filter-urldecode"
+  gem.description = "A filter plugin to decode percent encoded fields"
+  gem.license     = "MIT"
+  gem.homepage    = "https://github.com/MerlinDMC/fluent-plugin-filter-urldecode"
+  gem.summary     = gem.description
+  gem.version     = "0.1.0"
+  gem.authors     = ["Daniel Malon"]
+  gem.email       = "daniel.malon@me.com"
+  gem.has_rdoc    = false
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency "fluentd", ">= 0.12"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/filter_urldecode.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'cgi'
+
+require 'fluent/plugin/filter'
+
+module Fluent
+  class URLDecodeFilter < Filter
+    Plugin.register_filter('urldecode', self)
+
+    def initialize
+      super
+    end
+
+    config_param :fields, :array, value_type: :string
+
+    def configure(conf)
+      super
+    end
+
+    def filter(tag, time, record)
+      @fields.each { |key|
+        record[key] = CGI.unescape(record[key]) if record.has_key? key
+      }
+      record
+    end
+
+  end if defined?(Filter) # Support only >= v0.12
+end

data/test/plugin/test_filter_urldecode.rb

@@ -0,0 +1,42 @@
+require_relative '../test_helper'
+
+class URLDecodeFilterTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  CONFIG = %[
+    fields field1,field2
+  ]
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::FilterTestDriver.new(Fluent::URLDecodeFilter).configure(conf, true)
+  end
+
+  def emit(config, record)
+    d = create_driver(config)
+    d.run {
+      d.emit(record, @time)
+    }.filtered
+  end
+
+  test 'configure' do
+    d = create_driver(CONFIG)
+    assert_equal ['field1', 'field2'], d.instance.fields
+  end
+
+  test 'decode' do
+    es = emit(CONFIG, {
+                'field1' => "1%202%203",
+                'field3' => "1%202%203"
+              })
+
+    es.each { |time, record|
+      assert_equal '1 2 3', record['field1']
+      assert_equal '1%202%203', record['field3']
+      assert_equal false, record.has_key?('field2')
+    }
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/filter_urldecode'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter-urldecode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Malon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A filter plugin to decode percent encoded fields
+email: daniel.malon@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-filter-urldecode.gemspec
+- lib/fluent/plugin/filter_urldecode.rb
+- test/plugin/test_filter_urldecode.rb
+- test/test_helper.rb
+homepage: https://github.com/MerlinDMC/fluent-plugin-filter-urldecode
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A filter plugin to decode percent encoded fields
+test_files:
+- test/plugin/test_filter_urldecode.rb
+- test/test_helper.rb