fluent-plugin-referer-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56f8bf0b194d231cd18480ccb8eb565b3f96da29
+  data.tar.gz: 653fbea2b2c809b8c027070ef1f86be948b9f728
+SHA512:
+  metadata.gz: af9bd61a4764e99dbc3ee371650bed74c4d26cbea11affb67bd01d82731dcb1e642367dda4d9c6c872fcf0330b70bd50137d39af6f8533f9f79e3c9a5c047cdb
+  data.tar.gz: c8f624d327d091b6b55535c044e8de72dca2d349ca176dd92f925a348098ae676ef65254e173b7e74747b15d26572f8fa9c26db06b126866af2daae6aa55ec52

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+Copyright (c) HARUYAMA Seigo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,38 @@
+# fluent-plugin-referer-parser
+
+## WootheeOutput
+
+'fluent-plugin-referer-parser' is a Fluentd plugin to parse Referer strings, based on [tagomoris/fluent-plugin-woothee](https://github.com/tagomoris/fluent-plugin-woothee).
+'fluent-plugin-referer-parser' uses [snowplow/referer-parser](https://github.com/snowplow/referer-parser).
+
+
+## Configuration
+
+To add referer-parser result into matched messages:
+
+    <match input.**>
+      type referer_parser
+      key_name referer
+      remove_prefix input
+      add_prefix merged
+    </match>
+
+Output messages with tag 'merged.**' has 'referer\_known', 'referer\_referer' and 'referer\_search\_term' attributes. If you want to change attribute names, write configurations as below:
+
+    <match input.**>
+      type referer_parser
+      key_name ref
+      remove_prefix input
+      add_prefix merged
+      out_key_known        ref_known
+      out_key_referer      ref_referer
+      out_key_search_term  ref_search_term
+    </match>
+
+
+## Copyright
+
+* Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+* Copyright (c) HARUYAMA Seigo
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,11 @@
+#!/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
+
+task :default => :test

data/fluent-plugin-referer-parser.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = 'fluent-plugin-referer-parser'
+  gem.version       = '0.0.1'
+  gem.authors       = ['TAGOMORI Satoshi', 'HARUYAMA Seigo']
+  gem.email         = ['tagomoris@gmail.com', 'haruyama@unixuser.org']
+  gem.description   = %q{parsing by referer-parser. See: https://github.com/snowplow/referer-parser}
+  gem.summary       = %q{Fluentd plugin to parse UserAgent strings}
+  gem.homepage      = 'https://github.com/haruyama/fluent-plugin-referer-parser'
+  gem.license       = 'APLv2'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+  gem.add_runtime_dependency 'fluentd'
+  gem.add_runtime_dependency 'referer-parser', '>= 0.2.0'
+end

data/lib/fluent/plugin/.rubocop.yml

@@ -0,0 +1,9 @@
+LineLength:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+MethodLength:
+  CountComments: false # count full line comments?
+  Max: 20

data/lib/fluent/plugin/out_referer_parser.rb

@@ -0,0 +1,79 @@
+require 'ostruct'
+
+# referer parser output
+class Fluent::RefererParserOutput < Fluent::Output
+  Fluent::Plugin.register_output('referer_parser', self)
+
+  config_param :tag,           :string, default: nil
+  config_param :remove_prefix, :string, default: nil
+  config_param :add_prefix,    :string, default: nil
+
+  config_param :key_name, :string
+
+  config_param :merge_referer_info,  :bool,   default: false
+  config_param :out_key_known,       :string, default: 'referer_known'
+  config_param :out_key_referer,     :string, default: 'referer_referer'
+  config_param :out_key_search_term, :string, default: 'referer_search_term'
+
+  UNKOWWN_STRING = 'UNKNOWN'
+  PARSE_ERROR_STRUCT = OpenStruct.new(known: false)
+
+  def initialize
+    super
+    require 'referer-parser'
+  end
+
+  def configure(conf)
+    super
+
+    if !@tag && !@remove_prefix && !@add_prefix
+      fail Fluent::ConfigError, 'missing both of remove_prefix and add_prefix'
+    end
+    if @tag && (@remove_prefix || @add_prefix)
+      fail Fluent::ConfigError, 'both of tag and remove_prefix/add_prefix must not be specified'
+    end
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    @added_prefix_string = @add_prefix + '.' if @add_prefix
+  end
+
+  def tag_mangle(tag)
+    if @tag
+      @tag
+    else
+      if @remove_prefix &&
+          ( (tag.start_with?(@removed_prefix_string) && tag.length > @removed_length) || tag == @remove_prefix)
+        tag = tag[@removed_length..-1]
+      end
+      if @add_prefix
+        tag = if tag && tag.length > 0
+                @added_prefix_string + tag
+              else
+                @add_prefix
+              end
+      end
+      tag
+    end
+  end
+
+  def emit(tag, es, chain)
+    tag = tag_mangle(tag)
+    es.each do |time, record|
+      parsed =
+        begin
+          RefererParser::Referer.new(record[@key_name])
+        rescue
+          PARSE_ERROR_STRUCT
+        end
+      record.merge!(
+        @out_key_known       => parsed.known,
+        @out_key_referer     => parsed.referer     || UNKOWWN_STRING,
+        @out_key_search_term => parsed.search_term || UNKOWWN_STRING,
+      )
+      Fluent::Engine.emit(tag, time, record)
+    end
+    chain.next
+  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.key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval do |obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  end
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_referer_parser'
+
+class Test::Unit::TestCase
+end

data/test/plugin/.rubocop.yml

@@ -0,0 +1,25 @@
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: true
+  CountComments: false # count full line comments?
+  Max: 50
+
+FavorSprintf:
+  Enabled: false
+
+MultilineBlocks:
+  Enabled: false
+
+AvoidPerlBackrefs:
+  Enabled: false
+
+PercentLiterals:
+  Enabled: false
+
+BraceAfterPercent:
+  Enabled: false
+
+ClassLength:
+  Enabled: false

data/test/plugin/test_out_referer_parser.rb

@@ -0,0 +1,131 @@
+require 'helper'
+
+# RefererParserOutput test
+class Fluent::RefererParserOutputTest < Test::Unit::TestCase
+  # through & merge
+  CONFIG1 = %[
+type referer_parser
+key_name referer
+remove_prefix test
+add_prefix merged
+]
+
+  CONFIG2 = %[
+type referer_parser
+key_name ref
+remove_prefix test
+add_prefix merged
+out_key_known        ref_known
+out_key_referer      ref_referer
+out_key_search_term  ref_search_term
+]
+
+  def create_driver(conf = CONFIG1, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::RefererParserOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    # through & merge
+    d = create_driver CONFIG1
+    assert_equal 'referer', d.instance.key_name
+    assert_equal 'test',    d.instance.remove_prefix
+    assert_equal 'merged',  d.instance.add_prefix
+
+    assert_equal 'referer_known',       d.instance.out_key_known
+    assert_equal 'referer_referer',     d.instance.out_key_referer
+    assert_equal 'referer_search_term', d.instance.out_key_search_term
+
+    # filter & merge
+    d = create_driver CONFIG2
+    assert_equal 'ref',    d.instance.key_name
+    assert_equal 'test',   d.instance.remove_prefix
+    assert_equal 'merged', d.instance.add_prefix
+
+    assert_equal 'ref_known',       d.instance.out_key_known
+    assert_equal 'ref_referer',     d.instance.out_key_referer
+    assert_equal 'ref_search_term', d.instance.out_key_search_term
+  end
+
+  def test_tag_mangle
+    p = create_driver(CONFIG1).instance
+    assert_equal 'merged.data', p.tag_mangle('data')
+    assert_equal 'merged.data', p.tag_mangle('test.data')
+    assert_equal 'merged.test.data', p.tag_mangle('test.test.data')
+    assert_equal 'merged', p.tag_mangle('test')
+  end
+
+  def test_emit1
+    d = create_driver(CONFIG1, 'test.message')
+    time = Time.parse('2012-07-20 16:40:30').to_i
+    d.run do
+      d.emit({ 'value' => 0 }, time)
+      d.emit({ 'value' => 1, 'referer' => 'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari' }, time)
+      d.emit({ 'value' => 2, 'referer' => 'http://www.unixuser.org/' }, time)
+    end
+
+    emits = d.emits
+    assert_equal 3,                emits.size
+    assert_equal 'merged.message', emits[0][0]
+    assert_equal time,             emits[0][1]
+
+    m = emits[0][2]
+    assert_equal 0,         m['value']
+    assert_equal false,     m['referer_known']
+    assert_equal 'UNKNOWN', m['referer_referer']
+    assert_equal 'UNKNOWN', m['referer_search_term']
+    assert_equal 4,         m.keys.size
+
+    m = emits[1][2]
+    assert_equal 1,                                  m['value']
+    assert_equal true,                               m['referer_known']
+    assert_equal 'Google',                           m['referer_referer']
+    assert_equal 'gateway oracle cards denise linn', m['referer_search_term']
+
+    m = emits[2][2]
+    assert_equal 2,         m['value']
+    assert_equal false,     m['referer_known']
+    assert_equal 'UNKNOWN', m['referer_referer']
+    assert_equal 'UNKNOWN', m['referer_search_term']
+  end
+
+  def test_emit2
+    d = create_driver(CONFIG2, 'test.message')
+    time = Time.parse('2012-07-20 16:40:30').to_i
+    d.run do
+      d.emit({ 'value' => 0 }, time)
+      d.emit({ 'value' => 1, 'ref' => 'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari' }, time)
+      d.emit({ 'value' => 2, 'ref' => 'http://www.unixuser.org/' }, time)
+      d.emit({ 'value' => 3, 'ref' => 'https://www.google.com/search?q=%E3%81%BB%E3%81%92&ie=utf-8&oe=utf-8' }, time)
+    end
+
+    emits = d.emits
+    assert_equal 4,                emits.size
+    assert_equal 'merged.message', emits[0][0]
+    assert_equal time,             emits[0][1]
+
+    m = emits[0][2]
+    assert_equal 0,         m['value']
+    assert_equal false,     m['ref_known']
+    assert_equal 'UNKNOWN', m['ref_referer']
+    assert_equal 'UNKNOWN', m['ref_search_term']
+    assert_equal 4,         m.keys.size
+
+    m = emits[1][2]
+    assert_equal 1,                                  m['value']
+    assert_equal true,                               m['ref_known']
+    assert_equal 'Google',                           m['ref_referer']
+    assert_equal 'gateway oracle cards denise linn', m['ref_search_term']
+
+    m = emits[2][2]
+    assert_equal 2,         m['value']
+    assert_equal false,     m['ref_known']
+    assert_equal 'UNKNOWN', m['ref_referer']
+    assert_equal 'UNKNOWN', m['ref_search_term']
+
+    m = emits[3][2]
+    assert_equal 3,        m['value']
+    assert_equal true,     m['ref_known']
+    assert_equal 'Google', m['ref_referer']
+    assert_equal 'ほげ',   m['ref_search_term']
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-referer-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+- HARUYAMA Seigo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-30 00:00:00.000000000 Z
+dependencies:
+- !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: 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: referer-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 'parsing by referer-parser. See: https://github.com/snowplow/referer-parser'
+email:
+- tagomoris@gmail.com
+- haruyama@unixuser.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-referer-parser.gemspec
+- lib/fluent/plugin/.rubocop.yml
+- lib/fluent/plugin/out_referer_parser.rb
+- test/helper.rb
+- test/plugin/.rubocop.yml
+- test/plugin/test_out_referer_parser.rb
+homepage: https://github.com/haruyama/fluent-plugin-referer-parser
+licenses:
+- APLv2
+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.0
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to parse UserAgent strings
+test_files:
+- test/helper.rb
+- test/plugin/.rubocop.yml
+- test/plugin/test_out_referer_parser.rb