valid_email2 7.0.15 → 7.1.0

data/lib/valid_email2/address.rb

@@ -8,9 +8,12 @@ module ValidEmail2
   class Address
     attr_accessor :address
 
-    PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'#`]/
+    PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'#`|]/
     DEFAULT_RECIPIENT_DELIMITER = '+'
     DOT_DELIMITER = '.'
+    HYPHEN_DELIMITER = '-'
+    MAX_DOMAIN_LENGTH = 253
+    MAX_LABEL_LENGTH = 63
 
     def self.prohibited_domain_characters_regex
       @prohibited_domain_characters_regex ||= PROHIBITED_DOMAIN_CHARACTERS_REGEX
@@ -52,13 +55,13 @@ module ValidEmail2
     def valid_domain?
       domain = address.domain
       return false if domain.nil?
+      return false if domain =~ self.class.prohibited_domain_characters_regex
+      return false if domain.length > MAX_DOMAIN_LENGTH
 
-      domain !~ self.class.prohibited_domain_characters_regex &&
-        domain.include?('.') &&
-        !domain.include?('..') &&
-        !domain.start_with?('.') &&
-        !domain.start_with?('-') &&
-        !domain.include?('-.')
+      labels = domain.split(DOT_DELIMITER, -1)
+      return false if labels.length < 2
+
+      labels.all? { |label| valid_domain_label?(label) }
     end
 
     def valid_address?
@@ -82,11 +85,11 @@ module ValidEmail2
     end
 
     def disposable_domain?
-      domain_is_in?(address.domain, ValidEmail2.disposable_emails)
+      valid? && domain_is_in?(address.domain, ValidEmail2.disposable_emails)
     end
 
     def allow_listed?
-      domain_is_in?(address.domain, ValidEmail2.allow_list)
+      valid? && domain_is_in?(address.domain, ValidEmail2.allow_list)
     end
 
     def deny_listed?
@@ -109,6 +112,14 @@ module ValidEmail2
 
     private
 
+    # An RFC 1035 label: 1-63 octets, and it may not begin or end with a hyphen.
+    def valid_domain_label?(label)
+      !label.empty? &&
+        label.length <= MAX_LABEL_LENGTH &&
+        !label.start_with?(HYPHEN_DELIMITER) &&
+        !label.end_with?(HYPHEN_DELIMITER)
+    end
+
     def disposable_mx_server?
       mx_server_is_in?(ValidEmail2.disposable_emails)
     end

data/lib/valid_email2/email_validator.rb

@@ -6,7 +6,16 @@ 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, dns_nameserver: nil }
+      {
+        disposable: false,
+        mx: false,
+        strict_mx: false,
+        disallow_subaddressing: false,
+        multiple: false,
+        dns_timeout: 5,
+        dns_nameserver: nil,
+        specific_error_messages: false
+      }
     end
 
     def validate_each(record, attribute, value)
@@ -19,39 +28,39 @@ module ValidEmail2
       error(record, attribute) && return unless addresses.all?(&:valid?)
 
       if options[:disallow_dotted]
-        error(record, attribute) && return if addresses.any?(&:dotted?)
+        error(record, attribute, :disallow_dotted) && return if addresses.any?(&:dotted?)
       end
 
       if options[:disallow_subaddressing]
-        error(record, attribute) && return if addresses.any?(&:subaddressed?)
+        error(record, attribute, :disallow_subaddressing) && return if addresses.any?(&:subaddressed?)
       end
 
       if options[:disposable]
-        error(record, attribute) && return if addresses.any?(&:disposable?)
+        error(record, attribute, :disposable) && return if addresses.any?(&:disposable?)
       end
 
       if options[:disposable_domain]
-        error(record, attribute) && return if addresses.any?(&:disposable_domain?)
+        error(record, attribute, :disposable_domain) && return if addresses.any?(&:disposable_domain?)
       end
 
       if options[:disposable_with_allow_list]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.allow_listed? }
+        error(record, attribute, :disposable_with_allow_list) && return if addresses.any? { |address| address.disposable? && !address.allow_listed? }
       end
 
       if options[:disposable_domain_with_allow_list]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.allow_listed? }
+        error(record, attribute, :disposable_domain_with_allow_list) && return if addresses.any? { |address| address.disposable_domain? && !address.allow_listed? }
       end
 
       if options[:deny_list]
-        error(record, attribute) && return if addresses.any?(&:deny_listed?)
+        error(record, attribute, :deny_list) && return if addresses.any?(&:deny_listed?)
       end
 
       if options[:mx]
-        error(record, attribute) && return unless addresses.all?(&:valid_mx?)
+        error(record, attribute, :mx) && return unless addresses.all?(&:valid_mx?)
       end
 
       if options[:strict_mx]
-        error(record, attribute) && return unless addresses.all?(&:valid_strict_mx?)
+        error(record, attribute, :strict_mx) && return unless addresses.all?(&:valid_strict_mx?)
       end
     end
 
@@ -67,10 +76,11 @@ module ValidEmail2
       email_list.reject(&:empty?)
     end
 
-    def error(record, attribute)
+    def error(record, attribute, error_key = :invalid)
       message = options[:message].respond_to?(:call) ? options[:message].call : options[:message]
+      message ||= options[:specific_error_messages] ? error_key : :invalid
 
-      record.errors.add(attribute, message || :invalid)
+      record.errors.add(attribute, message)
     end
   end
 end

data/lib/valid_email2/version.rb

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

data/pull_mailchecker_emails.rb

@@ -16,6 +16,7 @@ allow_listed_emails = %w[
   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 embarqmail.com
+  unlimit.com reallyfast.info
 ]
 
 existing_emails = File.open("config/disposable_email_domains.txt") { |f| f.read.split("\n") }

data/spec/address_spec.rb

@@ -38,6 +38,11 @@ describe ValidEmail2::Address do
       expect(address.valid?).to be false
     end
 
+    it "is invalid if email contains a pipe" do
+      address = described_class.new("foo@gmai|.com")
+      expect(address.valid?).to be false
+    end
+
     it "is invalid if it contains Japanese characters" do
       address = described_class.new("あいうえお@example.com")
       expect(address.valid?).to be false
@@ -83,6 +88,11 @@ describe ValidEmail2::Address do
         address = described_class.new("foo@example.com")
         expect(address.disposable_domain?).to eq false
       end
+
+      it "is false if the email cannot be parsed" do
+        address = described_class.new('"><test>')
+        expect(address.disposable_domain?).to eq false
+      end
     end
 
     context "when the disposable domain has subdomains" do

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 $:.unshift File.expand_path("../lib",__FILE__)
+require "bundler/setup"
+require "rspec"
 require "valid_email2"
 require "debug"
 

data/spec/valid_email2_spec.rb

@@ -7,6 +7,10 @@ class TestUser < TestModel
   validates :email, 'valid_email_2/email': true
 end
 
+class TestUserSpecificErrorMessage < TestModel
+  validates :email, 'valid_email_2/email': { disallow_dotted: true, specific_error_messages: true }
+end
+
 class TestUserDotted < TestModel
   validates :email, 'valid_email_2/email': { disallow_dotted: true }
 end
@@ -171,6 +175,48 @@ describe ValidEmail2 do
       user = TestUser.new(email: "foo@example.com#")
       expect(user.valid?).to be_falsey
     end
+
+    describe "domain label structure" do
+      # A domain label may not begin or end with a hyphen and is limited to 63
+      # octets; the whole domain is limited to 253. These rules apply to every
+      # label, not only the first/last position of the domain string.
+      long_label = "a" * 64
+      long_domain = (["aa"] + ["a"] * 126).join(".") # 254 chars, all-valid labels
+
+      {
+        "a leading hyphen on the first label" => "foo@-example.com",
+        "a leading hyphen on a later label" => "foo@sub.-example.com",
+        "a leading hyphen on a deeply nested label" => "foo@a.b.-c.example.com",
+        "a trailing hyphen on a non-final label" => "foo@example-.com",
+        "a trailing hyphen on the final label" => "foo@example.com-",
+        "a bare hyphen label" => "foo@example.-.com",
+        "a label longer than 63 octets" => "foo@#{long_label}.com",
+        "a later label longer than 63 octets" => "foo@example.#{long_label}.com",
+        "a domain longer than 253 octets" => "foo@#{long_domain}"
+      }.each do |description, email|
+        it "is invalid with #{description}" do
+          expect(TestUser.new(email: email).valid?).to be_falsey
+        end
+      end
+
+      full_label = "a" * 63
+      max_domain = (["a"] * 127).join(".") # exactly 253 chars
+
+      {
+        "an internal hyphen" => "foo@ex-ample.com",
+        "hyphens on several internal labels" => "foo@f-o-o.example.com",
+        "a double internal hyphen" => "foo@a--b.example.com",
+        "a punycode (IDNA ACE) label" => "foo@xn--bcher-kva.com",
+        "a label beginning with a digit" => "foo@3m.com",
+        "a 63 octet label at the limit" => "foo@#{full_label}.com",
+        "a later 63 octet label" => "foo@example.#{full_label}.com",
+        "a domain at the 253 octet limit" => "foo@#{max_domain}"
+      }.each do |description, email|
+        it "is valid with #{description}" do
+          expect(TestUser.new(email: email).valid?).to be_truthy
+        end
+      end
+    end
   end
 
   describe "with disposable validation" do
@@ -418,6 +464,7 @@ describe ValidEmail2 do
     it "is invalid when address cotains dots" do
       user = TestUserDotted.new(email: "john.doe@gmail.com")
       expect(user.valid?).to be_falsey
+      expect(user.errors.full_messages).to include("Email is invalid")
     end
   end
 
@@ -433,6 +480,30 @@ describe ValidEmail2 do
     end
   end
 
+  context "when detail error messages are enabled" do
+    describe "with custom error message" do
+      it "supports settings a custom error message" do
+        with_translations(:en, { errors: { messages: { disallow_dotted: "dotted message" } } }) do
+          user = TestUserSpecificErrorMessage.new(email: "john.doe@gmail.com")
+          user.valid?
+
+          expect(user.errors.full_messages).to include("Email dotted message")
+        end
+      end
+    end
+  end
+
+  def with_translations(locale, translations)
+    original_backend = I18n.backend
+
+    I18n.backend = I18n::Backend::KeyValue.new({}, true)
+    I18n.backend.store_translations locale, translations
+
+    yield
+  ensure
+    I18n.backend = original_backend
+  end
+
   context "when message is present" do
     describe "with custom error message" do
       it "supports settings a custom error message" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 7.0.15
+  version: 7.1.0
 platform: ruby
 authors:
 - Micke Lisinge
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.19
 specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email
   deny list