fluent-plugin-uri_decoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b04f3cbd3a4c76240f197ee2691770b974a7788
+  data.tar.gz: 3fc00cb9d59e3cc592f40968e761ed42d3cf9385
+SHA512:
+  metadata.gz: bfa71f002ee3fc7a6a09a69cb981814fd56eb627a8dcd63cf9592704782fc65f24f789bb990b5d919325e6584ae6704704637176203a5138c37fabfe787e371a
+  data.tar.gz: 66383a9770c476f3cecef5259c7f121dcc5b075f14e93d9fe7aa8e1813c9b042f0d96ecaf4f31be511a2ecef18ad6bd028269188a7d03afcad16e8ab01e1cc46

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-uri_decoder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- Yasuharu Ozaki
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+# Fluent::Plugin::URIDecoder
+
+Fluent plugin to decode uri encoded value.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-uri_decoder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-uri_decoder
+
+## Usage
+
+Specify decode target with `key_name`:
+
+```
+<match input.**>
+  type uri_decode
+  key_name query_param
+  remove_prefix input
+  add_prefix decoded
+</match>
+```
+
+This re-emits `decoded.**` tagged message with uri decoded.
+
+If you have multiple decode target, use `key_names` with comma separated:
+
+```
+<match input.**>
+  type uri_decode
+  key_names first_query_param, second_query_param
+  remove_prefix input
+  add_prefix decoded
+</match>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-uri_decoder.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-uri_decoder"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Yasuharu Ozaki"]
+  spec.email         = ["yasuharu.ozaki@gmail.com"]
+  spec.description   = %q{Fluent plugin to decode uri encoded value. See more https://github.com/YasuOza/fluent-plugin-uri_decoder}
+  spec.summary       = %q{Fluent plugin to decode uri encoded value.}
+  spec.homepage      = "https://github.com/YasuOza/fluent-plugin-uri_decoder"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/fluent/plugin/uri_decoder.rb

@@ -0,0 +1,71 @@
+class Fluent::URIDecoder < Fluent::Output
+  Fluent::Plugin.register_output('uri_decode', self)
+
+  config_param :tag, :string, :default => nil
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix, :string, :default => nil
+  config_param :key_name, :string, :default => nil
+  config_param :key_names, :string, :default => ''
+
+  def initialize
+    super
+    require 'uri'
+  end
+
+  def configure(conf)
+    super
+
+    if !@remove_prefix && !@add_prefix && !@tag
+      raise Fluent::ConfigError, "missing both of remove_prefix and add_prefix"
+    end
+    if @tag && @remove_prefix && @add_prefix
+      raise Fluent::ConfigError, "either remove_prefix/add_prefix must not be specified"
+    end
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    if @add_prefix
+      @added_prefix_string = @add_prefix + '.'
+    end
+  end
+
+  def tag_mangle(tag)
+    if @tag
+      @tag
+    else
+      if @remove_prefix and
+         (tag == @remove_prefix || tag.start_with?(@removed_prefix_string) && tag.length > @removed_length)
+        tag = tag[@removed_length..-1]
+      end
+      if @add_prefix
+        tag =
+          if tag and tag.length > 0
+            @added_prefix_string + tag
+          else
+            @add_prefix
+          end
+      end
+      tag
+    end
+  end
+
+  def emit(tag, es, chain)
+    tag = tag_mangle(tag)
+
+    if @key_names
+      @key_names = @key_names.split(/,\s*/)
+    end
+    @key_names << @key_name if @key_name
+
+    es.each do |time, record|
+      @key_names.each do |key_name|
+        record[key_name] = URI.decode(record[key_name] || '').gsub(/"/, "'")
+      end
+
+      Fluent::Engine.emit(tag, time, record)
+    end
+
+    chain.next
+  end
+end

data/test/plugin/test_out_uri_decoder.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+require 'fluent/plugin/uri_decoder'
+
+class Fluent::URIDecorderTest < MiniTest::Unit::TestCase
+  CONFIG0 = %[
+    type uri_decode
+    key_name encoded
+    tag decoded
+  ]
+
+  CONFIG1 = %[
+    type uri_decode
+    key_name encoded
+    remove_prefix encoded
+    add_prefix decoded
+  ]
+
+  CONFIG2 = %[
+    type uri_decode
+    key_names encoded, another_encoded
+    remove_prefix encoded
+    add_prefix decoded
+  ]
+
+
+  def create_driver(conf=CONFIG0, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::URIDecoder, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver(CONFIG0)
+    assert_equal 'encoded', d.instance.key_name
+    assert_equal 'decoded', d.instance.tag
+
+    d = create_driver(CONFIG1)
+    assert_equal 'encoded', d.instance.remove_prefix
+    assert_equal 'decoded', d.instance.add_prefix
+  end
+
+  def test_tag_mangle
+    p = create_driver(CONFIG0).instance
+    assert_equal 'decoded', p.tag_mangle('data')
+    assert_equal 'decoded', p.tag_mangle('test.data')
+
+    p = create_driver(CONFIG1).instance
+    assert_equal 'decoded.data', p.tag_mangle('data')
+    assert_equal 'decoded.test.data', p.tag_mangle('test.data')
+  end
+
+  def test_emit_with_tag_specification
+    d = create_driver(CONFIG0)
+    time = Time.now.to_i
+    d.run do
+      d.emit({'encoded' => '%23hash', 'value' => 1}, time)
+    end
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    assert_equal 'decoded', emits[0][0]
+    assert_equal time,  emits[0][1]
+    assert_equal '#hash', emits[0][2]['encoded']
+  end
+
+  def test_emit_with_prefix_specification
+    d = create_driver(CONFIG1, 'encoded.message')
+    time = Time.now.to_i
+    d.run do
+      d.emit({'encoded' => '%23hash', 'value' => 1}, time)
+    end
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    assert_equal 'decoded.message', emits[0][0]
+    assert_equal time,  emits[0][1]
+    assert_equal '#hash', emits[0][2]['encoded']
+  end
+
+  def test_emit_with_multi_key_names
+    d = create_driver(CONFIG2, 'encoded.message')
+    time = Time.now.to_i
+    d.run do
+      d.emit({'encoded' => '%23hash', 'another_encoded' => '%23another_hash'}, time)
+    end
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    assert_equal 'decoded.message', emits[0][0]
+    assert_equal time,  emits[0][1]
+    assert_equal '#hash', emits[0][2]['encoded']
+    assert_equal '#another_hash', emits[0][2]['another_encoded']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+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 'minitest/unit'
+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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-uri_decoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasuharu Ozaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: minitest
+  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: Fluent plugin to decode uri encoded value. See more https://github.com/YasuOza/fluent-plugin-uri_decoder
+email:
+- yasuharu.ozaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-uri_decoder.gemspec
+- lib/fluent/plugin/uri_decoder.rb
+- test/plugin/test_out_uri_decoder.rb
+- test/test_helper.rb
+homepage: https://github.com/YasuOza/fluent-plugin-uri_decoder
+licenses:
+- Apache 2.0
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Fluent plugin to decode uri encoded value.
+test_files:
+- test/plugin/test_out_uri_decoder.rb
+- test/test_helper.rb
+has_rdoc: