valid_email2 5.2.6 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a01a2acf82274bd6e459721211ff637ab27f24ca2ec01ae4423ed4ffac25d9
-  data.tar.gz: cd8506ab6c60327a789e2fb4f1d702a49a2059ff2c9af79c6db10ecb0c7023b0
+  metadata.gz: a0296ec313cffb7390cb7ca2b22d48f15854bbb1cc8dc1442b31389b7350f31b
+  data.tar.gz: 11da87b6097bdc4df988d16045809dc42336b68b2f4fdf087a1ad38013619061
 SHA512:
-  metadata.gz: 91af74f0a0c8fecac0ade9e9320186c0e86c76e48665d07ab79fe9ef0fdde75a3ff37d0d39b2cce8e2fd30a04a4815492ab5f24e7094f55b7852e3a6b41aef95
-  data.tar.gz: d19d1e8c83b8aa2833ed2d472e41b8722018d08d5d465416f4cefc8c588dd9a9334d07401787acb9cee89cc9b326892097a6d3ad5d5ff015b0bce774bdbfc4ee
+  metadata.gz: e6003807039faf5c307d53b2617adcc5c0a0e75055f560e48073ea9cc1d5093f50aba58f2cbe121cc913b99ba8df62789e11a59d236cd0b13b17ad800925e5a5
+  data.tar.gz: 981042cfa3c8a72f101ba40a3922a0a3c2c2aa26ea0635ac4beb0ce59917171ec0ff1126dde68c77edb42939e4618372960c88645f720ad588e6735a2c392baf

data/.github/workflows/ci.yaml

@@ -1,5 +1,5 @@
 name: CI
-on: [push, pull_request]
+on: [push, pull_request_target]
 jobs:
   test:
     strategy:

data/.github/workflows/release.yaml

@@ -1,7 +1,7 @@
 on:
   push:
     branches:
-      - master
+      - main
 
 permissions:
   contents: write

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"5.2.6"}
+{".":"6.0.0"}

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [6.0.0](https://github.com/micke/valid_email2/compare/v5.3.0...v6.0.0) (2024-11-03)
+
+
+### ⚠ BREAKING CHANGES
+
+* Remove deprecated methods and options
+
+### Features
+
+* Cache DNS lookups ([#256](https://github.com/micke/valid_email2/issues/256)) ([72115ec](https://github.com/micke/valid_email2/commit/72115ec1b866e54b5a4d530d7eaeb7e52a3c8e98))
+* Remove deprecated methods and options ([1a29d27](https://github.com/micke/valid_email2/commit/1a29d27d587a39d181dfe2b6f39028bc317aff52))
+
+
+### Bug Fixes
+
+* disallow # in domain ([#259](https://github.com/micke/valid_email2/issues/259)) ([1643323](https://github.com/micke/valid_email2/commit/1643323fa3da8973cb63a727410aa9696706e3c8))
+* **email_validator:** handle trailing whitespace in emails ([#255](https://github.com/micke/valid_email2/issues/255)) ([a06fdf7](https://github.com/micke/valid_email2/commit/a06fdf72cfc0df51c81057c6094aba332b692741))
+* Falsely detecting Scandinavian characters as emojis ([#257](https://github.com/micke/valid_email2/issues/257)) ([e64de5c](https://github.com/micke/valid_email2/commit/e64de5c675a015c09c7e6b89bb4f65a39137f48f))
+* typo in readme about config file to deny email domains ([#254](https://github.com/micke/valid_email2/issues/254)) ([a39ed57](https://github.com/micke/valid_email2/commit/a39ed5792a9d46abd954fceff929770eabf99a73))
+
+## [5.3.0](https://github.com/micke/valid_email2/compare/v5.2.6...v5.3.0) (2024-08-31)
+
+
+### Features
+
+* Deprecate blacklist and whitelist naming ([9df0bf8](https://github.com/micke/valid_email2/commit/9df0bf8c9912721b007e5a6acc67f533ca560c9f))
+* Warn when loading deprecated files ([46634df](https://github.com/micke/valid_email2/commit/46634dff409f9a47f10684d629dc022b22daf362))
+
 ## [5.2.6](https://github.com/micke/valid_email2/compare/v5.2.5...v5.2.6) (2024-08-10)
 
 

data/README.md

@@ -73,20 +73,20 @@ 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 (checks domain and MX server) 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 allow-listed (under config/allow_listed_email_domains.yml):
 ```ruby
-validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
+validates :email, 'valid_email_2/email': { disposable_with_allow_list: 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):
+To validate that the domain is not a disposable email or a disposable email (checks domain only, does not check MX server) but allow-listed (under config/allow_listed_email_domains.yml):
 
 ```ruby
-validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+validates :email, 'valid_email_2/email': { disposable_domain_with_allow_list: true }
 ```
 
-To validate that the domain is not blacklisted (under config/blacklisted_email_domains.yml):
+To validate that the domain is not on the deny list (under config/deny_listed_email_domains.yml):
 ```ruby
-validates :email, 'valid_email_2/email': { blacklist: true }
+validates :email, 'valid_email_2/email': { deny_list: true }
 ```
 
 To validate that email is not subaddressed:
@@ -147,6 +147,15 @@ end
 
 This gem is tested against currently supported Ruby and Rails versions. For an up to date list, check the build matrix in the [workflow](.github/workflows/ci.yaml).
 
+## Upgrading to v5.3.0
+
+In version v5.3.0 the config directory files were renamed as follows:
+
+`config/blacklisted_email_domains.yml` -> `config/deny_listed_email_domains.yml`  
+`config/whitelisted_email_domains.yml` -> `config/allow_listed_email_domains.yml`
+
+You won't need to make any changes yourself if you're installing this version for the first time. For individuals updating from earlier versions, make sure to update the file namings as per the above. In future versions this will be a breaking change.
+
 ## Upgrading to v3.0.0
 
 In version v3.0.0 I decided to move __and__ rename the config files from the

data/config/deny_listed_email_domains.yml

@@ -0,0 +1 @@
+- deny-listed-test.com

data/config/disposable_email_domains.txt

@@ -51296,7 +51296,6 @@ embaeqmail.com
 embalaje.us
 embaramail.com
 embarq.net
-embarqmail.com
 embarqumail.com
 embassyofcoffee.de
 embatqmail.com

data/lib/valid_email2/address.rb

@@ -3,12 +3,14 @@
 require "valid_email2"
 require "resolv"
 require "mail"
+require "unicode/emoji"
+require "valid_email2/dns_records_cache"
 
 module ValidEmail2
   class Address
     attr_accessor :address
 
-    PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'`]/
+    PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'#`]/
     DEFAULT_RECIPIENT_DELIMITER = '+'
     DOT_DELIMITER = '.'
 
@@ -24,9 +26,7 @@ module ValidEmail2
       @parse_error = false
       @raw_address = address
       @dns_timeout = dns_timeout
-
-      @resolv_config = Resolv::DNS::Config.default_config_hash
-      @resolv_config[:nameserver] = dns_nameserver if dns_nameserver
+      @dns_nameserver = dns_nameserver
 
       begin
         @address = Mail::Address.new(address)
@@ -34,7 +34,7 @@ module ValidEmail2
         @parse_error = true
       end
 
-      @parse_error ||= address_contain_emoticons? @raw_address
+      @parse_error ||= address_contain_emoticons?
     end
 
     def valid?
@@ -84,12 +84,12 @@ module ValidEmail2
       valid? && mx_server_is_in?(ValidEmail2.disposable_emails)
     end
 
-    def whitelisted?
-      domain_is_in?(ValidEmail2.whitelist)
+    def allow_listed?
+      domain_is_in?(ValidEmail2.allow_list)
     end
 
-    def blacklisted?
-      valid? && domain_is_in?(ValidEmail2.blacklist)
+    def deny_listed?
+      valid? && domain_is_in?(ValidEmail2.deny_list)
     end
 
     def valid_mx?
@@ -130,16 +130,30 @@ module ValidEmail2
       }
     end
 
-    def address_contain_emoticons?(email)
-      return false if email.nil?
+    def address_contain_emoticons?
+      return false if @raw_address.nil?
+
+      @raw_address.scan(Unicode::Emoji::REGEX).length >= 1
+    end
+
+    def resolv_config
+      @resolv_config ||= begin
+        config = Resolv::DNS::Config.default_config_hash
+        config[:nameserver] = @dns_nameserver if @dns_nameserver
+        config
+      end
 
-      email.each_char.any? { |char| char.bytesize > 1 }
+      @resolv_config
     end
 
     def mx_servers
-      @mx_servers ||= Resolv::DNS.open(@resolv_config) do |dns|
-        dns.timeouts = @dns_timeout
-        dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+      @mx_servers_cache ||= ValidEmail2::DnsRecordsCache.new
+
+      @mx_servers_cache.fetch(address.domain.downcase) do
+        Resolv::DNS.open(resolv_config) do |dns|
+          dns.timeouts = @dns_timeout
+          dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+        end
       end
     end
 
@@ -148,10 +162,14 @@ module ValidEmail2
     end
 
     def mx_or_a_servers
-      @mx_or_a_servers ||= Resolv::DNS.open(@resolv_config) do |dns|
-        dns.timeouts = @dns_timeout
-        (mx_servers.any? && mx_servers) ||
-          dns.getresources(address.domain, Resolv::DNS::Resource::IN::A)
+      @mx_or_a_servers_cache ||= ValidEmail2::DnsRecordsCache.new
+
+      @mx_or_a_servers_cache.fetch(address.domain.downcase) do
+        Resolv::DNS.open(resolv_config) do |dns|
+          dns.timeouts = @dns_timeout
+          (mx_servers.any? && mx_servers) ||
+            dns.getresources(address.domain, Resolv::DNS::Resource::IN::A)
+        end
       end
     end
   end

data/lib/valid_email2/dns_records_cache.rb

@@ -0,0 +1,37 @@
+module ValidEmail2
+  class DnsRecordsCache
+    MAX_CACHE_SIZE = 1_000
+
+    def initialize
+      # Cache structure: { domain (String): { records: [], cached_at: Time, ttl: Integer } }
+      @cache = {}
+    end
+
+    def fetch(domain, &block)
+      prune_cache if @cache.size > MAX_CACHE_SIZE
+
+      cache_entry = @cache[domain]
+
+      if cache_entry && (Time.now - cache_entry[:cached_at]) < cache_entry[:ttl]
+        return cache_entry[:records]
+      else
+        @cache.delete(domain)
+      end
+
+      records = block.call
+
+      if records.any?
+        ttl = records.map(&:ttl).min
+        @cache[domain] = { records: records, cached_at: Time.now, ttl: ttl }
+      end
+
+      records
+    end
+
+    def prune_cache
+      entries_sorted_by_cached_at_asc = (@cache.sort_by { |_domain, data| data[:cached_at] }).flatten
+      entries_to_remove = entries_sorted_by_cached_at_asc.first(@cache.size - MAX_CACHE_SIZE)
+      entries_to_remove.each { |domain| @cache.delete(domain) }
+    end
+  end
+end

data/lib/valid_email2/email_validator.rb

@@ -32,16 +32,16 @@ module ValidEmail2
         error(record, attribute) && return if addresses.any?(&:disposable_domain?)
       end
 
-      if options[:disposable_with_whitelist]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.whitelisted? }
+      if options[:disposable_with_allow_list]
+        error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.allow_listed? }
       end
 
-      if options[:disposable_domain_with_whitelist]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.whitelisted? }
+      if options[:disposable_domain_with_allow_list]
+        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.allow_listed? }
       end
 
-      if options[:blacklist]
-        error(record, attribute) && return if addresses.any?(&:blacklisted?)
+      if options[:deny_list]
+        error(record, attribute) && return if addresses.any?(&:deny_listed?)
       end
 
       if options[:mx]
@@ -57,12 +57,12 @@ module ValidEmail2
       options = default_options.merge(self.options)
 
       if options[:multiple]
-        email_list = input.is_a?(Array) ? input : input.split(',')
+        email_list = input.is_a?(Array) ? input : input.split(',').map(&:strip)
       else
         email_list = [input]
       end
 
-      email_list.reject(&:empty?).map(&:strip)
+      email_list.reject(&:empty?)
     end
 
     def error(record, attribute)

data/lib/valid_email2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal:true
 
 module ValidEmail2
-  VERSION = "5.2.6"
+  VERSION = "6.0.0"
 end

data/lib/valid_email2.rb

@@ -3,8 +3,8 @@
 require "valid_email2/email_validator"
 
 module ValidEmail2
-  BLACKLIST_FILE  = "config/blacklisted_email_domains.yml"
-  WHITELIST_FILE  = "config/whitelisted_email_domains.yml"
+  DENY_LIST_FILE  = "config/deny_listed_email_domains.yml"
+  ALLOW_LIST_FILE  = "config/allow_listed_email_domains.yml"
   DISPOSABLE_FILE = File.expand_path('../config/disposable_email_domains.txt', __dir__)
 
   class << self
@@ -12,18 +12,18 @@ module ValidEmail2
       @disposable_emails ||= load_file(DISPOSABLE_FILE)
     end
 
-    def blacklist
-      @blacklist ||= load_if_exists(BLACKLIST_FILE)
+    def deny_list
+      @deny_list ||= load_if_exists(DENY_LIST_FILE) || Set.new
     end
 
-    def whitelist
-      @whitelist ||= load_if_exists(WHITELIST_FILE)
+    def allow_list
+      @allow_list ||= load_if_exists(ALLOW_LIST_FILE) || Set.new
     end
 
     private
 
     def load_if_exists(path)
-      File.exist?(path) ? load_file(path) : Set.new
+      load_file(path) if File.exist?(path)
     end
 
     def load_file(path)

data/pull_mailchecker_emails.rb

@@ -5,7 +5,7 @@ require "yaml"
 require "json"
 require "net/http"
 
-whitelisted_emails = %w[
+allow_listed_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 webdesignspecialist.com.au vp.com
@@ -15,7 +15,7 @@ whitelisted_emails = %w[
   passinbox.com passfwd.com passmail.com passmail.net
   duck.com mozmail.com dralias.com 8alias.com 8shield.net
   mailinblack.com anonaddy.com anonaddy.me addy.io privaterelay.appleid.com appleid.com
-  net.ua kommespaeter.de alpenjodel.de my.id web.id directbox.com
+  net.ua kommespaeter.de alpenjodel.de my.id web.id directbox.com embarqmail.com
 ]
 
 existing_emails = File.open("config/disposable_email_domains.txt") { |f| f.read.split("\n") }
@@ -29,6 +29,6 @@ remote_emails = [
   resp.body.split("\n").flatten
 end
 
-result_emails = (existing_emails + remote_emails).map(&:strip).uniq.sort - whitelisted_emails
+result_emails = (existing_emails + remote_emails).map(&:strip).uniq.sort - allow_listed_emails
 
 File.write("config/disposable_email_domains.txt", result_emails.join("\n"))

data/release-please-config.json

@@ -1,7 +1,6 @@
 {
   "release-type": "ruby",
   "include-component-in-tag": false,
-  "last-release-sha": "b327e76f71e764f6d76351425e11d1563e04f188",
   "packages": {
     ".": {
       "release-type": "ruby",

data/spec/address_spec.rb

@@ -33,5 +33,289 @@ describe ValidEmail2::Address do
       address = described_class.new("foo🙈@gmail.com")
       expect(address.valid?).to be false
     end
+
+    it "is valid if it contains special scandinavian characters" do
+      address = described_class.new("jørgen@email.dk")
+      expect(address.valid?).to eq true
+    end
+  end
+
+  describe "caching" do
+    let(:email_address) { "example@ymail.com" }
+    let(:email_instance) { described_class.new(email_address) }
+    let(:dns_records_cache_instance) { ValidEmail2::DnsRecordsCache.new }
+    let(:ttl) { 1_000 }
+    let(:mock_resolv_dns) { instance_double(Resolv::DNS) }
+    let(:mock_mx_records) { [double("MX", exchange: "mx.ymail.com", preference: 10, ttl: ttl)] }
+
+    before do
+      allow(email_instance).to receive(:null_mx?).and_return(false)
+      allow(Resolv::DNS).to receive(:open).and_yield(mock_resolv_dns)
+      allow(mock_resolv_dns).to receive(:timeouts=)
+    end
+
+    describe "#valid_strict_mx?" do
+      let(:cached_at) { Time.now }
+      let(:mock_cache_data) { { email_instance.address.domain => { records: mock_mx_records, cached_at: cached_at, ttl: ttl } } }
+
+      before do
+        allow(mock_resolv_dns).to receive(:getresources)
+          .with(email_instance.address.domain, Resolv::DNS::Resource::IN::MX)
+          .and_return(mock_mx_records)
+      end
+
+      it "calls the MX servers lookup when the email is not cached" do
+        result = email_instance.valid_strict_mx?
+
+        expect(Resolv::DNS).to have_received(:open).once
+        expect(result).to be true
+      end
+
+      it "does not call the MX servers lookup when the email is cached" do
+        email_instance.valid_strict_mx?
+        email_instance.valid_strict_mx?
+
+        expect(Resolv::DNS).to have_received(:open).once
+      end
+
+      it "returns the cached result for subsequent calls" do
+        first_result = email_instance.valid_strict_mx?
+        expect(first_result).to be true
+
+        allow(mock_resolv_dns).to receive(:getresources)
+          .with(email_instance.address.domain, Resolv::DNS::Resource::IN::MX)
+          .and_return([])
+
+        second_result = email_instance.valid_strict_mx?
+        expect(second_result).to be true
+      end
+
+      describe "ttl" do
+        before do
+          dns_records_cache_instance.instance_variable_set(:@cache, mock_cache_data)
+          allow(ValidEmail2::DnsRecordsCache).to receive(:new).and_return(dns_records_cache_instance)
+          allow(dns_records_cache_instance).to receive(:fetch).with(email_instance.address.domain).and_call_original
+        end
+
+        context "when the time since last lookup is less than the cached ttl entry" do
+          let(:cached_at) { Time.now }
+
+          it "does not call the MX servers lookup" do
+            email_instance.valid_strict_mx?
+
+            expect(Resolv::DNS).not_to have_received(:open)
+          end
+        end
+
+        context "when the time since last lookup is greater than the cached ttl entry" do
+          let(:cached_at) { Time.now - ttl }
+
+          it "calls the MX servers lookup" do
+            email_instance.valid_strict_mx?
+
+            expect(Resolv::DNS).to have_received(:open).once
+          end
+        end
+      end
+
+      describe "cache size" do
+        before do
+          dns_records_cache_instance.instance_variable_set(:@cache, mock_cache_data)
+          allow(ValidEmail2::DnsRecordsCache).to receive(:new).and_return(dns_records_cache_instance)
+          allow(dns_records_cache_instance).to receive(:fetch).with(email_instance.address.domain).and_call_original
+        end
+
+        context "when the cache size is less than or equal to the max cache size" do
+          before do
+            stub_const("ValidEmail2::DnsRecordsCache::MAX_CACHE_SIZE", 1)
+          end
+
+          it "does not prune the cache" do
+            expect(dns_records_cache_instance).not_to receive(:prune_cache)
+
+            email_instance.valid_strict_mx?
+          end
+
+          it "does not call the MX servers lookup" do
+            email_instance.valid_strict_mx?
+
+            expect(Resolv::DNS).not_to have_received(:open)
+          end
+
+          context "and there are older cached entries" do
+            let(:mock_cache_data) { { "another_domain.com" => { records: mock_mx_records, cached_at: cached_at - 100, ttl: ttl } } }
+
+            it "does not prune those entries" do
+              email_instance.valid_strict_mx?
+
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys.size).to eq 2
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys).to match_array([email_instance.address.domain, "another_domain.com"])
+            end
+          end
+        end
+
+        context "when the cache size is greater than the max cache size" do
+          before do
+            stub_const("ValidEmail2::DnsRecordsCache::MAX_CACHE_SIZE", 0)
+          end
+
+          it "prunes the cache" do
+            expect(dns_records_cache_instance).to receive(:prune_cache).once
+
+            email_instance.valid_strict_mx?
+          end
+
+          it "calls the the MX servers lookup" do    
+            email_instance.valid_strict_mx?
+
+            expect(Resolv::DNS).to have_received(:open).once
+          end
+
+          context "and there are older cached entries" do
+            let(:mock_cache_data) { { "another_domain.com" => { records: mock_mx_records, cached_at: cached_at - 100, ttl: ttl } } }
+
+            it "prunes those entries" do
+              email_instance.valid_strict_mx?
+
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys.size).to eq 1
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys).to match_array([email_instance.address.domain])
+            end
+          end
+        end
+      end
+    end
+
+    describe "#valid_mx?" do
+      let(:cached_at) { Time.now }
+      let(:mock_cache_data) { { email_instance.address.domain => { records: mock_a_records, cached_at: cached_at, ttl: ttl } } }
+      let(:mock_a_records) { [double("A", address: "192.168.1.1", ttl: ttl)] }
+
+      before do
+        allow(email_instance).to receive(:mx_servers).and_return(mock_mx_records)
+        allow(mock_resolv_dns).to receive(:getresources)
+          .with(email_instance.address.domain, Resolv::DNS::Resource::IN::A)
+          .and_return(mock_a_records)
+      end
+
+      it "calls the MX or A servers lookup when the email is not cached" do
+        result = email_instance.valid_mx?
+
+        expect(Resolv::DNS).to have_received(:open).once
+        expect(result).to be true
+      end
+
+      it "does not call the MX or A servers lookup when the email is cached" do
+        email_instance.valid_mx?
+        email_instance.valid_mx?
+
+        expect(Resolv::DNS).to have_received(:open).once
+      end
+
+      it "returns the cached result for subsequent calls" do
+        first_result = email_instance.valid_mx?
+        expect(first_result).to be true
+
+        allow(mock_resolv_dns).to receive(:getresources)
+          .with(email_instance.address.domain, Resolv::DNS::Resource::IN::A)
+          .and_return([])
+
+        second_result = email_instance.valid_mx?
+        expect(second_result).to be true
+      end
+
+      describe "ttl" do
+        before do
+          dns_records_cache_instance.instance_variable_set(:@cache, mock_cache_data)
+          allow(ValidEmail2::DnsRecordsCache).to receive(:new).and_return(dns_records_cache_instance)
+          allow(dns_records_cache_instance).to receive(:fetch).with(email_instance.address.domain).and_call_original
+        end
+
+        context "when the time since last lookup is less than the cached ttl entry" do
+          let(:cached_at) { Time.now }
+
+          it "does not call the MX or A servers lookup" do
+            email_instance.valid_mx?
+
+            expect(Resolv::DNS).not_to have_received(:open)
+          end
+        end
+
+        context "when the time since last lookup is greater than the cached ttl entry" do
+          let(:cached_at) { Time.now - ttl }
+
+          it "calls the MX or A servers lookup " do
+            email_instance.valid_mx?
+
+            expect(Resolv::DNS).to have_received(:open).once
+          end
+        end
+      end
+
+      describe "cache size" do
+        before do
+          dns_records_cache_instance.instance_variable_set(:@cache, mock_cache_data)
+          allow(ValidEmail2::DnsRecordsCache).to receive(:new).and_return(dns_records_cache_instance)
+          allow(dns_records_cache_instance).to receive(:fetch).with(email_instance.address.domain).and_call_original
+        end
+
+        context "when the cache size is less than or equal to the max cache size" do
+          before do
+            stub_const("ValidEmail2::DnsRecordsCache::MAX_CACHE_SIZE", 1)
+          end
+
+          it "does not prune the cache" do
+            expect(email_instance).not_to receive(:prune_cache)
+
+            email_instance.valid_mx?
+          end
+
+          it "does not call the MX or A servers lookup" do
+            email_instance.valid_mx?
+
+            expect(Resolv::DNS).not_to have_received(:open)
+          end
+
+          context "and there are older cached entries" do
+            let(:mock_cache_data) { { "another_domain.com" => { records: mock_a_records, cached_at: cached_at - 100, ttl: ttl } } }
+
+            it "does not prune those entries" do
+              email_instance.valid_mx?
+
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys.size).to eq 2
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys).to match_array([email_instance.address.domain, "another_domain.com"])
+            end
+          end
+        end
+
+        context "when the cache size is greater than the max cache size" do
+          before do
+            stub_const("ValidEmail2::DnsRecordsCache::MAX_CACHE_SIZE", 0)
+          end
+
+          it "prunes the cache" do 
+            expect(dns_records_cache_instance).to receive(:prune_cache).once 
+
+            email_instance.valid_mx?
+          end
+
+          it "calls the MX or A servers lookup" do
+            email_instance.valid_mx?
+
+            expect(Resolv::DNS).to have_received(:open).once
+          end
+
+          context "and there are older cached entries" do
+            let(:mock_cache_data) { { "another_domain.com" => { records: mock_a_records, cached_at: cached_at - 100, ttl: ttl } } }
+
+            it "prunes those entries" do
+              email_instance.valid_mx?
+
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys.size).to eq 1
+              expect(dns_records_cache_instance.instance_variable_get(:@cache).keys).to match_array([email_instance.address.domain])
+            end
+          end
+        end
+      end    
+    end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require "valid_email2"
 require 'rspec-benchmark'
 RSpec.configure do |config|
   config.include RSpec::Benchmark::Matchers
+  config.default_formatter = 'doc'
 end
 RSpec::Benchmark.configure do |config|
   config.disable_gc = true

data/spec/valid_email2_spec.rb

@@ -47,16 +47,16 @@ class TestUserDisallowDisposableDomain < TestModel
   validates :email, 'valid_email_2/email': { disposable_domain: true }
 end
 
-class TestUserDisallowDisposableWithWhitelist < TestModel
-  validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
+class TestUserDisallowDisposableWithAllowList < TestModel
+  validates :email, 'valid_email_2/email': { disposable_with_allow_list: true }
 end
 
-class TestUserDisallowDisposableDomainWithWhitelist < TestModel
-  validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+class TestUserDisallowDisposableDomainWithAllowList < TestModel
+  validates :email, 'valid_email_2/email': { disposable_domain_with_allow_list: true }
 end
 
-class TestUserDisallowBlacklisted < TestModel
-  validates :email, 'valid_email_2/email': { blacklist: true }
+class TestUserDisallowDenyListed < TestModel
+  validates :email, 'valid_email_2/email': { deny_list: true }
 end
 
 class TestUserMessage < TestModel
@@ -158,6 +158,16 @@ describe ValidEmail2 do
       user = TestUser.new(email: "foo@gmail-.com")
       expect(user.valid?).to be_falsy
     end
+
+    it "is invalid with trailing whitespace" do
+      user = TestUser.new(email: "foo@example.com ")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if domain contains #" do
+      user = TestUser.new(email: "foo@example.com#")
+      expect(user.valid?).to be_falsey
+    end
   end
 
   describe "with disposable validation" do
@@ -208,58 +218,58 @@ describe ValidEmail2 do
       end
     end
 
-    describe "with whitelisted emails" do
-      let(:whitelist_domain) { disposable_domain }
-      let(:whitelist_file_path) { "config/whitelisted_email_domains.yml" }
+    describe "with allow-listed emails" do
+      let(:allow_list_domain) { disposable_domain }
+      let(:allow_list_file_path) { "config/allow_listed_email_domains.yml" }
 
-      # Some of the specs below need to explictly set the whitelist var or it
+      # Some of the specs below need to explictly set the allow list var or it
       # may be cached to an empty set
-      def set_whitelist
+      def set_allow_list
         ValidEmail2.instance_variable_set(
-          :@whitelist,
-          ValidEmail2.send(:load_if_exists, ValidEmail2::WHITELIST_FILE)
+          :@allow_list,
+          ValidEmail2.send(:load_if_exists, ValidEmail2::ALLOW_LIST_FILE)
         )
       end
 
       after do
-        FileUtils.rm(whitelist_file_path, force: true)
-        set_whitelist
+        FileUtils.rm(allow_list_file_path, force: true)
+        set_allow_list
       end
 
-      it "is invalid if the domain is disposable and not in the whitelist" do
-        user = TestUserDisallowDisposableWithWhitelist.new(email: "foo@#{whitelist_domain}")
+      it "is invalid if the domain is disposable and not in the allow list" do
+        user = TestUserDisallowDisposableWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_falsey
       end
 
-      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}")
+      it "is valid if the domain is disposable but in the allow list" do
+        File.open(allow_list_file_path, "w") { |f| f.write [allow_list_domain].to_yaml }
+        set_allow_list
+        user = TestUserDisallowDisposableWithAllowList.new(email: "foo@#{allow_list_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}")
+      it "is invalid if the domain is a disposable_domain and not in the allow list" do
+        user = TestUserDisallowDisposableDomainWithAllowList.new(email: "foo@#{allow_list_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}")
+      it "is valid if the domain is a disposable_domain but in the allow list" do
+        File.open(allow_list_file_path, "w") { |f| f.write [allow_list_domain].to_yaml }
+        set_allow_list
+        user = TestUserDisallowDisposableDomainWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_truthy
       end
     end
   end
 
-  describe "with blacklist validation" do
-    it "is valid if the domain is not blacklisted" do
-      user = TestUserDisallowBlacklisted.new(email: "foo@gmail.com")
+  describe "with deny list validation" do
+    it "is valid if the domain is not deny-listed" do
+      user = TestUserDisallowDenyListed.new(email: "foo@gmail.com")
       expect(user.valid?).to be_truthy
     end
 
-    it "is invalid if the domain is blacklisted" do
-      user = TestUserDisallowBlacklisted.new(email: "foo@blacklisted-test.com")
+    it "is invalid if the domain is deny-listed" do
+      user = TestUserDisallowDenyListed.new(email: "foo@deny-listed-test.com")
       expect(user.valid?).to be_falsey
     end
   end

data/valid_email2.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ValidEmail2::VERSION
   spec.authors       = ["Micke Lisinge"]
   spec.email         = ["hi@micke.me"]
-  spec.description   = %q{ActiveModel validation for email. Including MX lookup and disposable email blacklist}
-  spec.summary       = %q{ActiveModel validation for email. Including MX lookup and disposable email blacklist}
+  spec.description   = %q{ActiveModel validation for email. Including MX lookup and disposable email deny list}
+  spec.summary       = %q{ActiveModel validation for email. Including MX lookup and disposable email deny list}
   spec.homepage      = "https://github.com/micke/valid_email2"
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 3.1.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3"
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "net-smtp"
   spec.add_development_dependency "pry"
   spec.add_runtime_dependency "mail", "~> 2.5"
-  spec.add_runtime_dependency "activemodel", ">= 3.2"
+  spec.add_runtime_dependency "activemodel", ">= 6.0"
+  spec.add_runtime_dependency "unicode-emoji", "~> 3.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 5.2.6
+  version: 6.0.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-10 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,16 +114,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: unicode-emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 description: ActiveModel validation for email. Including MX lookup and disposable
-  email blacklist
+  email deny list
 email:
 - hi@micke.me
 executables: []
@@ -140,12 +154,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- config/blacklisted_email_domains.yml
+- config/deny_listed_email_domains.yml
 - config/disposable_email_domains.txt
 - gemfiles/activemodel6.gemfile
 - gemfiles/activemodel7.gemfile
 - lib/valid_email2.rb
 - lib/valid_email2/address.rb
+- lib/valid_email2/dns_records_cache.rb
 - lib/valid_email2/email_validator.rb
 - lib/valid_email2/version.rb
 - pull_mailchecker_emails.rb
@@ -167,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -178,7 +193,7 @@ rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email
-  blacklist
+  deny list
 test_files:
 - spec/address_spec.rb
 - spec/benchmark_spec.rb

data/config/blacklisted_email_domains.yml

@@ -1 +0,0 @@
-- blacklisted-test.com