email_assessor 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e8db711b1571f9f105f0e341b8798bf557edcdd21bfa9af93b97a2fc6e7989
-  data.tar.gz: 697a161767368eed35a1cf12eaca2fc9c129b6e27f4ab48a4bd07362597a678c
+  metadata.gz: 8cb395329e3cd39283e977bf23e76aace70bf54f8a4e735fb853452e9e2cd6a9
+  data.tar.gz: b5584869b5c06e03a9be43827685a59b69a1d3b0f516b3670649557097ddc642
 SHA512:
-  metadata.gz: ac12ac0944a707a72b3d7f507b016c0d4dad6cd3cd924c1f229178e8dd806cff1e2bdf4eca887566c2271c15ea4a9210f02b2f6e24e26d768c85e47e73104fdb
-  data.tar.gz: fd148a7343b485d42f320c0e7fcc2265a636f2973faacf3e928d5315c39e8b909c970809c6ebd07b3d929484a2239b33be3c7b2bb38ef0aeb0bd3648e2288db4
+  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.1"
+  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 }
 

data/vendor/educational_domains.txt

@@ -0,0 +1,169 @@
+edu
+education
+school
+edu.my
+edu.ph
+edu.au
+edu.vn
+edu.ar
+edu.sv
+edu.mx
+edu.eg
+edu.sg
+edu.co
+edu.jm
+edu.it
+edu.hk
+edu.bd
+edu.tr
+edu.om
+edu.mn
+edu.np
+edu.pk
+edu.ge
+edu.kh
+edu.br
+edu.tw
+edu.in
+edu.do
+edu.kw
+edu.iq
+edu.ee
+edu.pa
+edu.lb
+edu.gh
+edu.gt
+edu.sa
+edu.ec
+edu.pe
+edu.ng
+edu.gr
+edu.pl
+edu.lc
+edu.rs
+edu.cu
+ecsrd.ca
+lbpearson.ca
+egusd.net
+mytusd.org
+rcsd121.org
+nisdtx.org
+fusdk12.net
+stocktonusd.org
+ggusd.net
+ausd.net
+ousd.org
+mytusd.org
+rialtousd.org
+usd250.org
+cusd200.org
+lausd.net
+cusdstudent.com
+sgusd.net
+sjusd.org
+losbanosusd.net
+arusd.org
+cusdk12.org
+dvusd.org
+conejousd.net
+busdk12.com
+lbusd.org
+vusd.us
+cvusd.us
+scusd.net
+twinriversusd.org
+wcusd.net
+lusd.net
+sfusd.edu
+pusd.org
+mbusdapps.org
+lvjusd.org
+etusd.org
+hemetusd.org
+myabcusd.org
+lodiusd.org
+pusd.org
+gusd.org
+uusd.net
+cmsdk12.org
+dpsk12.net
+hdcsk12.org
+wilsonk12tn.us
+herricksk12.org
+gcssk12.net
+bostonk12.org
+rpsk12.org
+muhlsdk12.net
+lpsk12.org
+warrenk12nc.org
+washk12.org
+middletownk12.org
+astoriak12.org
+fusdk12.net
+aurorak12.org
+ycdsbk12.ca
+bentonvillek12.org
+soledadk12.org
+theacademyk12.org
+grinnell-k12.org
+maderak12.org
+boazk12.org
+ccsk12.net
+npsk12.net
+msdk12.org
+dcsk12.org
+nrpsk12.org
+psk12.net
+ilsonk12tn.us
+erricksk12.org
+cssk12.net
+ostonk12.org
+psk12.org
+uhlsdk12.net
+arrenk12nc.org
+gcpsk12.org
+dcsdk12.org
+ashk12.org
+romeok12.org
+storiak12.org
+usdk12.net
+iddletownk12.org
+urorak12.org
+cdsbk12.ca
+novik12.org
+entonvillek12.org
+ghctk12.com
+oledadk12.org
+heacademyk12.org
+rinnell-k12.org
+busdk12.com
+aderak12.org
+oazk12.org
+cusdk12.org
+csk12.net
+k12.nc.us
+k12.ca.us
+k12.or.us
+k12.oh.us
+k12.va.us
+k12.in.us
+k12.ga.us
+k12.mi.us
+k12.al.us
+k12.wi.us
+k12.de.us
+k12.ar.us
+k12.ny.us
+k12.nj.us
+k12.sc.us
+k12.mn.us
+k12.ma.us
+k12.mo.us
+k12.md.us
+k12.tr
+k12.hi.us
+k12.ct.us
+k12.ia.us
+k12.ms.us
+k12.ok.us
+k12.il.us

data/vendor/fastpass_domains.txt

@@ -0,0 +1,35 @@
+gmail.com
+live.co.uk
+hotmail.com
+web.de
+yahoo.de
+yahoo.com
+outlook.com
+yahoo.co.uk
+hotmail.fr
+seznam.cz
+citromail.hu
+live.com
+o2.pl
+yahoo.ca
+gmx.at
+icloud.com
+outlook.fr
+hotmail.co.uk
+yahoo.com.ph
+ymail.com
+hotmail.it
+mail.ru
+protonmail.com
+live.fr
+hotmail.ca
+me.com
+yahoo.co.id
+gmx.de
+wp.pl
+live.nl
+googlemail.com
+live.de
+mail.com
+outlook.de
+yandex.com

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_assessor
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Michael Wolfe Millard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,8 @@ files:
 - spec/spec_helper.rb
 - vendor/blacklisted_domains.txt
 - vendor/disposable_domains.txt
+- vendor/educational_domains.txt
+- vendor/fastpass_domains.txt
 homepage: https://github.com/wolfemm/email_assessor
 licenses:
 - MIT
@@ -124,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Advanced ActiveModel email validation