email_assessor 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ec3fdbcb7339d1a5d0854cc8fde6b45bc0440e8154807870a36332023be74bc
-  data.tar.gz: f5ccda7423d991a5e1512a96c39f38bb423bcdf6c86d51ca6f7f487ddfc3571a
+  metadata.gz: 8cb395329e3cd39283e977bf23e76aace70bf54f8a4e735fb853452e9e2cd6a9
+  data.tar.gz: b5584869b5c06e03a9be43827685a59b69a1d3b0f516b3670649557097ddc642
 SHA512:
-  metadata.gz: c083397bac2fa9a19441e9bb2697344522b54ef7abc0bf206d6f015a185ac365aecbdc1adaa4d50f1a1d393f7c541c821ec1807eda036608dec10188fe3bee4c
-  data.tar.gz: 92c2b3199bba839ac4e993caa677c20c033cc27b84fcd87cf3c0f85492c0d650bdb2725776882d4eed78616eeffdf08cfc764402aecdb41d34cd81f8caf0314b
+  metadata.gz: 22b2a38efbcb45ced0186a9a00a159747aa6c7d66c21c942b02d7862014f99e2a5b3c985d91cab0377ceee2fa91bfbf404e683bfb7b503ad57da4c4fc1bdeadf
+  data.tar.gz: 38fc56dd35d5c2dbc31f95cd491398ed102bdc494e6674c5e552e775ba57c538f750c5ae5823ba36ca89d2031b3cffd295fc552047e8793d8ca82a2394f6ec68

data/lib/email_assessor/address.rb

@@ -111,11 +111,23 @@ module EmailAssessor
     end
 
     def disposable?
-      valid? && EmailAssessor.domain_is_disposable?(address.domain)
+      domain_in_file?(EmailAssessor::DISPOSABLE_DOMAINS_FILE_NAME)
     end
 
     def blacklisted?
-      valid? && EmailAssessor.domain_is_blacklisted?(address.domain)
+      domain_in_file?(EmailAssessor::BLACKLISTED_DOMAINS_FILE_NAME)
+    end
+
+    def educational?
+      domain_in_file?(EmailAssessor::EDUCATIONAL_DOMAINS_FILE_NAME)
+    end
+
+    def fastpass?
+      domain_in_file?(EmailAssessor::FASTPASS_DOMAINS_FILE_NAME)
+    end
+
+    def domain_in_file?(filename)
+      valid? && EmailAssessor.domain_in_file?(address.domain, filename)
     end
 
     def valid_mx?

data/lib/email_assessor/email_validator.rb

@@ -5,31 +5,74 @@ require "active_model/validations"
 
 class EmailValidator < ActiveModel::EachValidator
   def default_options
-    { regex: true, disposable: false, mx: false }
+    { regex: true, disposable: false, mx: false, fastpass: true }
   end
 
   def validate_each(record, attribute, value)
     return unless value.present?
-    options = default_options.merge(self.options)
+
+    options = default_options.merge!(self.options)
 
     address = EmailAssessor::Address.new(value)
 
     error(record, attribute) && return unless address.valid?
 
+    # Skip all domain blocklist checks for fastpass domains.
+    # The goal is to skip needless validation for common "good" domains such as Gmail, Yahoo, and Outlook.
+    # The fastpass domain list is configurable via vendor/fastpass_domains.txt
+    validate_domain(record, attribute, address, options) unless options[:fastpass] && address.fastpass?
+
+    # Exit early if validate_domain found a validation error
+    return if record.errors.key?(attribute)
+
+    if options[:mx]
+      error(record, attribute, error_type(:mx, options)) && return unless address.valid_mx?
+    end
+  end
+
+  private
+
+  def error(record, attribute, type = options[:message] || :invalid)
+    record.errors.add(attribute, type)
+  end
+
+  def error_type(validator, options)
+    option_value = options[validator]
+
+    if option_value.is_a?(String) || option_value.is_a?(Symbol)
+      return option_value
+    end
+
+    options[:message] || :invalid
+  end
+
+  def validate_domain(record, attribute, address, options)
     if options[:disposable]
-      error(record, attribute) && return if address.disposable?
+      error(record, attribute, error_type(:disposable, options)) && return if address.disposable?
     end
 
     if options[:blacklist]
-      error(record, attribute) && return if address.blacklisted?
+      error(record, attribute, error_type(:blacklist, options)) && return if address.blacklisted?
     end
 
-    if options[:mx]
-      error(record, attribute) && return unless address.valid_mx?
+    if options[:educational]
+      error(record, attribute, error_type(:educational, options)) && return if address.educational?
     end
-  end
 
-  def error(record, attribute)
-    record.errors.add(attribute, options[:message] || :invalid)
+    # if options[:domain_not_in]
+    #   matched_blocklist = options[:domain_not_in].select do |entry|
+    #     unless entry.key?(:blocklist)
+    #       fail "domain_not_in entries must be in format { blocklist: \"filename\"[, message: symbol|string] }"
+    #     end
+
+    #     next unless address.domain_in_blocklist?(entry[:blocklist])
+
+    #     error(record, attribute, entry[:message])
+
+    #     true
+    #   end
+
+    #   return if matched_blocklist
+    # end
   end
 end

data/lib/email_assessor/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module EmailAssessor
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/email_assessor.rb

@@ -3,6 +3,8 @@ require "email_assessor/email_validator"
 
 module EmailAssessor
   DISPOSABLE_DOMAINS_FILE_NAME = File.expand_path("../../vendor/disposable_domains.txt", __FILE__)
+  FASTPASS_DOMAINS_FILE_NAME = File.expand_path("../../vendor/fastpass_domains.txt", __FILE__)
+  EDUCATIONAL_DOMAINS_FILE_NAME = File.expand_path("../../vendor/educational_domains.txt", __FILE__)
   BLACKLISTED_DOMAINS_FILE_NAME = File.expand_path("vendor/blacklisted_domains.txt")
 
   def self.domain_is_disposable?(domain)

data/spec/email_assessor_spec.rb

@@ -17,10 +17,15 @@ class TestUserDisallowBlacklisted < TestModel
   validates :email, email: { blacklist: true }
 end
 
+class TestUserDisallowEducational < TestModel
+  validates :email, email: { educational: :no_educational }
+end
+
 describe EmailAssessor do
   let(:plain_user) { TestUser.new(email: "") }
   let(:disposable_user) { TestUserDisallowDisposable.new(email: "foo@gmail.com") }
   let(:blacklist_user) { TestUserDisallowBlacklisted.new(email: "foo@gmail.com") }
+  let(:educational_user) { TestUserDisallowEducational.new(email: "foo@gmail.com") }
   let(:mx_user) { TestUserMX.new(email: "foo@gmail.com") }
 
   let(:blacklisted_domains_file_name) { described_class::BLACKLISTED_DOMAINS_FILE_NAME }
@@ -29,6 +34,9 @@ describe EmailAssessor do
   let(:disposable_domains_file_name) { described_class::DISPOSABLE_DOMAINS_FILE_NAME }
   let(:disposable_domain) { File.open(disposable_domains_file_name, &:readline).chomp }
 
+  let(:educational_domains_file_name) { described_class::EDUCATIONAL_DOMAINS_FILE_NAME }
+  let(:educational_domain) { File.open(educational_domains_file_name, &:readline).chomp }
+
   describe "basic validation" do
     subject(:user) { plain_user }
 
@@ -161,6 +169,31 @@ describe EmailAssessor do
     end
   end
 
+  describe "educational domains" do
+    subject(:user) { educational_user }
+
+    it "is valid when email domain is not in the educational blocklist" do
+      is_expected.to be_valid
+    end
+
+    it "is invalid when email domain is in the educational blocklist" do
+      user.email = "foo@#{educational_domain}"
+      is_expected.to be_invalid
+    end
+
+    it "is invalid when email is in the educational blocklist regardless of case" do
+      user.email = "foo@#{educational_domain.upcase}"
+      is_expected.to be_invalid
+    end
+
+    it "is invalid when email domain is in the educational blocklist regardless of subdomain" do
+      user.email = "foo@abc123.#{educational_domain}"
+      is_expected.to be_invalid
+      expect(user.errors.added?(:email, :no_educational)).to be_truthy
+    end
+  end
+
+
   describe "mx lookup" do
     subject(:user) { mx_user }