valid_email2 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925627af7072ddf7e2f82482253520d9bef1111e605317106afbf84b951c5a57
-  data.tar.gz: 7eb5251aa7f5cf9e2bcd24c63f23fb45ea6770581d8e1ceebf00933f64f24498
+  metadata.gz: c2972753ce57ed3f1c8b9f4b3a5738956bcd3bd67deed34ae248180c9b01155f
+  data.tar.gz: 7b0ca1ec81052af623267b0703e90e63f4200133f556bc6dbe52663593588399
 SHA512:
-  metadata.gz: 3f02e361ed0c985a4f770a09222fef9179de6a9f01995ac84c57ae6b9a843172afaf80116d01dc1ad9a9b5959dfcc6a089ce5b2ea2d6340701308b8e3b8a9817
-  data.tar.gz: f05c620994e0aaf353dfc4227cc317d20d2bd9be59e1b85ba4ab70db5d0cf0522ed939dab7fff625ad5701c710da33f037ba37e44123d9f1989b14b3faa64980
+  metadata.gz: 1ff8f1b5eee02958bbd8337e340f9fc90fc41f0d7ede63a3019a403bcc65c1dc6d6f4f031a386e15f601316d4965a3068d6d023a34dfdcca0410f209e46e51b1
+  data.tar.gz: 7a27bc60a0b7e4522ce28a5bc055b37750a285811b3d2aba8ff0d93addeb70668dcb770c4cf62b28b03486d8bd135bb46f040657028893e8e6aeba083a5ca04f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Version 5.2.0
+* Allow configuration of DNS nameserver [#230](https://github.com/micke/valid_email2/pull/230)
+
 ## Version 5.1.1
 * Remove false positives [#223](https://github.com/micke/valid_email2/issues/223)
 

data/README.md

@@ -51,12 +51,18 @@ To validate strictly that the domain has an MX record:
 ```ruby
 validates :email, 'valid_email_2/email': { strict_mx: true }
 ```
-`strict_mx` and `mx` both default to a 5 second timeout for DNS lookups.  To
-override this timeout, specify a `dns_timeout` option:
+`strict_mx` and `mx` both default to a 5 second timeout for DNS lookups.  
+To override this timeout, specify a `dns_timeout` option:
 ```ruby
 validates :email, 'valid_email_2/email': { strict_mx: true, dns_timeout: 10 }
 ```
 
+Any checks that require DNS resolution will use the default `Resolv::DNS` nameservers for DNS lookups.  
+To override these, specify a `dns_nameserver` option:
+```ruby
+validates :email, 'valid_email_2/email': { mx: true, dns_nameserver: ['8.8.8.8', '8.8.4.4'] }
+```
+
 To validate that the domain is not a disposable email (checks domain and MX server):
 ```ruby
 validates :email, 'valid_email_2/email': { disposable: true }

data/lib/valid_email2/address.rb

@@ -20,11 +20,14 @@ module ValidEmail2
       @prohibited_domain_characters_regex = val
     end
 
-    def initialize(address, dns_timeout = 5)
+    def initialize(address, dns_timeout = 5, dns_nameserver = nil)
       @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
+
       begin
         @address = Mail::Address.new(address)
       rescue Mail::Field::ParseError
@@ -134,7 +137,7 @@ module ValidEmail2
     end
 
     def mx_servers
-      @mx_servers ||= Resolv::DNS.open do |dns|
+      @mx_servers ||= Resolv::DNS.open(@resolv_config) do |dns|
         dns.timeouts = @dns_timeout
         dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
       end
@@ -145,7 +148,7 @@ module ValidEmail2
     end
 
     def mx_or_a_servers
-      @mx_or_a_servers ||= Resolv::DNS.open do |dns|
+      @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)

data/lib/valid_email2/email_validator.rb

@@ -5,14 +5,14 @@ require "active_model/validations"
 module ValidEmail2
   class EmailValidator < ActiveModel::EachValidator
     def default_options
-      { disposable: false, mx: false, strict_mx: false, disallow_subaddressing: false, multiple: false, dns_timeout: 5 }
+      { disposable: false, mx: false, strict_mx: false, disallow_subaddressing: false, multiple: false, dns_timeout: 5, dns_nameserver: nil }
     end
 
     def validate_each(record, attribute, value)
       return unless value.present?
       options = default_options.merge(self.options)
 
-      addresses = sanitized_values(value).map { |v| ValidEmail2::Address.new(v, options[:dns_timeout]) }
+      addresses = sanitized_values(value).map { |v| ValidEmail2::Address.new(v, options[:dns_timeout], options[:dns_nameserver]) }
 
       error(record, attribute) && return unless addresses.all?(&:valid?)
 

data/lib/valid_email2/version.rb

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

data/spec/valid_email2_spec.rb

@@ -23,6 +23,22 @@ class TestUserStrictMX < TestModel
   validates :email, 'valid_email_2/email': { strict_mx: true }
 end
 
+class TestUserMXDnsTimeout < TestModel
+  validates :email, 'valid_email_2/email': { mx: true, dns_timeout: 10 }
+end
+
+class TestUserMXDnsFailingTimeout < TestModel
+  validates :email, 'valid_email_2/email': { mx: true, dns_timeout: Float::MIN }
+end
+
+class TestUserMXDnsNameserver < TestModel
+  validates :email, 'valid_email_2/email': { mx: true, dns_nameserver: ['8.8.8.8', '8.8.4.4'] }
+end
+
+class TestUserMXDnsFailingNameserver < TestModel
+  validates :email, 'valid_email_2/email': { mx: true, dns_timeout: 0.1, dns_nameserver: '1.0.0.0' }
+end
+
 class TestUserDisallowDisposable < TestModel
   validates :email, 'valid_email_2/email': { disposable: true }
 end
@@ -292,6 +308,94 @@ describe ValidEmail2 do
     end
   end
 
+  describe "with mx validation and dns not hitting timeout" do
+    it "is valid if mx records are found" do
+      user = TestUserMXDnsTimeout.new(email: "foo@gmail.com")
+      expect(user.valid?).to be_truthy
+    end
+
+    it "is valid if A records are found" do
+      user = TestUserMXDnsTimeout.new(email: "foo@ghs.google.com")
+      expect(user.valid?).to be_truthy
+    end
+
+    it "is invalid if no mx records are found" do
+      user = TestUserMXDnsTimeout.new(email: "foo@subdomain.gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if a null mx is found" do
+      user = TestUserMXDnsTimeout.new(email: "foo@gmail.de")
+      expect(user.valid?).to be_falsey
+    end
+  end
+
+  describe "with mx validation and dns hitting timeout" do
+    it "is never valid even if mx records exist" do
+      user = TestUserMXDnsFailingTimeout.new(email: "foo@gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is never valid even A records exist" do
+      user = TestUserMXDnsFailingTimeout.new(email: "foo@ghs.google.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if no mx records exist" do
+      user = TestUserMXDnsFailingTimeout.new(email: "foo@subdomain.gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if a null mx exists" do
+      user = TestUserMXDnsFailingTimeout.new(email: "foo@gmail.de")
+      expect(user.valid?).to be_falsey
+    end
+  end
+
+  describe "with mx validation and dns nameserver" do
+    it "is valid if mx records are found" do
+      user = TestUserMXDnsNameserver.new(email: "foo@gmail.com")
+      expect(user.valid?).to be_truthy
+    end
+
+    it "is valid if A records are found" do
+      user = TestUserMXDnsNameserver.new(email: "foo@ghs.google.com")
+      expect(user.valid?).to be_truthy
+    end
+
+    it "is invalid if no mx records are found" do
+      user = TestUserMXDnsNameserver.new(email: "foo@subdomain.gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if a null mx is found" do
+      user = TestUserMXDnsNameserver.new(email: "foo@gmail.de")
+      expect(user.valid?).to be_falsey
+    end
+  end
+
+  describe "with mx validation and failing dns nameserver" do
+    it "is never valid even if mx records exist" do
+      user = TestUserMXDnsFailingNameserver.new(email: "foo@gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is never valid even A records exist" do
+      user = TestUserMXDnsFailingNameserver.new(email: "foo@ghs.google.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if no mx records exist" do
+      user = TestUserMXDnsFailingNameserver.new(email: "foo@subdomain.gmail.com")
+      expect(user.valid?).to be_falsey
+    end
+
+    it "is invalid if a null mx exists" do
+      user = TestUserMXDnsFailingNameserver.new(email: "foo@gmail.de")
+      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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler