Feature/configurable smtp error body, #19 (#37)

* Implement Validate::Base#configuration * Implement configurable smtp error body * Update linter configuration * Update tests * Update readme * Update gem version
truemail-rb · May 10, 2019 · ef26feb · ef26feb
1 parent 22ead56
commit ef26feb
Show file tree

Hide file tree

Showing 15 changed files with 76 additions and 20 deletions.
diff --git a/.reek.yml b/.reek.yml
@@ -27,6 +27,7 @@ detectors:
     exclude:
       - Truemail::Validate::Smtp::Request#compose_from
       - Truemail::Validator#select_validation_type
+      - Truemail::Validate::Base#configuration
       - Truemail::Validate::Mx#null_mx?
       - Truemail::Validate::Mx#a_record
       - Truemail::Audit::Base#verifier_domain

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    truemail (0.1.9)
+    truemail (0.1.10)
 
 GEM
   remote: https://rubygems.org/
@@ -114,4 +114,4 @@ DEPENDENCIES
   truemail!
 
 BUNDLED WITH
-   1.16.6
+   1.17.3
diff --git a/README.md b/README.md
@@ -58,6 +58,9 @@ Truemail.configure do |config|
   # Optional parameter. You can override default regex pattern
   config.email_pattern = /regex_pattern/
 
+  # Optional parameter. You can override default regex pattern
+  config.smtp_error_body_pattern = /regex_pattern/
+
   # Optional parameter. Connection timeout is equal to 2 ms by default.
   config.connection_timeout = 1
 
@@ -92,6 +95,7 @@ Truemail.configuration
 => #<Truemail::Configuration:0x000055590cb17b40
  @connection_timeout=1,
  @email_pattern=/regex_pattern/,
+ @smtp_error_body_pattern=/regex_pattern/,
  @response_timeout=1,
  @connection_attempts=3,
  @validation_type_by_domain={},
@@ -114,6 +118,7 @@ Truemail.configuration
 => #<Truemail::Configuration:0x000055590cb17b40
  @connection_timeout=3,
  @email_pattern=/regex_pattern/,
+ @smtp_error_body_pattern=/regex_pattern/,
  @response_timeout=4,
  @connection_attempts=1,
  @validation_type_by_domain={},
@@ -270,6 +275,7 @@ Truemail.validate('email@example.com')
               #<Truemail::Configuration:0x0000000002d49930
               @connection_timeout=2,
               @email_pattern=/regex_pattern/,
+              @smtp_error_body_pattern=/regex_pattern/,
               @response_timeout=2,
               @connection_attempts=2,
               @smtp_safe_check=false,
@@ -323,6 +329,7 @@ Truemail.validate('email@example.com')
               #<Truemail::Configuration:0x0000000002c95b38
                 @connection_timeout=2,
                 @email_pattern=/regex_pattern/,
+                @smtp_error_body_pattern=/regex_pattern/,
                 @response_timeout=2,
                 @connection_attempts=2,
                 @smtp_safe_check=true,
@@ -360,6 +367,7 @@ Truemail.validate('email@example.com')
             #<Truemail::Configuration:0x0000000002d49930
               @connection_timeout=2,
               @email_pattern=/regex_pattern/,
+              @smtp_error_body_pattern=/regex_pattern/,
               @response_timeout=2,
               @connection_attempts=2,
               @smtp_safe_check=true,

diff --git a/lib/truemail/configuration.rb b/lib/truemail/configuration.rb
@@ -7,6 +7,7 @@ class Configuration
     DEFAULT_CONNECTION_ATTEMPTS = 2
 
     attr_reader :email_pattern,
+                :smtp_error_body_pattern,
                 :verifier_email,
                 :verifier_domain,
                 :connection_timeout,
@@ -20,16 +21,19 @@ class Configuration
 
     def initialize
       @email_pattern = Truemail::RegexConstant::REGEX_EMAIL_PATTERN
+      @smtp_error_body_pattern = Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN
       @connection_timeout = Truemail::Configuration::DEFAULT_CONNECTION_TIMEOUT
       @response_timeout = Truemail::Configuration::DEFAULT_RESPONSE_TIMEOUT
       @connection_attempts = Truemail::Configuration::DEFAULT_CONNECTION_ATTEMPTS
       @validation_type_by_domain = {}
       @smtp_safe_check = false
     end
 
-    def email_pattern=(regex_pattern)
-      raise Truemail::ArgumentError.new(regex_pattern, Regexp) unless regex_pattern.is_a?(Regexp)
-      @email_pattern = regex_pattern
+    %i[email_pattern smtp_error_body_pattern].each do |method|
+      define_method("#{method}=") do |argument|
+        raise Truemail::ArgumentError.new(argument, __method__) unless argument.is_a?(Regexp)
+        instance_variable_set(:"@#{method}", argument)
+      end
     end
 
     def verifier_email=(email)

diff --git a/lib/truemail/core.rb b/lib/truemail/core.rb
@@ -21,6 +21,7 @@ module RegexConstant
     REGEX_EMAIL_PATTERN = /(?=\A.{6,255}\z)(\A([a-zA-Z0-9]+[\w|\-|\.|\+]*)@(#{REGEX_DOMAIN})\z)/
     REGEX_DOMAIN_PATTERN = /(?=\A.{4,255}\z)(\A#{REGEX_DOMAIN}\z)/
     REGEX_DOMAIN_FROM_EMAIL = /\A.+@(.+)\z/
+    REGEX_SMTP_ERROR_BODY_PATTERN = /(?=.*550)(?=.*(user|account|customer|mailbox)).*/i
   end
 
   module Audit

diff --git a/lib/truemail/validate/base.rb b/lib/truemail/validate/base.rb
@@ -12,6 +12,10 @@ def add_error(message)
       def mail_servers
         result.mail_servers
       end
+
+      def configuration
+        Truemail.configuration
+      end
     end
   end
 end
diff --git a/lib/truemail/validate/regex.rb b/lib/truemail/validate/regex.rb
@@ -6,7 +6,7 @@ class Regex < Truemail::Validate::Base
       ERROR = 'email does not match the regular expression'
 
       def run
-        return true if success(Truemail.configuration.email_pattern.match?(result.email))
+        return true if success(configuration.email_pattern.match?(result.email))
         add_error(Truemail::Validate::Regex::ERROR)
         false
       end

diff --git a/lib/truemail/validate/smtp.rb b/lib/truemail/validate/smtp.rb
@@ -4,7 +4,6 @@ module Truemail
   module Validate
     class Smtp < Truemail::Validate::Base
       ERROR = 'smtp error'
-      ERROR_BODY = /(?=.*550)(?=.*(user|account|customer|mailbox)).*/i
 
       attr_reader :smtp_results
 
@@ -31,7 +30,7 @@ def request
 
       def attempts
         @attempts ||=
-          mail_servers.one? ? { attempts: Truemail.configuration.connection_attempts } : {}
+          mail_servers.one? ? { attempts: configuration.connection_attempts } : {}
       end
 
       def rcptto_error
@@ -53,11 +52,11 @@ def success_response?
       end
 
       def not_includes_user_not_found_errors?
-        return unless Truemail.configuration.smtp_safe_check
+        return unless configuration.smtp_safe_check
         result.smtp_debug.map(&:response).map(&:errors).all? do |errors|
           next true unless errors.key?(:rcptto)
           errors.slice(:rcptto).values.none? do |error|
-            Truemail::Validate::Smtp::ERROR_BODY.match?(error)
+            configuration.smtp_error_body_pattern.match?(error)
           end
         end
       end

diff --git a/lib/truemail/version.rb b/lib/truemail/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Truemail
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end
diff --git a/spec/support/shared_examples/has_attr_accessor.rb b/spec/support/shared_examples/has_attr_accessor.rb
@@ -4,6 +4,7 @@ module Truemail
   RSpec.shared_examples 'has attr_accessor' do
     %i[
       email_pattern
+      smtp_error_body_pattern
       verifier_email
       verifier_domain
       connection_timeout

diff --git a/spec/support/shared_examples/sets_default_configuration.rb b/spec/support/shared_examples/sets_default_configuration.rb
@@ -3,7 +3,8 @@
 module Truemail
   RSpec.shared_examples 'sets default configuration' do
     it 'sets default configuration settings' do
-      expect(configuration_instance.email_pattern).to be_an_instance_of(Regexp)
+      expect(configuration_instance.email_pattern).to eq(Truemail::RegexConstant::REGEX_EMAIL_PATTERN)
+      expect(configuration_instance.smtp_error_body_pattern).to eq(Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN)
       expect(configuration_instance.verifier_email).to be_nil
       expect(configuration_instance.verifier_domain).to be_nil
       expect(configuration_instance.connection_timeout).to eq(Truemail::Configuration::DEFAULT_CONNECTION_TIMEOUT)

diff --git a/spec/truemail/configuration_spec.rb b/spec/truemail/configuration_spec.rb
@@ -30,6 +30,7 @@
     context 'when auto configuration' do
       let(:configuration_instance_expectaions) do
         expect(configuration_instance.email_pattern).to eq(Truemail::RegexConstant::REGEX_EMAIL_PATTERN)
+        expect(configuration_instance.smtp_error_body_pattern).to eq(Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN)
         expect(configuration_instance.connection_timeout).to eq(2)
         expect(configuration_instance.response_timeout).to eq(2)
         expect(configuration_instance.connection_attempts).to eq(2)
@@ -46,6 +47,7 @@
           .and change(configuration_instance, :complete?)
           .from(false).to(true)
           .and not_change(configuration_instance, :email_pattern)
+          .and not_change(configuration_instance, :smtp_error_body_pattern)
           .and not_change(configuration_instance, :connection_timeout)
           .and not_change(configuration_instance, :response_timeout)
           .and not_change(configuration_instance, :validation_type_by_domain)
@@ -63,6 +65,7 @@
           .and change(configuration_instance, :complete?)
           .from(false).to(true)
           .and not_change(configuration_instance, :email_pattern)
+          .and not_change(configuration_instance, :smtp_error_body_pattern)
           .and not_change(configuration_instance, :connection_timeout)
           .and not_change(configuration_instance, :response_timeout)
           .and not_change(configuration_instance, :validation_type_by_domain)
@@ -80,6 +83,7 @@
           .and change(configuration_instance, :complete?)
           .from(false).to(true)
           .and not_change(configuration_instance, :email_pattern)
+          .and not_change(configuration_instance, :smtp_error_body_pattern)
           .and not_change(configuration_instance, :connection_timeout)
           .and not_change(configuration_instance, :response_timeout)
           .and not_change(configuration_instance, :validation_type_by_domain)
@@ -150,12 +154,29 @@
           end
         end
 
-        context 'with invalid value' do
-          specify do
-            expect { configuration_instance.email_pattern = 'not_regex_object' }
-              .to raise_error(Truemail::ArgumentError)
+        context 'with invalid email pattern' do
+          let(:setter) { :email_pattern= }
+
+          include_examples 'raises argument error'
+        end
+      end
+
+      describe '#smtp_error_body_pattern=' do
+        context 'with valid value' do
+          let(:valid_smtp_error_body_pattern) { /\d+/ }
+
+          it 'sets custom email pattern' do
+            expect { configuration_instance.smtp_error_body_pattern = valid_smtp_error_body_pattern }
+              .to change(configuration_instance, :smtp_error_body_pattern)
+              .from(Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN).to(valid_smtp_error_body_pattern)
           end
         end
+
+        context 'with invalid smtp error body pattern' do
+          let(:setter) { :smtp_error_body_pattern= }
+
+          include_examples 'raises argument error'
+        end
       end
 
       describe '#connection_timeout=' do

diff --git a/spec/truemail/core_spec.rb b/spec/truemail/core_spec.rb
@@ -14,6 +14,7 @@ module Truemail
       specify { expect(described_class).to be_const_defined(:REGEX_EMAIL_PATTERN) }
       specify { expect(described_class).to be_const_defined(:REGEX_DOMAIN_PATTERN) }
       specify { expect(described_class).to be_const_defined(:REGEX_DOMAIN_FROM_EMAIL) }
+      specify { expect(described_class).to be_const_defined(:REGEX_SMTP_ERROR_BODY_PATTERN) }
     end
 
     describe 'Truemail::RegexConstant::REGEX_EMAIL_PATTERN' do
@@ -121,6 +122,16 @@ module Truemail
       specify { expect(regex_pattern.match?(email)).to be(true) }
       specify { expect(email[regex_pattern, 1]).to eq('domain') }
     end
+
+    describe 'Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN' do
+      subject(:regex_pattern) { described_class::REGEX_SMTP_ERROR_BODY_PATTERN }
+
+      let(:smtp_error_context) { 'some smtp 550 error with' }
+
+      %w[user account customer mailbox].map { |item| [item, item.upcase] }.flatten.each do |account_name_type|
+        specify { expect(regex_pattern.match?("#{smtp_error_context} #{account_name_type}")).to be(true) }
+      end
+    end
   end
 
   RSpec.describe Truemail::Validate do

diff --git a/spec/truemail/validate/smtp_spec.rb b/spec/truemail/validate/smtp_spec.rb
@@ -7,7 +7,6 @@
 
   describe 'defined constants' do
     specify { expect(described_class).to be_const_defined(:ERROR) }
-    specify { expect(described_class).to be_const_defined(:ERROR_BODY) }
     specify { expect(described_class).to be_const_defined(:RESPONSE_ATTRS) }
     specify { expect(described_class).to be_const_defined(:Response) }
     specify { expect(described_class).to be_const_defined(:Request) }
@@ -206,8 +205,10 @@
           end
 
           context 'when smtp user error has been detected' do
+            let(:smtp_error_context) { 'some 550 error with user or account in body' }
+
             context 'with error in rcptto response' do
-              let(:smtp_error_context_2) { 'some 550 error with user or account in body' }
+              let(:smtp_error_context_2) { smtp_error_context }
 
               specify do
                 allow(result_instance.mail_servers).to receive(:each)
@@ -225,7 +226,7 @@
 
             context 'with error in others smtp responses' do
               context 'with error in rcptto response' do
-                let(:smtp_error_context_1) { 'some 550 error with user or account in body' }
+                let(:smtp_error_context_1) { smtp_error_context }
 
                 specify do
                   allow(result_instance.mail_servers).to receive(:each)

diff --git a/spec/truemail_spec.rb b/spec/truemail_spec.rb
@@ -81,6 +81,7 @@
     let(:new_email) { FFaker::Internet.email }
     let(:new_domain) { FFaker::Internet.domain_name }
     let(:new_regex_pattern) { /\A+.\z/ }
+    let(:new_smtp_error_body_pattern) { /\A\d+\z/ }
 
     specify { expect(configuration).to be_instance_of(Truemail::Configuration) }
 
@@ -89,14 +90,17 @@
         configuration.tap(&configuration_block(
           verifier_email: new_email,
           verifier_domain: new_domain,
-          email_pattern: new_regex_pattern
+          email_pattern: new_regex_pattern,
+          smtp_error_body_pattern: new_smtp_error_body_pattern
           )
         )
       end
       .to change(configuration, :verifier_email).from(email).to(new_email)
       .and change(configuration, :verifier_domain).from(domain).to(new_domain)
       .and change(configuration, :email_pattern)
       .from(Truemail::RegexConstant::REGEX_EMAIL_PATTERN).to(new_regex_pattern)
+      .and change(configuration, :smtp_error_body_pattern)
+      .from(Truemail::RegexConstant::REGEX_SMTP_ERROR_BODY_PATTERN).to(new_smtp_error_body_pattern)
     end
   end