fluent-plugin-has-keys 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d001634898485cc3c5a8d46a8b3d837fe6e56f5
+  data.tar.gz: 7744273ba81cf6716ab42b183a0ae50ebbb0c37c
+SHA512:
+  metadata.gz: 43c260db3859bf75ca21b85f5c48c19ed129bc131a9c66755c99a97357a30d92a3047e15ae54fcbbc6582a3fe8e4a2795d4532edacb529febccfab5e7d8262d8
+  data.tar.gz: 53a4029371a6d0480b4a04e4ef691f61aff18a8228bf73b3e289d1ad059ea2f1a0efeda9baff5d0fb1fabafc746199efb86e6cc897498a33ce52a360f37a58e6

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Trickey
+
+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,38 @@
+# fluent-plugin-has-keys
+This fluentd plugin is to filter records without the given keys.
+
+## Usage
+
+fluentd.conf
+
+```
+<filter **>
+  @type has_keys
+  keys  hoge, foo
+</filter>
+```
+
+Input messages:
+
+```
+  2016-05-03T11:22:33 test {"hoge" => "fuga", "foo" => "bar"}
+  2016-05-03T11:22:34 test {"hoge" => "fuga"}
+  2016-05-03T11:22:35 test {"foo" => "bar"}
+  2016-05-03T11:22:36 test {"spam" => "ham"}
+  2016-05-03T11:22:37 test {"hoge" => "fuga", "foo" => "bar", "spam" => "ham"}
+```
+
+Output messages:
+
+```
+  2016-05-03T11:22:33 test {"hoge" => "fuga", "foo" => "bar"}
+  2016-05-03T11:22:37 test {"hoge" => "fuga", "foo" => "bar", "spam" => "ham"}
+```
+
+## TODO
+* Check whether this plugin works under a general operation.
+
+## Copyright
+Copyright (c) 2016 Trickey
+Released under the MIT license
+https://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+# -*- mode:ruby -*-
+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-has-keys.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# -*- mode:ruby -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Trickey"]
+  gem.email         = ["cafegentle@gmail.com"]
+  gem.description   = %q{Fluentd plugin to filter records without essential keys}
+  gem.summary       = %q{Fluentd plugin to filter records without essential keys}
+  gem.homepage      = "https://github.com/TrickyMonkey/fluent-plugin-has-keys"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fluent-plugin-has-keys"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_runtime_dependency "fluentd", ">= 0.12.0"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+end

data/lib/fluent/plugin/filter_has_keys.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+module Fluent
+  class HasKeysFilter < Filter
+    Fluent::Plugin.register_filter('has_keys', self)
+
+    config_param :keys, :string, :default => nil
+
+    def configure(conf)
+      super
+      @essential_keys = @keys ? @keys.split(",").map(&:strip) : nil
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def filter_stream(tag, es)
+      new_es = MultiEventStream.new
+      es.each do |time, record|
+        if @essential_keys.nil? or @essential_keys.all? {|k| record.has_key?(k) }
+            new_es.add(time, record)
+        end
+      end
+      return new_es
+    end
+  end if defined?(Filter)
+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/filter_has_keys'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_filter_has_keys.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+require 'fluent/plugin/filter_has_keys'
+
+class HasKeysFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  TAG = 'test'
+
+  def create_driver(conf)
+    Fluent::Test::FilterTestDriver.new(Fluent::HasKeysFilter).configure(conf, TAG)
+  end
+
+  def test_emit_with_essential_keys
+    return unless defined? Fluent::Filter
+
+    driver = create_driver(%[ keys hoge, foo ])
+    es = Fluent::MultiEventStream.new
+
+    time = Time.parse("2016-05-06 11:22:33 UTC").to_i
+    driver.run do
+      driver.filter({"hoge" => "fuga", "foo" => "bar"})
+      driver.filter({"hoge" => "fuga"})
+      driver.filter({"foo" => "bar"})
+      driver.filter({"spam" => "ham"})
+      driver.filter({"hoge" => "fuga", "foo" => "bar", "spam" => "ham"})
+    end
+
+    filtered_records = driver.filtered_as_array
+    assert_equal 2, filtered_records.length
+    assert_equal({"hoge" => "fuga", "foo" => "bar"}, filtered_records[0][2])
+    assert_equal({"hoge" => "fuga", "foo" => "bar", "spam" => "ham"}, filtered_records[1][2])
+  end
+
+  def test_emit_without_essential_keys
+    return unless defined? Fluent::Filter
+
+    driver = create_driver(%[ ])
+    es = Fluent::MultiEventStream.new
+
+    time = Time.parse("2016-05-06 11:22:33 UTC").to_i
+    driver.run do
+      driver.filter({"hoge" => "fuga", "foo" => "bar"})
+      driver.filter({"hoge" => "fuga"})
+      driver.filter({"foo" => "bar"})
+      driver.filter({"spam" => "ham"})
+      driver.filter({"hoge" => "fuga", "foo" => "bar", "spam" => "ham"})
+    end
+
+    filtered_records = driver.filtered_as_array
+    assert_equal 5, filtered_records.length
+    assert_equal({"hoge" => "fuga", "foo" => "bar"}, filtered_records[0][2])
+    assert_equal({"hoge" => "fuga"}, filtered_records[1][2])
+    assert_equal({"foo" => "bar"}, filtered_records[2][2])
+    assert_equal({"spam" => "ham"}, filtered_records[3][2])
+    assert_equal({"hoge" => "fuga", "foo" => "bar", "spam" => "ham"}, filtered_records[4][2])
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-has-keys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Trickey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-07 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Fluentd plugin to filter records without essential keys
+email:
+- cafegentle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-has-keys.gemspec
+- lib/fluent/plugin/filter_has_keys.rb
+- test/helper.rb
+- test/plugin/test_filter_has_keys.rb
+homepage: https://github.com/TrickyMonkey/fluent-plugin-has-keys
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to filter records without essential keys
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_has_keys.rb