fluent-plugin-parse_cookie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22eaeee0fdeb4f1158f5957db87a9e1fa00fa3bf
+  data.tar.gz: eddd439e59e66f93644f524e0c5f0e7e0a5ab899
+SHA512:
+  metadata.gz: 8c6b308be1fe6d01bb7d754a0f5482c3917e5ab4feab89037842e1d2958db0c11708b4afbe376b6d09930e669f04d8c12034387d9cf075f85ff9c9b37acfc6b2
+  data.tar.gz: cee4b10f6e18acec7b18e7415b475c9786dd5d6421a17a06412b87b7bf77754f1dfc51e52e30461c652521f3dd305f30e9208c9443687b4b6e9bb13454c10e11

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-parse_cookie.gemspec
+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,163 @@
+# Fluent::Plugin::ParseCookie, a plugin for [Fluentd](http://fluentd.org)
+
+Fluentd plugin to parse cookie log.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-parse_cookie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-parse_cookie
+
+## Usage
+
+default usage
+```
+<match foo.**>
+  type parse_cookie
+  key  cookie
+</match>
+
+input
+"test" {
+  "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+}
+
+output
+    "parsed_cookie.test" {
+      "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+      "foo": ["baz"],
+      "empty": [],
+      "array": ["123", "abc", "1a2b"]
+    }
+```
+
+change tag prefix (default tag prefix is "parsed_cookie.")
+```
+<match foo.**>
+  type parse_cookie
+  key  cookie
+  tag_prefix changed.
+  
+</match>
+
+input
+"test" {
+  "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+}
+
+output
+    "changed.test" {
+      "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+      "foo": ["baz"],
+      "empty": [],
+      "array": ["123", "abc", "1a2b"]
+    }
+```
+
+If you want to remove empty array.
+```
+<match foo.**>
+  type                parse_cookie
+  key                 cookie
+  remove_empty_array  true
+</match>
+
+input
+"test" {
+  "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+}
+
+output
+    "parsed_cookie.test" {
+      "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+      "foo": ["baz"],
+      "array": ["123", "abc", "1a2b"]
+    }
+```
+
+If you want convert array that has only single object to string.
+```
+<match foo.**>
+  type                    parse_cookie
+  key                     cookie
+  single_value_to_string  true
+</match>
+
+input
+"test" {
+  "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+}
+
+output
+    "parsed_cookie.test" {
+      "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+      "foo": "baz",
+      "empty": [],
+      "array": ["123", "abc", "1a2b"]
+    }
+```
+
+If you want remove cookie from record.
+```
+<match foo.**>
+  type           parse_cookie
+  key            cookie
+  remove_cookie  true
+</match>
+
+input
+"test" {
+  "cookie": "foo=baz; empty=; array=123; array=abc; array=1a2b"
+}
+
+output
+    "parsed_cookie.test" {
+      "foo": ["baz"],
+      "empty": [],
+      "array": ["123", "abc", "1a2b"]
+    }
+```
+## Option Parameters
+
+### key :String
+key is used to point a key thad is cookie.
+
+### tag_prefix :String
+Added tag prefix.
+Default value is "parsed."
+
+### remove_empty_array :Bool
+You want to remove empty array.
+You must be this option setting true.
+Default value is false.
+
+### single_value_to_string :Bool
+You want to convert array that has only single object to string.
+You must be this option setting true.
+Default value is false.
+
+### remove_cookie :Bool
+You want to remove cookie.
+You must be this option setting true.
+Default value is false.
+
+## Change log
+See [CHANGELOG.md](https://github.com/[my-github-username]/fluent-plugin-parse_cookie/blob/master/CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fluent-plugin-parse_cookie/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-parse_cookie.gemspec

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

data/lib/fluent/plugin/out_parse_cookie.rb

@@ -0,0 +1,71 @@
+module Fluent
+  class ParseCookieOutput < Output
+  	Fluent::Plugin.register_output('parse_cookie', self)
+  	config_param :key,                    :string
+    config_param :tag_prefix,             :string, :default => 'parsed_cookie.'
+    config_param :remove_empty_array,     :bool, :default => false
+    config_param :single_value_to_string, :bool, :default => false
+    config_param :remove_cookie,          :bool, :default => false
+
+    def initialize
+      super
+      require 'CGI'
+    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_cookie(record)
+
+        t = @tag_prefix + t unless @tag_prefix.nil?
+
+        Engine.emit(t, time, new_record)
+      }
+      chain.next
+    rescue => e
+      log.warn("out_parse_cookie: error_class:#{e.class} error_message:#{e.message} tag:#{tag} es:#{es} bactrace:#{e.backtrace.first}")
+    end
+
+    def parse_cookie(record)
+      if record[key]
+        parsed_cookie = CGI::Cookie.parse(record[key])
+        hash = {}
+        parsed_cookie.each do |k,array| 
+          hash.merge!({k => array.select {|v| v.class == String }})
+        end
+        
+        hash = hash.select {|k, v| v != []} if remove_empty_array == true
+
+        if single_value_to_string == true
+          hash.each do |k, v|
+            if v.count == 1
+              hash[k] = v[0]
+            end
+          end
+        end
+        record.merge!(hash)
+        record.delete(key) if remove_cookie
+      end
+      return record
+    rescue => e
+      log.warn("out_parse_cookie: error_class:#{e.class} error_message:#{e.message} tag:#{tag} record:#{record} bactrace:#{e.backtrace.first}")
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fluent
+  module ParseCookie
+    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_cookie'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_parse_cookie.rb

@@ -0,0 +1,173 @@
+require 'helper'
+require 'rr'
+require 'timecop'
+require 'pry-byebug'
+require 'fluent/plugin/out_parse_cookie'
+
+class ParseCookieOutputTest < Test::Unit::TestCase
+
+  COOKIE = 'temporary=tmp; empty=; __test=miahcel; array=123; array=abc; array=1a2b'
+
+  def setup
+    Fluent::Test.setup
+    Timecop.freeze(@time)
+  end
+
+  teardown do
+    Timecop.return
+  end
+
+  def create_driver(conf, tag)
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::ParseCookieOutput, 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                cookie
+    ], "test")
+
+    assert_equal 'cookie',          d.instance.key
+    assert_equal 'parsed_cookie.',  d.instance.tag_prefix
+    assert_equal false,             d.instance.remove_empty_array
+  end
+
+  def test_parse_cookie
+    conf = %[
+      key            cookie
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed_cookie.test',                     tag
+      assert_equal ['tmp'],                                  record['temporary']
+      assert_equal [],                                       record['empty']
+      assert_equal ['miahcel'],                              record['__test']
+      assert_equal ['123', 'abc', '1a2b'],                   record['array']
+      assert_equal COOKIE,                                   record['cookie']
+    end
+  end
+
+  def test_delete_cookie
+    conf = %[
+      key            cookie
+      remove_cookie  true
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed_cookie.test',              tag
+      assert_equal ['tmp'],       record['temporary']
+      assert_equal [],            record['empty']
+      assert_equal ['miahcel'],     record['__test']
+      assert_equal ['123', 'abc', '1a2b'],     record['array']
+      assert_equal nil,     record['cookie']
+    end
+  end
+
+  def test_add_tag_prefix
+    conf = %[
+      key            cookie
+      tag_prefix     add_tag.
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'add_tag.test',              tag
+      assert_equal ['tmp'],       record['temporary']
+      assert_equal [],            record['empty']
+      assert_equal ['miahcel'],     record['__test']
+      assert_equal ['123', 'abc', '1a2b'],     record['array']
+      assert_equal COOKIE,     record['cookie']
+    end
+  end
+
+  def test_remove_empty_array
+    conf = %[
+      key                 cookie
+      remove_empty_array  true
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed_cookie.test',              tag
+      assert_equal ['tmp'],       record['temporary']
+      assert_equal nil,            record['empty']
+      assert_equal ['miahcel'],     record['__test']
+      assert_equal ['123', 'abc', '1a2b'],     record['array']
+      assert_equal COOKIE,     record['cookie']
+    end
+  end
+
+  def test_single_value_to_string
+    conf = %[
+      key                     cookie
+      single_value_to_string  true
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed_cookie.test',              tag
+      assert_equal 'tmp',       record['temporary']
+      assert_equal [],            record['empty']
+      assert_equal 'miahcel',     record['__test']
+      assert_equal ['123', 'abc', '1a2b'],     record['array']
+      assert_equal COOKIE,     record['cookie']
+    end
+  end
+
+  def test_remove_empty_array_single_value_to_string
+    conf = %[
+      key                     cookie
+      remove_empty_array      true
+      single_value_to_string  true
+    ]
+
+    record = {
+      'cookie' => COOKIE,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed_cookie.test',              tag
+      assert_equal 'tmp',       record['temporary']
+      assert_equal nil,            record['empty']
+      assert_equal 'miahcel',     record['__test']
+      assert_equal ['123', 'abc', '1a2b'],     record['array']
+      assert_equal COOKIE,     record['cookie']
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-parse_cookie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hirokazu Hata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 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: 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 cookie
+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_cookie.gemspec
+- lib/fluent/plugin/out_parse_cookie.rb
+- lib/fluent/plugin/parse_cookie/version.rb
+- test/helper.rb
+- test/plugin/test_out_parse_cookie.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 cookie
+test_files:
+- test/helper.rb
+- test/plugin/test_out_parse_cookie.rb