truemail 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21b06ee93aa17673879a07cd4757ea0508d4acf4340c45406ef389c38d3897f
-  data.tar.gz: 5c4322968164282e3128fd1350bc614eb9ddc596a541a5dcab94e9dab81fb358
+  metadata.gz: d6ae9e8559f02e6dc3c192d25b68299d710b0f725d6415dcce94291b67cfedec
+  data.tar.gz: ca8150d40f29c19424c75203ebc8725a158f9ab211e31fed6139258f850f061e
 SHA512:
-  metadata.gz: 7782e71da1ff862e233a6acf68ba63f38858f167c291118083a291c2305202f6038ba375ea9d6597600755ffd0cc9264a41e6f3a51fe5c65c2978bc7b1bbf5ea
-  data.tar.gz: ce1f9ae97ebd2cc7d929f4ee99c1af0e95d97116053be9d1dd19849eade75a89094f085c4475b52095459533e2aa9a19a1f19b0f1a3b51e7851e107a74b6364d
+  metadata.gz: 756ac97059a71e39fff2161c9d484ac5c916061403d7165fb1afd45c1d363928c10330fc0175ed33fe0915eedc503b237e8c796fe1cdfd4c80a7dc7c2fc4d6f5
+  data.tar.gz: 565ab89967301f5f8b9cd5cd6c230ee6c1a6e908776532f1346131850afccfe72063bb2acc05b573b806c8cd8be13b0f085eaadf136de9165ace3a6ee232651e

data/.reek.yml

@@ -38,6 +38,7 @@ detectors:
       - Truemail::GenerateEmailHelper#calculate_email_size
       - Truemail::Worker#success
       - Truemail#raise_unless
+      - Truemail::Configuration#raise_unless
 
   FeatureEnvy:
     exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    truemail (1.0.0)
+    truemail (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -77,7 +77,8 @@ Truemail.configure do |config|
   # Optional parameter. You can predefine which type of validation will be used for domains.
   # Also you can skip validation by domain. Available validation types: :regex, :mx, :smtp
   # This configuration will be used over current or default validation type parameter
-  # All of validations for 'somedomain.com' will be processed with mx validation only
+  # All of validations for 'somedomain.com' will be processed with regex validation only.
+  # And all of validations for 'otherdomain.com' will be processed with mx validation only.
   config.validation_type_for = { 'somedomain.com' => :regex, 'otherdomain.com' => :mx }
 
   # Optional parameter. Validation of email which contains whitelisted domain always will
@@ -154,9 +155,92 @@ Truemail.configuration
 
 ### Validation features
 
+#### Whitelist/Blacklist check
+
+Whitelist/Blacklist check is zero validation level. You can define white and black list domains. It means that validation of email which contains whitelisted domain always will return ```true```, and for blacklisted domain will return ```false```.
+
+Please note, other validations will not processed even if it was defined in ```validation_type_for```.
+
+**Sequence of domain list check:**
+1. Whitelist check
+2. Blacklist check
+
+Example of usage:
+
+```ruby
+require 'truemail'
+
+Truemail.configure do |config|
+  config.verifier_email = 'verifier@example.com'
+  config.whitelisted_domains = ['white-domain.com', 'somedomain.com']
+  config.blacklisted_domains = ['black-domain.com', 'somedomain.com']
+  config.validation_type_for = { 'somedomain.com' => :mx }
+end
+```
+
+##### Whitelist case
+
+When email in whitelist, validation type will be redefined. Validation result returns ```true```
+
+```ruby
+Truemail.validate('email@white-domain.com')
+
+#<Truemail::Validator:0x000055b8429f3490
+  @result=#<struct Truemail::Validator::Result
+    success=true,
+    email="email@white-domain.com",
+    domain=nil,
+    mail_servers=[],
+    errors={},
+    smtp_debug=nil>,
+  @validation_type=:whitelist>
+```
+
+##### Blacklist case
+
+When email in blacklist, validation type will be redefined too. Validation result returns ```false```
+
+```ruby
+Truemail.validate('email@black-domain.com')
+
+#<Truemail::Validator:0x000023y8429f3493
+  @result=#<struct Truemail::Validator::Result
+    success=false,
+    email="email@black-domain.com",
+    domain=nil,
+    mail_servers=[],
+    errors={},
+    smtp_debug=nil>,
+  @validation_type=:blacklist>
+```
+
+##### Duplication case
+
+Validation result for this email returns ```true```, because it was found in whitelisted domains list first. Also ```validation_type``` for this case will be redefined.
+
+```ruby
+Truemail.validate('email@somedomain.com')
+
+#<Truemail::Validator:0x000055b8429f3490
+  @result=#<struct Truemail::Validator::Result
+    success=true,
+    email="email@somedomain.com",
+    domain=nil,
+    mail_servers=[],
+    errors={},
+    smtp_debug=nil>,
+  @validation_type=:whitelist>
+```
+
 #### Regex validation
 
-Validation with regex pattern is the first validation level. By default this validation not performs strictly following RFC 5322 standard, so you can override Truemail default regex pattern if you want.
+Validation with regex pattern is the first validation level. It uses whitelist/blacklist check before running itself.
+
+```code
+[Whitelist/Blacklist] -> [Regex validation]
+```
+
+By default this validation not performs strictly following [RFC 5322](https://www.ietf.org/rfc/rfc5322.txt) standard, so you can override Truemail default regex pattern if you want.
 
 Example of usage:
 
@@ -211,7 +295,7 @@ Truemail.validate('email@example.com', with: :regex)
 Validation by MX records is the second validation level. It uses Regex validation before running itself. When regex validation has completed successfully then runs itself.
 
 ```code
-[Regex validation] -> [MX validation]
+[Whitelist/Blacklist] -> [Regex validation] -> [MX validation]
 ```
 
 Please note, Truemail MX validator not performs strict compliance of the [RFC 5321](https://tools.ietf.org/html/rfc5321#section-5) standard for best validation outcome.
@@ -244,7 +328,7 @@ Truemail.validate('email@example.com', with: :mx)
 SMTP validation is a final, third validation level. This type of validation tries to check real existence of email account on a current email server. This validation runs a chain of previous validations and if they're complete successfully then runs itself.
 
 ```code
-[Regex validation] -> [MX validation] -> [SMTP validation]
+[Whitelist/Blacklist] -> [Regex validation] -> [MX validation] -> [SMTP validation]
 ```
 
 If total count of MX servers is equal to one, ```Truemail::Smtp``` validator will use value from ```Truemail.configuration.connection_attempts``` as connection attempts. By default it's equal 2.

data/lib/truemail/configuration.rb

@@ -35,7 +35,7 @@ module Truemail
 
     %i[email_pattern smtp_error_body_pattern].each do |method|
       define_method("#{method}=") do |argument|
-        raise Truemail::ArgumentError.new(argument, __method__) unless argument.is_a?(Regexp)
+        raise_unless(argument, __method__, argument.is_a?(Regexp))
         instance_variable_set(:"@#{method}", argument)
       end
     end
@@ -53,7 +53,7 @@ module Truemail
 
     %i[connection_timeout response_timeout connection_attempts].each do |method|
       define_method("#{method}=") do |argument|
-        raise ArgumentError.new(argument, __method__) unless argument.is_a?(Integer) && argument.positive?
+        raise_unless(argument, __method__, argument.is_a?(Integer) && argument.positive?)
         instance_variable_set(:"@#{method}", argument)
       end
     end
@@ -65,7 +65,7 @@ module Truemail
 
     %i[whitelisted_domains blacklisted_domains].each do |method|
       define_method("#{method}=") do |argument|
-        raise ArgumentError.new(argument, __method__) unless argument.is_a?(Array) && check_domain_list(argument)
+        raise_unless(argument, __method__, argument.is_a?(Array) && check_domain_list(argument))
         instance_variable_set(:"@#{method}", argument)
       end
     end
@@ -76,9 +76,13 @@ module Truemail
 
     private
 
+    def raise_unless(argument_context, argument_name, condition)
+      raise Truemail::ArgumentError.new(argument_context, argument_name) unless condition
+    end
+
     def validate_arguments(argument, method)
       constant = Truemail::RegexConstant.const_get("regex_#{method[/\A.+_(.+)\=\z/, 1]}_pattern".upcase)
-      raise Truemail::ArgumentError.new(argument, method) unless constant.match?(argument.to_s)
+      raise_unless(argument, method, constant.match?(argument.to_s))
     end
 
     def default_verifier_domain
@@ -90,7 +94,7 @@ module Truemail
     end
 
     def check_domain(domain)
-      raise Truemail::ArgumentError.new(domain, 'domain') unless domain_matcher.call(domain)
+      raise_unless(domain, 'domain', domain_matcher.call(domain))
     end
 
     def check_domain_list(domains)
@@ -98,12 +102,11 @@ module Truemail
     end
 
     def check_validation_type(validation_type)
-      raise Truemail::ArgumentError.new(validation_type, 'validation type') unless
-        Truemail::Validator::VALIDATION_TYPES.include?(validation_type)
+      raise_unless(validation_type, 'validation type', Truemail::Validator::VALIDATION_TYPES.include?(validation_type))
     end
 
     def validate_validation_type(settings)
-      raise Truemail::ArgumentError.new(settings, 'hash with settings') unless settings.is_a?(Hash)
+      raise_unless(settings, 'hash with settings', settings.is_a?(Hash))
       settings.each do |domain, validation_type|
         check_domain(domain)
         check_validation_type(validation_type)

data/lib/truemail/validator.rb

@@ -22,7 +22,7 @@ module Truemail
 
     def run
       Truemail::Validate::DomainListMatch.check(result)
-      Truemail::Validate.const_get(validation_type.capitalize).check(result) if result_not_changed?
+      result_not_changed? ? Truemail::Validate.const_get(validation_type.capitalize).check(result) : update_validation_type
       self
     end
 
@@ -32,6 +32,10 @@ module Truemail
       result.success.nil?
     end
 
+    def update_validation_type
+      @validation_type = result.success ? :whitelist : :blacklist
+    end
+
     def select_validation_type(email, current_validation_type)
       domain = email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]
       Truemail.configuration.validation_type_by_domain[domain] || current_validation_type

data/lib/truemail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Truemail
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2019-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler