truemail 1.8.0 → 2.0.1

data/lib/truemail.rb

@@ -5,6 +5,7 @@ require_relative 'truemail/core'
 module Truemail
   INCOMPLETE_CONFIG = 'verifier_email is required parameter'
   NOT_CONFIGURED = 'use Truemail.configure before or pass custom configuration'
+  INVALID_TYPE = 'email should be a String'
 
   class << self
     def configuration(&block)
@@ -25,10 +26,12 @@ module Truemail
     end
 
     def validate(email, custom_configuration: nil, **options)
+      check_argument_type(email)
       Truemail::Validator.new(email, configuration: determine_configuration(custom_configuration), **options).run
     end
 
     def valid?(email, **options)
+      check_argument_type(email)
       validate(email, **options).result.valid?
     end
 
@@ -38,8 +41,12 @@ module Truemail
 
     private
 
-    def raise_unless(condition, message)
-      raise Truemail::ConfigurationError, message unless condition
+    def raise_unless(condition, message, error_class = Truemail::ConfigurationError)
+      raise error_class, message unless condition
+    end
+
+    def check_argument_type(argument)
+      raise_unless(argument.is_a?(String), Truemail::INVALID_TYPE, Truemail::TypeError)
     end
 
     def determine_configuration(custom_configuration)

data/lib/truemail/audit/dns.rb

@@ -3,7 +3,7 @@
 module Truemail
   module Audit
     class Dns < Truemail::Audit::Base
-      VERIFIER_DOMAIN_NOT_REFER = 'a record of verifier domain not refers to current host ip address'
+      VERIFIER_DOMAIN_NOT_REFER = 'A-record of verifier domain not refers to current host ip address'
 
       def run
         return if verifier_domain_refer_to_current_host_ip?

data/lib/truemail/audit/ptr.rb

@@ -3,8 +3,8 @@
 module Truemail
   module Audit
     class Ptr < Truemail::Audit::Base
-      PTR_NOT_FOUND = 'ptr record for current host ip address was not found'
-      PTR_NOT_REFER = 'ptr record does not reference to current verifier domain'
+      PTR_NOT_FOUND = 'PTR-record for current host ip address was not found'
+      PTR_NOT_REFER = 'PTR-record does not reference to current verifier domain'
 
       def run
         return add_warning(Truemail::Audit::Ptr::PTR_NOT_FOUND) if ptr_records.empty?

data/lib/truemail/auditor.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
 module Truemail
-  class Auditor
+  class Auditor < Truemail::Executor
     Result = Struct.new(:current_host_ip, :warnings, :configuration, keyword_init: true) do
       def initialize(warnings: {}, **args)
         super
       end
     end
 
-    attr_reader :result
-
     def initialize(configuration:)
       @result = Truemail::Auditor::Result.new(configuration: configuration)
     end
@@ -18,5 +16,9 @@ module Truemail
       Truemail::Audit::Ip.check(result)
       self
     end
+
+    def as_json
+      Truemail::Log::Serializer::AuditorJson.call(self)
+    end
   end
 end

data/lib/truemail/configuration.rb

@@ -6,6 +6,7 @@ module Truemail
     DEFAULT_RESPONSE_TIMEOUT = 2
     DEFAULT_CONNECTION_ATTEMPTS = 2
     DEFAULT_VALIDATION_TYPE = :smtp
+    DEFAULT_LOGGER_OPTIONS = { tracking_event: :error, stdout: false, log_absolute_path: nil }.freeze
 
     attr_reader :email_pattern,
                 :smtp_error_body_pattern,
@@ -71,7 +72,8 @@ module Truemail
       end
     end
 
-    def logger=(tracking_event: :error, stdout: false, log_absolute_path: nil)
+    def logger=(options)
+      tracking_event, stdout, log_absolute_path = logger_options(options)
       valid_event = Truemail::Log::Event::TRACKING_EVENTS.key?(tracking_event)
       stdout_only = stdout && log_absolute_path.nil?
       file_only = log_absolute_path.is_a?(String)
@@ -109,7 +111,7 @@ module Truemail
     end
 
     def validate_arguments(argument, method)
-      constant = Truemail::RegexConstant.const_get("regex_#{method[/\A.+_(.+)\=\z/, 1]}_pattern".upcase)
+      constant = Truemail::RegexConstant.const_get("regex_#{method[/\A.+_(.+)=\z/, 1]}_pattern".upcase)
       raise_unless(argument, method, constant.match?(argument.to_s))
     end
 
@@ -140,5 +142,9 @@ module Truemail
         check_validation_type(validation_type)
       end
     end
+
+    def logger_options(current_options)
+      Truemail::Configuration::DEFAULT_LOGGER_OPTIONS.merge(current_options).values
+    end
   end
 end

data/lib/truemail/core.rb

@@ -4,12 +4,14 @@ module Truemail
   require_relative '../truemail/version'
   require_relative '../truemail/configuration'
   require_relative '../truemail/worker'
+  require_relative '../truemail/executor'
   require_relative '../truemail/wrapper'
   require_relative '../truemail/auditor'
   require_relative '../truemail/validator'
   require_relative '../truemail/logger'
 
   ConfigurationError = Class.new(StandardError)
+  TypeError = Class.new(StandardError)
 
   ArgumentError = Class.new(StandardError) do
     def initialize(arg_value, arg_name)
@@ -29,8 +31,8 @@ module Truemail
   end
 
   module RegexConstant
-    REGEX_DOMAIN = /[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}/i.freeze
-    REGEX_EMAIL_PATTERN = /(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@(#{REGEX_DOMAIN})\z)/.freeze
+    REGEX_DOMAIN = /[\p{L}0-9]+([\-.]{1}[\p{L}0-9]+)*\.\p{L}{2,63}/i.freeze
+    REGEX_EMAIL_PATTERN = /(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|.|+]*)@(#{REGEX_DOMAIN})\z)/.freeze
     REGEX_DOMAIN_PATTERN = /(?=\A.{4,255}\z)(\A#{REGEX_DOMAIN}\z)/.freeze
     REGEX_DOMAIN_FROM_EMAIL = /\A.+@(.+)\z/.freeze
     REGEX_SMTP_ERROR_BODY_PATTERN = /(?=.*550)(?=.*(user|account|customer|mailbox)).*/i.freeze
@@ -56,7 +58,9 @@ module Truemail
   module Log
     require_relative '../truemail/log/event'
     require_relative '../truemail/log/serializer/base'
-    require_relative '../truemail/log/serializer/text'
-    require_relative '../truemail/log/serializer/json'
+    require_relative '../truemail/log/serializer/auditor_json'
+    require_relative '../truemail/log/serializer/validator_base'
+    require_relative '../truemail/log/serializer/validator_text'
+    require_relative '../truemail/log/serializer/validator_json'
   end
 end

data/lib/truemail/executor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Truemail
+  class Executor
+    attr_reader :result
+
+    def run; end
+
+    def as_json; end
+  end
+end

data/lib/truemail/log/serializer/auditor_json.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Truemail
+  module Log
+    module Serializer
+      class AuditorJson < Truemail::Log::Serializer::Base
+        def serialize
+          result.to_json
+        end
+
+        private
+
+        def result
+          @result ||=
+            {
+              date: Time.now,
+              current_host_ip: executor_result.current_host_ip,
+              warnings: warnings(executor_result.warnings),
+              configuration: configuration
+            }
+        end
+      end
+    end
+  end
+end

data/lib/truemail/log/serializer/base.rb

@@ -4,47 +4,35 @@ module Truemail
   module Log
     module Serializer
       class Base
+        require 'json'
+
         DEFAULT_GEM_VALUE = 'default gem value'
 
-        def self.call(validator_instance)
-          new(validator_instance).serialize
+        def self.call(executor_instance)
+          new(executor_instance).serialize
         end
 
-        def initialize(validator_instance)
-          @validation_type = validator_instance.validation_type
-          @validation_result = validator_instance.result
-          @validation_configuration = validation_result.configuration
+        def initialize(executor_instance)
+          @executor_result = executor_instance.result
+          @executor_configuration = executor_result.configuration
         end
 
         def serialize; end
 
         private
 
-        attr_reader :validation_type, :validation_result, :validation_configuration
+        attr_reader :executor_result, :executor_configuration
 
-        def errors
-          validation_errors = validation_result.errors
-          return if validation_errors.empty?
-          validation_errors
+        def errors(executor_result_target)
+          return if executor_result_target.empty?
+          executor_result_target
         end
 
-        def smtp_debug
-          validation_smtp_debug = validation_result.smtp_debug
-          return unless validation_smtp_debug
-          validation_smtp_debug.map do |smtp_request|
-            smtp_response = smtp_request.response
-            {
-              mail_host: smtp_request.host,
-              port_opened: smtp_response.port_opened,
-              connection: smtp_response.connection,
-              errors: smtp_response.errors
-            }
-          end
-        end
+        alias warnings errors
 
         %i[validation_type_by_domain whitelisted_domains blacklisted_domains].each do |method|
           define_method(method) do
-            value = validation_configuration.public_send(method)
+            value = executor_configuration.public_send(method)
             return if value.empty?
             value
           end
@@ -52,7 +40,7 @@ module Truemail
 
         %i[email_pattern smtp_error_body_pattern].each do |method|
           define_method(method) do
-            value = validation_configuration.public_send(method)
+            value = executor_configuration.public_send(method)
             default_pattern = Truemail::RegexConstant.const_get(
               (method.eql?(:email_pattern) ? :regex_email_pattern : :regex_smtp_error_body_pattern).upcase
             )
@@ -64,28 +52,15 @@ module Truemail
         def configuration
           {
             validation_type_by_domain: validation_type_by_domain,
-            whitelist_validation: validation_configuration.whitelist_validation,
+            whitelist_validation: executor_configuration.whitelist_validation,
             whitelisted_domains: whitelisted_domains,
             blacklisted_domains: blacklisted_domains,
-            not_rfc_mx_lookup_flow: validation_configuration.not_rfc_mx_lookup_flow,
-            smtp_safe_check: validation_configuration.smtp_safe_check,
+            not_rfc_mx_lookup_flow: executor_configuration.not_rfc_mx_lookup_flow,
+            smtp_safe_check: executor_configuration.smtp_safe_check,
             email_pattern: email_pattern,
             smtp_error_body_pattern: smtp_error_body_pattern
           }
         end
-
-        def result
-          @result ||=
-            {
-              date: Time.now,
-              email: validation_result.email,
-              validation_type: validation_type,
-              success: validation_result.success,
-              errors: errors,
-              smtp_debug: smtp_debug,
-              configuration: configuration
-            }
-        end
       end
     end
   end

data/lib/truemail/log/serializer/validator_base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Truemail
+  module Log
+    module Serializer
+      class ValidatorBase < Truemail::Log::Serializer::Base
+        def initialize(executor_instance)
+          @validation_type = executor_instance.validation_type
+          super
+        end
+
+        private
+
+        attr_reader :validation_type
+
+        def smtp_debug
+          validation_smtp_debug = executor_result.smtp_debug
+          return unless validation_smtp_debug
+          validation_smtp_debug.map do |smtp_request|
+            smtp_response = smtp_request.response
+            {
+              mail_host: smtp_request.host,
+              port_opened: smtp_response.port_opened,
+              connection: smtp_response.connection,
+              errors: smtp_response.errors
+            }
+          end
+        end
+
+        def result
+          @result ||=
+            {
+              date: Time.now,
+              email: executor_result.email,
+              validation_type: validation_type,
+              success: executor_result.success,
+              errors: errors(executor_result.errors),
+              smtp_debug: smtp_debug,
+              configuration: configuration
+            }
+        end
+      end
+    end
+  end
+end

data/lib/truemail/log/serializer/{json.rb → validator_json.rb}

@@ -3,7 +3,7 @@
 module Truemail
   module Log
     module Serializer
-      class Json < Truemail::Log::Serializer::Base
+      class ValidatorJson < Truemail::Log::Serializer::ValidatorBase
         def serialize
           result.to_json
         end

data/lib/truemail/log/serializer/{text.rb → validator_text.rb}

@@ -3,7 +3,7 @@
 module Truemail
   module Log
     module Serializer
-      class Text < Truemail::Log::Serializer::Base
+      class ValidatorText < Truemail::Log::Serializer::ValidatorBase
         ATTEMPT = 'ATTEMPT #'
 
         def serialize
@@ -30,7 +30,7 @@ module Truemail
 
         def collection_printer(collection)
           collection.inject([]) { |array, hash| array << printer(hash) }.map.with_index do |item, index|
-            "\n#{Truemail::Log::Serializer::Text::ATTEMPT}#{index + 1}:\n#{item}\n"
+            "\n#{Truemail::Log::Serializer::ValidatorText::ATTEMPT}#{index + 1}:\n#{item}\n"
           end
         end
 

data/lib/truemail/logger.rb

@@ -15,7 +15,7 @@ module Truemail
     def push(validator_instance)
       current_event = Truemail::Log::Event.new(event, validator_instance)
       return unless current_event.valid?
-      create_logs(current_event.log_level, Truemail::Log::Serializer::Text.call(validator_instance))
+      create_logs(current_event.log_level, Truemail::Log::Serializer::ValidatorText.call(validator_instance))
     end
 
     private

data/lib/truemail/validate/smtp/request.rb

@@ -31,8 +31,8 @@ module Truemail
         end
 
         def run
-          session.start do |smtp_request|
-            response.connection = true
+          session.start(configuration.verifier_domain) do |smtp_request|
+            response.connection = response.helo = true
             smtp_handshakes(smtp_request, response)
           end
         rescue => error
@@ -83,7 +83,6 @@ module Truemail
 
         def session_data
           {
-            helo: configuration.verifier_domain,
             mailfrom: configuration.verifier_email,
             rcptto: email
           }

data/lib/truemail/validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Truemail
-  class Validator
+  class Validator < Truemail::Executor
     RESULT_ATTRS = %i[success email domain mail_servers errors smtp_debug configuration].freeze
     VALIDATION_TYPES = %i[regex mx smtp].freeze
 
@@ -16,9 +16,9 @@ module Truemail
       alias_method :valid?, :success
     end
 
-    attr_reader :validation_type, :result
+    attr_reader :validation_type
 
-    def initialize(email, with: nil, configuration:)
+    def initialize(email, configuration:, with: nil)
       with ||= configuration.default_validation_type
       raise Truemail::ArgumentError.new(with, :argument) unless Truemail::Validator::VALIDATION_TYPES.include?(with)
       @result = Truemail::Validator::Result.new(email: email, configuration: configuration)
@@ -33,7 +33,7 @@ module Truemail
     end
 
     def as_json
-      Truemail::Log::Serializer::Json.call(self)
+      Truemail::Log::Serializer::ValidatorJson.call(self)
     end
 
     private

data/lib/truemail/version.rb

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

data/truemail.gemspec

@@ -13,9 +13,17 @@ Gem::Specification.new do |spec|
   spec.summary       = %(truemail)
   spec.description   = %(Configurable framework agnostic plain Ruby email validator. Verify email via Regex, DNS and SMTP.)
 
-  spec.homepage      = 'https://github.com/rubygarage/truemail'
+  spec.homepage      = 'https://github.com/truemail-rb/truemail'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'homepage_uri' => 'https://truemail-rb.org',
+    'changelog_uri' => 'https://github.com/truemail-rb/truemail/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/truemail-rb/truemail',
+    'documentation_uri' => 'https://truemail-rb.org/truemail-gem',
+    'bug_tracker_uri' => 'https://github.com/truemail-rb/truemail/issues'
+  }
+
   spec.required_ruby_version = '>= 2.5.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -26,18 +34,18 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'simpleidn', '~> 0.1.1'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'bundler-audit', '~> 0.6.1'
+  spec.add_development_dependency 'bundler-audit', '~> 0.7.0.1'
   spec.add_development_dependency 'fasterer', '~> 0.8.3'
-  spec.add_development_dependency 'ffaker', '~> 2.14'
+  spec.add_development_dependency 'ffaker', '~> 2.17'
   spec.add_development_dependency 'json_matchers', '~> 0.11.1'
-  spec.add_development_dependency 'overcommit', '~> 0.53.0'
+  spec.add_development_dependency 'overcommit', '~> 0.57.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
-  spec.add_development_dependency 'reek', '~> 6.0'
+  spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.2'
   spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5', '>= 1.5.2'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8', '>= 1.8.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43', '>= 1.43.2'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'truemail-rspec', '~> 0.1.2'
+  spec.add_development_dependency 'truemail-rspec', '~> 0.2.1'
 end