fluent-plugin-string-scrub 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor/*

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Noriaki Katayama
+
+MIT License
+
+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,60 @@
+# fluent-plugin-string-scrub [![Build Status](https://travis-ci.org/kataring/fluent-plugin-string-scrub.svg)](https://travis-ci.org/kataring/fluent-plugin-string-scrub) 
+
+fluent plugin for string scrub.
+
+## [String#scrub](https://github.com/hsbt/string-scrub)
+
+>If the given string contains an invalid byte sequence then that invalid byte sequence is replaced with the [unicode replacement character](http://www.fileformat.info/info/unicode/char/0fffd/index.htm) (�) and a new string is returned.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-string-scrub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-string-scrub
+
+## Configuration
+
+```
+<match **>
+  type string_scrub
+  tag scrubbed.string
+  replace_char ?
+</match>
+```
+
+## Usage
+
+```
+<source>
+  type forward
+</source>
+
+<match raw.**>
+  type string_scrub
+  remove_prefix raw
+  add_prefix scrubbed
+</match>
+
+<match scrubbed.**>
+  type stdout
+</match>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fluent-plugin-string-scrub/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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-string-scrub.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-string-scrub"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Noriaki Katayama"]
+  spec.email         = ["kataring@gmail.com"]
+  spec.summary       = %q{Fluentd Output filter plugin.}
+  spec.description   = %q{fluent plugin for string scrub.}
+  spec.homepage      = "https://github.com/kataring/fluent-plugin-string-scrub"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "fluentd"
+  spec.add_runtime_dependency "string-scrub", "~> 0.0.5" if RUBY_VERSION.to_f < 2.1
+end

data/lib/fluent/plugin/out_string_scrub.rb

@@ -0,0 +1,85 @@
+class Fluent::StringScrubOutput < Fluent::Output
+  Fluent::Plugin.register_output('string_scrub', self)
+
+  config_param :tag, :string, :default => nil
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix, :string, :default => nil
+  config_param :replace_char, :string, :default => ''
+
+  def initialize
+    super
+    require 'string/scrub' if RUBY_VERSION.to_f < 2.1
+  end
+
+  def configure(conf)
+    super
+
+    if not @tag and not @remove_prefix and not @add_prefix
+      raise Fluent::ConfigError, "missing both of remove_prefix and add_prefix"
+    end
+    if @tag and (@remove_prefix or @add_prefix)
+      raise Fluent::ConfigError, "both of tag and 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
+
+    if @replace_char and @replace_char.length >= 2
+        raise Fluent::ConfigError, "replace_char: mast be 1 character"
+    end
+  end
+
+  def emit(tag, es, chain)
+    tag = if @tag
+            @tag
+          else
+            if @remove_prefix and
+                ( (tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
+              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
+
+    es.each do |time,record|
+      scrubbed = recv_record(record)
+      next if scrubbed.nil?
+      Fluent::Engine.emit(tag, time, scrubbed)
+    end
+
+    chain.next
+  end
+
+  def recv_record(record)
+    scrubbed = {}
+    record.each do |k,v|
+      if v.instance_of? Hash
+        scrubbed[with_scrub(k)] = recv_record(v)
+      else
+        scrubbed[with_scrub(k)] = with_scrub(v)
+      end
+    end
+    scrubbed
+  end
+
+  def with_scrub(string)
+    begin
+      string =~ //
+      return string
+    rescue ArgumentError => e
+      raise e unless e.message.index("invalid byte sequence in") == 0
+      string.scrub!(@replace_char)
+      retry
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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/out_string_scrub'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_string-scrub.rb

@@ -0,0 +1,122 @@
+require 'helper'
+
+class StringScrubOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    remove_prefix input
+    add_prefix scrubbed
+  ]
+
+  CONFIG_REPLACE_CHAR = %[
+    remove_prefix input
+    add_prefix scrubbed
+    replace_char ?
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::StringScrubOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        tag foo.bar
+        remove_prefix removed
+      ]
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        tag foo.bar
+        add_prefix added
+      ]
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        tag foo.bar
+        remove_prefix removed
+        add_prefix added
+      ]
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        tag foo.bar
+      ]
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        add_prefix added
+      ]
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        remove_prefix removed
+      ]
+    }
+    assert_nothing_raised {
+      d = create_driver %[
+        remove_prefix removed
+        add_prefix added
+      ]
+    }
+  end
+
+  def test_emit1_invalid_string
+    orig_message = 'testtesttest'
+    invalid_utf8 = "\xff".force_encoding('UTF-8')
+    d1 = create_driver(CONFIG, 'input.log')
+    d1.run do
+      d1.emit({'message' => orig_message + invalid_utf8})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    
+    e1 = emits[0]
+    assert_equal "scrubbed.log", e1[0]
+    assert_equal orig_message, e1[2]['message']
+
+    invalid_ascii = "\xff".force_encoding('US-ASCII')
+    d2 = create_driver(CONFIG, 'input.log2')
+    d2.run do
+      d2.emit({'message' => orig_message + invalid_utf8})
+    end
+    emits = d2.emits
+    assert_equal 1, emits.length
+    
+    e2 = emits[0]
+    assert_equal "scrubbed.log2", e2[0]
+    assert_equal orig_message, e2[2]['message']
+  end
+
+  def test_emit2_replace_char
+    orig_message = 'testtesttest'
+    invalid_utf8 = "\xff".force_encoding('UTF-8')
+    d1 = create_driver(CONFIG_REPLACE_CHAR, 'input.log')
+    d1.run do
+      d1.emit({'message' => orig_message + invalid_utf8})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+
+    e1 = emits[0]
+    assert_equal "scrubbed.log", e1[0]
+    assert_equal orig_message + '?', e1[2]['message']
+
+    invalid_ascii = "\xff".force_encoding('US-ASCII')
+    d2 = create_driver(CONFIG_REPLACE_CHAR, 'input.log2')
+    d2.run do
+        d2.emit({'message' => orig_message + invalid_utf8})
+    end
+    emits = d2.emits
+    assert_equal 1, emits.length
+
+    e2 = emits[0]
+    assert_equal "scrubbed.log2", e2[0]
+    assert_equal orig_message + '?', e2[2]['message']
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-string-scrub
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Noriaki Katayama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: string-scrub
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: fluent plugin for string scrub.
+email:
+- kataring@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-string-scrub.gemspec
+- lib/fluent/plugin/out_string_scrub.rb
+- test/helper.rb
+- test/plugin/test_out_string-scrub.rb
+homepage: https://github.com/kataring/fluent-plugin-string-scrub
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Fluentd Output filter plugin.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_string-scrub.rb