fluent-plugin-filter_codec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21d07fea055581657501e1d4518e7c5e6ddd198d
+  data.tar.gz: 7a7a7f9ca7b26f018f138567c00b8200444300ed
+SHA512:
+  metadata.gz: 80aff95f6a2800a906fd2cb3ab8ce5a3130374ce8bd9cdf68f8d41aebe9f024ad0e37d11ad911c303839057db63413672b539eba803edd566c131a5ca5d8b15e
+  data.tar.gz: 44da4eb7e6356e0fafcd67b6ff41349ef8de0f713f6b170a4c27fbe17230aed630dd23401fdf9ca1e6e0c1c93c9f5fbb51c3a53e9110f6abb1dd2289240864be

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-filter_custom_cart.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+Example :
+
+```
+<match test>
+    type filter_codec
+    add_tag_prefix decoded.
+    codec base64-decode
+    field key1
+    output_field key2
+</match>
+```
+
+Example of records :
+```
+{
+    'key1' => "Tmljb2xhcyBDYWdl",
+    'foo' => "bar"
+}
+```
+... will output (unchanged) :
+```
+{
+    'key1' => "Nicolas Cage",
+    'foo' => "bar"
+}
+```
+
+You can omit 'output_field' so 'field' value will be replaced by output value.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Default: run test.'
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/fluent-plugin-filter_codec.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-filter_codec"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Neozaru"]
+  spec.email         = ["neozaru@mailoo.org"]
+  spec.description   = %q{Fluentd custom plugin to encode/decode fields}
+  spec.summary       = %q{Fluentd custom plugin to encode/decode fields}
+  spec.homepage      = "https://github.com/Neozaru/fluent-plugin-filter_codec.git"
+  spec.license       = "NONE"
+
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fluentd"
+end

data/lib/fluent/plugin/out_filter_codec.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+require "base64"
+
+module Fluent
+  class FilterCodecOutput < Output
+    include Fluent::HandleTagNameMixin
+
+    Fluent::Plugin.register_output('filter_codec', self)
+
+    config_param :field, :string, :default => nil
+    config_param :output_field, :string, :default => nil
+    config_param :codec, :string, :default => nil
+
+
+    def configure(conf)
+      super
+
+      # Put new functions here
+      @codec_functions = {
+        'base64-decode' => method(:base64_decode),
+        'base64-encode' => method(:base64_encode)
+      }
+
+      if (field.nil? || codec.nil?) 
+        raise ConfigError, "filter_codec: Both 'field', and 'codec' are required to be set."
+      end
+
+      if (@codec_functions[codec].nil?)
+        raise ConfigError, "filter_codec: Unknown codec : " + codec
+      end
+
+      @field = field
+      @codec = codec
+      @output_field = output_field || field
+
+    end
+
+    def emit(tag, es, chain)
+      es.each { |time, record|
+        t = tag.dup
+        filter_record(t, time, record)
+        Engine.emit(t, time, record)
+      }
+
+      chain.next
+    end
+
+    def filter_record(tag, time, record)
+      super(tag, time, record)
+      value_in = record[@field]
+      if (value_in.nil?)
+        return
+      end
+
+      record[@output_field] = process(value_in, @codec) || value_in
+    end
+
+    private
+    def process(value, codec)
+      return @codec_functions[codec].call(value)
+
+      return value
+    end
+
+    def base64_decode(value)
+      return Base64.strict_decode64(value)
+    end
+
+    def base64_encode(value)
+      return Base64.strict_encode64(value)
+    end
+
+  end
+end

data/test/plugin/test_out_filter_codec.rb

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+require 'test_helper'
+require 'fluent/plugin/out_filter_codec'
+
+class FilterCodecOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::FilterCodecOutput, tag
+    ).configure(conf)
+  end
+
+  def test_configure_on_success
+
+    # All set
+    d = create_driver(%[
+      add_tag_prefix decoded.
+      field key1
+      output_field key2
+      codec base64-decode
+    ])
+
+    assert_equal 'decoded.', d.instance.add_tag_prefix
+    assert_equal 'key1',    d.instance.field
+    assert_equal 'key2', d.instance.output_field
+    assert_equal 'base64-decode', d.instance.codec
+
+    # output_field missing
+    d = create_driver(%[
+      add_tag_prefix decoded.
+      field key1
+      codec base64-decode
+    ])
+
+    assert_equal 'decoded.', d.instance.add_tag_prefix
+    assert_equal 'key1',    d.instance.field
+    assert_equal 'key1', d.instance.output_field
+    assert_equal 'base64-decode', d.instance.codec
+
+  end
+
+  def test_configure_on_failure
+    # when mandatory keys not set
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[
+        blah blah
+      ])
+    end
+
+    # when 'field' is missing
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[
+      add_tag_prefix decoded.
+      output_field key2
+      codec base64-decode
+    ])
+    end
+
+    # when unknown codec
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[
+      add_tag_prefix decoded.
+      field key1
+      output_field key2
+      codec unknown-codec
+    ])
+    end
+
+  end
+
+  def test_emit_with_base64_decode
+    d = create_driver(%[
+      add_tag_prefix decoded.
+      field key1
+      output_field key2
+      codec base64-decode
+    ])
+
+    record = {
+      'key1' => "Tmljb2xhcyBDYWdl",
+      'foo' => "bar"
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,           emits.count
+    assert_equal 'decoded.test', emits[0][0]
+    assert_equal 'Nicolas Cage',emits[0][2]['key2']
+  end
+
+  def test_emit_with_base64_decode_and_no_output
+    d = create_driver(%[
+      add_tag_prefix decoded.
+      field key1
+      codec base64-decode
+    ])
+
+    record = {
+      'key1' => "Tmljb2xhcyBDYWdl",
+      'foo' => "bar"
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,           emits.count
+    assert_equal 'decoded.test', emits[0][0]
+    assert_equal 'Nicolas Cage',emits[0][2]['key1']
+  end
+
+  def test_emit_with_base64_encode
+    d = create_driver(%[
+      add_tag_prefix encoded.
+      field key1
+      output_field key2
+      codec base64-encode
+    ])
+
+    record = {
+      'key1' => "Nicolas Cage",
+      'foo' => "bar"
+    }
+
+    d.run { d.emit(record) }
+    emits = d.emits
+
+    assert_equal 1,           emits.count
+    assert_equal 'encoded.test', emits[0][0]
+    assert_equal 'Tmljb2xhcyBDYWdl',emits[0][2]['key2']
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+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
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter_codec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neozaru
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !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: fluentd
+  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: Fluentd custom plugin to encode/decode fields
+email:
+- neozaru@mailoo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-filter_codec.gemspec
+- lib/fluent/plugin/out_filter_codec.rb
+- test/plugin/test_out_filter_codec.rb
+- test/test_helper.rb
+homepage: https://github.com/Neozaru/fluent-plugin-filter_codec.git
+licenses:
+- NONE
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fluentd custom plugin to encode/decode fields
+test_files:
+- test/plugin/test_out_filter_codec.rb
+- test/test_helper.rb