truemail 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c2fc87715dca966f6671f6b1d58d58e9d411bb01ae460ff31a34125d8f4a14'
-  data.tar.gz: 30ef54377bce7d03294e73dafbbb9d637ed8d6e55dfbf0931768a1246837b45d
+  metadata.gz: ce37fd460cb5da28f5880be61ac6abb5ca5e8d0fe1010738e45a02a70417fa31
+  data.tar.gz: 3f66bb5169a012e7bd77af80c40c51c021332cb86be4f2ef6f1450611001cebf
 SHA512:
-  metadata.gz: 9ef76732a55fb837e0f0eeb77da337a34b5b019e9f774debc777f5a4155c4a7ba6640ca245e106c90dd560814f87870513664a601986518e4f23399b1351ce56
-  data.tar.gz: 203da733353f7377bda0527d6f330281c1d8357b6e65ba384c3f80decfcc8cdbf2cec8b6f80a31aa967e22bfa9e4afa16c77d576412848f397ba91cfb2035e8e
+  metadata.gz: 4902f4e7d2c68cc8714c536ae1844904b99c7609a2b36d057902e6a838d2e2e33bb301f99b7cb067e108bb4bae845ec2e9dfbb9be529db8d53c9bf50a31dfdf9
+  data.tar.gz: f049315d919448d56d8082da28df31d1bc7ad6e191fc5b30629b38011ff4450f870fb7597a6bc4645007fe7bcbc4a7fa3b0855ee408f4115466e9a3496c926c8

data/CHANGELOG.md

@@ -1,6 +1,54 @@
 # Changelog
+
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2020.06.21
+
+## Added
+
+Separated audit features for verifier host.
+
+- `Truemail::Audit::Ip`
+- `Truemail::Audit::Dns`
+
+```ruby
+Truemail.host_audit
+
+=> #<Truemail::Auditor:0x00005580df358828
+@result=
+  #<struct Truemail::Auditor::Result
+    current_host_ip="127.0.0.1",
+    warnings={
+      :dns=>"a record of verifier domain not refers to current host ip address",
+      :ptr=>"ptr record does not reference to current verifier domain"
+    },
+    configuration=
+    #<Truemail::Configuration:0x00005615e86327a8
+      @blacklisted_domains=[],
+      @connection_attempts=2,
+      @connection_timeout=2,
+      @default_validation_type=:smtp,
+      @email_pattern=/(?=\A.{6,255}\z)(\A([\p{L}0-9]+[\w|\-|\.|\+]*)@((?i-mx:[\p{L}0-9]+([\-\.]{1}[\p{L}0-9]+)*\.[\p{L}]{2,63}))\z)/,
+      @response_timeout=2,
+      @smtp_error_body_pattern=/(?=.*550)(?=.*(user|account|customer|mailbox)).*/i,
+      @not_rfc_mx_lookup_flow=false,
+      @smtp_safe_check=false,
+      @validation_type_by_domain={},
+      @verifier_domain="example.com",
+      @verifier_email="verifier@example.com",
+      @whitelist_validation=false,
+      @whitelisted_domains=[]>
+```
+
+### Changed
+
+- `Truemail::Auditor`
+- `Truemail::Auditor::Result`
+- `Truemail::Audit::Base`
+- `Truemail::Audit::Ptr`
+- `Truemail::VERSION`
+- gem documentation
+
 ## [1.7.1] - 2020.05.10
 
 ## Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    truemail (1.7.1)
+    truemail (1.8.0)
       simpleidn (~> 0.1.1)
 
 GEM

data/README.md

@@ -36,7 +36,10 @@ Configurable framework agnostic plain Ruby email validator. Verify email via Reg
     - [Available tracking events](#available-tracking-events)
   - [JSON serializer](#json-serializer)
   - [Host audit features](#host-audit-features)
+    - [IP audit](#ip-audit)
+    - [DNS audit](#dns-audit)
     - [PTR audit](#ptr-audit)
+    - [Example of using](#example-of-using)
   - [Truemail helpers](#truemail-helpers)
     - [.valid?](#valid)
     - [#as_json](#as_json)
@@ -70,6 +73,7 @@ Also Truemail gem allows performing an audit of the host in which runs.
 - Whitelist/blacklist validation layers
 - Simple SMTP debugger
 - Event logger
+- Host auditor tools (helps to detect common host problems interfering to proper email verification)
 - JSON serializer
 
 ## Requirements
@@ -951,18 +955,31 @@ Truemail::Log::Serializer::Json.call(Truemail.validate('nonexistent_email@bestwe
 
 ### Host audit features
 
-Truemail gem allows performing an audit of the host in which runs. Only PTR record audit performs for today.
+Truemail gem allows performing an audit of the host in which runs. It will help to detect common host problems interfering to proper email verification.
+
+#### IP audit
+
+Checks is current Truemail host has proper internet connection and detects current host ip address.
+
+#### DNS audit
+
+Checks is verifier domain refer to current Truemail host IP address.
 
 #### PTR audit
 
 So what is a PTR record? A PTR record, or pointer record, enables someone to perform a reverse DNS lookup. This allows them to determine your domain name based on your IP address. Because generic domain names without a PTR are often associated with spammers, incoming mail servers identify email from hosts without PTR records as spam and you can't verify yours emails qualitatively.
 
+Checks is PTR record exists for your Truemail host ip address exists and refers to current verifier domain.
+
+#### Example of using
+
 ```ruby
 Truemail.host_audit
 # Everything is good
 => #<Truemail::Auditor:0x00005580df358828
    @result=
      #<struct Truemail::Auditor::Result
+       current_host_ip="127.0.0.1",
        warnings={}>,
        configuration=
         #<Truemail::Configuration:0x00005615e86327a8
@@ -981,12 +998,15 @@ Truemail.host_audit
          @whitelist_validation=false,
          @whitelisted_domains=[]>
 
-# Has PTR warning
+# Has audit warnings
 => #<Truemail::Auditor:0x00005580df358828
    @result=
      #<struct Truemail::Auditor::Result
-       warnings=
-         {:ptr=>"ptr record does not reference to current verifier domain"}>,
+       current_host_ip="127.0.0.1",
+       warnings={
+         :dns=>"a record of verifier domain not refers to current host ip address",
+         :ptr=>"ptr record does not reference to current verifier domain"
+       },
        configuration=
         #<Truemail::Configuration:0x00005615e86327a8
          @blacklisted_domains=[],

data/lib/truemail.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'truemail/core'
+require_relative 'truemail/core'
 
 module Truemail
   INCOMPLETE_CONFIG = 'verifier_email is required parameter'

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_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
@@ -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

@@ -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/core.rb

@@ -1,13 +1,13 @@
 # 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)
 
@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Vladislav Trotsenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simpleidn
@@ -277,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
@@ -302,7 +304,7 @@ homepage: https://github.com/rubygarage/truemail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -317,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: []