validators 3.1.0 → 3.4.0

data/lib/validators.rb

@@ -7,8 +7,9 @@ module Validators
   require "validators/ip"
   require "validators/tld"
   require "validators/hostname"
-  require "validators/disposable_hostnames"
-  require "validators/reserved_hostnames"
+  require "validators/disposable_domains"
+  require "validators/disposable_emails"
+  require "validators/reserved_subdomains"
 
   require "validators/validates_datetime"
   require "validators/validates_ip_address"
@@ -20,8 +21,8 @@ module Validators
   require "validators/validates_ssh_private_key"
   require "validators/validates_ssh_public_key"
   require "validators/validates_hostname_format_of"
-  require "validators/validates_reserved_hostname"
-  require "validators/validates_reserved_username"
+  require "validators/validates_subdomain"
+  require "validators/validates_username"
 
   I18n.load_path += Dir[File.join(__dir__, "validators/locale/*.yml")]
 end

data/lib/validators/constants.rb

@@ -2,7 +2,7 @@
 
 module Validators
   EMAIL_FORMAT = /\A[a-z0-9]+([-._][a-z0-9]+)*(\+[^@]+)?@[a-z0-9]+([.-][a-z0-9]+)*\.[a-z]{2,}\z/i.freeze
-  MICROSOFT_EMAIL_FORMAT = /\A[\w][\w\d._-]*[\w\d_-]+(\+[\w\d]+)?@(hotmail|outlook).com\z/i.freeze
+  MICROSOFT_EMAIL_FORMAT = /\A[a-z0-9][a-z0-9._-]*[a-z0-9_-]+(\+[a-z0-9]+)?@(hotmail|outlook).com\z/i.freeze
 
   # Source: https://github.com/henrik/validates_url_format_of
   IPV4_PART = /\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]/.freeze # 0-255

data/lib/validators/disposable_domains.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Validators
+  class DisposableDomains
+    def self.all
+      @all ||=
+        begin
+          require "email_data"
+          EmailData.disposable_domains
+        rescue LoadError
+          raise "email_data is not part of the bundle. Add it to Gemfile."
+        end
+    end
+
+    def self.include?(domain)
+      all.include?(domain)
+    end
+  end
+end

data/lib/validators/disposable_emails.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Validators
+  class DisposableEmails
+    def self.all
+      @all ||=
+        begin
+          require "email_data"
+          EmailData.disposable_emails
+        rescue LoadError
+          raise "email_data is not part of the bundle. Add it to Gemfile."
+        end
+    end
+
+    def self.include?(email)
+      mailbox, domain = email.to_s.split("@")
+      mailbox = mailbox.to_s.gsub(".", "")
+      mailbox = mailbox.gsub(/\+(.+)?\Z/, "")
+
+      all.include?("#{mailbox}@#{domain}")
+    end
+  end
+end

data/lib/validators/locale/en.yml

@@ -3,7 +3,8 @@ en:
   activemodel: &activemodel
     errors:
       messages:
-        disposable_email: "is not allowed (high-bounce domain)"
+        disposable_email: "is not allowed (high-bounce email)"
+        disposable_domain: "is not allowed (high-bounce domain)"
         invalid_cnpj: "is not a valid CNPJ"
         invalid_cpf: "is not a valid CPF"
         invalid_date: "is not a valid date"
@@ -20,8 +21,10 @@ en:
         invalid_ssh_private_key_type: "must be a %{value} key"
         invalid_ssh_public_key: "is not a valid public SSH key"
         invalid_url: "is not a valid address"
-        reserved_hostname: "%{value} is a reserved hostname"
+        reserved_subdomain: "%{value} is a reserved subdomain"
+        invalid_subdomain: "is invalid"
         reserved_username: "%{value} is a reserved username"
+        invalid_username: "is invalid"
 
   activerecord:
     <<: *activemodel

data/lib/validators/locale/pt-BR.yml

@@ -4,6 +4,7 @@ pt-BR:
     errors:
       messages:
         disposable_email: "não é permitido (e-mail temporário)"
+        disposable_domain: "não é permitido (e-mail temporário)"
         invalid_cnpj: "não é um CNPJ válido"
         invalid_cpf: "não é um CPF válido"
         invalid_date: "não é uma data válida"

data/lib/validators/{reserved_hostnames.rb → reserved_subdomains.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Validators
-  class ReservedHostnames
-    FILE_PATH = File.expand_path("../../data/reserved_hostnames.json", __dir__)
+  class ReservedSubdomains
+    FILE_PATH = File.expand_path("../../data/reserved_subdomains.txt", __dir__)
 
     def self.reserved?(hostname, matchers = nil)
       matchers = parse_list(matchers) if matchers
@@ -11,9 +11,7 @@ module Validators
     end
 
     def self.all
-      @all ||= JSON
-               .parse(File.read(FILE_PATH))
-               .map {|matcher| parse(matcher) }
+      @all ||= File.read(FILE_PATH).lines.map {|matcher| parse(matcher.chomp) }
     end
 
     def self.parse(matcher)

data/lib/validators/tld.rb

@@ -2,10 +2,14 @@
 
 module Validators
   class TLD
-    FILE_PATH = File.expand_path("../../data/tld.json", __dir__)
-
     def self.all
-      @all ||= JSON.parse(File.read(FILE_PATH))
+      @all ||=
+        begin
+          require "email_data"
+          EmailData.tlds
+        rescue LoadError
+          raise "email_data is not part of the bundle. Add it to Gemfile."
+        end
     end
 
     def self.host_with_valid_tld?(host)
@@ -13,10 +17,10 @@ module Validators
 
       return false if host.split(".").size == 1
 
-      valid?(host[/\.([^.]+)$/, 1].to_s.downcase)
+      include?(host[/\.([^.]+)$/, 1].to_s.downcase)
     end
 
-    def self.valid?(tld)
+    def self.include?(tld)
       all.include?(tld)
     end
   end

data/lib/validators/validates_email_format_of.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "root_domain"
+
 module ActiveModel
   module Validations
     class EmailValidator < EachValidator
@@ -14,6 +16,7 @@ module ActiveModel
 
         validate_tld(record, attribute, value, options) if check_tld
         validate_email_format(record, attribute, value, options)
+        validate_disposable_domain(record, attribute, value, options) unless allow_disposable
         validate_disposable_email(record, attribute, value, options) unless allow_disposable
       end
 
@@ -41,12 +44,24 @@ module ActiveModel
         )
       end
 
-      def validate_disposable_email(record, attribute, value, _options)
+      def validate_disposable_domain(record, attribute, value, _options)
+        return unless value
+
         hostname = value.to_s.split(AT_SIGN).last.to_s.downcase
+        root_domain = RootDomain.call(hostname)
 
-        return if Validators::DisposableHostnames.all.none? do |disposable_hostname|
-          hostname == disposable_hostname || hostname.end_with?(".#{disposable_hostname}")
-        end
+        return unless Validators::DisposableDomains.include?(root_domain)
+
+        record.errors.add(
+          attribute,
+          :disposable_domain,
+          value: value
+        )
+      end
+
+      def validate_disposable_email(record, attribute, value, _options)
+        return unless value
+        return unless Validators::DisposableEmails.include?(value)
 
         record.errors.add(
           attribute,

data/lib/validators/validates_subdomain.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class SubdomainValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if value.nil? && options[:allow_nil]
+
+        value = value.to_s
+
+        validate_reserved_subdomain(record, attribute, value)
+        validate_format(record, attribute, value)
+      end
+
+      def reserved?(subdomain)
+        ::Validators::ReservedSubdomains.reserved?(subdomain, options[:in])
+      end
+
+      def validate_reserved_subdomain(record, attribute, value)
+        return unless options.fetch(:reserved, true)
+        return unless reserved?(value)
+
+        record.errors.add(
+          attribute,
+          :"reserved_#{options[:error_name]}",
+          message: options[:message],
+          value: value
+        )
+      end
+
+      def validate_format(record, attribute, value)
+        return if Validators::Hostname.valid_label?(value)
+
+        record.errors.add(
+          attribute,
+          :"invalid_#{options[:error_name]}",
+          message: options[:message],
+          value: value
+        )
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified host label is valid.
+      # The `in: array` can have strings and patterns. A pattern is everything
+      # that starts with `/` and will be parsed as a regular expression.
+      #
+      # Notice that subdomains will be normalized; it'll be downcased and have
+      # its underscores and hyphens stripped before validating.
+      #
+      #   class User < ActiveRecord::Base
+      #     # Validates format and rejects reserved subdomains.
+      #     validates_subdomain :subdomain
+      #
+      #     # Validates against a custom list.
+      #     validates_subdomain :subdomain, in: %w[www]
+      #
+      #     # Rejects reserved domains validation.
+      #     validates_subdomain :subdomain, reserved: false
+      #   end
+      #
+      def validates_subdomain(*attr_names)
+        options = _merge_attributes(attr_names).merge(error_name: :subdomain)
+        validates_with SubdomainValidator, options
+      end
+    end
+  end
+end

data/lib/validators/validates_username.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class UsernameValidator < SubdomainValidator
+    end
+
+    module ClassMethods
+      def validates_username(*attr_names)
+        options = _merge_attributes(attr_names).merge(error_name: :username)
+        validates_with UsernameValidator, options
+      end
+    end
+  end
+end

data/lib/validators/version.rb

@@ -3,7 +3,7 @@
 module Validators
   module Version
     MAJOR = 3
-    MINOR = 1
+    MINOR = 4
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

data/test/test_helper.rb

@@ -3,7 +3,6 @@
 $VERBOSE = nil
 
 require "simplecov"
-SimpleCov.start
 
 SimpleCov.start do
   add_filter "test/support"
@@ -17,9 +16,25 @@ require "active_support/all"
 require "minitest/utils"
 require "minitest/autorun"
 
+def build_email_with_filter(email)
+  mailbox, domain = email.split("@")
+  "#{mailbox}+#{SecureRandom.hex(3)}@#{domain}"
+end
+
+def build_email_with_dots(email)
+  mailbox, domain = email.split("@")
+  new_mailbox = mailbox.chars.map {|char| [char, "."] }.flatten[0..-2].join
+
+  "#{new_mailbox}@#{domain}"
+end
+
 Time.zone = "America/Sao_Paulo"
 TLDs = Validators::TLD.all.sample(10)
-DISPOSABLE_EMAILS = Validators::DisposableHostnames.all.sample(10)
+DISPOSABLE_DOMAINS = Validators::DisposableDomains.all.sample(10)
+DISPOSABLE_EMAILS = Validators::DisposableEmails.all +
+                    Validators::DisposableEmails.all.sample(10).map {|email| build_email_with_filter(email) } +
+                    Validators::DisposableEmails.all.sample(10).map {|email| build_email_with_dots(email) } +
+                    Validators::DisposableEmails.all.sample(10).map {|email| build_email_with_filter(build_email_with_dots(email)) }
 
 Dir[File.join(__dir__, "support/**/*.rb")].sort.each {|f| require f }
 

data/test/validators/disposable_email_test.rb

@@ -3,18 +3,19 @@
 require "test_helper"
 
 class DisposableEmailTest < Minitest::Test
-  DISPOSABLE_EMAILS.each do |domain|
-    test "rejects disposable e-mail (#{domain})" do
+  DISPOSABLE_DOMAINS.each do |domain|
+    test "rejects disposable domain (#{domain})" do
       User.validates_email_format_of :email
 
       user = User.new(email: "user@#{domain}")
       user.valid?
 
-      assert_includes user.errors[:email], I18n.t("activerecord.errors.messages.disposable_email")
+      assert_includes user.errors[:email],
+                      I18n.t("activerecord.errors.messages.disposable_domain")
     end
   end
 
-  DISPOSABLE_EMAILS.each do |domain|
+  DISPOSABLE_DOMAINS.each do |domain|
     test "rejects disposable e-mail with subdomain (custom.#{domain})" do
       User.validates_email_format_of :email
 
@@ -22,7 +23,7 @@ class DisposableEmailTest < Minitest::Test
       user.valid?
 
       assert_includes user.errors[:email],
-                      "is not allowed (high-bounce domain)"
+                      I18n.t("activerecord.errors.messages.disposable_domain")
     end
   end
 
@@ -34,4 +35,16 @@ class DisposableEmailTest < Minitest::Test
 
     assert user.errors[:email].empty?
   end
+
+  DISPOSABLE_EMAILS.each do |email|
+    test "rejects disposable e-mail (#{email})" do
+      User.validates_email_format_of :email
+
+      user = User.new(email: email)
+      user.valid?
+
+      assert_includes user.errors[:email],
+                      I18n.t("activerecord.errors.messages.disposable_email")
+    end
+  end
 end

data/test/validators/validates_email_format_of_test.rb

@@ -12,10 +12,12 @@ class ValidatesEmailFormatOfTest < Minitest::Test
   VALID_EMAILS.each do |email|
     test "accepts #{email.inspect} as a valid email" do
       user = User.new(email: email, corporate_email: email)
-      assert user.valid?
+      user.valid?
+      assert_empty user.errors
 
       user = Person.new(email: email)
-      assert user.valid?
+      user.valid?
+      assert_empty user.errors
     end
   end
 

data/test/validators/validates_subdomain_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ValidatesSubdomainTest < Minitest::Test
+  test "don't explode with nil values" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain
+    end
+
+    instance = model.new(subdomain: nil)
+
+    refute instance.valid?
+    assert_includes instance.errors[:subdomain], "is invalid"
+  end
+
+  test "rejects invalid subdomain" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain
+    end
+
+    instance = model.new(subdomain: "1234")
+
+    refute instance.valid?
+    assert_includes instance.errors[:subdomain], "is invalid"
+  end
+
+  test "rejects reserved subdomain" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain
+    end
+
+    instance = model.new(subdomain: "www")
+
+    refute instance.valid?
+    assert_includes instance.errors[:subdomain],
+                    "www is a reserved subdomain"
+  end
+
+  test "rejects reserved subdomain with pattern" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain
+    end
+
+    instance = model.new(subdomain: "www1234")
+
+    refute instance.valid?
+  end
+
+  test "uses custom list" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain, in: %w[nope]
+    end
+
+    instance = model.new(subdomain: "nope")
+
+    refute instance.valid?
+  end
+
+  test "ignores reserved subdomain validation" do
+    model = build_model do
+      attr_accessor :subdomain
+      validates_subdomain :subdomain, reserved: false
+    end
+
+    instance = model.new(subdomain: "www")
+
+    assert instance.valid?
+  end
+end