fluent-plugin-extract_query_params 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1396de021b24f6213a916e19163285ae71c510fa
+  data.tar.gz: 142ad5a3809f685a61a197cdf055af0a1aa295e9
+SHA512:
+  metadata.gz: 50f99f2bdd7ca5d0f83d197c0a8d7beb39c491f160b7dfde64a388023a51e9e971e2f2173db2b88d593b5c3e00d23f5dbeb3afd4c8156feeac110a995090d04f
+  data.tar.gz: f92c5e653b1311665e7ec04e39631a453cbc88bd55195f69e56bd559dcbfbfbb124b6f544a97b5af887a697649dd1c2d2e25ae408726d2fe3c5928b6ad02f770

data/README.md

@@ -64,6 +64,22 @@ If set, the key/value whose key is included `except` will NOT be added to the re
 
 If set to `true`, the original `key` url will be discarded from the record. Defaults to `false` (preserve key).
 
+### add_url_scheme
+
+If set to `true`, scheme (use `url_scheme` key) will be added to the record. Defaults to `false`.
+
+### add_url_host
+
+If set to `true`, host (use `url_host` key) will be added to the record. Defaults to `false`.
+
+### add_url_port
+
+If set to `true`, port (use `url_port` key) will be added to the record. Defaults to `false`.
+
+### add_url_path
+
+If set to `true`, path (use `url_path` key) will be added to the record. Defaults to `false`.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/fluent-plugin-extract_query_params.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'fluent-plugin-extract_query_params'
-  gem.version       = '0.0.7'
+  gem.version       = '0.0.8'
   gem.authors       = ['Kentaro Kuribayashi']
   gem.email         = ['kentarok@gmail.com']
   gem.homepage      = 'http://github.com/kentaro/fluent-plugin-extract_query_params'

data/lib/fluent/plugin/out_extract_query_params.rb

@@ -13,6 +13,11 @@ module Fluent
     config_param :add_field_prefix, :string, :default => nil
     config_param :permit_blank_key, :bool, :default => false
 
+    config_param :add_url_scheme, :bool, :default => false
+    config_param :add_url_host, :bool, :default => false
+    config_param :add_url_port, :bool, :default => false
+    config_param :add_url_path, :bool, :default => false
+
     def initialize
       super
       require 'webrick'
@@ -58,6 +63,31 @@ module Fluent
                 rescue URI::InvalidURIError => e
                   URI.parse(WEBrick::HTTPUtils.escape(record[key]))
                 end
+
+          if @add_url_scheme
+            url_scheme_key = 'url_scheme'
+            url_scheme_key = @add_field_prefix + url_scheme_key if @add_field_prefix
+            record[url_scheme_key] = url.scheme || ''
+          end
+
+          if @add_url_host
+            url_host_key = 'url_host'
+            url_host_key = @add_field_prefix + url_host_key if @add_field_prefix
+            record[url_host_key] = url.host || ''
+          end
+
+          if @add_url_port
+            url_port_key = 'url_port'
+            url_port_key = @add_field_prefix + url_port_key if @add_field_prefix
+            record[url_port_key] = url.port || ''
+          end
+
+          if @add_url_path
+            url_path_key = 'url_path'
+            url_path_key = @add_field_prefix + url_path_key if @add_field_prefix
+            record[url_path_key] = url.path || ''
+          end
+
           unless url.query.nil?
             url.query.split('&').each do |pair|
               key, value = pair.split('=').map { |i| URI.unescape(i) }

data/test/plugin/test_out_extract_query_params.rb

@@ -3,7 +3,8 @@
 require 'test_helper'
 
 class ExtractQueryParamsOutputTest < Test::Unit::TestCase
-  URL = 'http://example.com/?foo=bar&baz=qux&%E3%83%A2%E3%83%AA%E3%82%B9=%E3%81%99%E3%81%9F%E3%81%98%E3%81%8A'
+  URL = 'http://example.com:80/?foo=bar&baz=qux&%E3%83%A2%E3%83%AA%E3%82%B9=%E3%81%99%E3%81%9F%E3%81%98%E3%81%8A'
+  QUERY_ONLY = '?foo=bar&baz=qux&%E3%83%A2%E3%83%AA%E3%82%B9=%E3%81%99%E3%81%9F%E3%81%98%E3%81%8A'
 
   def setup
     Fluent::Test.setup
@@ -325,4 +326,87 @@ class ExtractQueryParamsOutputTest < Test::Unit::TestCase
     assert_equal 2, r.size
     assert_equal 'b', r['a']
   end
+
+  def test_filter_record_with_url_scheme_host_port_path
+    d = create_driver(%[
+      key            url
+      add_tag_prefix extracted.
+
+      add_url_scheme true
+      add_url_host true
+      add_url_port true
+      add_url_path true
+    ])
+    tag    = 'test'
+    record = {
+      'url' => URL,
+    }
+    d.instance.filter_record('test', Time.now, record)
+
+    assert_equal URL,       record['url']
+    assert_equal 'bar',     record['foo']
+    assert_equal 'qux',     record['baz']
+    assert_equal 'すたじお', record['モリス']
+    assert_equal 'http',     record['url_scheme']
+    assert_equal 'example.com', record['url_host']
+    assert_equal 80,     record['url_port']
+    assert_equal '/',     record['url_path']
+  end
+
+  def test_filter_record_with_field_prefix_and_url_scheme_host_port_path
+    d = create_driver(%[
+      key            url
+      add_field_prefix query_
+      add_tag_prefix extracted.
+
+      add_url_scheme true
+      add_url_host true
+      add_url_port true
+      add_url_path true
+    ])
+
+    tag    = 'test'
+    record = {
+      'url' => URL,
+    }
+    d.instance.filter_record('test', Time.now, record)
+
+    assert_equal URL,       record['url']
+    assert_nil record['foo']
+    assert_nil record['baz']
+    assert_nil record['モリス']
+    assert_equal 'bar',     record['query_foo']
+    assert_equal 'qux',     record['query_baz']
+    assert_equal 'すたじお', record['query_モリス']
+    assert_equal 'http',     record['query_url_scheme']
+    assert_equal 'example.com', record['query_url_host']
+    assert_equal 80,     record['query_url_port']
+    assert_equal '/',     record['query_url_path']
+  end
+
+  def test_filter_record_from_query_only_url_with_url_scheme_host_port_path
+    d = create_driver(%[
+      key            url
+      add_tag_prefix extracted.
+
+      add_url_scheme true
+      add_url_host true
+      add_url_port true
+      add_url_path true
+    ])
+    tag    = 'test'
+    record = {
+      'url' => QUERY_ONLY,
+    }
+    d.instance.filter_record('test', Time.now, record)
+
+    assert_equal QUERY_ONLY, record['url']
+    assert_equal 'bar',     record['foo']
+    assert_equal 'qux',     record['baz']
+    assert_equal 'すたじお', record['モリス']
+    assert_equal '', record['url_scheme']
+    assert_equal '', record['url_host']
+    assert_equal '', record['url_port']
+    assert_equal '', record['url_path']
+  end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-extract_query_params
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - Kentaro Kuribayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-12-20 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: fluentd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Fluentd plugin to extract key/values from URL query parameters.
@@ -62,27 +57,26 @@ files:
 homepage: http://github.com/kentaro/fluent-plugin-extract_query_params
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fluentd plugin to extract key/values from URL query parameters
 test_files:
 - test/plugin/test_out_extract_query_params.rb