truemail 0.1.1.2 → 0.1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13520ee41d1b2cc2f2fdf79a85445b801f3b9e957724874e0280d3f8100b5f31
-  data.tar.gz: bb099da51d9bd3625dcb3849848d94d574399d2013dd2bcb4371cc1de32b592b
+  metadata.gz: 047d26e7e9e7843b9db9f4bad1d45fc758a2db21e0b1b08f161dd798fdbb9019
+  data.tar.gz: 520f4f237023451512359176b728f2b1d4d85721a6ffa0924d0062f7a7e5fa6e
 SHA512:
-  metadata.gz: 6e3b77f459df942ba079408dde029f1bdc298ab4a9667f978b69ad690c17b7aaf19ac2e8c25fa840eea6392957b95e48117b0f05e48d6506fec290f371f98e92
-  data.tar.gz: 579b1880a838097e3f15736e37fb093f2563ba85cd8799ab8e7d8caa0d1b3fa3ace672dea85872c15faccd98aea662585b8a4dc8b053fc99e20c25b5260ecbd8
+  metadata.gz: 31af7442e139b2812cf329ecd239df80bb56d989aa4e157f05253ec3f371539277389017550acd6000b171872716d2304420e9df11efbc7711681362c81d2d19
+  data.tar.gz: 15f647100c86ab2281fe3a62cd370616ac967340f84f0a19d9c3ae20984b9f7d02194a5fd57f3b9edba9725954077db1db94ca8ebadece4598a910095b74aaf2

data/.reek.yml

@@ -17,15 +17,9 @@ detectors:
 
   UtilityFunction:
     exclude:
-      - Truemail::Validate::Mx#mx_records
-      - Truemail::Validate::Smtp::Request#configuration
       - Truemail::Validate::Smtp::Request#compose_from
       - Truemail::Validator#select_validation_type
 
   ControlParameter:
     exclude:
       - Truemail::GenerateEmailHelper#calculate_email_size
-
-  NilCheck:
-    exclude:
-      - Truemail::Validator#select_validation_type

data/.rubocop.yml

@@ -10,12 +10,6 @@ Metrics/LineLength:
 Documentation:
   Enabled: false
 
-FrozenStringLiteralComment:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
 

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,8 @@
 # Truemail
 
-[![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/feature/validator-result-class.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/feature/validator-result-class)
+[![Maintainability](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/maintainability)](https://codeclimate.com/github/rubygarage/truemail/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/657aa241399927dcd2e2/test_coverage)](https://codeclimate.com/github/rubygarage/truemail/test_coverage) [![Gem Version](https://badge.fury.io/rb/truemail.svg)](https://badge.fury.io/rb/truemail) [![CircleCI](https://circleci.com/gh/rubygarage/truemail/tree/develop.svg?style=svg)](https://circleci.com/gh/rubygarage/truemail/tree/develop)
 
-The main idea of this gem is to validate emails by regex pattern, presence of domain mx-records, and real existence of email account on a current email server.
+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.
 
 ## Installation
 
@@ -22,13 +22,13 @@ Or install it yourself as:
 
 ## Email Validation Methods
 
-Email validation is a tricky thing to do properly. There are a number of different ways to validate an email address. All checking mechanisms conform to best practices, and provide confident validation.
+Email validation is a tricky thing. There are a number of different ways to validate an email address and all mechanisms must conform with the best practices and provide proper validation.
 
-**Syntax Checking**: This checks the email addresses via regex pattern.
+**Syntax Checking**: Checks the email addresses via regex pattern.
 
-**Mail Server Existence Check**: This checks the availability of the email address domain using DNS MX records.
+**Mail Server Existence Check**: Checks the availability of the email address domain using DNS MX records.
 
-**Mail Existence Check**: This checks if the email address really exists and can receive email via SMTP connections and email-sending emulation techniques.
+**Mail Existence Check**: Checks if the email address really exists and can receive email via SMTP connections and email-sending emulation techniques.
 
 ## Usage
 
@@ -36,27 +36,27 @@ Email validation is a tricky thing to do properly. There are a number of differe
 
 #### Set configuration
 
-To have access for Truemail.configuration and gem features you must configure it first. Just do it with block like in example below.
+To have an access for ```Truemail.configuration``` and gem features, you must configure it first as in the example below:
 
 ```ruby
 Truemail.configure do |config|
-  # Required parameter. Should be an existing email on behalf of which verification will be performed
+  # Required parameter. Must be an existing email on behalf of which verification will be performed
   config.verifier_email = 'verifier@example.com'
 
-  # Optional parameter. Should be an existing domain on behalf of which verification will be performed.
+  # Optional parameter. Must be an existing domain on behalf of which verification will be performed.
   # By default verifier domain based on verifier email
   config.verifier_domain = 'somedomain.com'
 
   # Optional parameter. You can override default regex pattern
   config.email_pattern = /regex_pattern/
 
-  # Optional parameter. By default connection timeout is equal to 2 ms
+  # Optional parameter. Connection timeout is equal to 2 ms by default.
   config.connection_timeout = 1
 
-  # Optional parameter. By default smtp response timeout is equal to 2 ms
+  # Optional parameter. A SMTP server response timeout is equal to 2 ms by default.
   config.response_timeout = 1
 
-  # Optional parameter. You can to predefined which validation use for some domains
+  # 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
   # All of validations for 'somedomain.com' will be processed with mx validation only
@@ -66,7 +66,7 @@ end
 
 #### Read configuration
 
-After successful configuration you can read current Truemail configuration instance anywhere in your application.
+After successful configuration, you can read current Truemail configuration instance anywhere in your application.
 
 ```ruby
 Truemail.configuration
@@ -113,9 +113,9 @@ Truemail.configuration
 
 #### Regex validation
 
-Validation with regex pattern is first validation level. You can redefine regex pattern in gem configuration.
+Validation with regex pattern is the first validation level.
 
-Examples of using:
+Example of usage:
 
 1. With default regex pattern
 
@@ -131,7 +131,7 @@ Truemail.validate('email@example.com', with: :regex)
  @validation_type=:regex>
 ```
 
-2. With custom regex pattern
+2. With custom regex pattern. You should define your custom regex pattern in a gem configuration before.
 
 ```ruby
 Truemail.configure do |config| 
@@ -147,9 +147,9 @@ Truemail.validate('email@example.com', with: :regex)
 
 #### MX validation
 
-Validation by MX records is second validation level. It use Regex validation before run. When regex validation has completed successfully then starts itself.
+Validation by MX records is second validation level. It uses Regex validation before launch. When regex validation has completed successfully then runs itself.
 
-Example of using:
+Example of usage:
 
 ```ruby
 Truemail.configure do |config| 
@@ -165,13 +165,13 @@ Truemail.validate('email@example.com', with: :mx)
 
 #### SMTP validation
 
-SMTP validation is a final, third validation level. It try to check real existence of email account on a current email server. This validation runs chain of previous validations, and if they 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 runs itself.
 
 ```code
 [Regex validation] -> [MX validation] -> [SMTP validation]
 ```
 
-By default you don't need pass with-parameter to use it. Example of using:
+By default, you don't need pass with-parameter to use it. Example of usage is specified below:
 
 ```ruby
 Truemail.configure do |config| 

data/lib/truemail.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'truemail/version'
 require 'truemail/core'
 require 'truemail/configuration'
 require 'truemail/validator'
 
 module Truemail
-  INCOMPLETE_CONFIG = 'verifier_email is required parameter'.freeze
-  NOT_CONFIGURED = 'use Truemail.configure before'.freeze
+  INCOMPLETE_CONFIG = 'verifier_email is required parameter'
+  NOT_CONFIGURED = 'use Truemail.configure before'
 
   class << self
     def configuration

data/lib/truemail/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Truemail
   class Configuration
     DEFAULT_CONNECTION_TIMEOUT = 2

data/lib/truemail/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Truemail
   class ConfigurationError < StandardError; end
 

data/lib/truemail/validate/base.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Base
       attr_reader :result
 
-      def initialize(result)
-        @result = result
-      end
-
       def self.check(result)
         new(result).run
       end
 
+      def initialize(result)
+        @result = result
+      end
+
       private
 
       def success(condition)

data/lib/truemail/validate/mx.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Mx < Truemail::Validate::Base
       require 'resolv'
 
-      ERROR = 'mx records not found'.freeze
+      ERROR = 'mx records not found'
 
       def run
         return false unless Truemail::Validate::Regex.check(result)
         result.domain = result.email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]
-        return true if success(!result.mail_servers.push(*mx_records(result.domain)).empty?)
+        return true if success(!result.mail_servers.push(*mx_records).empty?)
         add_error(Truemail::Validate::Mx::ERROR)
         false
       end
 
       private
 
-      def mx_records(domain)
-        mx_records = Resolv::DNS.open { |dns| dns.getresources(domain, Resolv::DNS::Resource::IN::MX) }
+      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 }
       end
     end

data/lib/truemail/validate/regex.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Regex < Truemail::Validate::Base
-      ERROR = 'email does not match the regular expression'.freeze
+      ERROR = 'email does not match the regular expression'
 
       def run
         return true if success(Truemail.configuration.email_pattern.match?(result.email))

data/lib/truemail/validate/smtp.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Smtp < Truemail::Validate::Base
-      ERROR = 'smtp error'.freeze
+      ERROR = 'smtp error'
 
       attr_reader :smtp_results
 
@@ -38,7 +40,7 @@ module Truemail
       end
 
       def success_response?
-        !!smtp_results.map(&:response).find(&:rcptto)
+        smtp_results.map(&:response).any?(&:rcptto)
       end
     end
   end

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

@@ -1,22 +1,28 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Smtp
-      SMTP_PORT = 25
-      CONNECTION_TIMEOUT_ERROR = 'connection timed out'.freeze
-      RESPONSE_TIMEOUT_ERROR = 'server response timeout'.freeze
-      CONNECTION_DROPPED = 'server dropped connection after response'.freeze
-
-      Request = Struct.new(:host, :email, :response, keyword_init: true) do
+      class Request
         require 'net/smtp'
 
-        def initialize(response: Truemail::Validate::Smtp::Response.new, **args)
-          super
+        SMTP_PORT = 25
+        CONNECTION_TIMEOUT_ERROR = 'connection timed out'
+        RESPONSE_TIMEOUT_ERROR = 'server response timeout'
+        CONNECTION_DROPPED = 'server dropped connection after response'
+
+        attr_reader :host, :email, :response
+
+        def initialize(host:, email:)
+          @host = host
+          @email = email
+          @response = Truemail::Validate::Smtp::Response.new
         end
 
         def check_port
           Timeout.timeout(configuration.connection_timeout) do
             return response.port_opened =
-              !TCPSocket.new(host, Truemail::Validate::Smtp::SMTP_PORT).close
+              !TCPSocket.new(host, Truemail::Validate::Smtp::Request::SMTP_PORT).close
           end
         rescue Timeout::Error
           response.port_opened = false
@@ -34,11 +40,11 @@ module Truemail
         private
 
         def configuration
-          Truemail.configuration.dup.freeze
+          @configuration ||= Truemail.configuration.dup.freeze
         end
 
         def session
-          Net::SMTP.new(host, Truemail::Validate::Smtp::SMTP_PORT).tap do |settings|
+          Net::SMTP.new(host, Truemail::Validate::Smtp::Request::SMTP_PORT).tap do |settings|
             settings.open_timeout = configuration.connection_timeout
             settings.read_timeout = configuration.response_timeout
           end
@@ -46,9 +52,9 @@ module Truemail
 
         def compose_from(error)
           case error.class.name
-          when 'Net::OpenTimeout' then Truemail::Validate::Smtp::CONNECTION_TIMEOUT_ERROR
-          when 'Net::ReadTimeout' then Truemail::Validate::Smtp::RESPONSE_TIMEOUT_ERROR
-          when 'EOFError' then Truemail::Validate::Smtp::CONNECTION_DROPPED
+          when 'Net::OpenTimeout' then Truemail::Validate::Smtp::Request::CONNECTION_TIMEOUT_ERROR
+          when 'Net::ReadTimeout' then Truemail::Validate::Smtp::Request::RESPONSE_TIMEOUT_ERROR
+          when 'EOFError' then Truemail::Validate::Smtp::Request::CONNECTION_DROPPED
           else error.message
           end
         end
@@ -73,8 +79,8 @@ module Truemail
         end
 
         def smtp_handshakes(smtp_request, smtp_response)
-          !!session_data.each do |method, value|
-            break unless smtp_response.public_send(:"#{method}=", smtp_resolver(smtp_request, method, value))
+          session_data.all? do |method, value|
+            smtp_response.public_send(:"#{method}=", smtp_resolver(smtp_request, method, value))
           end
         end
       end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Truemail
   module Validate
     class Smtp
-      RESPONSE_ATTRS = %i[port_opened connection helo mailfrom rcptto errors]
+      RESPONSE_ATTRS = %i[port_opened connection helo mailfrom rcptto errors].freeze
 
       Response = Struct.new(*RESPONSE_ATTRS, keyword_init: true) do
         def initialize(errors: {}, **args)

data/lib/truemail/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Truemail
   class Validator
     RESULT_ATTRS = %i[success email domain mail_servers errors smtp_debug].freeze
@@ -14,7 +16,8 @@ module Truemail
 
     def initialize(email, with: :smtp)
       raise ArgumentError.new(with, :argument) unless VALIDATION_TYPES.include?(with)
-      @validation_type, @result = select_validation_type(email, with), Result.new(email: email)
+      @validation_type = select_validation_type(email, with)
+      @result = Result.new(email: email)
     end
 
     def run
@@ -26,7 +29,7 @@ module Truemail
 
     def select_validation_type(email, current_validation_type)
       domain = email[Truemail::RegexConstant::REGEX_EMAIL_PATTERN, 3]
-      Truemail.configuration&.validation_type_by_domain[domain] || current_validation_type
+      Truemail.configuration.validation_type_by_domain[domain] || current_validation_type
     end
   end
 end

data/lib/truemail/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Truemail
-  VERSION = '0.1.1.2'.freeze
+  VERSION = '0.1.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: truemail
 version: !ruby/object:Gem::Version
-  version: 0.1.1.2
+  version: 0.1.1.3
 platform: ruby
 authors:
 - Vladislav Trotsenko