valid_email2 3.2.5 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 826d65203316bb843deb2167608e1fcd087741ad0d2cbb96d123eb87997d633c
-  data.tar.gz: 8e67f13e8b38393f0b8cf3d6562135bd1bdab809ce54c267c6fed615bbbd7304
+  metadata.gz: f6543e0ca764df6ed5698a864b232260e456a0fc3b8e3f82918122e21cdca0c3
+  data.tar.gz: 989805e58182e1b4ab18b9a16a80a9507465f840bea19840abebe841d628dfa9
 SHA512:
-  metadata.gz: 8c2bef1c61e6cabfba92a339b4157809a090aafc709d18652f3c1e149bb438f8fcc79fddb467efba8fd859ac299926f9695c1d6f89b5b680bb1264e66029ffea
-  data.tar.gz: 5626451520015990d7f1f64d6f34cabf75b38f9f3a82ca2c6af9616b0c03a50e43ef78ba733b59ec1818cd07b68eca10478a01a1085efa47295d6f31b1f41d30
+  metadata.gz: 59813d38f00f9c75cbaae7d944f47d50f9e0239f740c468e8718c51345af324f46411e13b2796c5881769a62127345529be92ae374d07082d07e06610e50b62a
+  data.tar.gz: 131d25e900327ff67b0cd80e17ecc0de83462394d8094cafbed93780ec9b4d472b8e1b95591dc8c894fc8c4f47a8a5a60d31d7fa3c6733210f1b429ca79ff72c

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## Version 3.6.0
+* Add strict_mx validation https://github.com/micke/valid_email2/pull/173
+
+## Version 3.5.0
+* Disallow emails starting with a dot https://github.com/micke/valid_email2/pull/170
+* Add option to whitelist domains from MX check https://github.com/micke/valid_email2/pull/167
+* Remove false positives
+
+## Version 3.4.0
+* Disallow consecutive dots https://github.com/micke/valid_email2/pull/163
+* Add andyes.net https://github.com/micke/valid_email2/pull/162
+
+## Version 3.3.1
+* Fix some performance regressions (https://github.com/micke/valid_email2/pull/150)
+
+## Version 3.3.0
+* Allow multiple addresses separated by comma (https://github.com/micke/valid_email2/pull/156)
+* Make prohibited_domain_characters_regex changeable (https://github.com/micke/valid_email2/pull/157)
+
 ## Version 3.2.5
 * Remove false positives
 * Pull new domains

data/README.md

@@ -43,10 +43,14 @@ class User < ActiveRecord::Base
 end
 ```
 
-To validate that the domain has a MX record:
+To validate that the domain has an MX record or A record:
 ```ruby
 validates :email, 'valid_email_2/email': { mx: true }
 ```
+To validate strictly that the domain has an MX record:
+```ruby
+validates :email, 'valid_email_2/email': { strict_mx: true }
+```
 
 To validate that the domain is not a disposable email (checks domain and MX server):
 ```ruby
@@ -58,11 +62,17 @@ To validate that the domain is not a disposable email (checks domain only, does
 validates :email, 'valid_email_2/email': { disposable_domain: true }
 ```
 
-To validate that the domain is not a disposable email or a disposable email but whitelisted (under config/whitelisted_email_domains.yml):
+To validate that the domain is not a disposable email or a disposable email (checks domain and MX server) but whitelisted (under config/whitelisted_email_domains.yml):
 ```ruby
 validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
 ```
 
+To validate that the domain is not a disposable email or a disposable email (checks domain only, does not check MX server) but whitelisted (under config/whitelisted_email_domains.yml):
+
+```ruby
+validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+```
+
 To validate that the domain is not blacklisted (under config/blacklisted_email_domains.yml):
 ```ruby
 validates :email, 'valid_email_2/email': { blacklist: true }
@@ -83,6 +93,11 @@ To validate create your own custom message:
 validates :email, 'valid_email_2/email': { message: "is not a valid email" }
 ```
 
+To allow multiple addresses separated by comma:
+```ruby
+validates :email, 'valid_email_2/email': { multiple: true }
+```
+
 All together:
 ```ruby
 validates :email, 'valid_email_2/email': { mx: true, disposable: true, disallow_subaddressing: true}
@@ -98,6 +113,7 @@ address = ValidEmail2::Address.new("lisinge@gmail.com")
 address.valid? => true
 address.disposable? => false
 address.valid_mx? => true
+address.valid_strict_mx? => true
 address.subaddressed? => false
 ```
 
@@ -109,6 +125,7 @@ Do so by adding this in your `spec_helper`:
 ```ruby
 config.before(:each) do
   allow_any_instance_of(ValidEmail2::Address).to receive(:valid_mx?).and_return(true)
+  allow_any_instance_of(ValidEmail2::Address).to receive(:valid_strict_mx?).and_return(true)
 end
 ```
 

data/config/disposable_email_domains.txt

@@ -3398,6 +3398,7 @@ androidsapps.co
 androidworld.tw
 andthen.us
 andy1mail.host
+andyes.net
 andynugraha.net
 andyyxc45.biz
 aneaproducciones.com
@@ -4173,6 +4174,7 @@ avuimkgtbgccejft901.ml
 avuimkgtbgccejft901.tk
 avumail.com
 avvmail.com
+avxrja.com
 aw.kikwet.com
 awahal0vk1o7gbyzf0.cf
 awahal0vk1o7gbyzf0.ga
@@ -12788,6 +12790,7 @@ gmailllll.ga
 gmaills.eu
 gmailmail.ga
 gmailmarina.com
+gmailnator.com
 gmailner.com
 gmailnew.com
 gmailom.co
@@ -12938,6 +12941,7 @@ golivejasmin.com
 gomail.in
 gomail.pgojual.com
 gomailbox.info
+gomaild.com
 gomaile.com
 gomailstar.xyz
 gomessage.ml
@@ -18053,6 +18057,7 @@ louboutinshoessalejp.com
 louboutinshoesstoresjp.com
 louboutinshoesus.com
 louder1.bid
+loufad.com
 louis-vuitton-onlinestore.com
 louis-vuitton-outlet.com
 louis-vuitton-outletenter.com
@@ -31026,7 +31031,6 @@ voyagebirmanie.net
 voyancegratuite10min.com
 voyeurseite.info
 vozmivtop.ru
-vp.com
 vp.ycare.de
 vpanel.ru
 vpc608a0.pl
@@ -31423,7 +31427,6 @@ webcontact-france.eu
 webcool.club
 webdesign-guide.info
 webdesign-romania.net
-webdesignspecialist.com.au
 webdesigrsbio.gr
 webdespro.ru
 webdev-pro.ru
@@ -32328,6 +32331,7 @@ xdvsagsdg4we.ga
 xe2g.com
 xeames.net
 xeb9xwp7.tk
+xedmi.com
 xemaps.com
 xemne.com
 xenacareholdings.com
@@ -32378,6 +32382,7 @@ xhkss.net
 xijjfjoo.turystyka.pl
 xilopro.com
 xilor.com
+ximtyl.com
 xinbo.info
 xinbox.info
 xinfi.com.pl

data/lib/valid_email2.rb

@@ -7,23 +7,35 @@ module ValidEmail2
   WHITELIST_FILE  = "config/whitelisted_email_domains.yml"
   DISPOSABLE_FILE = File.expand_path('../config/disposable_email_domains.txt', __dir__)
 
-  def self.disposable_emails
-    @disposable_emails ||= File.open(DISPOSABLE_FILE){ |f| f.read }.split("\n")
-  end
+  class << self
+    def disposable_emails
+      @disposable_emails ||= load_file(DISPOSABLE_FILE)
+    end
 
-  def self.blacklist
-    @blacklist ||= if File.exist?(BLACKLIST_FILE)
-                     YAML.load_file(File.expand_path(BLACKLIST_FILE))
-                   else
-                     []
-                   end
-  end
+    def blacklist
+      @blacklist ||= load_if_exists(BLACKLIST_FILE)
+    end
+
+    def whitelist
+      @whitelist ||= load_if_exists(WHITELIST_FILE)
+    end
+
+    private
+
+    def load_if_exists(path)
+      File.exist?(path) ? load_file(path) : Set.new
+    end
 
-  def self.whitelist
-    @whitelist ||= if File.exist?(WHITELIST_FILE)
-                     YAML.load_file(File.expand_path(WHITELIST_FILE))
-                   else
-                     []
-                   end
+    def load_file(path)
+      # This method MUST return a Set, otherwise the
+      # performance will suffer!
+      if path.end_with?(".yml")
+        Set.new(YAML.load_file(path))
+      else
+        File.open(path, "r").each_line.each_with_object(Set.new) do |domain, set|
+          set << domain.tap(&:chomp!)
+        end
+      end
+    end
   end
 end

data/lib/valid_email2/address.rb

@@ -10,6 +10,14 @@ module ValidEmail2
     DEFAULT_RECIPIENT_DELIMITER = '+'.freeze
     DOT_DELIMITER = '.'.freeze
 
+    def self.prohibited_domain_characters_regex
+      @prohibited_domain_characters_regex ||= PROHIBITED_DOMAIN_CHARACTERS_REGEX
+    end
+
+    def self.prohibited_domain_characters_regex=(val)
+      @prohibited_domain_characters_regex = val
+    end
+
     def initialize(address)
       @parse_error = false
       @raw_address = address
@@ -24,25 +32,22 @@ module ValidEmail2
     end
 
     def valid?
-      @valid ||= begin
-        return false if @parse_error
+      return @valid unless @valid.nil?
+      return false  if @parse_error
 
+      @valid = begin
         if address.domain && address.address == @raw_address
           domain = address.domain
 
-          domain !~ PROHIBITED_DOMAIN_CHARACTERS_REGEX &&
-            # Domain needs to have at least one dot
-            domain =~ /\./ &&
-            # Domain may not have two consecutive dots
-            domain !~ /\.{2,}/ &&
-            # Domain may not start with a dot
-            domain !~ /^\./ &&
-            # Domain may not start with a dash
-            domain !~ /^-/ &&
-            # Domain name may not end with a dash
-            domain !~ /-\./ &&
-            # Address may not contain a dot directly before @
-            address.address !~ /\.@/
+          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?('.') &&
+            !address.local.start_with?('.')
         else
           false
         end
@@ -62,7 +67,7 @@ module ValidEmail2
     end
 
     def disposable_domain?
-      valid? && domain_is_in?(ValidEmail2.disposable_emails)
+      domain_is_in?(ValidEmail2.disposable_emails)
     end
 
     def disposable_mx_server?
@@ -80,6 +85,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
 
@@ -114,7 +125,12 @@ module ValidEmail2
 
     def mx_servers
       @mx_servers ||= Resolv::DNS.open do |dns|
-        mx_servers = dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+        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|
         (mx_servers.any? && mx_servers) ||
           dns.getresources(address.domain, Resolv::DNS::Resource::IN::A)
       end

data/lib/valid_email2/email_validator.rb

@@ -5,43 +5,52 @@ require "active_model/validations"
 module ValidEmail2
   class EmailValidator < ActiveModel::EachValidator
     def default_options
-      { regex: true, disposable: false, mx: false, disallow_subaddressing: false }
+      { regex: true, disposable: false, mx: false, strict_mx: false, disallow_subaddressing: false, multiple: false }
     end
 
     def validate_each(record, attribute, value)
       return unless value.present?
       options = default_options.merge(self.options)
 
-      address = ValidEmail2::Address.new(value)
+      value_spitted = options[:multiple] ? value.split(',').map(&:strip) : [value]
+      addresses = value_spitted.map { |v| ValidEmail2::Address.new(v) }
 
-      error(record, attribute) && return unless address.valid?
+      error(record, attribute) && return unless addresses.all?(&:valid?)
 
       if options[:disallow_dotted]
-        error(record, attribute) && return if address.dotted?
+        error(record, attribute) && return if addresses.any?(&:dotted?)
       end
 
       if options[:disallow_subaddressing]
-        error(record, attribute) && return if address.subaddressed?
+        error(record, attribute) && return if addresses.any?(&:subaddressed?)
       end
 
       if options[:disposable]
-        error(record, attribute) && return if address.disposable?
+        error(record, attribute) && return if addresses.any?(&:disposable?)
       end
 
       if options[:disposable_domain]
-        error(record, attribute) && return if address.disposable_domain?
+        error(record, attribute) && return if addresses.any?(&:disposable_domain?)
       end
 
       if options[:disposable_with_whitelist]
-        error(record, attribute) && return if address.disposable? && !address.whitelisted?
+        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 address.blacklisted?
+        error(record, attribute) && return if addresses.any?(&:blacklisted?)
       end
 
       if options[:mx]
-        error(record, attribute) && return unless address.valid_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
 

data/lib/valid_email2/version.rb

@@ -1,3 +1,3 @@
 module ValidEmail2
-  VERSION = "3.2.5"
+  VERSION = "3.6.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/benchmark_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Performance testing" do
+  let(:disposable_domain) { ValidEmail2.disposable_emails.first }
+
+  it "has acceptable lookup performance" do
+    address = ValidEmail2::Address.new("test@example.com")
+
+    # preload list and check size
+    expect(ValidEmail2.disposable_emails).to be_a(Set)
+    expect(ValidEmail2.disposable_emails.count).to be > 30000
+
+    # check lookup timing
+    expect { address.disposable_domain? }.to perform_under(0.0001).sample(10).times
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,15 @@
 $:.unshift File.expand_path("../lib",__FILE__)
 require "valid_email2"
 
+# Include and configure  benchmark
+require 'rspec-benchmark'
+RSpec.configure do |config|
+  config.include RSpec::Benchmark::Matchers
+end
+RSpec::Benchmark.configure do |config|
+  config.disable_gc = true
+end
+
 class TestModel
   include ActiveModel::Validations
 

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
@@ -39,6 +47,10 @@ class TestUserMessage < TestModel
   validates :email, 'valid_email_2/email': { message: "custom message" }
 end
 
+class TestUserMultiple < TestModel
+  validates :email, 'valid_email_2/email': { multiple: true }
+end
+
 describe ValidEmail2 do
 
   let(:disposable_domain) { ValidEmail2.disposable_emails.first }
@@ -83,13 +95,23 @@ describe ValidEmail2 do
       expect(user.valid?).to be_falsey
     end
 
-    it "is invalid if the domain contains emoticons" do
-      user = TestUser.new(email: "foo🙈@gmail.com")
-      expect(user.valid?).to be_falsy
+    it "is invalid if the address contains consecutive dots" do
+      user = TestUser.new(email: "foo..bar@gmail.com")
+      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 domain contains .@ consecutively" do
-      user = TestUser.new(email: "foo.@gmail.com")
+    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
     end
 
@@ -166,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
@@ -177,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
 
@@ -212,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")
@@ -244,6 +306,20 @@ describe ValidEmail2 do
     end
   end
 
+  describe "with multiple addresses" do
+    it "tests each address for it's own" do
+      user = TestUserMultiple.new(email: "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")
+        expect(user.valid?).to be_falsey
+      end
+    end
+  end
+
   describe "#dotted?" do
     it "is true when address local part contains a dot delimiter ('.')" do
       email = ValidEmail2::Address.new("john.doe@gmail.com")

data/valid_email2.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec-benchmark", "~> 0.6"
   spec.add_development_dependency "pry"
   spec.add_runtime_dependency "mail", "~> 2.5"
   spec.add_runtime_dependency "activemodel", ">= 3.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.6.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - lib/valid_email2/email_validator.rb
 - lib/valid_email2/version.rb
 - pull_mailchecker_emails.rb
+- spec/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/valid_email2_spec.rb
 - valid_email2.gemspec
@@ -142,11 +157,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email
   blacklist
 test_files:
+- spec/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/valid_email2_spec.rb