valid_email2 3.2.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0eea64eb523ab5e3993b7e8c8abff01c0de45535ec72e81c94177c70442d59
-  data.tar.gz: 771e67404527aa129be31a94c2eef0738f54b3e653f394964fa215dabe786b21
+  metadata.gz: 85903e3f9f5d0e8222dcc7768e15632eecf4a6008e8a43c2d88549cfa9a140ae
+  data.tar.gz: 2519e54f15012418caa00608301ff19f91640ecf63e9cf88c586afa2d1a0d2d2
 SHA512:
-  metadata.gz: 4d491d4b61f26a9155cee37e78e5a78fd60579418f17bfbe76713b3d9ab7d6a0e371f919c36bddf2843c69392c2cb6e3ed4f32d2b392b7642d5008b02b0ae02a
-  data.tar.gz: 5ad7f4f013df6a23662c12e70113bdc9f74e98f31b680fad0de7730f17b4bd15b8761b26d1fb2d21f3b58dc89abcf049f225bfc5a05c5edc5ca9b0f50a81bd70
+  metadata.gz: 811d82babbd7ad076fc077d4dea52074ecf6591926ed6b37b4f6595b614bc46eeacfd944db95ebc577a6cfb36d858009a051eed67e87fa5ce3f06b63c576c8b6
+  data.tar.gz: 653fe9f637840019997480853e5784e4fba055f4d579bce8af3b30e631da8fe86a5074e00564d72444f7b4a1cd0f4d7d829d9928e7c3962d1b612b595cc16545

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 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
+
 ## Version 3.2.4
 * Remove false positives
 

data/README.md

@@ -58,11 +58,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 +89,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}

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
@@ -7866,6 +7867,7 @@ cungmuachungnhom.com
 cungsuyngam.com
 cungtam.com
 cuoiz.com
+cuoly.com
 cuongvumarketingseo.com
 cupf6mdhtujxytdcoxh.cf
 cupf6mdhtujxytdcoxh.ga
@@ -9772,7 +9774,6 @@ edu.auction
 edu.dmtc.dev
 edu.hstu.eu.org
 edu.my
-edu.sg
 eduanswer.ru
 education.eu
 educationleaders-ksa.com
@@ -10352,6 +10353,7 @@ eo-z.com
 eoffice.top
 eomail.com
 eonmech.com
+eoopy.com
 eorbs.com
 eos2mail.com
 eotoplenie.ru
@@ -11401,6 +11403,8 @@ fitnessjockey.org
 fitnessmojo.org
 fitnessreviewsonline.com
 fitnesszbyszko.pl
+fitschool.be
+fitschool.space
 fittinggeeks.pl
 fitzgeraldforjudge.com
 five-club.com
@@ -12320,7 +12324,6 @@ gd6ubc0xilchpozgpg.gq
 gd6ubc0xilchpozgpg.ml
 gd6ubc0xilchpozgpg.tk
 gdb.armageddon.org
-gdf.it
 gdfretertwer.com
 gdmail.top
 gdradr.com
@@ -28483,6 +28486,7 @@ tempemailaddress.com
 tempemails.io
 tempinbox.co.uk
 tempinbox.com
+tempinbox.xyz
 tempm.cf
 tempm.com
 tempm.ga
@@ -31022,7 +31026,6 @@ voyagebirmanie.net
 voyancegratuite10min.com
 voyeurseite.info
 vozmivtop.ru
-vp.com
 vp.ycare.de
 vpanel.ru
 vpc608a0.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?

data/lib/valid_email2/email_validator.rb

@@ -5,43 +5,48 @@ 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, 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
     end
 

data/lib/valid_email2/version.rb

@@ -1,3 +1,3 @@
 module ValidEmail2
-  VERSION = "3.2.4"
+  VERSION = "3.5.0"
 end

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

@@ -31,6 +31,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 +43,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 +91,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 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 domain contains .@ consecutively" do
-      user = TestUser.new(email: "foo.@gmail.com")
+    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 +184,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 +205,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
 
@@ -244,6 +285,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.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-10-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.4
+rubygems_version: 3.1.2
 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