fluent-plugin-decode_location 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7696e324681561250bf52e77f0d5bc73ba457d1
+  data.tar.gz: 0197fc55126f7c46f396b291774460f36d1398f9
+SHA512:
+  metadata.gz: 46318e05963391dcac2bfcbc7cd2002af6e9013ddf190856f3db9eaca8e088f1de6d8530f54279c555c29a328dd349e2335438930cd9dbca2d1d1c3b9ea5233b
+  data.tar.gz: 3db1613ab27392e4ab795d741b2b456524c69d98895d470446be9e5c28d14cb32443e6066a9d882370d3c4389b97447de50fc3175113aed3a27dd7a930d71283

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/04/02)
+Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-decode_location.gemspec
+gemspec
+
+gem 'base62'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 sredni
+
+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,86 @@
+## Fluent::Plugin::DecodeLoaction, a plugin for [Fluentd](http://fluentd.org)
+
+Fluentd plugin to decode location.
+
+Basic usage
+```
+<match foo.**>
+  type           decode_location
+  key            parameters.loc
+</match>
+
+input
+"test" {
+  "parameters":{
+    "loc":"2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k="
+  }
+}
+
+output
+    "location_decoded.test" {
+      "parameters":{
+	    "loc":"2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k="
+	  },
+      "lat": "50.6099014282",
+      "lng": "18.4776992798",
+      "continent": "EU",
+      "countryCode": "PL",
+      "province": "79",
+      "city": "Zawadzki"
+    }
+```
+
+If you want create key with parsed data.
+```
+<match foo.**>
+  type           decode_location
+  key            location.loc
+  sub_key        location
+</match>
+
+input
+"test" {
+  "parameters":{
+    "loc":"2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k="
+  }
+}
+
+output
+    "location_decoded.test" {
+      "parameters":{
+	    "loc":"2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k="
+	  },
+	  "location": {
+        "lat": "50.6099014282",
+        "lng": "18.4776992798",
+        "continent": "EU",
+        "countryCode": "PL",
+        "province": "79",
+        "city": "Zawadzki"
+      }
+    }
+```
+
+## Option Parameters
+
+### key :String
+key is used to point a key thad is cookie.
+
+### tag_prefix :String
+Added tag prefix.
+Default value is "parsed."
+
+### sub_key :String
+You want to put parsed data into separate key.
+Default value is false.
+
+## Change log
+See [CHANGELOG.md](https://github.com/sredni/fluent-plugin-decode_location/blob/master/CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it ( https://github.com/sredni/fluent-plugin-decode_location/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-decode_location.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'fluent/plugin/decode_location/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-decode_location"
+  spec.version       = Fluent::DecodeLocation::VERSION
+  spec.authors       = ["L. Srednicki"]
+  spec.email         = ["lukasz@sredni.pl"]
+  spec.summary       = %q{Fluentd plugin to decode location}
+  spec.description   = %q{Fluentd plugin to decode location}
+  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/decode_location/version.rb

@@ -0,0 +1,5 @@
+module Fluent
+  module DecodeLocation
+    VERSION = "0.0.1"
+  end
+end

data/lib/fluent/plugin/out_decode_location.rb

@@ -0,0 +1,90 @@
+module Fluent
+  class DecodeLocationOutput < Output
+  	Fluent::Plugin.register_output('decode_location', self)
+  	config_param :key,                    :string, :default => 'parameters.loc'
+    config_param :tag_prefix,             :string, :default => 'location_decoded.'
+    config_param :sub_key,                :string, :default => nil
+
+    SEPARATOR = 'a';
+    SEPARATOR_DOT = 'b';
+    SEPARATOR_DASH = 'c';
+
+    def initialize
+      super
+      require 'base62'
+      require 'base64'
+    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 = decode_location(record)
+
+        t = @tag_prefix + t unless @tag_prefix.nil?
+
+        Engine.emit(t, time, new_record)
+      }
+      chain.next
+    rescue => e
+      log.warn("out_decode_location: error_class:#{e.class} error_message:#{e.message} tag:#{tag} es:#{es} bactrace:#{e.backtrace.first}")
+    end
+
+    def decode_location(record)
+      source = record
+
+      key.split('.').each do |v|
+        if source[v.to_sym]   
+          source = source[v.to_sym]
+        else 
+          record['break'] = true
+          source = nil
+          break
+        end
+      end
+      
+      if source
+        hash = {}
+        city = ''
+
+        if source.include? ":|"
+          exploded = source.split(":|")
+          source = exploded[0]
+          city = exploded[1]
+        end
+
+        array = source.to_i.base62_encode.gsub(SEPARATOR_DASH, '-').gsub(SEPARATOR_DOT, '.').split(SEPARATOR)
+
+        hash['lat'] = array[0] ? array[0] : ''
+        hash['lng'] = array[1] ? array[1] : ''
+        hash['continent'] = array[2] ? array[2] : ''
+        hash['countryCode'] = array[3] ? array[3] : ''
+        hash['province'] = array[4] ? array[4] : ''
+        hash['city'] = city ? Base64.decode64(city) : ''
+
+        target = sub_key ? (record[sub_key] ||= {}) : record
+
+        target.merge!(hash)
+      end
+      return record
+    rescue => e
+      log.warn("out_decode_location: error_class:#{e.class} error_message:#{e.message} tag:#{tag} record:#{record} bactrace:#{e.backtrace.first}")
+    end
+  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_decode_location'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_decode_location.rb

@@ -0,0 +1,109 @@
+require 'helper'
+require 'rr'
+require 'timecop'
+require 'pry-byebug'
+require 'fluent/plugin/out_decode_location'
+
+class DecodeLoactionOutputTest < Test::Unit::TestCase
+
+  RECORD = {
+    "remote":"93.97.192.253",
+    "host":"-",
+    "user":"-",
+    "datetime":"02/Apr/2015:10:05:49 +0200",
+    "method":"GET",
+    "path":"/widget/core.js?key=D111-96FC-CF47-5B47-1WKpvg&type=2&domain=zmianynaziemi.pl&loc=2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k=&url=http%3A%2F%2Fzmianynaziemi.pl%2Fwiadomosc%2Fdoradca-putina-wysmial-publicznie-wiare-ze-brzoza-spowodowala-katastrofe-w-smolensku&is_mobile=false&lang=&cnt=2&ts=1427961948895&referer=http%3A%2F%2Fwww.google.co.uk%2Furl%3Fsa%3Dt%26rct%3Dj%26q%3D%26esrc%3Ds%26source%3Dweb%26cd%3D20%26ved%3D0CHMQFjAJOAo%26url%3Dhttp%253A%252F%252Fzmianynaziemi.pl%252Fwiadomosc%252Fdoradca-putina-wysmial-publicznie-wiare-ze-brzoza-spowodowala-katastrofe-w-smolensku%26ei%3DWvccVf3LAdPSaOKFgYAK%26usg%3DAFQjCNGh8yfYXkXFOEYt4UucoG6uO1H1VQ%26bvm%3Dbv.89744112%2Cd.d2s&status=0&live_preview_hash=&",
+    "code":"200",
+    "size":"2195",
+    "referer":"http://zmianynaziemi.pl/wiadomosc/doradca-putina-wysmial-publicznie-wiare-ze-brzoza-spowodowala-katastrofe-w-smolensku",
+    "agent":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:36.0) Gecko/20100101 Firefox/36.0",
+    "parameters":{
+      "key":"D111-96FC-CF47-5B47-1WKpvg",
+      "type":"2",
+      "domain":
+      "zmianynaziemi.pl",
+      "loc":"2713417160022875720572523180974772929416894547711076940525453875:|WmF3YWR6a2k=",
+      "url":"http://zmianynaziemi.pl/wiadomosc/doradca-putina-wysmial-publicznie-wiare-ze-brzoza-spowodowala-katastrofe-w-smolensku",
+      "is_mobile":"false",
+      "lang":"",
+      "cnt":"2",
+      "ts":"1427961948895",
+      "referer":"http://www.google.co.uk/url?sa=t&rct=j&q=&esrc=s&source=web&cd=20&ved=0CHMQFjAJOAo&url=http%3A%2F%2Fzmianynaziemi.pl%2Fwiadomosc%2Fdoradca-putina-wysmial-publicznie-wiare-ze-brzoza-spowodowala-katastrofe-w-smolensku&ei=WvccVf3LAdPSaOKFgYAK&usg=AFQjCNGh8yfYXkXFOEYt4UucoG6uO1H1VQ&bvm=bv.89744112,d.d2s",
+      "status":"0",
+      "live_preview_hash":""
+    },
+    "cookie":{
+      "__nc_ms":"c9f833a16d69432eb5f6f538883b026a"
+    }
+  }
+
+  def setup
+    Fluent::Test.setup
+    Timecop.freeze(@time)
+  end
+
+  teardown do
+    Timecop.return
+  end
+
+  def create_driver(conf, tag)
+    Fluent::Test::OutputTestDriver.new(
+      Fluent::DecodeLocationOutput, 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                test
+    ], "test")
+
+    assert_equal 'test',    d.instance.key
+    assert_equal 'location_decoded.', d.instance.tag_prefix
+  end
+
+  def test_decode
+    conf = %[
+      
+    ]
+
+    record = RECORD.dup
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'location_decoded.test', tag
+      assert_equal '50.6099014282',  record['lat']
+      assert_equal '18.4776992798',  record['lng']
+      assert_equal 'EU',             record['continent']
+      assert_equal 'PL',             record['countryCode']
+      assert_equal '79',             record['province']
+      assert_equal 'Zawadzki',       record['city']
+    end
+  end
+
+  def test_sub_key
+    conf = %[
+      sub_key  location
+    ]
+
+    record = RECORD.dup
+
+    emits = emit(conf, record)
+
+    emits.each_with_index do |(tag, time, record), i|
+      assert_equal 'location_decoded.test', tag
+      assert_equal '50.6099014282',  record['location']['lat']
+      assert_equal '18.4776992798',  record['location']['lng']
+      assert_equal 'EU',             record['location']['continent']
+      assert_equal 'PL',             record['location']['countryCode']
+      assert_equal '79',             record['location']['province']
+      assert_equal 'Zawadzki',       record['location']['city']
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-decode_location
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- L. Srednicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 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 decode location
+email:
+- lukasz@sredni.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-decode_location.gemspec
+- lib/fluent/plugin/decode_location/version.rb
+- lib/fluent/plugin/out_decode_location.rb
+- test/helper.rb
+- test/plugin/test_out_decode_location.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.4.6
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to decode location
+test_files:
+- test/helper.rb
+- test/plugin/test_out_decode_location.rb