truemail 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4060f7dac2add0bb0d3db39eead01f018eea7e7b63777610786481196910ace3
-  data.tar.gz: 37d590352efefcd159e9ed57a9ffe67a06ca4be8bdc5fb15f3d7791b89f3ef61
+  metadata.gz: 8dbdc2b39f8f74cdf2965ab1bde2fd613647247827b64c322250046f1a9a22d5
+  data.tar.gz: f1acdd0da6664afa9e03e4031c45d957fbc765378dbc38553f4bae5f4f9569bf
 SHA512:
-  metadata.gz: 3071c58d0624ffd0a9bcc17e7859c75be4b0d63429315ad446b96d49f4a430dbfab95fb467780ed3efe1fadc55e5d9f0f796c8647197bff7f58cf67db903a45d
-  data.tar.gz: 8f451a87f8b7c39c3fe38ef2fe8d720ded9d06ceed7cf381c17edb51b3dbca13fce6b3e9d9143032ea38257da1e5f172ef1af54ae93d774b6d7da0f135eaefd3
+  metadata.gz: 772bba708fc85b90f2bc3785e40959f067a1ca10bce27c16016ef1f089928f480eb008ec53d18832ce110ae3b5a4c2043ea8c09095af1ce9b92ede14818975d8
+  data.tar.gz: 8d915247fa460b109c18f0e8bd359135c7e4ed738cd5265aa4cec76894910e6199c6e2370d0271674f45597e832501589dfc85e564ffc69846e20f050e20d9ce

data/.reek.yml

@@ -11,6 +11,8 @@ detectors:
     exclude:
       - Truemail::Validate::Smtp::Request#run
       - Truemail::Validate::Smtp#run
+      - Truemail::Validate::Mx#hosts_from_cname_records
+      - Truemail::Configuration#initialize
 
   TooManyInstanceVariables:
     exclude:
@@ -19,11 +21,13 @@ detectors:
   Attribute:
     exclude:
       - Truemail::Configuration#smtp_safe_check
+      - Truemail::Validate::ResolverExecutionWrapper#attempts
 
   UtilityFunction:
     exclude:
       - Truemail::Validate::Smtp::Request#compose_from
       - Truemail::Validator#select_validation_type
+      - Truemail::Validate::Mx#mx_records
 
   ControlParameter:
     exclude:

data/.rubocop.yml

@@ -35,3 +35,6 @@ RSpec/ContextWording:
 
 RSpec/AnyInstance:
   Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false

data/Gemfile.lock

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

data/README.md

@@ -4,6 +4,12 @@
 
 The Truemail gem helps you validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server.
 
+## Features
+
+- Configurable validator, validate only what you need
+- Zero runtime dependencies
+- 100% test coverage
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,6 +64,9 @@ Truemail.configure do |config|
   # Optional parameter. A SMTP server response timeout is equal to 2 ms by default.
   config.response_timeout = 1
 
+  # Optional parameter. Total of timeout retry. It is equal to 1 by default.
+  config.retry_count = 2
+
   # Optional parameter. You can predefine which type of validation will be used for domains.
   # Available validation types: :regex, :mx, :smtp
   # This configuration will be used over current or default validation type parameter
@@ -82,6 +91,7 @@ Truemail.configuration
  @connection_timeout=1,
  @email_pattern=/regex_pattern/,
  @response_timeout=1,
+ @retry_count=2,
  @validation_type_by_domain={},
  @verifier_domain="somedomain.com",
  @verifier_email="verifier@example.com"
@@ -95,12 +105,15 @@ Truemail.configuration.connection_timeout = 3
 => 3
 Truemail.configuration.response_timeout = 4
 => 4
+Truemail.configuration.retry_count = 1
+=> 1
 
 Truemail.configuration
 => #<Truemail::Configuration:0x000055590cb17b40
  @connection_timeout=3,
  @email_pattern=/regex_pattern/,
  @response_timeout=4,
+ @retry_count=1,
  @validation_type_by_domain={},
  @verifier_domain="somedomain.com",
  @verifier_email="verifier@example.com",
@@ -122,7 +135,7 @@ Truemail.configuration
 
 #### Regex validation
 
-Validation with regex pattern is the first validation level.
+Validation with regex pattern is the first validation level. By default this validation not performs strictly following RFC 5322 standart, so you can override Truemail default regex pattern if you want.
 
 Example of usage:
 
@@ -174,7 +187,7 @@ Truemail.validate('email@example.com', with: :regex)
 
 #### MX validation
 
-Validation by MX records is second validation level. It uses Regex validation before launch. When regex validation has completed successfully then runs itself.
+Validation by MX records is the second validation level. It uses Regex validation before running itself. When regex validation has completed successfully then runs itself. Truemail MX validation performs strictly following the [RFC 5321](https://tools.ietf.org/html/rfc5321#section-5) standard.
 
 Example of usage:
 
@@ -201,7 +214,7 @@ Truemail.validate('email@example.com', with: :mx)
 
 #### SMTP validation
 
-SMTP validation is a final, third validation level. This type of validation tries to check real existence of email account on a current email server. This validation runs a chain of previous validations, and if they're complete, successfully runs itself.
+SMTP validation is a final, third validation level. This type of validation tries to check real existence of email account on a current email server. This validation runs a chain of previous validations and if they're complete successfully then runs itself.
 
 ```code
 [Regex validation] -> [MX validation] -> [SMTP validation]
@@ -354,11 +367,39 @@ Truemail.validate('email@example.com')
     @validation_type=:smtp>
 ```
 
+### Truemail helpers
+
+#### .valid?
+
+You can use the ```.valid?``` helper for quick validation of email address. It returns a boolean:
+
+```ruby
+# It is shortcut for Truemail.validate('email@example.com').result.valid?
+Truemail.valid?('email@example.com')
+=> true
+```
+
+### Test environment
+
+You can stub out that validation for your test environment. Just add RSpec before action:
+
+```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  config.before { allow(Truemail).to receive(:valid?).and_return(true) }
+  # or
+  config.before { allow(Truemail).to receive(:validate).and_return(true) }
+  # or
+  config.before { allow(Truemail).to receive_message_chain(:validate, :result, :valid?).and_return(true) }
+end
+```
+
+---
 ## ToDo
 
 1. Gem compatibility with Ruby 2.3
 2. Fail validations logger
-3. The ability to use a proxy
 
 ## Contributing
 

data/lib/truemail.rb

@@ -32,5 +32,9 @@ module Truemail
       raise ConfigurationError, NOT_CONFIGURED unless configuration
       Truemail::Validator.new(email, **options).run
     end
+
+    def valid?(email, **options)
+      validate(email, **options).result.valid?
+    end
   end
 end

data/lib/truemail/configuration.rb

@@ -4,20 +4,23 @@ module Truemail
   class Configuration
     DEFAULT_CONNECTION_TIMEOUT = 2
     DEFAULT_RESPONSE_TIMEOUT = 2
+    DEFAULT_RETRY_COUNT = 1
 
     attr_reader :email_pattern,
                 :verifier_email,
                 :verifier_domain,
                 :connection_timeout,
                 :response_timeout,
+                :retry_count,
                 :validation_type_by_domain
 
     attr_accessor :smtp_safe_check
 
     def initialize
       @email_pattern = Truemail::RegexConstant::REGEX_EMAIL_PATTERN
-      @connection_timeout = DEFAULT_CONNECTION_TIMEOUT
-      @response_timeout = DEFAULT_RESPONSE_TIMEOUT
+      @connection_timeout = Truemail::Configuration::DEFAULT_CONNECTION_TIMEOUT
+      @response_timeout = Truemail::Configuration::DEFAULT_RESPONSE_TIMEOUT
+      @retry_count = Truemail::Configuration::DEFAULT_RETRY_COUNT
       @validation_type_by_domain = {}
       @smtp_safe_check = false
     end
@@ -38,7 +41,7 @@ module Truemail
       @verifier_domain = domain.downcase
     end
 
-    %i[connection_timeout response_timeout].each do |method|
+    %i[connection_timeout response_timeout retry_count].each do |method|
       define_method("#{method}=") do |argument|
         raise ArgumentError.new(argument, __method__) unless argument.is_a?(Integer) && argument.positive?
         instance_variable_set(:"@#{method}", argument)

data/lib/truemail/core.rb

@@ -19,6 +19,7 @@ module Truemail
   module Validate
     require 'truemail/validate/base'
     require 'truemail/validate/regex'
+    require 'truemail/validate/resolver_execution_wrapper'
     require 'truemail/validate/mx'
     require 'truemail/validate/smtp'
     require 'truemail/validate/smtp/response'

data/lib/truemail/validate/mx.rb

@@ -5,21 +5,62 @@ module Truemail
     class Mx < Truemail::Validate::Base
       require 'resolv'
 
-      ERROR = 'mx records not found'
+      ERROR = 'target host(s) not found'
 
       def run
         return false unless Truemail::Validate::Regex.check(result)
         result.domain = result.email[Truemail::RegexConstant::REGEX_DOMAIN_FROM_EMAIL, 1]
-        return true if success(!result.mail_servers.push(*mx_records).empty?)
+        return true if success(mx_lookup)
         add_error(Truemail::Validate::Mx::ERROR)
         false
       end
 
       private
 
-      def mx_records
-        mx_records = Resolv::DNS.open { |dns| dns.getresources(result.domain, Resolv::DNS::Resource::IN::MX) }
-        mx_records.sort_by(&:preference).map { |mx_record| mx_record.exchange.to_s }
+      def host_extractor_methods
+        %i[hosts_from_mx_records? hosts_from_cname_records? host_from_a_record?]
+      end
+
+      def mx_lookup
+        host_extractor_methods.any? do |method|
+          Truemail::Validate::ResolverExecutionWrapper.call { send(method) }
+        end
+      end
+
+      def fetch_target_hosts(hosts)
+        result.mail_servers.push(*hosts)
+      end
+
+      def mx_records(domain)
+        Resolv::DNS.new.getresources(domain, Resolv::DNS::Resource::IN::MX).sort_by(&:preference).map do |mx_record|
+          Resolv.getaddress(mx_record.exchange.to_s)
+        end
+      end
+
+      def mail_servers_found?
+        !result.mail_servers.empty?
+      end
+
+      def hosts_from_mx_records?
+        fetch_target_hosts(mx_records(result.domain))
+        mail_servers_found?
+      end
+
+      def hosts_from_cname_records?
+        cname_records = Resolv::DNS.new.getresources(result.domain, Resolv::DNS::Resource::IN::CNAME)
+        return if cname_records.empty?
+        cname_records.each do |cname_record|
+          host = Resolv.getaddress(cname_record.name.to_s)
+          hostname = Resolv.getname(host)
+          found_hosts = mx_records(hostname)
+          fetch_target_hosts(found_hosts.empty? ? [host] : found_hosts)
+        end
+        mail_servers_found?
+      end
+
+      def host_from_a_record?
+        fetch_target_hosts([Resolv.getaddress(result.domain)])
+        mail_servers_found?
       end
     end
   end

data/lib/truemail/validate/resolver_execution_wrapper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Truemail
+  module Validate
+    class ResolverExecutionWrapper
+      attr_accessor :attempts
+
+      def self.call(&block)
+        new.call(&block)
+      end
+
+      def initialize
+        @attempts = Truemail.configuration.retry_count
+      end
+
+      def call(&block)
+        Timeout.timeout(Truemail.configuration.connection_timeout, &block)
+      rescue Resolv::ResolvError
+        false
+      rescue Timeout::Error
+        retry unless (self.attempts -= 1).zero?
+        false
+      end
+    end
+  end
+end

data/lib/truemail/validate/smtp.rb

@@ -18,7 +18,7 @@ module Truemail
         establish_smtp_connection
         return true if success(success_response?)
         result.smtp_debug = smtp_results
-        return true if success(not_includes_user_not_found_errors)
+        return true if success(not_includes_user_not_found_errors?)
         add_error(Truemail::Validate::Smtp::ERROR)
         false
       end
@@ -45,7 +45,7 @@ module Truemail
         smtp_results.map(&:response).any?(&:rcptto)
       end
 
-      def not_includes_user_not_found_errors
+      def not_includes_user_not_found_errors?
         return unless Truemail.configuration.smtp_safe_check
         result.smtp_debug.map(&:response).map(&:errors).all? do |errors|
           next true unless errors.key?(:rcptto)

data/lib/truemail/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Vladislav Trotsenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,6 +195,7 @@ files:
 - lib/truemail/validate/base.rb
 - lib/truemail/validate/mx.rb
 - lib/truemail/validate/regex.rb
+- lib/truemail/validate/resolver_execution_wrapper.rb
 - lib/truemail/validate/smtp.rb
 - lib/truemail/validate/smtp/request.rb
 - lib/truemail/validate/smtp/response.rb