fluent-plugin-add_empty_array 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30ec5539884ad9010c521c18e264387f5bb89980
+  data.tar.gz: bb6f7a37359d21b953a687216b1c049c7d0e704b
+SHA512:
+  metadata.gz: 51c90cfbe7d12db391117a32be84b66b375b39fb2f2a2faea2b25167a0dc7218e208635998bcc94455702aba4e177e6f59b1f17fdc5a81ebb79e446a959f110c
+  data.tar.gz: bc4629091ea9bfc08b885340602ccddc6e048514089da69a1f0ba5234a3b681d1b0c6390df04fb8cbb748b6c96def9bf04ceb28d6801b546b66cb1f06820931f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1 (2015/03/04)
+First release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 h-michael-z
+
+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,112 @@
+## Fluent::Plugin::AddEmptyArray, a plugin for [Fluentd](http://fluentd.org)
+
+Fluentd plugin to add empty array.
+
+## Use case
+When using Google Bigquery with schema include "repeated" mode columns and insert record without "repeated" mode columns key, failed insert.
+So this plugin support this case according to add such keys complement with "[]".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-add_empty_array'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-add_empty_array
+
+## Usage
+
+default usage
+```
+<match test>
+  type            add_empty_array
+  array_type_key  test3,test4
+</match>
+
+input
+"test" {
+  "test1": "foo",
+  "test2": "bar"
+}
+
+output
+  "add_empty_array.test" {
+    "test1": "foo",
+    "test2": "bar",
+    "test3": [],
+    "test4": []
+  }
+```
+
+change tag prefix (default tag prefix is "add_empty_array.")
+```
+<match test>
+  type            add_empty_array
+  array_type_key  test3,test4
+  tag_prefix      prefix_test.
+</match>
+
+input
+"test" {
+  "test1": "foo",
+  "test2": "bar"
+}
+
+output
+  "prefix_test.test" {
+    "test1": "foo",
+    "test2": "bar",
+    "test3": [],
+    "test4": []
+  }
+```
+
+## Option Parameters
+
+### array_type_key :keys delimited by commas
+array_type_key points to keys which you want complement with "[]" if there are no those keys.
+You should set value to array_type_key like this.
+Default value is 'nil'.
+Require option.
+
+```
+array_type_key  foo
+```
+```
+array_type_key  foo,bar,baz
+```
+
+If you use this plugin with key include commas, you must use delimiter option like this.
+This example, use '.' as delimiter.
+
+```
+  type            add_empty_array
+  array_type_key  test,3.test,4
+  delimiter       .
+```
+
+### delimiter :String
+Default value is ','.
+
+### tag_prefix :String
+Added tag prefix.
+Default value is "parsed."
+
+## Change log
+See [CHANGELOG.md](https://github.com/h-michael-z/fluent-plugin-add_empty_array/blob/master/CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it ( https://github.com/h-michael-z/fluent-plugin-add_empty_array/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,9 @@
+#!/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

data/fluent-plugin-add_empty_array.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'fluent/plugin/add_empty_array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-add_empty_array"
+  spec.version       = Fluent::ParseCookie::VERSION
+  spec.authors       = ["Hirokazu Hata"]
+  spec.email         = ["h.hata.ai.t@gmail.com"]
+  spec.summary       = %q{Fluentd plugin to add empty array}
+  spec.description   = %q{
+                            We can't add record has nil value which target repeated mode column to google bigquery.
+                            So this plugin add empty array if record has nil value or don't have key and value which target repeated mode column.
+                          }
+  spec.homepage      = ""
+  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_dependency "fluentd"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "timecop"
+end

data/lib/fluent/plugin/add_empty_array/version.rb

@@ -0,0 +1,5 @@
+module Fluent
+  module ParseCookie
+    VERSION = "0.0.1"
+  end
+end

data/lib/fluent/plugin/out_add_empty_array.rb

@@ -0,0 +1,60 @@
+module Fluent
+  class AddEmptyArrayOutput < Output
+  	Fluent::Plugin.register_output('add_empty_array', self)
+  	config_param :array_type_key,         :string, :default => nil
+    config_param :delimiter,              :string, :default => ','
+    config_param :tag_prefix,             :string, :default => 'add_empty_array.'
+
+    def initialize
+      super
+    end
+
+	  # Define `log` method for v0.10.42 or earlier
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def configure(conf)
+      super
+
+      if @array_type_key
+        @array_type_key = @array_type_key.split(@delimiter)
+      end
+
+      unless @array_type_key
+        raise ConfigError, "'array_type_key' parameter is required on 'fluent-plugin-add_empty_array'"
+      end
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def emit(tag, es, chain)
+      es.each {|time, record|
+        t = tag.dup
+        new_record = add_empty_array(record)
+
+        t = @tag_prefix + t unless @tag_prefix.nil?
+
+        Engine.emit(t, time, new_record)
+      }
+      chain.next
+    rescue => e
+      log.warn("out_add_empty_array: error_class:#{e.class} error_message:#{e.message} tag:#{tag} es:#{es} record:#{record} bactrace:#{e.backtrace.first}")
+    end
+
+    def add_empty_array(record)
+      @array_type_key.each do |key|
+        record[key] = [] unless record.has_key?(key)
+      end
+      return record
+    rescue => e
+      log.warn("out_add_empty_array: error_class:#{e.class} error_message:#{e.message} tag:#{tag} record:#{record} bactrace:#{e.backtrace.first}")
+    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_add_empty_array'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_add_empty_array.rb

@@ -0,0 +1,109 @@
+require 'helper'
+require 'pry-byebug'
+require 'timecop'
+require 'fluent/plugin/out_add_empty_array'
+
+class AddEmptyArrayOutputTest < Test::Unit::TestCase
+
+  TEST_RECORD = {
+    "abc" => "edf",
+    "123" => "456"
+  }
+
+  def setup
+    Fluent::Test.setup
+    Timecop.freeze(@time)
+  end
+
+  def create_driver(conf, tag)
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::AddEmptyArrayOutput, tag
+    ).configure(conf)
+  end
+
+  def emit(conf, record, tag='test')
+    d = create_driver(conf, tag)
+    d.run {d.emit(record)}
+    emits = d.emits
+  end
+
+  def test_configure_default_tag_prefix
+    d = create_driver(%[array_type_key  a,b,c,1,2,3], "test")
+    assert_equal ["a", "b", "c" , "1" , "2" , "3"],  d.instance.array_type_key
+    assert_equal 'add_empty_array.',                 d.instance.tag_prefix
+  end
+
+  def test_configure_array_type_key_eq_nil
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[], "test")
+    end
+  end
+
+  def test_configure
+    d = create_driver(%[
+      array_type_key  a.b.c.1.2.3
+      delimiter       .
+      tag_prefix      michael.
+    ], "test")
+
+    assert_equal ["a", "b", "c" , "1" , "2" , "3"],  d.instance.array_type_key
+    assert_equal '.',                                  d.instance.delimiter
+    assert_equal 'michael.',                         d.instance.tag_prefix
+  end
+
+  def test_add_empty_array
+    conf = %[
+      array_type_key  test_array
+    ]
+
+    record = TEST_RECORD
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'add_empty_array.test',                     tag
+      assert_equal 'edf',                                  record['abc']
+      assert_equal '456',                                       record['123']
+      assert_equal [],                              record['test_array']
+    end
+  end
+
+  def test_add_empty_array_with_multiple_keys
+    conf = %[
+      array_type_key  test_array1,test_array2,test_array3
+    ]
+
+    record = TEST_RECORD
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'add_empty_array.test',                     tag
+      assert_equal 'edf',                                  record['abc']
+      assert_equal '456',                                       record['123']
+      assert_equal [],                              record['test_array1']
+      assert_equal [],                              record['test_array2']
+      assert_equal [],                              record['test_array3']
+    end
+  end
+
+  def test_add_empty_array_with_delimiter
+    conf = %[
+      array_type_key  test_array1.test_array2.test_array3
+      delimiter       .
+    ]
+
+    record = TEST_RECORD
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'add_empty_array.test',                     tag
+      assert_equal 'edf',                                  record['abc']
+      assert_equal '456',                                       record['123']
+      assert_equal [],                              record['test_array1']
+      assert_equal [],                              record['test_array2']
+      assert_equal [],                              record['test_array3']
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-add_empty_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hirokazu Hata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 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: 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: pry
+  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: pry-byebug
+  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: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: "\n                            We can't add record has nil value which
+  target repeated mode column to google bigquery.\n                            So
+  this plugin add empty array if record has nil value or don't have key and value
+  which target repeated mode column.\n                          "
+email:
+- h.hata.ai.t@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-add_empty_array.gemspec
+- lib/fluent/plugin/add_empty_array/version.rb
+- lib/fluent/plugin/out_add_empty_array.rb
+- test/helper.rb
+- test/plugin/test_add_empty_array.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to add empty array
+test_files:
+- test/helper.rb
+- test/plugin/test_add_empty_array.rb
+has_rdoc: