fluent-plugin-ua-parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bfaad885e169c908b5b18e1728c562d4a79e52e
-  data.tar.gz: 8fe29abe85417832006f06e754d0c32cc38f0816
+  metadata.gz: bd7243e11aeb13ee3450f17e66c69dee21b52c64
+  data.tar.gz: 39fee6ce9cadd51ef84cd397b8ef6f7312d15b13
 SHA512:
-  metadata.gz: 29830d7fcff2f8a16571197ec9a611800ccc628ad400b9bb17a75be5a9f0137c3ba099a56990e844a236ce806e61e6699f9bf6c9065c19b2f5cd8a2f8f564df9
-  data.tar.gz: c4b72e1c42ab599f1431054d5b0a5379aa823eb9ec60ea6b4ceffff24605b0900e3d947d355498512019ca43af6648259968ba5e7e0a7d933f212352933f97db
+  metadata.gz: 7cebd1b5f2161188e90e20f034bea87e23cabbea0fa164f59d49ba67202d03a209789880587efb301b69442d5ea197e3c7cfd3f7b7a19038ddd9622862102587
+  data.tar.gz: 9cbe5d70ab0205b7bca84bea16e2fe8b54f178b5fc4479808733964cb8672bec2ca7b3c90e32d7ed14c8cf90853fd5034436e4efac50a41ee3e007a0f355a9e7

data/README.md

@@ -1,4 +1,4 @@
-# Fluent-plugin-ua-parser
+# fluent-plugin-ua-parser
 
 [Fluentd](http://fluentd.org) filter plugin to parse user-agent.
 
@@ -26,23 +26,24 @@ $ sudo td-agent-gem install fluent-plugin-ua-parser
 
 Assuming following inputs are coming:
 
-```
+```json
 access.nginx: {
   "remote_addr":"10.20.30.40",
   "scheme":"http", "method":"GET", "host":"example.com",
   "path":"/", "query":"-", "req_bytes":200, "referer":"-",
-  "user_agent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36",
-  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001,
+  "user_agent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36"
 }
 ```
 
 then output bocomes as belows:
 
-```
+```json
 access.nginx: {
   "remote_addr":"10.20.30.40",
   "scheme":"http", "method":"GET", "host":"example.com",
   "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001,
   "user_agent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36",
   "ua":{
     "browser":{
@@ -55,8 +56,7 @@ access.nginx: {
       "version":""
     },
     "device":"Other"
-  },
-  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+  }
 }
 ```
 
@@ -67,30 +67,31 @@ access.nginx: {
   @type ua_parser
   key_name ua_string
   delete_key yes
-  out_prefix ua
+  out_key ua
   patterns_path /etc/td-agent/data/regexes.yaml
 </filter>
 ```
 
 Assuming following inputs are coming:
 
-```
+```json
 access.apache: {
   "remote_addr":"10.20.30.40",
   "scheme":"http", "method":"GET", "host":"example.com",
   "path":"/", "query":"-", "req_bytes":200, "referer":"-",
-  "ua_string":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/601.2.7 (KHTML, like Gecko) Version/9.0.1 Safari/601.2.7",
-  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001,
+  "ua_string":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/601.2.7 (KHTML, like Gecko) Version/9.0.1 Safari/601.2.7"
 }
 ```
 
 then output bocomes as belows:
 
-```
+```json
 access.apache: {
   "remote_addr":"10.20.30.40",
   "scheme":"http", "method":"GET", "host":"example.com",
   "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001,
   "ua":{
     "browser":{
       "family":"Safari",
@@ -103,8 +104,7 @@ access.apache: {
       "major_version":10
     },
     "device":"Other"
-  },
-  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+  }
 }
 ```
 
@@ -119,7 +119,7 @@ access.apache: {
 
     Delete input key. default false.
 
-- out_prefix *string*
+- out_key *string*
 
     Output prefix key name. default ua.
 
@@ -131,7 +131,7 @@ access.apache: {
 
 ## TODO
 
-* patches welcome!
+* flatten option (join hashed data by '_')
 
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,9 @@
 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-ua-parser.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-ua-parser"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Yuri Umezaki"]
   spec.email         = ["bungoume@gmail.com"]
   spec.homepage      = "https://github.com/bungoume/fluent-plugin-ua-parser"
@@ -20,5 +20,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "fluentd", ">= 0.12"
   spec.add_runtime_dependency "user_agent_parser", ">= 2.2.0"
   spec.add_runtime_dependency "lru_redux", ">= 1.0.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    spec.add_development_dependency "test-unit", '~> 3'
+  end
 end

data/lib/fluent/plugin/filter_ua_parser.rb

@@ -12,7 +12,7 @@ module Fluent
 
     config_param :key_name, :string, :default => 'user_agent'
     config_param :delete_key, :bool, :default => false
-    config_param :out_prefix, :string, :default => 'ua'
+    config_param :out_key, :string, :default => 'ua'
     # config_param :flatten, :bool :default => false
     config_param :patterns_path, :string, :default => nil
 
@@ -52,5 +52,5 @@ module Fluent
       data['device'] = ua.device.to_s
       data
     end
-  end
+  end if defined?(Filter) # Support only >= v0.12
 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/filter_ua_parser'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_filter_ua_parser.rb

@@ -0,0 +1,46 @@
+require 'helper'
+
+class UaParserFilterTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type ua_parser
+    key_name user_agent
+    delete_key no
+    out_key ua
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::FilterTestDriver.new(Fluent::UaParserFilter, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver(CONFIG)
+    assert_equal 'user_agent', d.instance.config['key_name']
+    assert_equal 'ua', d.instance.config['out_key']
+  end
+
+  def test_emit
+    d1 = create_driver(CONFIG)
+    ua = 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36'
+    emit_message = 'error has occoured.'
+    emit_extra = {'foo' => {'array' => [1,2,3]}, 'hash' => {'nest' => 'data'}}
+
+    d1.run do
+      d1.emit({'user_agent' => ua})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'test', emits[0][0] # tag
+    ua_object = emits[0][2]['ua']
+    assert_equal 'Chrome', ua_object['browser']['family']
+    assert_equal 46, ua_object['browser']['major_version']
+    assert_equal '46.0.2490', ua_object['browser']['version']
+    assert_equal 'Windows 7', ua_object['os']['family']
+    assert_equal '', ua_object['os']['version']
+    assert_equal 'Other', ua_object['device']
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ua-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuri Umezaki
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.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
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Fluentd filter plugin to parse user-agent
 email:
 - bungoume@gmail.com
@@ -80,6 +108,8 @@ files:
 - Rakefile
 - fluent-plugin-ua-parser.gemspec
 - lib/fluent/plugin/filter_ua_parser.rb
+- test/helper.rb
+- test/plugin/test_filter_ua_parser.rb
 homepage: https://github.com/bungoume/fluent-plugin-ua-parser
 licenses:
 - APLv2
@@ -104,4 +134,6 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Fluentd filter plugin to parse user-agent
-test_files: []
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_ua_parser.rb