valid_email2 3.4.0 → 4.0.0

data/lib/valid_email2/address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal:true
+
 require "valid_email2"
 require "resolv"
 require "mail"
@@ -7,8 +9,8 @@ module ValidEmail2
     attr_accessor :address
 
     PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'`]/
-    DEFAULT_RECIPIENT_DELIMITER = '+'.freeze
-    DOT_DELIMITER = '.'.freeze
+    DEFAULT_RECIPIENT_DELIMITER = '+'
+    DOT_DELIMITER = '.'
 
     def self.prohibited_domain_characters_regex
       @prohibited_domain_characters_regex ||= PROHIBITED_DOMAIN_CHARACTERS_REGEX
@@ -18,9 +20,10 @@ module ValidEmail2
       @prohibited_domain_characters_regex = val
     end
 
-    def initialize(address)
+    def initialize(address, dns_timeout = 5)
       @parse_error = false
       @raw_address = address
+      @dns_timeout = dns_timeout
 
       begin
         @address = Mail::Address.new(address)
@@ -35,22 +38,27 @@ module ValidEmail2
       return @valid unless @valid.nil?
       return false  if @parse_error
 
-      @valid = begin
-        if address.domain && address.address == @raw_address
-          domain = address.domain
-
-          domain !~ self.class.prohibited_domain_characters_regex &&
-            domain.include?('.') &&
-            !domain.include?('..') &&
-            !domain.start_with?('.') &&
-            !domain.start_with?('-') &&
-            !domain.include?('-.') &&
-            !address.local.include?('..') &&
-            !address.local.end_with?('.')
-        else
-          false
-        end
-      end
+      @valid = address.domain &&
+               address.address == @raw_address &&
+               valid_domain? &&
+               valid_address?
+    end
+
+    def valid_domain?
+      domain = address.domain
+
+      domain !~ self.class.prohibited_domain_characters_regex &&
+        domain.include?('.') &&
+        !domain.include?('..') &&
+        !domain.start_with?('.') &&
+        !domain.start_with?('-') &&
+        !domain.include?('-.')
+    end
+
+    def valid_address?
+      !address.local.include?('..') &&
+        !address.local.end_with?('.') &&
+        !address.local.start_with?('.')
     end
 
     def dotted?
@@ -84,6 +92,12 @@ module ValidEmail2
     def valid_mx?
       return false unless valid?
 
+      mx_or_a_servers.any?
+    end
+
+    def valid_strict_mx?
+      return false unless valid?
+
       mx_servers.any?
     end
 
@@ -96,12 +110,13 @@ module ValidEmail2
       i = address_domain.index('.')
       return false unless i
 
-      return domain_list.include?(address_domain[(i+1)..-1])
+      domain_list.include?(address_domain[(i + 1)..-1])
     end
 
     def mx_server_is_in?(domain_list)
       mx_servers.any? { |mx_server|
         return false unless mx_server.respond_to?(:exchange)
+
         mx_server = mx_server.exchange.to_s
 
         domain_list.any? { |domain|
@@ -118,7 +133,14 @@ module ValidEmail2
 
     def mx_servers
       @mx_servers ||= Resolv::DNS.open do |dns|
-        mx_servers = dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+        dns.timeouts = @dns_timeout
+        dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+      end
+    end
+
+    def mx_or_a_servers
+      @mx_or_a_servers ||= Resolv::DNS.open do |dns|
+        dns.timeouts = @dns_timeout
         (mx_servers.any? && mx_servers) ||
           dns.getresources(address.domain, Resolv::DNS::Resource::IN::A)
       end

data/lib/valid_email2/email_validator.rb

@@ -5,15 +5,14 @@ require "active_model/validations"
 module ValidEmail2
   class EmailValidator < ActiveModel::EachValidator
     def default_options
-      { regex: true, disposable: false, mx: false, disallow_subaddressing: false, multiple: false }
+      { regex: true, disposable: false, mx: false, strict_mx: false, disallow_subaddressing: false, multiple: false, dns_timeout: 5 }
     end
 
     def validate_each(record, attribute, value)
       return unless value.present?
       options = default_options.merge(self.options)
 
-      value_spitted = options[:multiple] ? value.split(',').map(&:strip) : [value]
-      addresses = value_spitted.map { |v| ValidEmail2::Address.new(v) }
+      addresses = sanitized_values(value).map { |v| ValidEmail2::Address.new(v, options[:dns_timeout]) }
 
       error(record, attribute) && return unless addresses.all?(&:valid?)
 
@@ -37,6 +36,10 @@ module ValidEmail2
         error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.whitelisted? }
       end
 
+      if options[:disposable_domain_with_whitelist]
+        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.whitelisted? }
+      end
+
       if options[:blacklist]
         error(record, attribute) && return if addresses.any?(&:blacklisted?)
       end
@@ -44,6 +47,22 @@ module ValidEmail2
       if options[:mx]
         error(record, attribute) && return unless addresses.all?(&:valid_mx?)
       end
+
+      if options[:strict_mx]
+        error(record, attribute) && return unless addresses.all?(&:valid_strict_mx?)
+      end
+    end
+
+    def sanitized_values(input)
+      options = default_options.merge(self.options)
+
+      if options[:multiple]
+        email_list = input.is_a?(Array) ? input : input.split(',')
+      else
+        email_list = [input]
+      end
+
+      email_list.reject(&:empty?).map(&:strip)
     end
 
     def error(record, attribute)

data/lib/valid_email2/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal:true
+
 module ValidEmail2
-  VERSION = "3.4.0"
+  VERSION = "4.0.0"
 end

data/pull_mailchecker_emails.rb

@@ -8,7 +8,7 @@ require "net/http"
 whitelisted_emails = %w(
   onet.pl poczta.onet.pl fastmail.fm hushmail.com
   hush.ai hush.com hushmail.me naver.com qq.com example.com
-  yandex.net gmx.com gmx.es
+  yandex.net gmx.com gmx.es webdesignspecialist.com.au vp.com
 )
 
 existing_emails = File.open("config/disposable_email_domains.txt") { |f| f.read.split("\n") }

data/spec/valid_email2_spec.rb

@@ -19,6 +19,10 @@ class TestUserMX < TestModel
   validates :email, 'valid_email_2/email': { mx: true }
 end
 
+class TestUserStrictMX < TestModel
+  validates :email, 'valid_email_2/email': { strict_mx: true }
+end
+
 class TestUserDisallowDisposable < TestModel
   validates :email, 'valid_email_2/email': { disposable: true }
 end
@@ -31,6 +35,10 @@ class TestUserDisallowDisposableWithWhitelist < TestModel
   validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
 end
 
+class TestUserDisallowDisposableDomainWithWhitelist < TestModel
+  validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+end
+
 class TestUserDisallowBlacklisted < TestModel
   validates :email, 'valid_email_2/email': { blacklist: true }
 end
@@ -92,6 +100,16 @@ describe ValidEmail2 do
       expect(user.valid?).to be_falsey
     end
 
+    it "is invalid if the address starts with a dot" do
+      user = TestUser.new(email: ".foo@bar.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if the local part of the address ends with a dot" do
+      user = TestUser.new(email: "foo.@bar.com")
+      expect(user.valid?).to be_falsey
+    end
+
     it "is invalid if the email contains emoticons" do
       user = TestUser.new(email: "foo🙈@gmail.com")
       expect(user.valid?).to be_falsy
@@ -170,8 +188,18 @@ describe ValidEmail2 do
       let(:whitelist_domain) { disposable_domain }
       let(:whitelist_file_path) { "config/whitelisted_email_domains.yml" }
 
+      # Some of the specs below need to explictly set the whitelist var or it 
+      # may be cached to an empty set
+      def set_whitelist
+        ValidEmail2.instance_variable_set(
+          :@whitelist, 
+          ValidEmail2.send(:load_if_exists, ValidEmail2::WHITELIST_FILE)
+        )
+      end
+
       after do
         FileUtils.rm(whitelist_file_path, force: true)
+        set_whitelist
       end
 
       it "is invalid if the domain is disposable and not in the whitelist" do
@@ -181,9 +209,22 @@ describe ValidEmail2 do
 
       it "is valid if the domain is disposable but in the whitelist" do
         File.open(whitelist_file_path, "w") { |f| f.write [whitelist_domain].to_yaml }
+        set_whitelist
         user = TestUserDisallowDisposableWithWhitelist.new(email: "foo@#{whitelist_domain}")
+        expect(user.valid?).to be_truthy
+      end
+
+      it "is invalid if the domain is a disposable_domain and not in the whitelist" do
+        user = TestUserDisallowDisposableDomainWithWhitelist.new(email: "foo@#{whitelist_domain}")
         expect(user.valid?).to be_falsey
       end
+
+      it "is valid if the domain is a disposable_domain but in the whitelist" do
+        File.open(whitelist_file_path, "w") { |f| f.write [whitelist_domain].to_yaml }
+        set_whitelist
+        user = TestUserDisallowDisposableDomainWithWhitelist.new(email: "foo@#{whitelist_domain}")
+        expect(user.valid?).to be_truthy
+      end
     end
   end
 
@@ -216,6 +257,23 @@ describe ValidEmail2 do
     end
   end
 
+  describe "with strict mx validation" do
+    it "is valid if mx records are found" do
+      user = TestUserStrictMX.new(email: "foo@gmail.com")
+      expect(user.valid?).to be_truthy
+    end
+
+    it "is invalid if A records are found but no mx records are found" do
+      user = TestUserStrictMX.new(email: "foo@ghs.google.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if no mx records are found" do
+      user = TestUserStrictMX.new(email: "foo@subdomain.gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+  end
+
   describe "with dotted validation" do
     it "is valid when address does not contain dots" do
       user = TestUserDotted.new(email: "johndoe@gmail.com")
@@ -254,6 +312,11 @@ describe ValidEmail2 do
       expect(user.valid?).to be_truthy
     end
 
+    it "tests each address from an array" do
+      user = TestUserMultiple.new(email: %w[foo@gmail.com bar@gmail.com])
+      expect(user.valid?).to be_truthy
+    end
+
     context 'when one address is invalid' do
       it "fails for all" do
         user = TestUserMultiple.new(email: "foo@gmail.com, bar@123")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email