action_recipient 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8494299046a94fa75e5f75127e0c3854e0af1da065108c7d8c61c39be550e8af
-  data.tar.gz: a533cd9ad625688c008be2d95d6d493b57e4bc7c584d4168e58e87c999e4e74d
+  metadata.gz: '09e845ff355a04ccb8d66af051f105bcf697dce047c27bee099723149f536c01'
+  data.tar.gz: 407657879dfd3c599c7be2038f7351448870e10cfac466685779f779055aaf17
 SHA512:
-  metadata.gz: 491a5b5e79f2a6fe708239a1d89a4dc0d82ac4e92deac38bbb5f08993151e65f6777dc412d46e055c1cccac0c6d3c27ba880631f3bc0b5cbd154e2b5aff686d5
-  data.tar.gz: 8f2c371001d334168b1ee11622b4e1104b86ef51eb9e2a1859aaad7d12bf6704c13fbc82bcd29fd7dc1dfa7a0405c9d3abc413be7621538bae7206f4903b0b13
+  metadata.gz: ce9cc99d0a6a779738a755a5d35b45e3049681752c565d95425d123cb26de1989087a9abc246258d42faca85c9df4a304663ea0f22bd9899eaa937c089036f75
+  data.tar.gz: 277a74702a8d7a73d5e1fb9754584364c95807824742f9971489d5cb2fe0d6e06b3bae11bcdde69df4cfd1f05fbeacc1affdbe0e6d15f8851506e4b4fd25ed88

data/.travis.yml

@@ -3,8 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
+before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## [0.2.0]
+### Added
+- Support whitelist for non-filtered addresses and domains
+
+## [0.3.0]
+### Added
+- Accept regular expression for both whitelist addresses and domains
+- Support Ruby3.0.0 and Ruby2.7.2 (with CI)

data/README.md

@@ -4,15 +4,14 @@
 
 # ActionRecipient
 
-This gem overwrites email recipients addresses sent by ActionMailer , so that to prevent your application from dispatching emails accidentally to existing addresses, expecially your users or clients in non-production environments.
+This gem dynamically overwrites email recipients addresses sent with ActionMailer.
+With this gem, you no longer have to worry about your application delivering accidental emails to your real customer in non-production environments.
 
-### IMPORTANT NOTES
+It is particularily helpful if you are using gmail account for your staging mail, as it can append original recipients information in the address. (See [below](#Using Gmail) for details)
 
-* this gem is developed and tested carefully, but it does NOT mean this is 100% reliable. Please use this at your own risks, and test carefully before use.
+* although this gem has been developed and tested carefully, but there is no guarantee that this is 100% reliable. Please use this at your own risks, and test carefully before use.
 
-* It HAS NO EFFECT on the Non-Actionmailer emails (i.e. if the emails are delivered out of ActionMailer's control)
-
-* for example, if you are sending batch emails directly via Mailgun API, the gem cannot overwrite its addresses - please consider managing recipient addresses on your own.
+* Non-Actionmailer emails cannot be blocked nor redirected, as it works based on ActionMailer's interceptor mechanism.
 
 ## Installation
 
@@ -34,21 +33,41 @@ Or install it yourself as:
 
 ### Getting Started
 
-Let's say you want to trap all the emails that are sent out in staging environment. You need to replace outgoing emails' addresses to your work address `your_address_to_redirect@gmail.com`, with a few exception such as `my_personal_adddress@example.com`
+Set up ActionRecipient as follows to prevent outgoing mails in your staging environment.
+
+```ruby
+# config/initializers/action_recipient.rb
+
+if Rails.env.staging? # effective only in staging environment
+
+  ActionRecipient.configure do |config|
+    config.format = 'your_address_to_redirect@your_domain.com' # address that the emails to be redirected
+  end
+
+  ActionMailer::Base.register_interceptor(ActionRecipient::Interceptor) # register it as interceptor
+end
+```
 
-In `config/initializers`, register ActionRecipient as follows:
+If your colleague (in staging environment) accidentally send an email to `admin@your_client.com`, this gem overwrites its addresses as `your_address_to_redirect+admin_at_your_client.com@gmail.com` with help of ActionMailer's interceptor.
+
+### Whitelist
+
+Let's say, you wish to trap any outgoing emails, with an exception, e.g. `my_personal_adddress@example.com` that has to be actually delivered without interception.
+
+You can' whitelist' such email addresses as follows:
 
 ```ruby
 # config/initializers/action_recipient.rb
 
-if Rails.env.staging? # works only in staging environment
+if Rails.env.staging?
 
   ActionRecipient.configure do |config|
     config.format = 'your_address_to_redirect+%s@gmail.com'
 
+    # specify whitelisted addresses  as follows
     config.whitelist.addresses = [
-      'safe_address@example.com',
-      'my_personal_adddress@example.com'
+      'safe_address@my-company.com',
+      'my_personal_adddress@my-company.com'
     ]
   end
 
@@ -56,11 +75,51 @@ if Rails.env.staging? # works only in staging environment
 end
 ```
 
-Then, if you send an email to `admin@your_client.com` using ActionMailer, this gem traps it and overwrites its addresses as `your_address_to_redirect+admin_at_your_client.com@gmail.com`.
+You can also whitelist all the emails that belong to perticular domain:
+
+```ruby
+ActionRecipient.configure do |config|
+  config.whitelist.domains = [
+    'my-company.com'
+  ]
+end
+```
+
+Note: With a string matcher, you can whitelist only an address that has perfect match with it. If you prefer to whitelist all the addresses that belong to **any subdomains** under a specific domain, use regular expression instead.
+
+```ruby
+ActionRecipient.configure do |config|
+  config.whitelist.domains = [
+    'my-company.com\z'
+  ]
+end
+```
+
+This way an address such as `somebody@sales.my-company.com` is whitelisted, thus can deliver an out-going emails without getting trapped.
 
-You can find the email at your mailbox in `your_address_to_redirect@gmail.com`, just as your client would do if it were in production - with the only difference in its `to` address that are slightly modified.
+### Using Gmail
 
-### Detailed Settings
+You might wish to keep original recipient addresses somehow, so that you can confirm where the email must have been delivered to unless it gets trapped.
+
+This gem accepts a format where `%s` are dynamically replaced with the original address, prefixed with type of destination field (`to`, `cc`, or `bcc`).
+
+
+```ruby
+# config/initializers/action_recipient.rb
+
+if Rails.env.staging? # effective only in staging environment
+
+  ActionRecipient.configure do |config|
+    config.format = 'your_address_to_redirect+%s@gmail.com' # destination type and original address will be appended after your address
+  end
+
+  ActionMailer::Base.register_interceptor(ActionRecipient::Interceptor)
+end
+```
+
+This feature is particularity useful if you use gmail - as it ignores any strings that follow after a plus (+) sign appended in your address.
+
+## Detailed Settings
 
 1. set your "safe address" to indicate ActionRecipient an address to redirect outgoing emails:
 
@@ -79,13 +138,13 @@ If you add **%s** in the format, it is automatically replaced with the original
 ```ruby
   ActionRecipient.configure do |config|
     config.whitelist.addresses = [
-      'my_personal_address@example.com',
-      'my_colleagues_address@example.com'
+      'my_colleagues_address@my-workplace.com'
+      'a-contractor@somebody.net',
     ]
 
     config.whitelist.domains = [
-      'my_office_domain.com',
-      'subdomain.my_office_domain.com'
+      'my-department.my-workplace.com',
+      /my-private-domain.com\z/
     ]
   end
 ```
@@ -93,10 +152,12 @@ If you add **%s** in the format, it is automatically replaced with the original
 Whitelisted emails addresses are not overwritten, thus can be delivered as usual.
 
 IMPORTANT:
-With current version (version <~ 0.2.0) "domains" are the last part of email addresses after `@`, and matched with original email address literally on word-to-word basis.
+"domains" are the last part of email addresses after `@`, and matched with original email address literally on word-to-word basis.
 
 So whitelisted domains such as `bar.com` does NOT whitelist emails to subdomains like `somebody@foo.bar.com` (therefore redirected).
 
+If you wish to whitelist a domain including all the subdomains under it, use regular expressions as [described earlier](#detailed-settings)
+
 3. register ActionRecipient as the interceptor
 
 ```ruby
@@ -124,6 +185,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fursich/action_recipient.
 
+## Acknoledgement
+
+I'd like to thank @akeyhero who came up with the original idea about appending recipient information after plus leveraging gmail feature.
+Although the implementation work is done by myself seperately, this gem greatly benefited from his inspiring idea.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/action_recipient.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mail', '>= 2.5.4' # to liaise with ActionMailer 4.2 or higher
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'

data/lib/action_recipient/rewriter.rb

@@ -19,7 +19,19 @@ module ActionRecipient
       end
 
       def whitelisted?(email)
-        whitelist.addresses.include?(email) || whitelist.domains.include?(domain_for(email))
+        match_with_any_whitelisted_addresses?(email) || match_with_any_whitelisted_domains?(domain_for(email))
+      end
+
+      def match_with_any_whitelisted_addresses?(email)
+        whitelist.addresses.any? { |string_or_regexp|
+          string_or_regexp === email
+        }
+      end
+
+      def match_with_any_whitelisted_domains?(domain)
+        whitelist.domains.any? { |string_or_regexp|
+          string_or_regexp === domain
+        }
       end
 
       def whitelist

data/lib/action_recipient/version.rb

@@ -1,3 +1,3 @@
 module ActionRecipient
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_recipient
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Koji Onishi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-26 00:00:00.000000000 Z
+date: 2020-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +105,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Overwrites email recipients with ActionMailer emails to prevent accidental