fluent-plugin-email-obfuscate 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8c95d15752cf1fbeeb6e933d0d42423b05ebaf1
-  data.tar.gz: 177b3fd14bf1c47b985aed8ac168e861006c0327
+  metadata.gz: b5589da8d1f315ff538febbe33596f14c9f716d1
+  data.tar.gz: e78e4f9b610888244cfd4a2e5716f42f3a433743
 SHA512:
-  metadata.gz: ba7799b236bddd340016ffe52d09f4f7bc489c08d643fc173c0d2a615d9d2a64ef9c71cab921af779467e3acfb9fb33615a301860f7c2a8bf1e92e23d81fc9f6
-  data.tar.gz: 951b4832e624681add3ac22b0e9ca1e57d02bd2392e3cf3c822d56feda391710b2a889f364992dafbb67030975c3b9ac4e3bd597fef9382259bfec8ad29854fe
+  metadata.gz: df54f8e6f6ac2edd5a5717f5be94a67a8ca9c240078b21ebe103fba1397afc0e2bac8de6297418f496001b3c9898df6e223a7f93a2e9510fa24590426905f029
+  data.tar.gz: f3f6bbe3a21a66a5360821b76e6f6420f3f6c20eea9586763060e6f4c7f2122d2b19acb0d8ad8331720fc3f4297d2b3a317c43ad1c0690b46c0538f48d71b756

data/.gitignore

@@ -1 +1,2 @@
 **/*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.3
+ - 2.4

data/README.md

@@ -4,6 +4,7 @@
 
 [![CodeFactor](https://www.codefactor.io/repository/github/JamesJJ/fluent-plugin-email-obfuscate/badge)](https://www.codefactor.io/repository/github/JamesJJ/fluent-plugin-email-obfuscate)
 [![Gem Version](https://badge.fury.io/rb/fluent-plugin-email-obfuscate.svg)](https://badge.fury.io/rb/fluent-plugin-email-obfuscate)
+[![Travis CI](https://travis-ci.com/JamesJJ/fluent-plugin-email-obfuscate.svg?branch=master)](https://travis-ci.com/JamesJJ/fluent-plugin-email-obfuscate)
 
 This filter attempts to parse each field in the record, and will obfuscate all or part of any email addresses it finds, by replacing with the same number of asterisks.
 

data/fluent-plugin-email-obfuscate.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-email-obfuscate"
-  spec.version = "0.0.3"
+  spec.version = "0.0.4"
   spec.authors = ["JamesJJ"]
   spec.email   = ["jj@fcg.fyi"]
 

data/lib/fluent/plugin/filter_email_obfuscate.rb

@@ -20,7 +20,7 @@ module Fluent
     class EmailObfuscateFilter < Fluent::Plugin::Filter
       Fluent::Plugin.register_filter("email_obfuscate", self)
 
-      config_param :mode, :string, default: 'partial_name',
+      config_param :mode, :enum, list: [:partial_name, :full, :domain_only],  default: :partial_name,
         desc: <<-DESC
 'full' will replace all characters.
 'partial_name' will replace all characters in the 'domain' half of the address, and a subset of the 'name'.
@@ -38,11 +38,6 @@ DESC
 
       def configure(conf)
         super
-
-        if conf.has_key?('mode')
-          raise ConfigError, "'mode' must be one of: domain_only, full, partial_name" unless
-            ['domain_only', 'full', 'partial_name'].include?(conf.dig('mode'))
-        end
       end
 
       def hide_partial(str)
@@ -60,9 +55,9 @@ DESC
       def obfuscate(str)
         strmatch = str.match(/^([^@]+)(@.+)$/) { |m|
            case @mode
-           when 'domain_only'
+           when :domain_only
              m[1] + m[2].tr("@.a-zA-Z0-9", "@.*")
-           when 'full'
+           when :full
              m[1].gsub(/./, '*') + m[2].tr("@.a-zA-Z0-9", "@.*")
            else
              hide_partial(m[1]) + m[2].tr("@.a-zA-Z0-9", "@.*")

data/test/plugin/test_filter_email_obfuscate.rb

@@ -6,13 +6,105 @@ class EmailObfuscateFilterTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  test "failure" do
-    flunk
+  CONF = %[
+  ]
+
+  def test_configure
+    d = create_driver
+    assert_equal :partial_name, d.instance.mode
+    assert_equal [], d.instance.suffix_whitelist
+  end
+
+  def sample_records
+    {
+      "f1": "myEmail@example.net",
+      "list1": [
+        "user1@example.com",
+        "user2@example.org"
+      ],
+      "a": {
+        "nested": {
+          "field": "name3@example.museum"
+        }
+      },
+      "email_string": "Jane Doe <jane@example.name>, John Smith <john@example.name>"
+    }
+  end
+
+  test "invalid mode" do
+    assert_raise(Fluent::ConfigError) do
+      create_driver(CONF + %[mode invalid])
+    end
+  end
+
+  test "filter" do
+    d = create_driver
+    d.run(default_tag: 'test') do
+      d.feed(sample_records)
+    end
+    expected = [{f1: "myEma**@*******.***",
+                 list1: ["user*@*******.***", "user*@*******.***"],
+                 a: {nested:
+                       {field: "name*@*******.******"}},
+                 email_string: "jane@*******.****, john@*******.****"}]
+    assert_equal expected, d.filtered.map{|e| e.last}
+  end
+
+  test "filter_full" do
+    d = create_driver(CONF + %[mode full])
+    d.run(default_tag: 'test') do
+      d.feed(sample_records)
+    end
+    expected = [{f1: "*******@*******.***",
+                 list1: ["*****@*******.***", "*****@*******.***"],
+                 a: {nested:
+                       {field: "*****@*******.******"}},
+                 email_string: "****@*******.****, ****@*******.****"}]
+    assert_equal expected, d.filtered.map{|e| e.last}
+  end
+
+  test "filter_domain_only" do
+    d = create_driver(CONF + %[mode domain_only])
+    d.run(default_tag: 'test') do
+      d.feed(sample_records)
+    end
+    expected = [{f1: "myEmail@*******.***",
+                 list1: ["user1@*******.***", "user2@*******.***"],
+                 a: {nested:
+                       {field: "name3@*******.******"}},
+                 email_string: "jane@*******.****, john@*******.****"}]
+    assert_equal expected, d.filtered.map{|e| e.last}
+  end
+
+  test "suffix whitelist" do
+    d = create_driver(CONF + %[suffix_whitelist [".example.com", "@example.com"]])
+    sample_records = {
+      "f1": "myEmail@example.net",
+      "list1": [
+        "user1@example.com",
+        "user2@subdomain.example.com"
+      ],
+      "a": {
+        "nested": {
+          "field": "name3@example.museum"
+        }
+      },
+      "email_string": "Jane Doe <jane@example.name>, John Smith <john@example.name>"
+    }
+    d.run(default_tag: 'test') do
+      d.feed(sample_records)
+    end
+    expected = [{f1: "myEma**@*******.***",
+                 list1: ["user1@example.com", "user2@subdomain.example.com"],
+                 a: {nested:
+                       {field: "name*@*******.******"}},
+                 email_string: "jane@*******.****, john@*******.****"}]
+    assert_equal expected, d.filtered.map{|e| e.last}
   end
 
   private
 
-  def create_driver(conf)
+  def create_driver(conf = CONF)
     Fluent::Test::Driver::Filter.new(Fluent::Plugin::EmailObfuscateFilter).configure(conf)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-email-obfuscate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - JamesJJ
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Fluentd filter plugin to obfuscate email addresses