sanitize_email 2.0.4 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3ded29cb641327aee8c303ec9eb805fac032b68d3d82b7791e542c03577f05d
-  data.tar.gz: 97ee5eb56dd5b88498c2e9e9054609960927453ce52b8740113380b2935208d8
+  metadata.gz: ab280a496e5f7c676c9f34a0d9c947e79015cc1001fb64dd9c9d7240d140eeea
+  data.tar.gz: 455e2718f6bc3cf995b444768c2fcb855ff15685077d234c4887c829cb3b36ca
 SHA512:
-  metadata.gz: 21b23105d986537545b5c99738843dd7f16ff84626b6bffdb8870d6f479020084944abd1a4907ccf0eb9db07e3d37ae8756284bb223178f55ee0585ef041609f
-  data.tar.gz: 94c2a2944691dcced263a0db6d1af7c17d2e36d64820c90512938b642f247c299831c0be35ff5c7827b1c87ecbfd212052dcc22f119c5cdc70f037baea247bf4
+  metadata.gz: 847a73eb85a827ff002f26e0108f3bd5ad4f9750d3de08e8461363e6effe31058fe92dee7ea7b1d3fa0260ad4f00b0f52d6df285ab0dc9fc029faac34ccca380
+  data.tar.gz: 1e53fb956e7bb1223192164e151509c45c6f2c7e653c5b9d194925164e1141ae969a8364209e3fd5a7db4c5d833146016a9fbdfe2c7b8f38a17be1b4c6d04004

data/CHANGELOG.md

@@ -10,8 +10,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
+## [2.0.6] - 2024-04-25 ([tag][2.0.6t])
+### Added
+* Appraisals & Combustion for comprehensive testing across versions of Rails (@pboling)
+* Rails 3.0 to Test Matrix (@pboling)
+* Rails 3.1 to Test Matrix (@pboling)
+* Rails 3.2 to Test Matrix (@pboling)
+* Rails 4.0 to Test Matrix (@pboling)
+* Rails 4.1 to Test Matrix (@pboling)
+* Rails 4.2 to Test Matrix (@pboling)
+* Rails 5.0 to Test Matrix (@pboling)
+* Rails 5.1 to Test Matrix (@pboling)
+* More Documentation (@pboling)
+### Fixed
+* Compatibility with Rails 3.0, 3.1, 3.2 (@pboling)
+* Compatibility with Rails 6.0, 6.1, 7.0, 7.1 (@pboling)
+
+## [2.0.5] - 2024-04-18 ([tag][2.0.5t])
+### Added
+* New RSpec matcher (@pboling)
+  * `have_bcc_username`
+* Feature #21 - environment configuration option can now be set to proc / lambda / #call (@pboling)
+* Documentation of all configuration options in README.md (@pboling)
+* Many more tests
+  * Confirmed compatibility with [`sendgrid-actionmailer`](https://github.com/eddiezane/sendgrid-actionmailer)
+  * Code coverage up to 90%
+### Changed
+* Averted deprecation warnings when using Rails 6 (@pboling)
+## Fixed
+* Bug #37 - Unable to send email when only CC or BCC present
+
 ## [2.0.4] - 2024-03-22 ([tag][2.0.4t])
 ### Added
+* [#74](https://github.com/pboling/sanitize_email/pull/74) Support sanitizing SendGrid personalization fields (@joeyparis)
 * mail gem dependency (@pboling)
 * version_gem dependency (@pboling)
 * new RSpec Matchers (@pboling)
@@ -260,7 +291,11 @@ Old version?
 * Fixed require paths
 * added about.yml and this CHANGELOG
 
-[Unreleased]: https://github.com/pboling/sanitize_email/compare/v2.0.4...HEAD
+[Unreleased]: https://github.com/pboling/sanitize_email/compare/v2.0.6...HEAD
+[2.0.6]: https://github.com/pboling/sanitize_email/compare/v2.0.5...v2.0.6
+[2.0.6t]: https://github.com/pboling/sanitize_email/tags/v2.0.6
+[2.0.5]: https://github.com/pboling/sanitize_email/compare/v2.0.4...v2.0.5
+[2.0.5t]: https://github.com/pboling/sanitize_email/tags/v2.0.5
 [2.0.4]: https://github.com/pboling/sanitize_email/compare/v2.0.3...v2.0.4
 [2.0.4t]: https://github.com/pboling/sanitize_email/tags/v2.0.4
 [2.0.3]: https://github.com/pboling/sanitize_email/compare/v2.0.2...v2.0.3

data/CONTRIBUTING.md

@@ -7,6 +7,14 @@ the [code of conduct][🤝conduct].
 To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request
 and post a message to the [gitter chat][🏘chat].
 
+## Appraisal & Combustion
+
+### Generate a new set of Appraisal gemfiles:
+
+```sh
+BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal generate
+```
+
 ## Release
 
 To release a new version:

data/README.md

@@ -61,6 +61,17 @@ testing your email in the aforementioned `mailcatcher` may not be enough.
 If you want to test all the way through Paubox's system, but have the email go to a safe testing account address,
 then this is the gem for you.
 
+## Compatibility
+
+⚙️ Compatible with all versions of Ruby >= 2.3, plus JRuby and Truffleruby.
+⚙️ Compatible with all Ruby web Frameworks (Hanami, Roda, Sinatra, Rails).
+⚙️ Compatible with all versions of Rails from 3.0 - 7.1+.
+⚙️ Compatible with scripted usage of Mail gem outside a web framework.
+⚙️ Compatible with [`sendgrid-actionmailer`](https://github.com/eddiezane/sendgrid-actionmailer)'s support for personalizations, and will override email addresses there according to the configuration.
+⚙️ If this gem is not compatible with your use case, and you'd like it to be, I'd like to hear about it!
+
+It was a slog getting (very nearly) the entire compatibility matrix working with Github Actions, [`appraisal`](https://github.com/thoughtbot/appraisal), and [`combustion`](https://github.com/pat/combustion), and I'm very interested in hearing about ways to improve it!
+
 ## 🛞 DVCS
 
 This project does not trust any one version control system,
@@ -116,7 +127,7 @@ appended indicators:
 | 4️⃣ | testing                        | [![Supported][🏘sup-wf-img]][🏘sup-wf] [![Heads][🚎heads-wf-img]][🚎heads-wf]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | 5️⃣ | coverage & security            | [![CodeClimate][🔑cc-covi]][🔑cc-cov] [![CodeCov][🖇codecov-img♻️]][🖇codecov] [![Coveralls][🏘coveralls-img]][🏘coveralls] [![Security Policy][🚎sec-pol-img]][🚎sec-pol] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Code Coverage][🧮cov-wf-img]][🧮cov-wf]                                                                                                                                                                                                                                                                                                                  |
 | 6️⃣ | resources                      | [![Get help on Codementor][🖇codementor-img]][🖇codementor] [![Chat][🏘chat-img]][🏘chat] [![Blog][🚎blog-img]][🚎blog] [![Wiki][🖐wiki-img]][🖐wiki]                                                                                                                                                                                                                                                                                                                                                                                                                      |
-| 7️⃣ | ... 💖                         | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Follow Me on FLOSS.Social][🐘floss-mast-img]][🐘floss-mast] [![Follow Me on Mastodon.Social][🐘mast-img]][🐘mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
+| 7️⃣ | `...` 💖                       | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Follow Me on FLOSS.Social][🐘floss-mast-img]][🐘floss-mast] [![Follow Me on Mastodon.Social][🐘mast-img]][🐘mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
 
 <!--
 The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
@@ -219,7 +230,7 @@ The link tokens in the following sections should be kept ordered by the row and
 It's particularly helpful when you want to prevent the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.
 
 * compatible without Rails!  Can work with just the `mail` gem.
-* compatible with Rails >= 4.2.  See gem versions 1.x for older versions of Rails.
+* compatible with Rails >= 3.0.  See gem versions 1.x for older versions of Rails.
 * compatible with Ruby >= 2.3.  See gem versions 1.x for older versions of Ruby.
 * compatible with any Ruby app with a mail handler that uses the `register_interceptor` API (a la ActionMailer and `mail` gems)
 * configure it and forget it
@@ -354,6 +365,8 @@ end
 
 Keep in mind, this is ruby (and possibly rails), so you can add conditionals or utilize different environment.rb files to customize these settings on a per-environment basis.
 
+## Override the override
+
 But wait there's more:
 
 Let's say you have a method in your model that you can call to test the signup email. You want to be able to test sending it to any user at any time... but you don't want the user to ACTUALLY get the email, even in production. A dilemma, yes?  Not anymore!
@@ -364,7 +377,9 @@ To override the environment based switch use `force_sanitize`, which is normally
   SanitizeEmail.force_sanitize = true
 ```
 
-There are also two methods that take a block and turn SanitizeEmail on or off:
+When testing your email in a console, you can manipulate how email will be handled in this way.
+
+There are also two methods that take a block and turn SanitizeEmail on or off (see section on Thread Safety below):
 
 Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.
 
@@ -394,6 +409,36 @@ You have access to all the same configuration options in the parameter hash as y
   end
 ```
 
+## Configuration Options
+
+As used in the "Description" column below, `engaged` means: `SanitizeEmail.activate?(message) # => true`.
+This happens in a few different ways, and two of them are in the config below (`engage` and `activation_proc`).
+
+| Option                                      | Type (Yard format)                   | Description                                                                                                                          |
+|---------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+| sanitized_to                                | [String, Array[String]]              | (when engaged) Override CC field with these addresses                                                                                |
+| sanitized_cc                                | [String, Array[String]]              | (when engaged) Override CC field with these addresses                                                                                |
+| sanitized_bcc                               | [String, Array[String]]              | (when engaged) Override BCC field with these addresses                                                                               |
+| good_list                                   | [Array[String]]                      | (when engaged) Email addresses to allow to pass-through without overriding                                                           |
+| bad_list                                    | [Array[String]]                      | (when engaged) Email addresses to be removed from message's TO, CC, & BCC                                                            |
+| environment                                 | [String, #to_s, Proc, Lambda, #call] | (when engaged) The environment value to use wherever it is added to message (e.g. in the subject line)                               |
+| use_actual_email_as_sanitized_user_name     | [Boolean]                            | (when engaged) Use "real" email address as username for sanitized email address (e.g. "real at example.com <sanitized@example.com>") |
+| use_actual_email_prepended_to_subject       | [Boolean]                            | (when engaged) Use "real" email address prepended to subject (e.g. "real at example.com Original Subject")                           |
+| use_actual_environment_prepended_to_subject | [Boolean]                            | (when engaged) Use `environment` prepended to subject (e.g. "{{ STAGING }} Original Subject")                                        |
+| engage                                      | [Boolean, nil]                       | Boolean will turn engage or disengage this gem, while `nil` ignores this setting and instead checks `activation_proc`                |
+| activation_proc                             | [Proc, Lambda, #call]                | When checked, due to `engage: nil`, the result will either engage or disengage this gem                                              |
+
+## Thread Safety
+
+So long as you don't change the config after initializing it at runtime, you'll be fine.
+Like many Ruby tools' config objects, it is a single config object, shared by all threads.
+The helpers like `sanitary`, `unsanitary`, `janitor`, and `force_sanitize`
+are intended to be used in single threaded environments,
+like a test suite, or a console session.
+
+I doubt I'll ever have a need for runtime reconfiguration of the config,
+so I doubt I'll ever have a reason to make it "more" thread safe than it is now, but PRs are welcome!
+
 ## Use sanitize_email in your test suite!
 
 ### rspec
@@ -631,15 +676,18 @@ Learn more about, or become one of, our 🎖 contributors on:
 ## Running Specs
 
 The basic compatibility matrix:
-```
+```sh
 appraisal install
 appraisal rake test
 ```
 
 Sometimes also:
+```sh
+BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal update
 ```
-appraisal update
-```
+
+Except, is unlikely to be possible to install all of the supported Rubies & Railsies in a single container...
+See the various github action workflows for more inspiration on running certain oldies.
 
 ### Code Coverage
 

data/lib/sanitize_email/bleach.rb

@@ -10,84 +10,86 @@ module SanitizeEmail
     extend SanitizeEmail::Deprecation
     attr_accessor :overridden_addresses # TODO: Just a stub, not implemented
 
-    def initialize(*args)
-      deprecation_message unless args.empty?
-    end
+    class << self
+      # If all recipient addresses are allow-listed the field is left alone.
+      def delivering_email(message)
+        return unless sanitize_engaged?(message)
 
-    # If all recipient addresses are allow-listed the field is left alone.
-    def self.delivering_email(message)
-      return unless sanitize_engaged?(message)
+        SanitizeEmail::MailHeaderTools
+          .add_original_addresses_as_headers(message)
+        SanitizeEmail::MailHeaderTools
+          .prepend_custom_subject(message)
 
-      SanitizeEmail::MailHeaderTools
-        .add_original_addresses_as_headers(message)
-      SanitizeEmail::MailHeaderTools
-        .prepend_custom_subject(message)
+        overridden = SanitizeEmail::OverriddenAddresses.new(message)
 
-      overridden = SanitizeEmail::OverriddenAddresses.new(message)
+        message.to = overridden.overridden_to
+        message.cc = overridden.overridden_cc
+        message.bcc = overridden.overridden_bcc
 
-      message.to = overridden.overridden_to
-      message.cc = overridden.overridden_cc
-      message.bcc = overridden.overridden_bcc
+        return if message["personalizations"].nil?
 
-      return if message["personalizations"].nil?
+        message["personalizations"].value = overridden.overridden_personalizations
+      end
 
-      message["personalizations"].value = overridden.overridden_personalizations
-    end
+      # Will be called by the Hook to determine if an override should occur
+      # There are three ways SanitizeEmail can be turned on;
+      #   in order of precedence they are:
+      #
+      # 1. SanitizeEmail.force_sanitize = true # by default it is nil
+      #   Only useful for local context.
+      #   Inside a method where you will be sending an email, set
+      #
+      #     SanitizeEmail.force_sanitize = true
+      #
+      #   just prior to delivering it.  Also useful in the console.
+      #
+      # 2. If SanitizeEmail seems to not be sanitizing,
+      #     you have probably not registered the interceptor.
+      #   SanitizeEmail tries to do this for you.
+      #   *Note*: If you are working in an environment that has
+      #           a Mail or Mailer class that uses the register_interceptor API,
+      #           the interceptor will already have been registered.
+      #   The gem will probably have already done this for you,
+      #   but some really old versions of Rails may need you to do this manually:
+      #
+      #     Mail.register_interceptor(SanitizeEmail::Bleach)
+      #
+      #   Once registered, SanitizeEmail needs to be engaged:
+      #
+      #     # in config/initializers/sanitize_email.rb
+      #     SanitizeEmail::Config.configure {|config| config[:engage] = true }
+      #
+      # 3. SanitizeEmail::Config.configure do |config|
+      #      config[:activation_proc] = Proc.new { true }
+      #    end
+      #
+      #   If you don't need to compute anything,
+      #     then don't use the Proc, go with the previous option.
+      #
+      # Note: Number 1 is the method used by the SanitizeEmail.sanitary block
+      # Note: Number 2 You may need to setup your own register_interceptor
+      #
+      # If installed but not configured, sanitize_email DOES NOTHING.
+      # Until configured the defaults leave it turned off.
+      def sanitize_engaged?(message)
+        # Don't sanitize the message if it will not be delivered
+        return false unless message.perform_deliveries
 
-    # Will be called by the Hook to determine if an override should occur
-    # There are three ways SanitizeEmail can be turned on;
-    #   in order of precedence they are:
-    #
-    # 1. SanitizeEmail.force_sanitize = true # by default it is nil
-    #   Only useful for local context.
-    #   Inside a method where you will be sending an email, set
-    #
-    #     SanitizeEmail.force_sanitize = true
-    #
-    #   just prior to delivering it.  Also useful in the console.
-    #
-    # 2. If SanitizeEmail seems to not be sanitizing,
-    #     you have probably not registered the interceptor.
-    #   SanitizeEmail tries to do this for you.
-    #   *Note*: If you are working in an environment that has
-    #           a Mail or Mailer class that uses the register_interceptor API,
-    #           the interceptor will already have been registered.
-    #   The gem will probably have already done this for you,
-    #   but some really old versions of Rails may need you to do this manually:
-    #
-    #     Mail.register_interceptor(SanitizeEmail::Bleach)
-    #
-    #   Once registered, SanitizeEmail needs to be engaged:
-    #
-    #     # in config/initializers/sanitize_email.rb
-    #     SanitizeEmail::Config.configure {|config| config[:engage] = true }
-    #
-    # 3. SanitizeEmail::Config.configure do |config|
-    #      config[:activation_proc] = Proc.new { true }
-    #    end
-    #
-    #   If you don't need to compute anything,
-    #     then don't use the Proc, go with the previous option.
-    #
-    # Note: Number 1 is the method used by the SanitizeEmail.sanitary block
-    # Note: Number 2 You may need to setup your own register_interceptor
-    #
-    # If installed but not configured, sanitize_email DOES NOTHING.
-    # Until configured the defaults leave it turned off.
-    def self.sanitize_engaged?(message)
-      # Don't sanitize the message if it will not be delivered
-      return false unless message.perform_deliveries
+        # Has it been forced via the force_sanitize mattr?
+        forced = SanitizeEmail.force_sanitize
+        return forced unless forced.nil?
 
-      # Has it been forced via the force_sanitize mattr?
-      forced = SanitizeEmail.force_sanitize
-      return forced unless forced.nil?
+        # Is this particular instance of Bleach engaged
+        engaged = SanitizeEmail::Config.config[:engage]
+        return engaged unless engaged.nil?
 
-      # Is this particular instance of Bleach engaged
-      engaged = SanitizeEmail::Config.config[:engage]
-      return engaged unless engaged.nil?
+        # Should we sanitize due to the activation_proc?
+        SanitizeEmail.activate?(message)
+      end
+    end
 
-      # Should we sanitize due to the activation_proc?
-      SanitizeEmail.activate?(message)
+    def initialize(*args)
+      deprecation_message unless args.empty?
     end
 
     private

data/lib/sanitize_email/config.rb

@@ -42,11 +42,11 @@ module SanitizeEmail
 
       # Use the "real" email address as the username
       #   for the sanitized email address
-      # e.g. "real@example.com <sanitized@example.com>"
+      # e.g. "real at example.com <sanitized@example.com>"
       use_actual_email_as_sanitized_user_name: false,
 
       # Prepend the "real" email address onto the Subject line of the message
-      # e.g. "real@example.com rest of subject"
+      # e.g. "real at example.com rest of subject"
       use_actual_email_prepended_to_subject: false,
 
       # Prepend the Rails environment onto the Subject line of the message

data/lib/sanitize_email/{engine.rb → engine_v5.rb}

@@ -2,10 +2,12 @@
 
 # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+require "rails/engine"
 
 module SanitizeEmail
-  # For Rails >= 3.1
-  class Engine < ::Rails::Engine
+  # For Rails >= 3.1, < 6.0
+  # TODO: Remove when support for Rails < 6 is dropped
+  class EngineV5 < ::Rails::Engine
     config.to_prepare do
       ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach)
     end

data/lib/sanitize_email/engine_v6.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
+# Released under the MIT license
+require "rails/engine"
+
+module SanitizeEmail
+  # For Rails >= 6.0
+  class EngineV6 < ::Rails::Engine
+    config.to_prepare do
+      # For the reasoning behind the difference between v5 and v6 engines,
+      #   - see: https://github.com/rails/rails/issues/36546#issuecomment-850888284
+      Rails.application.config.action_mailer.register_interceptor(SanitizeEmail::Bleach)
+    end
+  end
+end

data/lib/sanitize_email/mail_ext.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 require "mail"
 
 # Cribbed from email_spec gem

data/lib/sanitize_email/mail_header_tools.rb

@@ -26,7 +26,11 @@ module SanitizeEmail
     end
 
     def self.prepend_environment_to_subject
-      SanitizeEmail::Config.config[:environment]
+      if SanitizeEmail::Config.config[:environment].respond_to?(:call)
+        SanitizeEmail::Config.config[:environment].call.to_s
+      else
+        SanitizeEmail::Config.config[:environment].to_s
+      end
     end
 
     def self.prepend_email_to_subject(actual_addresses)

data/lib/sanitize_email/overridden_addresses.rb

@@ -9,8 +9,11 @@ require "mail"
 module SanitizeEmail
   # Tools for overriding addresses
   class OverriddenAddresses
-    # Raised when after applying all sanitization rules there are no addresses to send the email to.
-    class MissingTo < StandardError; end
+    # Raised when there are no recipients after sanitization
+    class MissingRecipients < StandardError; end
+
+    # MissingTo is Deprecated
+    class MissingTo < MissingRecipients; end
 
     # Raised if there is a recipient type that sanitize_email doesn't recognize.
     # If you get this error please report it.
@@ -45,16 +48,23 @@ module SanitizeEmail
       tempmail.cc = cc_override(message.cc)
       tempmail.bcc = bcc_override(message.bcc)
 
+      # remove addresses from :cc / :bcc that are also in :to
       remove_duplicates
 
       @overridden_to = tempmail[:to].decoded
       @overridden_cc = tempmail[:cc].decoded
       @overridden_bcc = tempmail[:bcc].decoded
 
-      # remove addresses from :cc that are in :to
-      return if message["personalizations"].nil?
-
-      @overridden_personalizations = personalizations_override(message["personalizations"])
+      actual_personalizations = message["personalizations"]
+      if actual_personalizations.nil?
+        raise MissingRecipients, "No recipients left post-sanitization" if (tempmail.to + tempmail.cc + tempmail.bcc).empty?
+      elsif actual_personalizations.respond_to?(:unparsed_value)
+        @overridden_personalizations = personalizations_override(actual_personalizations)
+      else
+        # TODO: Remove check when dropping Rails 3.x
+        #       undefined method `unparsed_value' for #<Mail::OptionalField>
+        raise MissingRecipients, "Mail version is too old to use personalizations"
+      end
     end
 
     # Allow good listed email addresses, and then remove the bad listed addresses
@@ -66,8 +76,6 @@ module SanitizeEmail
 
     def to_override(actual_addresses)
       to = override_email(:to, actual_addresses)
-      raise MissingTo, "after overriding :to (#{actual_addresses}) there are no addresses to send in To: header." if to.empty?
-
       to.join(",")
     end
 
@@ -79,6 +87,7 @@ module SanitizeEmail
       override_email(:bcc, actual_addresses).join(",")
     end
 
+    # Intended to result in compatibility with https://github.com/eddiezane/sendgrid-actionmailer
     def personalizations_override(actual_personalizations)
       actual_personalizations.unparsed_value.map do |actual_personalization|
         actual_personalization.merge(

data/lib/sanitize_email/railtie.rb

@@ -2,6 +2,7 @@
 
 # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+require "rails/railtie"
 
 module SanitizeEmail
   # For Rails 3.0, which didn't yet support Engines

data/lib/sanitize_email/rspec_matchers.rb

@@ -89,6 +89,17 @@ module SanitizeEmail
       end
     end
 
+    RSpec::Matchers.define("have_bcc_username") do |matcher|
+      def get_bcc_usernames(email_message)
+        to_addrs = email_message[:bcc].addrs
+        to_addrs.map(&:name)
+      end
+      match do |actual|
+        @actual = get_bcc_usernames(actual)
+        expect(@actual).to(include(match(matcher)))
+      end
+    end
+
     # Cribbed from email_spec gem
     RSpec::Matchers.define("have_body_text") do |matcher|
       def get_fuzzy_body(email_message)

data/lib/sanitize_email/version.rb

@@ -5,6 +5,6 @@
 
 module SanitizeEmail
   module Version
-    VERSION = "2.0.4"
+    VERSION = "2.0.6"
   end
 end

data/lib/sanitize_email.rb

@@ -18,10 +18,19 @@ module SanitizeEmail
   # Error is raised when a block parameter is required and not provided to a method
   class MissingBlockParameter < StandardError; end
 
+  # Load order matters here!
+  # This gem must be loaded **after** Rails in order for the Engine/Railtie to register itself automatically.
+  # Otherwise, you'd have to manually require what you need from below.
   # Allow non-rails implementations to use this gem
   if defined?(::Rails) && defined?(::Rails::VERSION)
     if defined?(::Rails::Engine)
-      require "sanitize_email/engine"
+      if ::Rails::VERSION::MAJOR >= 6
+        # Rails 6.0+
+        require "sanitize_email/engine_v6"
+      else
+        # Rails 3.1 to 5.2
+        require "sanitize_email/engine_v5"
+      end
     elsif ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR.zero?
       require "sanitize_email/railtie"
     else
@@ -42,95 +51,101 @@ module SanitizeEmail
     end
   end
 
-  def self.[](key)
-    return unless key.respond_to?(:to_sym)
-    SanitizeEmail::Config.config[key.to_sym]
-  end
+  class << self
+    extend SanitizeEmail::Deprecation
 
-  def self.method_missing(name, *_args)
-    SanitizeEmail[name]
-  end
+    attr_accessor :force_sanitize
 
-  # NOTE: Deprecated method
-  # We have to actually define because we can't deprecate methods that are hooked up via method_missing
-  def self.sanitized_recipients
-    SanitizeEmail::Config.config[:sanitized_recipients]
-  end
+    def [](key)
+      return unless key.respond_to?(:to_sym)
+      SanitizeEmail::Config.config[key.to_sym]
+    end
 
-  # NOTE: Deprecated method
-  # We have to actually define because we can't deprecate methods that are hooked up via method_missing
-  def self.local_environments
-    SanitizeEmail::Config.config[:local_environments]
-  end
+    def method_missing(name, *_args)
+      if name
+        SanitizeEmail[name]
+      else
+        super
+      end
+    end
 
-  def self.activate?(message)
-    proc = SanitizeEmail::Config.config[:activation_proc]
-    proc.call(message) if proc.respond_to?(:call)
-  end
+    def respond_to_missing?(method_name, include_private = false)
+      method_name ? method_name : super
+    end
 
-  class << self
-    attr_accessor :force_sanitize
-  end
-  @force_sanitize = nil
+    # NOTE: Deprecated method
+    # We have to actually define because we can't deprecate methods that are hooked up via method_missing
+    def sanitized_recipients
+      # NOOP - This method is never actually executed, because the deprecations redirects the call to sanitized_to
+    end
 
-  # Regardless of the Config settings of SanitizeEmail you can do a local
-  # override to send sanitary email in any environment.
-  # You have access to all the same configuration options in the parameter hash
-  # as you can set in the actual SanitizeEmail.configure block.
-  #
-  # SanitizeEmail.sanitary({:sanitized_to => "boo@example.com"}) do
-  #   Mail.deliver do
-  #     from      "from@example.org"
-  #     # Will actually be sent to the override addresses, not this one:
-  #     to        "to@example.org"
-  #     reply_to  "reply_to@example.org"
-  #     subject   "subject"
-  #   end
-  # end
-  #
-  def self.sanitary(config_options = {})
-    raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
-    janitor(forcing: true) do
-      original = SanitizeEmail::Config.config.dup
-      SanitizeEmail::Config.config.merge!(config_options)
-      yield
-      SanitizeEmail::Config.config = original
+    # NOTE: Deprecated method
+    # We have to actually define because we can't deprecate methods that are hooked up via method_missing
+    def local_environments
+      SanitizeEmail::Config.config[:local_environments]
     end
-  end
 
-  # Regardless of the Config settings of SanitizeEmail you can do a local
-  # override to force unsanitary email in any environment.
-  #
-  # SanitizeEmail.unsanitary do
-  #   Mail.deliver do
-  #     from      "from@example.org"
-  #     to        "to@example.org"
-  #     reply_to  "reply_to@example.org"
-  #     subject   "subject"
-  #   end
-  # end
-  #
-  def self.unsanitary
-    raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
-    janitor(forcing: false) do
-      yield
+    def activate?(message)
+      proc = SanitizeEmail::Config.config[:activation_proc]
+      proc.call(message) if proc.respond_to?(:call)
     end
-  end
 
-  def self.janitor(options)
-    raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
-    original = SanitizeEmail.force_sanitize
-    SanitizeEmail.force_sanitize = options[:forcing]
-    yield
-    SanitizeEmail.force_sanitize = original
-  end
+    # Regardless of the Config settings of SanitizeEmail you can do a local
+    # override to send sanitary email in any environment.
+    # You have access to all the same configuration options in the parameter hash
+    # as you can set in the actual SanitizeEmail.configure block.
+    #
+    # SanitizeEmail.sanitary({:sanitized_to => "boo@example.com"}) do
+    #   Mail.deliver do
+    #     from      "from@example.org"
+    #     # Will actually be sent to the override addresses, not this one:
+    #     to        "to@example.org"
+    #     reply_to  "reply_to@example.org"
+    #     subject   "subject"
+    #   end
+    # end
+    #
+    def sanitary(config_options = {})
+      raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
+      janitor(forcing: true) do
+        original = SanitizeEmail::Config.config.dup
+        SanitizeEmail::Config.config.merge!(config_options)
+        yield
+        SanitizeEmail::Config.config = original
+      end
+    end
+
+    # Regardless of the Config settings of SanitizeEmail you can do a local
+    # override to force unsanitary email in any environment.
+    #
+    # SanitizeEmail.unsanitary do
+    #   Mail.deliver do
+    #     from      "from@example.org"
+    #     to        "to@example.org"
+    #     reply_to  "reply_to@example.org"
+    #     subject   "subject"
+    #   end
+    # end
+    #
+    def unsanitary
+      raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
+      janitor(forcing: false) do
+        yield
+      end
+    end
+
+    def janitor(options)
+      raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
+      original = SanitizeEmail.force_sanitize
+      SanitizeEmail.force_sanitize = options[:forcing]
+      yield
+      SanitizeEmail.force_sanitize = original
+    end
 
-  # Setup Deprecations!
-  class << self
-    extend SanitizeEmail::Deprecation
     deprecated_alias :sanitized_recipients, :sanitized_to
     deprecated :local_environments, :activation_proc
   end
+  @force_sanitize = nil
 end
 
 SanitizeEmail::Version.class_eval do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.6
 platform: ruby
 authors:
 - Peter Boling
@@ -38,26 +38,29 @@ cert_chain:
   KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
   pF8dMA==
   -----END CERTIFICATE-----
-date: 2024-03-23 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: version_gem
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.4
@@ -65,85 +68,68 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 1.7.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +164,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec-pending_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.16
 description: |2
     Email Condom for your Ruby Server.
   In Rails, Sinatra, et al, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.
@@ -197,7 +203,8 @@ files:
 - lib/sanitize_email/bleach.rb
 - lib/sanitize_email/config.rb
 - lib/sanitize_email/deprecation.rb
-- lib/sanitize_email/engine.rb
+- lib/sanitize_email/engine_v5.rb
+- lib/sanitize_email/engine_v6.rb
 - lib/sanitize_email/mail_ext.rb
 - lib/sanitize_email/mail_header_tools.rb
 - lib/sanitize_email/overridden_addresses.rb
@@ -205,10 +212,18 @@ files:
 - lib/sanitize_email/rspec_matchers.rb
 - lib/sanitize_email/test_helpers.rb
 - lib/sanitize_email/version.rb
-homepage: http://github.com/pboling/sanitize_email
+homepage: https://github.com/pboling/sanitize_email
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/pboling/sanitize_email
+  source_code_uri: https://github.com/pboling/sanitize_email/tree/v2.0.6
+  changelog_uri: https://github.com/pboling/sanitize_email/blob/v2.0.6/CHANGELOG.md
+  bug_tracker_uri: https://github.com/pboling/sanitize_email/issues
+  documentation_uri: https://www.rubydoc.info/gems/sanitize_email/2.0.6
+  wiki_uri: https://github.com/pboling/sanitize_email/wiki
+  funding_uri: https://liberapay.com/pboling
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -224,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Email Condom for your Ruby Server