truemail 1.7.1 → 2.0.0

data/lib/truemail.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'truemail/core'
+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/base.rb

@@ -3,12 +3,20 @@
 module Truemail
   module Audit
     class Base < Truemail::Worker
+      require 'net/http'
+      require 'ipaddr'
+      require 'resolv'
+
       private
 
       def add_warning(message)
         result.warnings[self.class.name.split('::').last.downcase.to_sym] = message
       end
 
+      def current_host_ip
+        result.current_host_ip
+      end
+
       def configuration
         result.configuration
       end

data/lib/truemail/audit/dns.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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'
+
+      def run
+        return if verifier_domain_refer_to_current_host_ip?
+        add_warning(Truemail::Audit::Dns::VERIFIER_DOMAIN_NOT_REFER)
+      end
+
+      private
+
+      def a_record
+        Truemail::Wrapper.call(configuration: configuration) do
+          Resolv::DNS.new.getaddress(verifier_domain).to_s
+        end
+      end
+
+      def verifier_domain_refer_to_current_host_ip?
+        a_record.eql?(current_host_ip)
+      end
+    end
+  end
+end

data/lib/truemail/audit/ip.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Truemail
+  module Audit
+    class Ip < Truemail::Audit::Base
+      GET_MY_IP_URL = 'https://api.ipify.org'
+      IPIFY_ERROR = 'impossible to detect current host address via third party service'
+
+      def run
+        return add_warning(Truemail::Audit::Ip::IPIFY_ERROR) unless detect_current_host_ip
+        Truemail::Audit::Dns.check(result)
+        Truemail::Audit::Ptr.check(result)
+      end
+
+      private
+
+      def detect_ip_via_ipify
+        Net::HTTP.get(URI(Truemail::Audit::Ip::GET_MY_IP_URL))
+      end
+
+      def detect_current_host_ip
+        result.current_host_ip = Truemail::Wrapper.call(configuration: configuration) do
+          detect_ip_via_ipify
+        end
+      end
+    end
+  end
+end

data/lib/truemail/audit/ptr.rb

@@ -3,38 +3,19 @@
 module Truemail
   module Audit
     class Ptr < Truemail::Audit::Base
-      require 'net/http'
-      require 'ipaddr'
-      require 'resolv'
-
-      GET_MY_IP_URL = 'https://api.ipify.org'
-      IPIFY_ERROR = 'impossible to detect current host address via third party service'
-      PTR_NOT_FOUND = 'ptr record for current host address was not found'
-      PTR_NOT_REFER = 'ptr record does not reference to current verifier domain'
-      VERIFIER_DOMAIN_NOT_REFER = 'a record of verifier domain not refers to current host address'
+      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 if !current_host_address && add_warning(Truemail::Audit::Ptr::IPIFY_ERROR)
-        return if ptr_records.empty? && add_warning(Truemail::Audit::Ptr::PTR_NOT_FOUND)
-        return if ptr_not_refer_to_verifier_domain? && add_warning(Truemail::Audit::Ptr::PTR_NOT_REFER)
-        return if verifier_domain_refer_to_current_host_address?
-        add_warning(Truemail::Audit::Ptr::VERIFIER_DOMAIN_NOT_REFER)
+        return add_warning(Truemail::Audit::Ptr::PTR_NOT_FOUND) if ptr_records.empty?
+        return if ptr_refer_to_verifier_domain?
+        add_warning(Truemail::Audit::Ptr::PTR_NOT_REFER)
       end
 
       private
 
-      def detect_ip_via_ipify
-        Net::HTTP.get(URI(Truemail::Audit::Ptr::GET_MY_IP_URL))
-      end
-
-      def current_host_address
-        @current_host_address ||= Truemail::Wrapper.call(configuration: configuration) do
-          IPAddr.new(detect_ip_via_ipify)
-        end
-      end
-
       def current_host_reverse_lookup
-        current_host_address.reverse
+        IPAddr.new(current_host_ip).reverse
       end
 
       def ptr_records
@@ -45,18 +26,8 @@ module Truemail
         end || []
       end
 
-      def ptr_not_refer_to_verifier_domain?
-        !ptr_records.include?(verifier_domain)
-      end
-
-      def a_record
-        Truemail::Wrapper.call(configuration: configuration) do
-          Resolv::DNS.new.getaddress(verifier_domain).to_s
-        end
-      end
-
-      def verifier_domain_refer_to_current_host_address?
-        a_record.eql?(current_host_address.to_s)
+      def ptr_refer_to_verifier_domain?
+        ptr_records.include?(verifier_domain)
       end
     end
   end

data/lib/truemail/auditor.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
 module Truemail
-  class Auditor
-    Result = Struct.new(:warnings, :configuration, keyword_init: true) do
+  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
 
     def run
-      Truemail::Audit::Ptr.check(result)
+      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

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 module Truemail
-  require 'truemail/version'
-  require 'truemail/configuration'
-  require 'truemail/worker'
-  require 'truemail/wrapper'
-  require 'truemail/auditor'
-  require 'truemail/validator'
-  require 'truemail/logger'
+  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,32 +31,36 @@ 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
   end
 
   module Audit
-    require 'truemail/audit/base'
-    require 'truemail/audit/ptr'
+    require_relative '../truemail/audit/base'
+    require_relative '../truemail/audit/ip'
+    require_relative '../truemail/audit/dns'
+    require_relative '../truemail/audit/ptr'
   end
 
   module Validate
-    require 'truemail/validate/base'
-    require 'truemail/validate/domain_list_match'
-    require 'truemail/validate/regex'
-    require 'truemail/validate/mx'
-    require 'truemail/validate/smtp'
-    require 'truemail/validate/smtp/response'
-    require 'truemail/validate/smtp/request'
+    require_relative '../truemail/validate/base'
+    require_relative '../truemail/validate/domain_list_match'
+    require_relative '../truemail/validate/regex'
+    require_relative '../truemail/validate/mx'
+    require_relative '../truemail/validate/smtp'
+    require_relative '../truemail/validate/smtp/response'
+    require_relative '../truemail/validate/smtp/request'
   end
 
   module Log
-    require 'truemail/log/event'
-    require 'truemail/log/serializer/base'
-    require 'truemail/log/serializer/text'
-    require 'truemail/log/serializer/json'
+    require_relative '../truemail/log/event'
+    require_relative '../truemail/log/serializer/base'
+    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