Feature/Ability to specify whitelisted/blacklisted emails (#82)

* Added ability to specify whitelisted/blacklisted emails
* Updated runtime/development dependencies
* Updated rubocop/codeclimate configs
* Updated version, docs, changelog

Author: bestwebua

.codeclimate.yml

@@ -7,7 +7,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-1-36
+    channel: rubocop-1-38
 
   reek:
     enabled: true

.rubocop.yml

@@ -104,3 +104,6 @@ RSpec/StubbedMock:
 
 RSpec/VerifiedDoubleReference:
   Enabled: false
+
+RSpec/Rails/InferredSpecType:
+  Enabled: false

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2022-11-03
+
+### Added
+
+- Ability to specify [whitelisted/blacklisted emails](https://github.com/truemail-rb/truemail/releases/tag/v3.0.0)
+
+### Changed
+
+- Updated application dependencies (truemail 3.0.1)
+- Updated development dependencies
+- Updated application codebase, tests
+- Updated application docs, version
+
 ## [0.4.2] - 2022-10-11
 
 ### Changed

Gemfile

@@ -4,25 +4,25 @@ source 'https://rubygems.org'
 
 ruby(::File.read(::File.join(::File.dirname(__FILE__), '.ruby-version')).strip[/-(.+)/, 1])
 
-gem 'dry-struct', '~> 1.4'
-gem 'net-smtp', '~> 0.3.2'
+gem 'dry-struct', '~> 1.5', '>= 1.5.2'
+gem 'net-smtp', '~> 0.3.3'
 gem 'rack', '~> 2.2', '>= 2.2.4'
 gem 'thin', '~> 1.8', '>= 1.8.1'
-gem 'truemail', '~> 2.7', '>= 2.7.5'
+gem 'truemail', '~> 3.0', '>= 3.0.1'
 
 group :development, :test do
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
   gem 'rack-test', '~> 2.0', '>= 2.0.2'
-  gem 'rspec', '~> 3.11'
+  gem 'rspec', '~> 3.12'
 
   # Code quality
   gem 'bundler-audit', '~> 0.9.1', require: false
   gem 'fasterer', '~> 0.10.0', require: false
   gem 'overcommit', '~> 0.59.1', require: false
   gem 'reek', '~> 6.1', '>= 6.1.1', require: false
-  gem 'rubocop', '~> 1.36', require: false
+  gem 'rubocop', '~> 1.38', require: false
   gem 'rubocop-performance', '~> 1.15', require: false
-  gem 'rubocop-rspec', '~> 2.13', '>= 2.13.2', require: false
+  gem 'rubocop-rspec', '~> 2.14', '>= 2.14.2', require: false
 end
 
 group :test do

Gemfile.lock

@@ -15,22 +15,26 @@ GEM
     docile (1.4.0)
     dry-container (0.11.0)
       concurrent-ruby (~> 1.0)
-    dry-core (0.8.1)
+    dry-core (0.9.1)
       concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
     dry-inflector (0.3.0)
-    dry-logic (1.2.0)
+    dry-logic (1.3.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-struct (1.4.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.5)
+      dry-core (~> 0.9, >= 0.9)
+      zeitwerk (~> 2.6)
+    dry-struct (1.5.2)
+      dry-core (~> 0.9, >= 0.9)
+      dry-types (~> 1.6)
       ice_nine (~> 0.11)
-    dry-types (1.5.1)
+      zeitwerk (~> 2.6)
+    dry-types (1.6.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
+      dry-core (~> 0.9, >= 0.9)
       dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
+      dry-logic (~> 1.3, >= 1.3)
+      zeitwerk (~> 2.6)
     eventmachine (1.2.7)
     fasterer (0.10.0)
       colorize (~> 0.7)
@@ -45,7 +49,7 @@ GEM
     method_source (1.0.0)
     net-protocol (0.1.3)
       timeout
-    net-smtp (0.3.2)
+    net-smtp (0.3.3)
       net-protocol
     overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
@@ -70,35 +74,35 @@ GEM
       rainbow (>= 2.0, < 4.0)
     regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.13.2)
+    rubocop-rspec (2.14.2)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby_parser (3.19.1)
@@ -118,34 +122,35 @@ GEM
       rack (>= 1, < 3)
     thor (1.2.1)
     timeout (0.3.0)
-    truemail (2.7.5)
+    truemail (3.0.1)
       simpleidn (~> 0.2.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (2.3.0)
+    zeitwerk (2.6.4)
 
 PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
   bundler-audit (~> 0.9.1)
-  dry-struct (~> 1.4)
+  dry-struct (~> 1.5, >= 1.5.2)
   fasterer (~> 0.10.0)
   json_matchers (~> 0.11.1)
-  net-smtp (~> 0.3.2)
+  net-smtp (~> 0.3.3)
   overcommit (~> 0.59.1)
   pry-byebug (~> 3.10, >= 3.10.1)
   rack (~> 2.2, >= 2.2.4)
   rack-test (~> 2.0, >= 2.0.2)
   reek (~> 6.1, >= 6.1.1)
-  rspec (~> 3.11)
-  rubocop (~> 1.36)
+  rspec (~> 3.12)
+  rubocop (~> 1.38)
   rubocop-performance (~> 1.15)
-  rubocop-rspec (~> 2.13, >= 2.13.2)
+  rubocop-rspec (~> 2.14, >= 2.14.2)
   simplecov (~> 0.21.2)
   thin (~> 1.8, >= 1.8.1)
-  truemail (~> 2.7, >= 2.7.5)
+  truemail (~> 3.0, >= 3.0.1)
 
 RUBY VERSION
    ruby 3.1.2p20

README.md

@@ -58,9 +58,11 @@ Before run application you must configure it first. List of available env vars n
 | `CONNECTION_ATTEMPTS` | `3` | - | Total of connection attempts. It is equal to `2` by default. This parameter uses in mx lookup timeout error and smtp request (for cases when there is one mx server). |
 | `DEFAULT_VALIDATION_TYPE` | `mx` | - |  You can predefine Truemail default validation type (`smtp`). Available validation types: [`regex`](https://truemail-rb.org/truemail-gem/#/validations-layers?id=regex-validation), [`mx`](https://truemail-rb.org/truemail-gem/#/validations-layers?id=mx-validation), [`mx_blacklist`](https://truemail-rb.org/truemail-gem/#/validations-layers?id=mx-blacklist-validation), [`smtp`](https://truemail-rb.org/truemail-gem/#/validations-layers?id=smtp-validation). |
 | `VALIDATION_TYPE_FOR` | `somedomain.com:regex` | - | You can predefine which type of validation will be used for domains. Available validation types: `regex`, `mx`, `mx_blacklist`, `smtp`. This configuration will be used over `DEFAULT_VALIDATION_TYPE`. All of validations for `somedomain.com` will be processed with `regex` validation only. Accepts one or more key:value separated by commas. |
+| `WHITELISTED_EMAILS` | `user@somedomain1.com` | - | Validation of email which [contains whitelisted email](https://truemail-rb.org/truemail-gem/#/validations-layers?id=whitelist-case) always will return `true`. Other validations will not processed even if it was defined in `VALIDATION_TYPE_FOR`. Accepts one ore more values separated by commas. |
+| `BLACKLISTED_EMAILS` | `user@somedomain2.com` | - | Validation of email which [contains blacklisted email](https://truemail-rb.org/truemail-gem/#/validations-layers?id=blacklist-case) always will return `false`. Other validations will not processed even if it was defined in `VALIDATION_TYPE_FOR`. Accepts one ore more values separated by commas. |
 | `WHITELISTED_DOMAINS` | `somedomain1.com` | - | Validation of email which [contains whitelisted domain](https://truemail-rb.org/truemail-gem/#/validations-layers?id=whitelist-case) always will return `true`. Other validations will not processed even if it was defined in `VALIDATION_TYPE_FOR`. Accepts one ore more values separated by commas. |
-| `WHITELIST_VALIDATION` | `true` | - | With this option Truemail will validate email which [contains whitelisted domain only](https://truemail-rb.org/truemail-gem/#/validations-layers?id=whitelist-validation-case), i.e. if domain whitelisted, validation will passed to Regex, MX or SMTP validators. Validation of email which not contains whitelisted domain always will return `false`. It is equal `false` by default. |
 | `BLACKLISTED_DOMAINS` | `somedomain2.com` | - | Validation of email which [contains blacklisted domain](https://truemail-rb.org/truemail-gem/#/validations-layers?id=blacklist-case) always will return `false`. Other validations will not processed even if it was defined in `VALIDATION_TYPE_FOR`. Accepts one ore more values separated by commas. |
+| `WHITELIST_VALIDATION` | `true` | - | With this option Truemail will validate email which [contains whitelisted domain only](https://truemail-rb.org/truemail-gem/#/validations-layers?id=whitelist-validation-case), i.e. if domain whitelisted, validation will passed to Regex, MX or SMTP validators. Validation of email which not contains whitelisted domain always will return `false`. It is equal `false` by default. |
 | `BLACKLISTED_MX_IP_ADDRESSES` | `127.0.1.1,127.0.1.2` | - | With this option Truemail will filter out unwanted mx servers via predefined list of ip addresses. It can be used as a part of DEA (disposable email address) validations. Accepts one ore more values separated by commas.
 | `DNS` | `8.8.8.8,8.8.4.4:53` | - | This option will provide to use custom DNS gateway when Truemail interacts with DNS. If you won't specify nameserver's ports Truemail will use default DNS TCP/UDP port 53. Accepts one ore more values separated by commas. By default Truemail uses DNS gateway from system settings.
 | `NOT_RFC_MX_LOOKUP_FLOW` | `true` | - | This option will provide to use not RFC MX lookup flow. It means that MX and Null MX records will be cheked on the DNS validation layer only. By default [this option is disabled](https://truemail-rb.org/truemail-gem/#/validations-layers?id=not-rfc-mx-lookup-flow). |
@@ -90,9 +92,11 @@ ACCESS_TOKENS=a262d915-15bc-417c-afeb-842c63b54154,f44cd67e-aaa0-4e6c-aa6c-d52cf
 EMAIL_PATTERN="/\A.+@.+\z/" \
 SMTP_ERROR_BODY_PATTERN="/(?=.*550)(?=.*(user|account|customer|mailbox|something_else)).*/" \
 VALIDATION_TYPE_FOR=somedomain1.com:regex,somedomain2.com:mx \
+WHITELISTED_EMAILS=whitelisted@example.com \
+BLACKLISTED_EMAILS=blacklisted1@example.com,blacklisted2@example.com \
 WHITELISTED_DOMAINS=somedomain3.com \
-WHITELIST_VALIDATION=true \
 BLACKLISTED_DOMAINS=somedomain4.com,somedomain5.com \
+WHITELIST_VALIDATION=true \
 BLACKLISTED_MX_IP_ADDRESSES=127.0.1.1,127.0.1.2 \
 DNS=8.8.8.8,8.8.4.4:53 \
 NOT_RFC_MX_LOOKUP_FLOW=true \
@@ -132,17 +136,19 @@ Server: thin
   "errors": null,
   "smtp_debug": null,
   "configuration": {
+    "validation_type_by_domain": null,
+    "whitelisted_emails": null,
+    "blacklisted_emails": null,
+    "whitelisted_domains": null,
     "blacklisted_domains": null,
+    "whitelist_validation": false,
     "blacklisted_mx_ip_addresses": null,
     "dns": null,
     "email_pattern": "default gem value",
     "not_rfc_mx_lookup_flow": false,
     "smtp_error_body_pattern": "default gem value",
     "smtp_fail_fast": false,
-    "smtp_safe_check": false,
-    "validation_type_by_domain": null,
-    "whitelist_validation": false,
-    "whitelisted_domains": null
+    "smtp_safe_check": false
   }
 }
 ```
@@ -179,17 +185,19 @@ Server: thin
     }
   ],
   "configuration": {
+    "validation_type_by_domain": null,
+    "whitelisted_emails": null,
+    "blacklisted_emails": null,
+    "whitelisted_domains": null,
     "blacklisted_domains": null,
+    "whitelist_validation": false,
     "blacklisted_mx_ip_addresses": null,
     "dns": null,
     "email_pattern": "default gem value",
     "not_rfc_mx_lookup_flow": false,
     "smtp_error_body_pattern": "default gem value",
     "smtp_fail_fast": false,
-    "smtp_safe_check": false,
-    "validation_type_by_domain": null,
-    "whitelist_validation": false,
-    "whitelisted_domains": null
+    "smtp_safe_check": false
   }
 }
 ```
@@ -208,9 +216,9 @@ Content-Type: application/json
 Server: thin
 
 {
-  "core": "2.7.1",
-  "platform": "ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-darwin20]",
-  "version": "0.4.0"
+  "core": "3.0.1",
+  "platform": "ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin20]",
+  "version": "0.5.0"
 }
 ```
 

app/truemail_server/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TruemailServer
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

config/system/command_line_params.rb

@@ -13,9 +13,11 @@ class CommandLineParams < Dry::Struct
     attribute :connection_attempts, System::Types::Coercible::Integer.optional
     attribute :default_validation_type, System::Types::Coercible::Symbol.optional
     attribute :validation_type_for, System::Types::StringToHash.optional
+    attribute :whitelisted_emails, System::Types::StringToArray.optional
+    attribute :blacklisted_emails, System::Types::StringToArray.optional
     attribute :whitelisted_domains, System::Types::StringToArray.optional
-    attribute :whitelist_validation, System::Types::Params::Bool.optional
     attribute :blacklisted_domains, System::Types::StringToArray.optional
+    attribute :whitelist_validation, System::Types::Params::Bool.optional
     attribute :blacklisted_mx_ip_addresses, System::Types::StringToArray.optional
     attribute :dns, System::Types::StringToArray.optional
     attribute :not_rfc_mx_lookup_flow, System::Types::Params::Bool.optional

config/system/configuration.rb

@@ -15,9 +15,11 @@ class Error < StandardError; end
       connection_attempts
       default_validation_type
       validation_type_for
+      whitelisted_emails
+      blacklisted_emails
       whitelisted_domains
-      whitelist_validation
       blacklisted_domains
+      whitelist_validation
       blacklisted_mx_ip_addresses
       dns
       not_rfc_mx_lookup_flow

spec/support/config/environment.rb

@@ -3,6 +3,8 @@
 ENV_VARS = {
   verifier_email: 'admin@bestweb.com.ua',
   access_tokens: 'token',
+  whitelisted_emails: 'whitelisted@example.com',
+  blacklisted_emails: 'blacklisted@example.com',
   whitelisted_domains: 'true.com',
   blacklisted_domains: 'false.com',
   log_stdout: 'false'