truemail 1.5.1 → 1.8.0

data/lib/truemail.rb

@@ -1,17 +1,16 @@
 # 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'
 
   class << self
-    def configuration
+    def configuration(&block)
       @configuration ||= begin
         return unless block_given?
-        configuration = Truemail::Configuration.new
-        yield(configuration)
+        configuration = Truemail::Configuration.new(&block)
         raise_unless(configuration.complete?, Truemail::INCOMPLETE_CONFIG)
         configuration
       end

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,37 +3,19 @@
 module Truemail
   module Audit
     class Ptr < Truemail::Audit::Base
-      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_FOUND = 'ptr record for current host ip 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'
 
       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
@@ -44,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

@@ -2,7 +2,7 @@
 
 module Truemail
   class Auditor
-    Result = Struct.new(:warnings, :configuration, keyword_init: true) do
+    Result = Struct.new(:current_host_ip, :warnings, :configuration, keyword_init: true) do
       def initialize(warnings: {}, **args)
         super
       end
@@ -15,7 +15,7 @@ module Truemail
     end
 
     def run
-      Truemail::Audit::Ptr.check(result)
+      Truemail::Audit::Ip.check(result)
       self
     end
   end

data/lib/truemail/configuration.rb

@@ -20,9 +20,7 @@ module Truemail
                 :blacklisted_domains,
                 :logger
 
-    attr_accessor :whitelist_validation, :smtp_safe_check
-
-    alias retry_count connection_attempts
+    attr_accessor :whitelist_validation, :not_rfc_mx_lookup_flow, :smtp_safe_check
 
     def initialize(&block)
       instance_initializer.each do |instace_variable, value|
@@ -101,6 +99,7 @@ module Truemail
         whitelisted_domains: [],
         whitelist_validation: false,
         blacklisted_domains: [],
+        not_rfc_mx_lookup_flow: false,
         smtp_safe_check: false
       }
     end

data/lib/truemail/core.rb

@@ -1,19 +1,19 @@
 # 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/wrapper'
+  require_relative '../truemail/auditor'
+  require_relative '../truemail/validator'
+  require_relative '../truemail/logger'
 
   ConfigurationError = Class.new(StandardError)
 
   ArgumentError = Class.new(StandardError) do
-    def initialize(current_param, class_name)
-      super("#{current_param} is not a valid #{class_name}")
+    def initialize(arg_value, arg_name)
+      super("#{arg_value} is not a valid #{arg_name}")
     end
   end
 
@@ -37,24 +37,26 @@ module Truemail
   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/text'
+    require_relative '../truemail/log/serializer/json'
   end
 end

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

@@ -67,6 +67,7 @@ module Truemail
             whitelist_validation: validation_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,
             email_pattern: email_pattern,
             smtp_error_body_pattern: smtp_error_body_pattern

data/lib/truemail/validate/mx.rb

@@ -19,6 +19,7 @@ module Truemail
       private
 
       def host_extractor_methods
+        return %i[hosts_from_mx_records?] if configuration.not_rfc_mx_lookup_flow
         %i[hosts_from_mx_records? hosts_from_cname_records? host_from_a_record?]
       end
 

data/lib/truemail/validator.rb

@@ -32,6 +32,10 @@ module Truemail
       self
     end
 
+    def as_json
+      Truemail::Log::Serializer::Json.call(self)
+    end
+
     private
 
     def select_validation_type(email, current_validation_type)

data/lib/truemail/version.rb

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

data/truemail.gemspec

@@ -27,17 +27,17 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'bundler-audit', '~> 0.6.1'
-  spec.add_development_dependency 'fasterer', '~> 0.8.1'
-  spec.add_development_dependency 'ffaker', '~> 2.13'
+  spec.add_development_dependency 'fasterer', '~> 0.8.3'
+  spec.add_development_dependency 'ffaker', '~> 2.14'
   spec.add_development_dependency 'json_matchers', '~> 0.11.1'
-  spec.add_development_dependency 'overcommit', '~> 0.52.1'
-  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'overcommit', '~> 0.53.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
-  spec.add_development_dependency 'reek', '~> 5.6'
+  spec.add_development_dependency 'reek', '~> 6.0'
   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.37', '>= 1.37.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'truemail-rspec', '~> 0.1.1'
+  spec.add_development_dependency 'truemail-rspec', '~> 0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simpleidn
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: json_matchers
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -210,20 +210,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -244,14 +238,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 description: Configurable framework agnostic plain Ruby email validator. Verify email
   via Regex, DNS and SMTP.
 email:
@@ -283,6 +277,8 @@ files:
 - bin/setup
 - lib/truemail.rb
 - lib/truemail/audit/base.rb
+- lib/truemail/audit/dns.rb
+- lib/truemail/audit/ip.rb
 - lib/truemail/audit/ptr.rb
 - lib/truemail/auditor.rb
 - lib/truemail/configuration.rb
@@ -308,7 +304,7 @@ homepage: https://github.com/rubygarage/truemail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -323,9 +319,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.3
+signing_key:
 specification_version: 4
 summary: truemail
 test_files: []