fluent-plugin-parse_multiple_value_query 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4d4b4c98f4d249b8fdf295c8d897bc5339aab35
-  data.tar.gz: 84a8d2bf6280767fd28b586f34ed98ce09f5a9e6
+  metadata.gz: 7c3d4fd446ddd2cb20f3902970b319a9a674278c
+  data.tar.gz: 4f834383bceb6245c9af89bf40cd1448860a525c
 SHA512:
-  metadata.gz: d9222b4f174ea83ba4d2e30a8a2b2453738c9f91ef97d0bdf290b570d43a7a7cda8ccced233fffa62a5f6c734d7080c91f17b26d472958b5ce42c2df17e6413a
-  data.tar.gz: c81f4e976a053c34eccabfbea1f270651886e5757876a6546dc91290166525a07489c4cafea57f87bd83da67487d83d88d13d5bee5ab6e9dcfb61bfd00956d08
+  metadata.gz: 7c46a9ee2b53dca420db708b819b89e10d4cd858685d2a9fbf419fec75dfd6d358dea33a13d45fcc8b609ff1563f57c1c88a4be0de45b7c6795681dec875cb13
+  data.tar.gz: c6ac4776e8d0783da0e7d212c861c87610ac5b69f30af9f95ad906ff1afb02c8aacae0a10e3c67717951a10a15deb1ba3e6854c0227a3685ba5163c35a1ed436

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.4 (2015/03/31)
+without_host option
+
+## 0.0.3 (2015/03/31)
+sub_key option
+
 ## 0.0.2 (2015/02/07)
 Fix plugin type
 

data/README.md

@@ -123,6 +123,53 @@ output
       "key2": ["value4", "value5"]
     }
 ```
+
+If you want create sub key with parsed data.
+```
+<match foo.**>
+  type                parse_multiple_value_query
+  key                 url
+  sub_key             url_parsed
+</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[]=",
+      "url_parsed": {
+        "key1": ["value1", "value2", "value3"],
+        "key2": ["value4", "value5"],
+        "key3": [""]
+      }
+    }
+```
+
+If you want to parse url withiut host.
+```
+<match foo.**>
+  type parse_multiple_value_query
+  key  url
+  without_host true
+</match>
+
+input
+"test" {
+  "url": "/custom/path?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]="
+}
+
+output
+    "parsed.test" {
+      "url": "/custom/path?key1[]=value1&key1[]=value2&key1[]=value3&key2[]=value4&key2[]=value5&key3[]=",
+      "key1": ["value1", "value2", "value3"],
+      "key2": ["value4", "value5"],
+      "key3": [""]
+    }
+```
+
 ## Option Parameters
 
 ### key :String
@@ -142,6 +189,14 @@ You want to remove parsed value that has [] or [""] or [nil].
 You must be this option setting true.
 Default value is false.
 
+### sub_key :String
+You want to put parsed data into separate key.
+Default value is false.
+
+### without_host :Bool
+You want to parse url without host.
+Default value is false.
+
 ## Relative
  - [fluent-plugin-extract_query_params](https://github.com/kentaro/fluent-plugin-extract_query_params)
 

data/lib/fluent/plugin/out_parse_multiple_value_query.rb

@@ -6,6 +6,8 @@ module Fluent
     config_param :tag_prefix,         :string, :default => 'parsed.'
     config_param :only_query_string,  :bool, :default => false
     config_param :remove_empty_array, :bool, :default => false
+    config_param :sub_key,            :string, :default => nil
+    config_param :without_host,       :bool, :default => false
 
     def initialize
       super
@@ -49,7 +51,9 @@ module Fluent
           record = parse_query_string(record,record[key])
           return record
         else
-          query = URI.parse(record[key]).query
+          url = without_host ? "http://example.com#{record[key]}" : record[key]
+
+          query = URI.parse(url).query
           record = parse_query_string(record, query)
           return record
         end
@@ -58,19 +62,21 @@ module Fluent
 
     def parse_query_string(record, query_string)
       begin
+        target = sub_key ? (record[sub_key] ||= {}) : record
+
         parsed_query = Rack::Utils.parse_nested_query(query_string)
         parsed_query.each do |key, value|
           if value == ""
-            record[key] = ""
+            target[key] = ""
           else
             if value.class == Array && remove_empty_array
               if value.empty? || value == [""] || value == [nil]
-                record.delete(key)
+                target.delete(key)
               else
-                record[key] = value
+                target[key] = value
               end
             else
-              record[key] = value
+              target[key] = value
             end
           end
         end

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

@@ -1,5 +1,5 @@
 module Fluent
   module ParseMultipleValueQuery
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/test/plugin/test_out_parse_multiple_value_query.rb

@@ -9,6 +9,7 @@ class ParseMultipleValueQueryOutTest < Test::Unit::TestCase
   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[]'
+  WITHOUT_HOST = '/test/url?foo=bar&baz=qux&multiple[]=1&multiple[]=2&multiple[]=3&multiple2[]='
 
   def setup
     Fluent::Test.setup
@@ -149,4 +150,46 @@ class ParseMultipleValueQueryOutTest < Test::Unit::TestCase
     end
   end
 
+  def test_sub_key
+    conf = %[
+      key                 url
+      sub_key             url_parsed
+    ]
+
+    record = {
+      'url' => URL,
+    }
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal URL,       record['url']
+      assert_equal 'bar',     record['url_parsed']['foo']
+      assert_equal 'qux',     record['url_parsed']['baz']
+      assert_equal ["1", "2", "3"],     record['url_parsed']['multiple']
+    end
+  end
+
+  def test_without_host
+    conf = %[
+      key            url
+      without_host   true
+    ]
+
+    record = {
+      'url' => WITHOUT_HOST,
+    }
+
+    emits = emit(conf, record)
+    
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'parsed.test',              tag
+      assert_equal 'bar',     record['foo']
+      assert_equal 'qux',     record['baz']
+      assert_equal ["1", "2", "3"],     record['multiple']
+      assert_equal [""],      record['multiple2']
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-parse_multiple_value_query
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Hirokazu Hata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -188,11 +188,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 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
-has_rdoc: