logstash-filter-tld 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971e758e880a9fb5c521da0414c99cc6ee5c5dd354e7df13f7c1b3b0639b9cce
-  data.tar.gz: 35d150315aca2a6ca4c911c0345dbae171bad7a035262e132bbae85f7a19af3c
+  metadata.gz: ca0f49ad03d78e4c4cbb989d541064af569c23a30984a83703b2fc35d44a0e61
+  data.tar.gz: b0daa7412413c708655e99a71d453ba7bf0ec50a5d7314f85472e428089d2d96
 SHA512:
-  metadata.gz: daedf5f8a13ac78308effe6dc53b2a70d4da14550a0542929674711957a7e5b429dd9455d7a2e95c124d294c8833d814f01eda474ec14670f0030f364d298fe2
-  data.tar.gz: d09b7bba705e1b5cd714a5c1c4680b41d205dc1e26da8f41cf754b13dc47cefa7e7ad51123ec2ca3d66387057b42bc486ab4171a32d33facf6298e1e31df0b49
+  metadata.gz: 842e0e37fd289ee2a8463a1718d9eb06d49227da27e481c88ff2eb4a925eba8025f90351ecba23a8254eed8970a95c93e1cf9826aefde3af7a68b4da2ccb2124
+  data.tar.gz: abbf5f13d9770c0b09ab2d05b69765e0abf2886788e86722df2cdfccd743497f7b303f82b492af4579bf06fdd97d20c7202c1ddaeb38606e6ac31aa08fe3afec

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.3
+  - Bumped `public_suffix` gem version to `> 4` `< 6` and updated specs [#24](https://github.com/logstash-plugins/logstash-filter-tld/issues/24)
+
 ## 3.1.2
   - Fix race condition initializing PublicSuffix list [#8](https://github.com/logstash-plugins/logstash-filter-tld/issues/8)
 

data/logstash-filter-tld.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-tld'
-  s.version         = '3.1.2'
+  s.version         = '3.1.3'
   s.licenses = ['Apache-2.0']
   s.summary = "Replaces the contents of the default message field with whatever you specify in the configuration"
   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"
@@ -17,14 +17,14 @@ Gem::Specification.new do |s|
   # Special flag to let us know this is actually a logstash plugin
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
-  # public_suffix 3.x+ includes ruby syntax from 2.1
-  # This effectively requires Logstash >= 6.x
-  s.required_ruby_version = '>= 2.1.0'
+  # Logstash 7.17.x-8.x uses ruby 2.5-3.1 compatiblity
+  # public_suffix 4.x+ includes ruby syntax from 2.3
+  # public_suffix 5.x+ includes ruby syntax from 2.6
+  s.required_ruby_version = '>= 2.3'
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency 'public_suffix', '~>3'
+  s.add_runtime_dependency 'public_suffix', '> 4', '< 6'
 
   s.add_development_dependency 'logstash-devutils'
-  s.add_development_dependency 'insist'
 end

data/spec/filters/tld_spec.rb

@@ -1,57 +1,85 @@
-require "logstash/devutils/rspec/spec_helper"
-require "insist"
-require "logstash/filters/tld"
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/filters/tld'
 
 describe LogStash::Filters::Tld do
-  describe "Set to TLD" do
-    config <<-CONFIG
-      filter {
-        tld {
-        }
-      }
-    CONFIG
-
-#{
-#       "message" => "google.com",
-#      "@version" => "1",
-#    "@timestamp" => "2015-01-22T17:33:19.669Z",
-#          "host" => "homer",
-#      "sequence" => 0,
-#           "tld" => {
-#              "tld" => "com",
-#              "sld" => "google",
-#              "trd" => nil,
-#           "domain" => "google.com",
-#        "subdomain" => nil
-#    }
-
-
-    sample("message" => "google.com") do
-      insist { subject.get("tld")["tld"] } == "com"
-      insist { subject.get("tld")["top_level_domain"] } == "com"
-      insist { subject.get("tld")["sld"] } == "google"
-      insist { subject.get("tld")["trd"] } == nil
-      insist { subject.get("tld")["domain"] } == "google.com"
-      insist { subject.get("tld")["subdomain"] } == nil
-    end
+  let(:config) { {} }
+
+  subject(:plugin) { described_class.new(config) }
+
+  let(:event) { LogStash::Event.new('message' => 'www.google.com') }
+
+  before(:each) { plugin.register }
+
+  shared_examples 'sets tld fields' do |source, target|
+    let(:config) { {'source' => source, 'target' => target } }
 
-    sample("message" => "google.co.uk") do
-      insist { subject.get("tld")["tld"] } == "co.uk"
-      insist { subject.get("tld")["top_level_domain"] } == "co.uk"
-      insist { subject.get("tld")["sld"] } == "google"
-      insist { subject.get("tld")["trd"] } == nil
-      insist { subject.get("tld")["domain"] } == "google.co.uk"
-      insist { subject.get("tld")["subdomain"] } == nil
+    context 'domain without subdomains' do
+      it 'should set tld fields' do
+        expect_tld_event_fields(target, LogStash::Event.new(source => 'google.com'), {
+                                  'tld' => 'com',
+                                  'top_level_domain' => 'com',
+                                  'sld' => 'google',
+                                  'trd' => nil,
+                                  'domain' => 'google.com',
+                                  'subdomain' => nil
+                                })
+
+        expect_tld_event_fields(target, LogStash::Event.new(source => 'google.co.uk'), {
+                                  'tld' => 'co.uk',
+                                  'top_level_domain' => 'co.uk',
+                                  'sld' => 'google',
+                                  'trd' => nil,
+                                  'domain' => 'google.co.uk',
+                                  'subdomain' => nil
+                                })
+      end
     end
 
-    sample("message" => "www.google.com") do
-      insist { subject.get("tld")["tld"] } == "com"
-      insist { subject.get("tld")["top_level_domain"] } == "com"
-      insist { subject.get("tld")["sld"] } == "google"
-      insist { subject.get("tld")["trd"] } == "www"
-      insist { subject.get("tld")["domain"] } == "google.com"
-      insist { subject.get("tld")["subdomain"] } == "www.google.com"
+    context 'domain with subdomains' do
+      it 'should set tld fields' do
+        expect_tld_event_fields(target, LogStash::Event.new(source => 'www.google.com'), {
+                                  'tld' => 'com',
+                                  'top_level_domain' => 'com',
+                                  'sld' => 'google',
+                                  'trd' => 'www',
+                                  'domain' => 'google.com',
+                                  'subdomain' => 'www.google.com'
+                                })
+
+        expect_tld_event_fields(target, LogStash::Event.new(source => 'foo.bar.google.es'), {
+                                  'tld' => 'es',
+                                  'top_level_domain' => 'es',
+                                  'sld' => 'google',
+                                  'trd' => 'foo.bar',
+                                  'domain' => 'google.es',
+                                  'subdomain' => 'foo.bar.google.es'
+                                })
+      end
     end
+  end
+
+  context 'with default configuration' do
+    include_examples('sets tld fields', 'message', 'tld')
+  end
+
+  context 'with `source` option configured' do
+    include_examples('sets tld fields', 'another_source', 'tld')
+  end
+
+  context 'with `target` option configured' do
+    include_examples('sets tld fields', 'message', 'another_tld')
+  end
 
+  context 'with `source` and `target` options configured' do
+    include_examples('sets tld fields', 'another_source', 'another_tld')
+  end
+
+  private
+
+  def expect_tld_event_fields(target, event, hash)
+    subject.filter(event)
+    hash.each do |key, value|
+      expect(event.get(target)[key]).to eq(value)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-tld
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -33,38 +33,30 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   name: public_suffix
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '4'
+    - - "<"
       - !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'
+        version: '6'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: insist
+  name: logstash-devutils
   prerelease: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
@@ -105,14 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Replaces the contents of the default message field with whatever you specify