fluent-plugin-parse_multiple_value_query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 341fa9246d8f6b4de99a2a370cc5a7e2ae10be62
+  data.tar.gz: cda8149b1812403982420aa7de9d7f3c31e2e707
+SHA512:
+  metadata.gz: 10463412bb040bf940b4de8cd54899991073d60e85bd740e1b5643e4364c4b8183390810daaba6a221df2a31c3ae97fa9a0f7cbc3ae717fe04ee9a813615f95b
+  data.tar.gz: 657550dd8d2afd93710198ee6a06831c5e58c8782cb3f53308594cfda7960c7e704211b6c0c6563ee74a8afc59d89939101614af3d9dad6917a78781ea55829a

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/02/07)
+First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 畑 宏和
+
+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,157 @@
+# Fluent::Plugin::ParseMultipleValueQuery
+
+Fluentd plugin to parse URL query parameters with Rack::Utils
+I think most of the type of query can be parsed by [fluent-plugin-extract_query_params](https://github.com/kentaro/fluent-plugin-extract_query_params).
+
+I wanted to be able to parse multiple value query string like this.
+```
+input
+"test" {
+  "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5"
+}
+
+output
+    "test" {
+      "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"],
+      "key3": [""]
+    }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-parse_multiple_value_query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-parse_multiple_value_query
+
+## Usage
+
+default usage
+```
+<match foo.**>
+  type parse_multiple_value_query
+  key  url
+</match>
+
+input
+"test" {
+  "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]="
+}
+
+output
+    "parsed.test" {
+      "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]=",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"],
+      "key3": [""]
+    }
+```
+
+change tag prefix (default tag prefix is "parsed.")
+```
+<match foo.**>
+  type parse_multiple_value_query
+  key  url
+  tag_prefix changed.
+  
+</match>
+
+input
+"test" {
+  "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]="
+}
+
+output
+    "changed.test" {
+      "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]=",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"],
+      "key3": [""]
+    }
+```
+
+If target value is only query string without uri.
+```
+<match foo.**>
+  type               parse_multiple_value_query
+  only_query_string  true
+  key                query_string
+</match>
+
+input
+"test" {
+  "query_string": "key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]="
+}
+
+output
+    "parsed.test" {
+      "query_string": "key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]=",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"],
+      "key3": [""]
+    }
+```
+
+If you want remove value that is like [] or [""] from record.
+```
+<match foo.**>
+  type                parse_multiple_value_query
+  key                 url
+  remove_empty_array  true
+</match>
+
+input
+"test" {
+  "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]="
+}
+
+output
+    "parsed.test" {
+      "url": "http://example.com?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]=",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"]
+    }
+```
+## Option Parameters
+
+### key :String
+key is used to point a key thad value contains URL string or query string.
+
+### tag_prefix :String
+Added tag prefix.
+Default value is "parsed."
+
+### only_query_string :Bool
+Parsed target isn't URL but only query string.
+You must be this option setting true.
+Default value is false.
+
+### remove_empty_array :Bool
+You want to remove parsed value that has [] or [""] or [nil].
+You must be this option setting true.
+Default value is false.
+
+## Relative
+ - [fluent-plugin-extract_query_params](https://github.com/kentaro/fluent-plugin-extract_query_params)
+
+## Change log
+See [CHANGELOG.md](https://github.com/h-michael-z/fluent-plugin-parse_multiple_value_query/blob/master/CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fluent-plugin-parse_multiple_value_query/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,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-parse_multiple_value_query.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'fluent/plugin/parse_multiple_value_query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-parse_multiple_value_query"
+  spec.version       = Fluent::ParseMultipleValueQuery::VERSION
+  spec.authors       = ["Hirokazu Hata"]
+  spec.email         = ["h.hata.ai.t@gmail.com"]
+  spec.summary       = %q{Fluentd plugin to parse query string with rails format}
+  spec.description   = %q{Fluentd plugin to parse query string with rails format}
+  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_dependency "rack", "~> 1.3.1"
+  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 "rr"
+  spec.add_development_dependency "timecop"
+end

data/lib/fluent/plugin/out_parse_multiple_value_query.rb

@@ -0,0 +1,83 @@
+module Fluent
+  class ParseMultipleValueQueryOutput < Output
+    Fluent::Plugin.register_output('parse_multipe_value_query', self)
+
+    config_param :key,                :string
+    config_param :tag_prefix,         :string, :default => 'parsed.'
+    config_param :only_query_string,  :bool, :default => false
+    config_param :remove_empty_array, :bool, :default => false
+
+    def initialize
+      super
+      require 'rack'
+    end
+
+    # Define `log` method for v0.10.42 or earlier
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def emit(tag, es, chain)
+      es.each {|time, record|
+        t = tag.dup
+        new_record = parse_uri(record)
+
+        t = @tag_prefix + t unless @tag_prefix.nil?
+
+        Engine.emit(t, time, new_record)
+      }
+      chain.next
+    rescue => e
+      log.warn("out_parse_multiple_value_uri_query: error_class:#{e.class} error_message:#{e.message} tag:#{tag} es:#{es} bactrace:#{e.backtrace.first}")
+    end
+
+    def parse_uri(record)
+      if record[key]
+        if only_query_string
+          record = parse_query_string(record,record[key])
+          return record
+        else
+          query = URI.parse(record[key]).query
+          record = parse_query_string(record, query)
+          return record
+        end
+      end
+    end
+
+    def parse_query_string(record, query_string)
+      begin
+        parsed_query = Rack::Utils.parse_nested_query(query_string)
+        parsed_query.each do |key, value|
+          if value == ""
+            record[key] = ""
+          else
+            if value.class == Array && remove_empty_array
+              if value.empty? || value == [""] || value == [nil]
+                record.delete(key)
+              else
+                record[key] = value
+              end
+            else
+              record[key] = value
+            end
+          end
+        end
+      rescue => e
+        log.warn("out_parse_multiple_value_uri_query: error_class:#{e.class} error_message:#{e.message} record:#{record} bactrace:#{e.backtrace.first}")
+      end
+      return record
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fluent
+  module ParseMultipleValueQuery
+    VERSION = "0.0.1"
+  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_parse_multiple_value_query'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_parse_multiple_value_query.rb

@@ -0,0 +1,152 @@
+require 'helper'
+require 'rr'
+require 'timecop'
+require 'fluent/plugin/out_parse_multiple_value_query'
+
+class ParseMultipleValueQueryOutTest < Test::Unit::TestCase
+
+  URL = 'http://example.com:80/?foo=bar&baz=qux&multiple[]=1&multiple[]=2&multiple[]=3&multiple2[]='
+  URL_INCLUDE_JP = 'http://example.com:80/?foo=bar&baz=qux&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%AD%E3%82%B9%E3%82%AF&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B7%E3%82%A7%E3%83%B3%E3%82%AB%E3%83%BC&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B8%E3%83%A3%E3%82%AF%E3%82%BD%E3%83%B3'
+  ONLY_QUERY_STRING_TEST = 'foo=bar&baz=qux&multiple[]=1&multiple[]=2&multiple[]=3&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%AD%E3%82%B9%E3%82%AF&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B7%E3%82%A7%E3%83%B3%E3%82%AB%E3%83%BC&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B8%E3%83%A3%E3%82%AF%E3%82%BD%E3%83%B3'
+  REMOVE_EMPTY_KEY = 'http://example.com:80/?foo=bar&baz=qux&multiple[]=&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%AD%E3%82%B9%E3%82%AF&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B7%E3%82%A7%E3%83%B3%E3%82%AB%E3%83%BC&%E3%81%BE%E3%81%84%E3%81%91%E3%82%8B%5B%5D=%E3%82%B8%E3%83%A3%E3%82%AF%E3%82%BD%E3%83%B3&multiple2[]'
+
+  def setup
+    Fluent::Test.setup
+    Timecop.freeze(@time)
+  end
+
+  teardown do
+    Timecop.return
+  end
+
+  def create_driver(conf, tag)
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::ParseMultipleValueQueryOutput, 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
+    d = create_driver(%[
+      key                url
+      only_query_string  true
+    ], "test")
+
+    assert_equal 'url',  d.instance.key
+    assert_equal true,   d.instance.only_query_string
+  end
+
+  def test_filter_record
+    conf = %[
+      key            url
+    ]
+
+    record = {
+      'url' => URL,
+    }
+
+    emits = emit(conf, record)
+# binding.pry
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed.test',              tag
+      assert_equal URL,       record['url']
+      assert_equal 'bar',     record['foo']
+      assert_equal 'qux',     record['baz']
+      assert_equal ["1", "2", "3"],     record['multiple']
+      assert_equal [""],      record['multiple2']
+    end
+
+  end
+
+  def test_jp_filter_record
+    conf = %[
+      key            url
+    ]
+
+    record = {
+      'url' => URL_INCLUDE_JP,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed.test',              tag
+      assert_equal URL_INCLUDE_JP,       record['url']
+      assert_equal 'bar',     record['foo']
+      assert_equal 'qux',     record['baz']
+      assert_equal ["キスク", "シェンカー", "ジャクソン"], record['まいける']
+    end
+
+  end
+
+  def test_only_query_string_filter_record
+    conf = %[
+      key                query_string
+      only_query_string  true
+    ]
+
+    record = {
+      'query_string' => ONLY_QUERY_STRING_TEST,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed.test',              tag
+      assert_equal ONLY_QUERY_STRING_TEST,       record['query_string']
+      assert_equal 'bar',     record['foo']
+      assert_equal 'qux',     record['baz']
+      assert_equal ["1", "2", "3"],     record['multiple']
+      assert_equal ["キスク", "シェンカー", "ジャクソン"], record['まいける']
+    end
+  end
+
+  def test_remove_empty_array
+    conf = %[
+      key                 url
+      remove_empty_array  true
+    ]
+
+    record = {
+      'url' => REMOVE_EMPTY_KEY,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed.test',              tag
+      assert_equal REMOVE_EMPTY_KEY,    record['url']
+      assert_equal 'bar',               record['foo']
+      assert_equal 'qux',               record['baz']
+      assert_equal nil,                 record['multiple']
+      assert_equal nil,                 record['multiple2']
+    end
+  end
+
+  def test_tag_prefix
+    conf = %[
+      key                 url
+      tag_prefix          prefix.
+    ]
+
+    record = {
+      'url' => URL,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'prefix.test',    tag
+      assert_equal URL,       record['url']
+      assert_equal 'bar',     record['foo']
+      assert_equal 'qux',     record['baz']
+      assert_equal ["1", "2", "3"],     record['multiple']
+    end
+  end
+
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-parse_multiple_value_query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hirokazu Hata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !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: rr
+  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: Fluentd plugin to parse query string with rails format
+email:
+- h.hata.ai.t@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-parse_multiple_value_query.gemspec
+- lib/fluent/plugin/out_parse_multiple_value_query.rb
+- lib/fluent/plugin/parse_multiple_value_query/version.rb
+- test/helper.rb
+- test/plugin/test_out_parse_multiple_value_query.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 parse query string with rails format
+test_files:
+- test/helper.rb
+- test/plugin/test_out_parse_multiple_value_query.rb