mail_auto_link_obfuscation 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 947109ff0c3285f1823f922d65078a11c56c16c2
-  data.tar.gz: 1f874335326fbb669fd4893c573b42a8c91c47c8
+  metadata.gz: 41d193dd872e293539f5bff5e25c87475e985438
+  data.tar.gz: 6b0725389bd2f78c87f43c18f951adb39ba16663
 SHA512:
-  metadata.gz: f8f9b45d76bd7cf36bb655d314bb95ab99eb83457320e8652e4fd5565bf3235aa69a85009e0a9e5d47d2000a622e94ac692e13ed4dca72ace2495766592e655e
-  data.tar.gz: c0992cd6d573e072ce27455a324810f7fd91090fe17fc39dbfd7b0b344cba7375c9ea5bcf9ffac28c656076e04889e94f77829c32a4674964bdc5082d51303f3
+  metadata.gz: b24594ba61270faebcf5d82b1d454c83b6081b9ecc044985c3a9fcd4b136d0a403a6da95527466d58cb291d0dc1c717d25a5c77578e94c315872c0dec4b5734c
+  data.tar.gz: 18f9362dc44978733eb4b22268477dfefd7b3d6ce73fc20b35e3158f5bc30b3dea7e89b8e1c2fa4b0c75aab4cf1d498d132a024861f94d7fb471333357de64b9

data/README.md

@@ -4,10 +4,9 @@ This gem hooks up your Rails application and prevents email clients from automat
 
 Automatic links can be an undesired feature, especially when user generated content is part of your emails, e.g. a user's name. If your user is called `your.enemy.com` and you insert his name directly in your mail, you will find that most email clients will make this name clickable. This effect can brake your email layout/design and even worse, it can be considered a security issue.
 
-To prevent email clients from auto-linking any link-like text we have to outsmart their link parsers. Inserting `span` tags in HTML parts and spaces in text parts has shown to work for most email clients. For HTML parts this obfuscation should be invisible. For text parts, it's unfortunately not.
+To prevent email clients from auto-linking any link-like text we have to outsmart their link parsers. Wrapping special link characters like `.`, `/` and `@` with invisible/non-printable [zero-width non-joiner](https://en.wikipedia.org/wiki/Zero-width_non-joiner) characters (Unicode U+200C) has shown to work for most email clients.
 
-HTML example: `Hello your.enemy.com!` becomes `Hello your<span>.</span>enemy<span>.</span>com`
-Plain text example: `Hello your.enemy.com!` becomes `Hello your .enemy .com`
+Example: `"Hello your.enemy.com!"` becomes `"Hello your\u200C.\u200Cenemy\u200C.\u200Ccom"`
 
 Note that this module will not touch any explicit links mentioned in anchors in the `href` attribute. Those links are considered desired and trusted. If you provide HTML and text parts with your email (which you should) this gem is also smart enough not to change links in the text part if those have been explicitly hyperlinked in the HTML part.
 
@@ -28,14 +27,6 @@ class MyMailer
 end
 ```
 
-## Configuration
-The obfuscation process can be configured at two places:
-
-1. `Rails.application.config.mail_auto_link_obfuscation`
-2. `MyMailer#mail_auto_link_obfuscation_options`
-
-Options are passed as a hash. At this moment you can only add a `style` attribute to the inserted `span` tags using `{ span_style: "font:inherit" }`
-
 ## Development
 
 Specs can be run with `rake spec`. Guard is also available.

data/lib/mail_auto_link_obfuscation/auto_link_obfuscator.rb

@@ -53,21 +53,13 @@ module MailAutoLinkObfuscation
 
     def transform_html(doc)
       doc.xpath('//body/descendant::text()').each do |node|
-        content = CGI.escapeHTML(node.content)
-        content = transform_auto_linked_pattern(content) do |match|
-          match.gsub(KEY_CHARS, span_template)
-        end
-
-        node.replace(content)
+        text = CGI.escapeHTML(node.content)
+        node.replace(transform_text(text))
       end
 
       doc.to_s
     end
 
-    def span_template
-      @span_template ||= '<span' + (@options[:span_style] ? " style=#{@options[:span_style]}" : '') + '>\0</span>'
-    end
-
     def transform_text_body
       @mail.body = transform_text(@mail.body.decoded)
     end
@@ -78,7 +70,7 @@ module MailAutoLinkObfuscation
 
     def transform_text(text)
       transform_auto_linked_pattern(text) do |match|
-        match.gsub(KEY_CHARS, ' \0')
+        match.gsub(KEY_CHARS, "\u200C\\0\u200C")
       end
     end
 

data/lib/mail_auto_link_obfuscation/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MailAutoLinkObfuscation
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/mail_auto_link_obfuscation.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Obfuscate link-like mail content on delivery to prevent auto hyperlinks in modern email clients.'
   spec.description   = 'Obfuscate link-like mail content on delivery to prevent auto hyperlinks in modern email clients.'
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/moneybird/mail_auto_link_obfuscation'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_auto_link_obfuscation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Oliver Jundt
@@ -199,7 +199,7 @@ files:
 - lib/mail_auto_link_obfuscation/railtie.rb
 - lib/mail_auto_link_obfuscation/version.rb
 - mail_auto_link_obfuscation.gemspec
-homepage: ''
+homepage: https://github.com/moneybird/mail_auto_link_obfuscation
 licenses:
 - MIT
 metadata: {}