truemail 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb37fadb88c2a0705dc7504ba9e227671d5ce61d75cb08ee7aa8cf2722abff05
-  data.tar.gz: 7a1d28d03fabc1043443b3283c5fbe219e6634d2116a005127a456d254478a04
+  metadata.gz: a21b06ee93aa17673879a07cd4757ea0508d4acf4340c45406ef389c38d3897f
+  data.tar.gz: 5c4322968164282e3128fd1350bc614eb9ddc596a541a5dcab94e9dab81fb358
 SHA512:
-  metadata.gz: fd889d737e59df1ea8f77953ebc6b87897b9b50a1632f68801e1c47329bfb96272be68de87935c0d2b97a93c91a6d3a85a6e7325f11d8dfacfb2cb5a77fb6de3
-  data.tar.gz: 85837fcdbe93933194f7bcceefac18bbda51fc4a841a501cd9166e8cdbf1f2668a9aeb4dea79761b8393a352ab3ddfa51feabdc45bdce496304227c26abeb97b
+  metadata.gz: 7782e71da1ff862e233a6acf68ba63f38858f167c291118083a291c2305202f6038ba375ea9d6597600755ffd0cc9264a41e6f3a51fe5c65c2978bc7b1bbf5ea
+  data.tar.gz: ce1f9ae97ebd2cc7d929f4ee99c1af0e95d97116053be9d1dd19849eade75a89094f085c4475b52095459533e2aa9a19a1f19b0f1a3b51e7851e107a74b6364d

data/.reek.yml

@@ -31,6 +31,7 @@ detectors:
       - Truemail::Validate::Mx#null_mx?
       - Truemail::Validate::Mx#a_record
       - Truemail::Audit::Base#verifier_domain
+      - Truemail::Configuration#domain_matcher
 
   ControlParameter:
     exclude:
@@ -42,3 +43,7 @@ detectors:
     exclude:
       - Truemail::Validate::Smtp#not_includes_user_not_found_errors
       - Truemail::GenerateEmailHelper#prepare_user_name
+
+  NilCheck:
+    exclude:
+      - Truemail::Validator#result_not_changed?

data/Gemfile.lock

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

data/README.md

@@ -8,6 +8,7 @@ The Truemail gem helps you validate emails by regex pattern, presence of domain
 
 - Configurable validator, validate only what you need
 - Zero runtime dependencies
+- Has whitelist/blacklist
 - Has simple SMTP debugger
 - 100% test coverage
 
@@ -74,10 +75,18 @@ Truemail.configure do |config|
   config.connection_attempts = 3
 
   # 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, :skip
+  # 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
-  config.validation_type_for = { 'somedomain.com' => :mx, 'otherdomain.com' => :skip }
+  config.validation_type_for = { 'somedomain.com' => :regex, 'otherdomain.com' => :mx }
+
+  # Optional parameter. Validation of email which contains whitelisted domain always will
+  # return true. Other validations will not processed even if it was defined in validation_type_for
+  config.whitelisted_domains = ['somedomain1.com', 'somedomain2.com']
+
+  # Optional parameter. Validation of email which contains whitelisted domain always will
+  # return false. Other validations will not processed even if it was defined in validation_type_for
+  config.blacklisted_domains = ['somedomain1.com', 'somedomain2.com']
 
   # Optional parameter. This option will be parse bodies of SMTP errors. It will be helpful
   # if SMTP server does not return an exact answer that the email does not exist
@@ -100,6 +109,8 @@ Truemail.configuration
  @response_timeout=1,
  @connection_attempts=3,
  @validation_type_by_domain={},
+ @whitelisted_domains=[],
+ @blacklisted_domains=[],
  @verifier_domain="somedomain.com",
  @verifier_email="verifier@example.com"
  @smtp_safe_check=true>
@@ -123,6 +134,8 @@ Truemail.configuration
  @response_timeout=4,
  @connection_attempts=1,
  @validation_type_by_domain={},
+ @whitelisted_domains=[],
+ @blacklisted_domains=[],
  @verifier_domain="somedomain.com",
  @verifier_email="verifier@example.com",
  @smtp_safe_check=true>
@@ -281,6 +294,8 @@ Truemail.validate('email@example.com')
               @connection_attempts=2,
               @smtp_safe_check=false,
               @validation_type_by_domain={},
+              @whitelisted_domains=[],
+              @blacklisted_domains=[],
               @verifier_domain="example.com",
               @verifier_email="verifier@example.com">,
             @email="email@example.com",
@@ -335,6 +350,8 @@ Truemail.validate('email@example.com')
                 @connection_attempts=2,
                 @smtp_safe_check=true,
                 @validation_type_by_domain={},
+                @whitelisted_domains=[],
+                @blacklisted_domains=[],
                 @verifier_domain="example.com",
                 @verifier_email="verifier@example.com">,
               @email="email@example.com",
@@ -373,6 +390,8 @@ Truemail.validate('email@example.com')
               @connection_attempts=2,
               @smtp_safe_check=true,
               @validation_type_by_domain={},
+              @whitelisted_domains=[],
+              @blacklisted_domains=[],
               @verifier_domain="example.com",
               @verifier_email="verifier@example.com">,
           @email="email@example.com",
@@ -447,8 +466,7 @@ end
 ---
 ## ToDo
 
-1. Gem compatibility with Ruby 2.3
-2. Fail validations logger
+Fail validations logger
 
 ## Contributing
 

data/lib/truemail/configuration.rb

@@ -13,7 +13,9 @@ module Truemail
                 :connection_timeout,
                 :response_timeout,
                 :connection_attempts,
-                :validation_type_by_domain
+                :validation_type_by_domain,
+                :whitelisted_domains,
+                :blacklisted_domains
 
     attr_accessor :smtp_safe_check
 
@@ -26,6 +28,8 @@ module Truemail
       @response_timeout = Truemail::Configuration::DEFAULT_RESPONSE_TIMEOUT
       @connection_attempts = Truemail::Configuration::DEFAULT_CONNECTION_ATTEMPTS
       @validation_type_by_domain = {}
+      @whitelisted_domains = []
+      @blacklisted_domains = []
       @smtp_safe_check = false
     end
 
@@ -59,6 +63,13 @@ module Truemail
       validation_type_by_domain.merge!(settings)
     end
 
+    %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)
+        instance_variable_set(:"@#{method}", argument)
+      end
+    end
+
     def complete?
       !!verifier_email
     end
@@ -74,17 +85,25 @@ module Truemail
       self.verifier_domain ||= verifier_email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]
     end
 
+    def domain_matcher
+      ->(domain) { Truemail::RegexConstant::REGEX_DOMAIN_PATTERN.match?(domain.to_s) }
+    end
+
     def check_domain(domain)
-      raise Truemail::ArgumentError.new(domain, 'domain') unless
-        Truemail::RegexConstant::REGEX_DOMAIN_PATTERN.match?(domain.to_s)
+      raise Truemail::ArgumentError.new(domain, 'domain') unless domain_matcher.call(domain)
+    end
+
+    def check_domain_list(domains)
+      domains.all?(&domain_matcher)
     end
 
     def check_validation_type(validation_type)
       raise Truemail::ArgumentError.new(validation_type, 'validation type') unless
-          Truemail::Validator::VALIDATION_TYPES.include?(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)
       settings.each do |domain, validation_type|
         check_domain(domain)
         check_validation_type(validation_type)

data/lib/truemail/core.rb

@@ -30,8 +30,8 @@ module Truemail
   end
 
   module Validate
-    require 'truemail/validate/skip'
     require 'truemail/validate/base'
+    require 'truemail/validate/domain_list_match'
     require 'truemail/validate/regex'
     require 'truemail/validate/mx'
     require 'truemail/validate/smtp'

data/lib/truemail/validate/base.rb

@@ -6,7 +6,7 @@ module Truemail
       private
 
       def add_error(message)
-        result.errors[self.class.name.split('::').last.downcase.to_sym] = message
+        result.errors[self.class.name.split('::').last.gsub(/(?<=.)(?=[A-Z])/, '_').downcase.to_sym] = message
       end
 
       def mail_servers

data/lib/truemail/validate/domain_list_match.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Truemail
+  module Validate
+    class DomainListMatch < Truemail::Validate::Base
+      ERROR = 'blacklisted email'
+
+      def run
+        return success(true) if whitelisted_domain?
+        return unless blacklisted_domain?
+        success(false)
+        add_error(Truemail::Validate::DomainListMatch::ERROR)
+      end
+
+      private
+
+      def email_domain
+        @email_domain ||= result.email[Truemail::RegexConstant::REGEX_DOMAIN_FROM_EMAIL, 1]
+      end
+
+      def whitelisted_domain?
+        configuration.whitelisted_domains.include?(email_domain)
+      end
+
+      def blacklisted_domain?
+        configuration.blacklisted_domains.include?(email_domain)
+      end
+    end
+  end
+end

data/lib/truemail/validator.rb

@@ -3,7 +3,7 @@
 module Truemail
   class Validator
     RESULT_ATTRS = %i[success email domain mail_servers errors smtp_debug].freeze
-    VALIDATION_TYPES = %i[regex mx smtp skip].freeze
+    VALIDATION_TYPES = %i[regex mx smtp].freeze
 
     Result = Struct.new(*RESULT_ATTRS, keyword_init: true) do
       def initialize(errors: {}, mail_servers: [], **args)
@@ -21,12 +21,17 @@ module Truemail
     end
 
     def run
-      Truemail::Validate.const_get(validation_type.capitalize).check(result)
+      Truemail::Validate::DomainListMatch.check(result)
+      Truemail::Validate.const_get(validation_type.capitalize).check(result) if result_not_changed?
       self
     end
 
     private
 
+    def result_not_changed?
+      result.success.nil?
+    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 = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,9 +199,9 @@ files:
 - lib/truemail/configuration.rb
 - lib/truemail/core.rb
 - lib/truemail/validate/base.rb
+- lib/truemail/validate/domain_list_match.rb
 - lib/truemail/validate/mx.rb
 - lib/truemail/validate/regex.rb
-- lib/truemail/validate/skip.rb
 - lib/truemail/validate/smtp.rb
 - lib/truemail/validate/smtp/request.rb
 - lib/truemail/validate/smtp/response.rb

data/lib/truemail/validate/skip.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Truemail
-  module Validate
-    class Skip < Truemail::Worker
-      def run
-        success(true)
-      end
-    end
-  end
-end