logstash-filter-useragent 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf3b22747da6e059893a8dd658b76868f9a8d76e
-  data.tar.gz: e74c8a5fc87f6467e0ea0a94e63a5094f014092b
+  metadata.gz: b15dbfc5639b8beaf8ab72610de93b6f4639175f
+  data.tar.gz: c9966b10c9b5a543a48c35e8e6bb7d54d4f156db
 SHA512:
-  metadata.gz: d4fc3a5c8c862735a6c4b929049e87227ac59945eadae56ca8f3433e87881af1a43d4ffb1925b3a48f44457e816a0c8b2aebe9cb17eaffd652fc2c743ec7febe
-  data.tar.gz: d2d93f3d62514940e71d783236748dea5522a8890f08d5ccd706ea5e6c517ac5655abddee14c225929f113d5e696d6ac18c28f726a3f37ac76b7a868d1259d0f
+  metadata.gz: 83f573235d4e17df240c22281705b5755d429e6dc868d943418848f70d087b40723969800d6ac91f5c59b538931f8e930924171a572e9f7b54584580ec1338dd
+  data.tar.gz: 626a212f02ab445506b2caa8a6006bd0098ab493f347e85d3e23b17358ed5ee8bec43b76d77e95e441a1a570e1dbddfa69dcc4dbae3abf47ae5c9d5c2ccabe3d

data/CHANGELOG.md

@@ -1,9 +1,13 @@
+## 2.0.4
+ - Fefactored field references, fixed specs and some cleanups
+
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - Dependency on logstash-core update to 2.0
 
-* 2.0.1
+## 2.0.1
   - Add ability to replace source with target
-* 1.1.0
-  - Add LRU cache 
+
+## 1.1.0
+  - Add LRU cache

data/README.md

@@ -1,5 +1,8 @@
 # Logstash Plugin
 
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-useragent-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-useragent-unit/)
+
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

data/lib/logstash/filters/useragent.rb

@@ -54,18 +54,18 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
   # number of cache misses and waste memory.
   config :lru_cache_size, :validate => :number, :default => 1000
 
-  public
   def register
     require 'user_agent_parser'
+
     if @regexes.nil?
       begin
-        @parser = UserAgentParser::Parser.new()
+        @parser = UserAgentParser::Parser.new
       rescue Exception => e
         begin
           path = ::File.expand_path('../../../vendor/regexes.yaml', ::File.dirname(__FILE__))
           @parser = UserAgentParser::Parser.new(:patterns_path => path)
         rescue => ex
-          raise "Failed to cache, due to: #{ex}\n"
+          raise("Failed to cache, due to: #{ex}\n")
         end
       end
     else
@@ -74,14 +74,28 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
     end
 
     LOOKUP_CACHE.max_size = @lru_cache_size
-  end #def register
 
-  public
-  def filter(event)
-    
+    # make @target in the format [field name] if defined, i.e. surrounded by brakets
+    normalized_target = (@target && @target !~ /^\[[^\[\]]+\]$/) ? "[#{@target}]" : ""
+
+    # predefine prefixed field names
+    @prefixed_name = "#{normalized_target}[#{@prefix}name]"
+    @prefixed_os = "#{normalized_target}[#{@prefix}os]"
+    @prefixed_os_name = "#{normalized_target}[#{@prefix}os_name]"
+    @prefixed_os_major = "#{normalized_target}[#{@prefix}os_major]"
+    @prefixed_os_minor = "#{normalized_target}[#{@prefix}os_minor]"
+    @prefixed_device = "#{normalized_target}[#{@prefix}device]"
+    @prefixed_major = "#{normalized_target}[#{@prefix}major]"
+    @prefixed_minor = "#{normalized_target}[#{@prefix}minor]"
+    @prefixed_patch = "#{normalized_target}[#{@prefix}patch]"
+    @prefixed_build = "#{normalized_target}[#{@prefix}build]"
+  end
 
+  def filter(event)
     useragent = event[@source]
-    useragent = useragent.first if useragent.is_a? Array
+    useragent = useragent.first if useragent.is_a?(Array)
+
+    return if useragent.nil? || useragent.empty?
 
     begin
       ua_data = lookup_useragent(useragent)
@@ -92,19 +106,14 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
 
     return unless ua_data
 
-    if @target.nil?
-      target = event
-    elsif @target == @source
-      target = event[@source] = {}
-    else
-      target = event[@target] ||= {}
-    end
-
-    write_to_target(target, ua_data)
+    event.remove(@source) if @target == @source
+    set_fields(event, ua_data)
 
     filter_matched(event)
-  end # def filter
+  end
 
+  # should be private but need to stay public for specs
+  # TODO: (colin) the related specs should be refactored to not rely on private methods.
   def lookup_useragent(useragent)
     return unless useragent
 
@@ -117,10 +126,12 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
     ua_data
   end
 
-  def write_to_target(target, ua_data)
+  private
+
+  def set_fields(event, ua_data)
     # UserAgentParser outputs as US-ASCII.
 
-    target[@prefix + "name"] = ua_data.name.dup.force_encoding(Encoding::UTF_8)
+    event[@prefixed_name] = ua_data.name.dup.force_encoding(Encoding::UTF_8)
 
     #OSX, Andriod and maybe iOS parse correctly, ua-agent parsing for Windows does not provide this level of detail
 
@@ -128,25 +139,23 @@ class LogStash::Filters::UserAgent < LogStash::Filters::Base
     # and corrupt the cache. See uap source here for details https://github.com/ua-parser/uap-ruby/tree/master/lib/user_agent_parser
     if (os = ua_data.os)
       # The OS is a rich object
-      target[@prefix + "os"] = ua_data.os.to_s.dup.force_encoding(Encoding::UTF_8)
-      target[@prefix + "os_name"] = os.name.dup.force_encoding(Encoding::UTF_8) if os.name
+      event[@prefixed_os] = ua_data.os.to_s.dup.force_encoding(Encoding::UTF_8)
+      event[@prefixed_os_name] = os.name.dup.force_encoding(Encoding::UTF_8) if os.name
 
       # These are all strings
       if (os_version = os.version)
-        target[@prefix + "os_major"] = os_version.major.dup.force_encoding(Encoding::UTF_8) if os_version.major
-        target[@prefix + "os_minor"] = os_version.minor.dup.force_encoding(Encoding::UTF_8) if os_version.minor
+        event[@prefixed_os_major] = os_version.major.dup.force_encoding(Encoding::UTF_8) if os_version.major
+        event[@prefixed_os_minor] = os_version.minor.dup.force_encoding(Encoding::UTF_8) if os_version.minor
       end
     end
 
-    target[@prefix + "device"] = ua_data.device.to_s.dup.force_encoding(Encoding::UTF_8) if ua_data.device
+    event[@prefixed_device] = ua_data.device.to_s.dup.force_encoding(Encoding::UTF_8) if ua_data.device
 
     if (ua_version = ua_data.version)
-      target[@prefix + "major"] = ua_version.major.dup.force_encoding(Encoding::UTF_8) if ua_version.major
-      target[@prefix + "minor"] = ua_version.minor.dup.force_encoding(Encoding::UTF_8) if ua_version.minor
-      target[@prefix + "patch"] = ua_version.patch.dup.force_encoding(Encoding::UTF_8) if ua_version.patch
-      target[@prefix + "build"] = ua_version.patch_minor.dup.force_encoding(Encoding::UTF_8) if ua_version.patch_minor
+      event[@prefixed_major] = ua_version.major.dup.force_encoding(Encoding::UTF_8) if ua_version.major
+      event[@prefixed_minor] = ua_version.minor.dup.force_encoding(Encoding::UTF_8) if ua_version.minor
+      event[@prefixed_patch] = ua_version.patch.dup.force_encoding(Encoding::UTF_8) if ua_version.patch
+      event[@prefixed_build] = ua_version.patch_minor.dup.force_encoding(Encoding::UTF_8) if ua_version.patch_minor
     end
   end
-
-end # class LogStash::Filters::UserAgent
-
+end

data/logstash-filter-useragent.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-useragent'
-  s.version         = '2.0.3'
+  s.version         = '2.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parse user agent strings into structured data based on BrowserScope data"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/useragent_spec.rb

@@ -41,12 +41,31 @@ describe LogStash::Filters::UserAgent do
     end
   end
 
+  describe "Without user agent" do
+    config <<-CONFIG
+      filter {
+        useragent {
+          source => "message"
+          target => "ua"
+        }
+      }
+    CONFIG
+
+    sample "foo" => "bar" do
+      reject { subject }.include?("ua")
+    end
+
+    sample "" do
+      reject { subject }.include?("ua")
+    end
+  end
+
   describe "LRU object identity" do
+    let(:ua_string) { "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.85 Safari/537.36" }
     let(:uafilter) { LogStash::Filters::UserAgent.new("source" => "foo") }
-    let(:ua_data) {
-      uafilter.lookup_useragent("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.85 Safari/537.36")
-    }
-    subject(:target) { {} }
+    let(:ua_data) { uafilter.lookup_useragent(ua_string) }
+
+    subject(:target) { LogStash::Event.new("foo" => ua_string) }
 
     before do
       uafilter.register
@@ -54,7 +73,8 @@ describe LogStash::Filters::UserAgent do
       # Stub this out because this UA doesn't have this field
       allow(ua_data.version).to receive(:patch_minor).and_return("foo")
 
-      uafilter.write_to_target(target, ua_data)
+      # expect(event).receive(:lookup_useragent)
+      uafilter.filter(target)
     end
 
     {
@@ -99,7 +119,7 @@ describe LogStash::Filters::UserAgent do
     CONFIG
 
     sample "Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.63 Safari/537.31" do
-      insist { subject }.include?("message")
+      insist { subject.to_hash }.include?("message")
       insist { subject["message"]["name"] } == "Chrome"
       insist { subject["message"]["os"] } == "Linux"
       insist { subject["message"]["major"] } == "26"

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-useragent
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,48 +28,50 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: user_agent_parser
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
-  name: user_agent_parser
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: lru_redux
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
+        version: 1.1.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
-  name: lru_redux
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []