logstash-filter-handsetdetection 4.1.5 → 4.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0baa66b30c1e7421a3d08915223d0b8676a10926
-  data.tar.gz: 8aad617cce69ef9fb9c0b86b77adc300c6f1d87f
+  metadata.gz: 62dc4e2101623ea269d793a59feb13604c229b77
+  data.tar.gz: dabde0a0b23eeae1512b0644b9d67a07421e512d
 SHA512:
-  metadata.gz: e97953b414d1351a1bc159515dc12af37280e3d4dd2aa3241e5a3f18fffe7b23c944bb7665b5015923aece0c32354b0a3bf4c8b4ebe0860efbfa414bb329ec29
-  data.tar.gz: 6050e7a6c4a52d347eb9751248eb8ac76f17333a88d8dce92e6d612e4114a09de079ef3217c565c5530458997a6203ee7b8d75a195d73249bbd04e3f48947c2b
+  metadata.gz: 9b4102c5d7a7bfaefe613dbe7c71a5e7cc3de956496c45c4fbba82d00ae8297abfd0572aff01ea482f65e05c1e66e6a9c79ca833d6f4fc0ae0a6947dc70de00b
+  data.tar.gz: fd4b92c23757ccb2deea8be24809f6a43015253b65026da712530ba93fe3b94fdc8efb67ebdf0fb97b6fe2bfc537ececc4eca14dda2eae5fe04fb9bdc3b2c461

data/README.md

@@ -21,7 +21,7 @@ Extract the User-Agent header from an Apache log with Grok, and then enrich the
             username   => "xxxxxxxxxx" 
             password   => "xxxxxxxxxxxxxxxx"
             site_id    => 000000
-            online_api => false
+            detection_type   => ultimate
             match      => { 
                 "agent" => "user-agent" 
             }
@@ -36,10 +36,11 @@ Extract the User-Agent header from an Apache log with Grok, and then enrich the
 
 | Field | Description | Default |
 | --- | --- | --- |
-| `online_api` | Set to `true` in order to do **online** lookups against the Handset Detection API  | `false` |
+| `detection_type` | Set to `cloud` in order to do **online** lookups against the Handset Detection API. Set to `ultimate` to use Handset Detection **Ultimate Edition**. Set to `community` to use Handset Detection **Community Edition** | `cloud` |
 | `username` | Your Handset Detection API username | |
 | `password` | Your Handset Detection API password | |
 | `site_id` | The Handset Detection API site ID to use | |
+| `db_refresh_days` | How often to update the locally stored database, in days (for Handset Detection Ultimate Edition and Community Edition) | `10` |
 | `match` | An associative array mapping input field names to header names used for handset detection. For example: Extract the `user-agent` header from the `agent` input field. | `{ "agent" => "user-agent" }` |
 | `filter` | Optionally, define an array of the handset spec properties to be included in the output. By default, all properties are included in the output. | [] |
 | `use_proxy` | Set to `true` if accessing the web through a proxy | `false` |

data/lib/logstash/filters/handsetdetection.rb

@@ -34,11 +34,12 @@ class LogStash::Filters::HandsetDetection < LogStash::Filters::Base
 
   config_name 'handsetdetection'
 
-  config :online_api,   :validate => :boolean, :default => false
+  config :detection_type, :validate => :string, :default => 'cloud'
   config :username,     :validate => :string,  :default => ''
   config :password,     :validate => :string,  :default => ''
   config :site_id,      :validate => :number,  :default => 0
   config :apiserver,    :validate => :string,  :default => 'api.handsetdetection.com'
+  config :db_refresh_days, :validate => :number, :default => 10
   config :match,        :validate => :hash,    :default => { 'agent' => 'user-agent' }
   config :filter,       :validate => :array,   :default => [] 
   config :use_proxy,    :validate => :boolean, :default => false 
@@ -47,6 +48,8 @@ class LogStash::Filters::HandsetDetection < LogStash::Filters::Base
   config :proxy_user,   :validate => :string,  :default => '' 
   config :proxy_pass,   :validate => :string,  :default => '' 
   config :log_unknown,  :validate => :boolean, :default => true
+  config :cache,        :validate => :boolean, :default => true
+  config :cache_requests, :validate => :boolean, :default => false
   config :local_archive_source, :validate => :string, :default => nil
 
   public
@@ -55,12 +58,11 @@ class LogStash::Filters::HandsetDetection < LogStash::Filters::Base
     @hd_config['username'] = @username
     @hd_config['secret'] = @password
     @hd_config['site_id'] = @site_id
-    @hd_config['use_local'] = @online_api ? false : true 
     @hd_config['filesdir'] = Dir.tmpdir 
-    @hd_config['cache'] = {'none' => {}}
+    @hd_config['cache'] = @cache ? {'memory' => {'thread_safe' => true}} : {'none' => {}}
     @hd_config['debug'] = false
     @hd_config['api_server'] = @apiserver
-    @hd_config['cache_requests'] = false
+    @hd_config['cache_requests'] = @cache_requests
     @hd_config['geoip'] = true
     @hd_config['timeout'] = 30
     @hd_config['use_proxy'] = @use_proxy
@@ -73,12 +75,23 @@ class LogStash::Filters::HandsetDetection < LogStash::Filters::Base
     @hd_config['local_archive_source'] = @local_archive_source 
 
     @@pool = ThreadSafe::Array.new 
-    unless @online_api
+    if @detection_type == 'ultimate' or @detection_type == 'community'
+      @hd_config['use_local'] = true
       hd = HD4.new @hd_config
-      hd.set_timeout 500
-      hd.device_fetch_archive
-      hd.set_timeout 30
+      path = (@detection_type == 'ultimate') ? hd.device_get_zip_path :  hd.community_get_zip_path
+      if !File.exist?(path) or (Time.now - File.mtime(path)) / (24 * 3600) > @db_refresh_days
+        hd.set_timeout 500
+        result = (@detection_type == 'ultimate') ? hd.device_fetch_archive : hd.community_fetch_archive
+        raise LogStash::Error, "Error downloading the Handset Detection database. (Original cause: \"#{hd.get_reply['message']}\") Please try again." unless result
+        hd.set_timeout 30
+      else
+        # Do not download the ZIP file.
+      end
       @@pool << hd
+    elsif @detection_type == 'cloud'
+      @hd_config['use_local'] = false
+    else
+      raise LogStash::ConfigurationError, 'Detection_type should be one of: cloud, ultimate, community.'
     end
   end
 

data/logstash-filter-handsetdetection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-handsetdetection'
-  s.version = '4.1.5'
+  s.version = '4.1.6'
   s.licenses = ['MIT']
   s.summary = "Handset Detection filter plugin for Logstash"
   s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99" 
-  s.add_runtime_dependency "handset_detection", "~> 4.1", ">= 4.1.5"
+  s.add_runtime_dependency "handset_detection", "~> 4.1", ">= 4.1.6"
 
   #s.add_development_dependency 'logstash-devutils'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-handsetdetection
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.6
 platform: ruby
 authors:
 - Handset Detection
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -39,7 +39,7 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.5
+        version: 4.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.5
+        version: 4.1.6
 description: This gem is a Logstash plugin required to be installed on top of the
   Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
   gem is not a stand-alone program