email_assessor 0.8.3 → 1.0.0

data/lib/email_assessor.rb

@@ -1,28 +1,75 @@
 # frozen_string_literal: true
+
 require "email_assessor/email_validator"
+require "email_assessor/directory_domain_list"
+require "email_assessor/file_domain_list"
+require "email_assessor/empty_domain_list"
+require "email_assessor/domain_token_set"
 
 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")
+  class << self
+    def tokenize_domain(domain)
+      EmailAssessor::DomainTokenSet.parse(domain)
+    end
 
-  def self.domain_is_disposable?(domain)
-    domain_in_file?(domain, DISPOSABLE_DOMAINS_FILE_NAME)
-  end
+    def [](pathname)
+      @domain_list_cache ||= {
+        # {pathname} => {domain list}
+      }
 
-  def self.domain_is_blacklisted?(domain)
-    domain_in_file?(domain, BLACKLISTED_DOMAINS_FILE_NAME)
-  end
+      return @domain_list_cache[pathname] if @domain_list_cache.key?(pathname)
+
+      list = if File.directory?(pathname)
+        DirectoryDomainList.new(pathname)
+      elsif File.file?(pathname)
+        FileDomainList.new(pathname)
+      end
+
+      @domain_list_cache[pathname] = list
+
+      list
+    end
+
+    def disposable_domains
+      @disposable_domains ||= default_domain_list("disposable_domains")
+    end
+
+    def disposable_domains=(pathname)
+      @disposable_domains = self[pathname]
+    end
+
+    def blacklisted_domains
+      @blacklisted_domains ||= default_domain_list("blacklisted_domains")
+    end
+
+    def blacklisted_domains=(pathname)
+      @blacklisted_domains = self[pathname]
+    end
+
+    def educational_domains
+      @educational_domains ||= default_domain_list("educational_domains")
+    end
+
+    def educational_domains=(pathname)
+      @educational_domains = self[pathname]
+    end
+
+    def fastpass_domains
+      @fastpass_domains ||= default_domain_list("fastpass_domains")
+    end
+
+    def fastpass_domains=(pathname)
+      @fastpass_domains = self[pathname]
+    end
 
-  def self.domain_in_file?(domain, file_name)
-    file_name ||= ""
-    domain = domain.downcase
+    private
 
-    File.foreach(file_name, chomp: true).any? do |line|
-      # String#end_with? is used as a cheaper initial check but due to potential false positives
-      # (hotmail.com is valid but tmail.com is not) regex is also necessary.
-      domain.end_with?(line) && domain.match?(%r{\A(?:.*\.)?#{Regexp.escape(line)}\z}i)
+    def default_domain_list(category)
+      self[File.expand_path("../../vendor/#{category}.txt", __FILE__)] ||
+        self[File.expand_path("../../vendor/#{category}", __FILE__)] ||
+        self[File.expand_path("../../assets/data/#{category}.txt", __FILE__)] ||
+        self[File.expand_path("../../assets/data/#{category}", __FILE__)] ||
+        EmptyDomainList.instance
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_assessor
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Wolfe Millard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,26 +87,100 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- email_assessor.gemspec
-- gemfiles/activemodel4.gemfile
+- assets/data/blacklisted_domains/_prioritization.txt
+- assets/data/blacklisted_domains/b.txt
+- assets/data/disposable_domains/0.txt
+- assets/data/disposable_domains/1.txt
+- assets/data/disposable_domains/2.txt
+- assets/data/disposable_domains/3.txt
+- assets/data/disposable_domains/4.txt
+- assets/data/disposable_domains/5.txt
+- assets/data/disposable_domains/6.txt
+- assets/data/disposable_domains/7.txt
+- assets/data/disposable_domains/8.txt
+- assets/data/disposable_domains/9.txt
+- assets/data/disposable_domains/_prioritization.txt
+- assets/data/disposable_domains/a.txt
+- assets/data/disposable_domains/b.txt
+- assets/data/disposable_domains/c.txt
+- assets/data/disposable_domains/d.txt
+- assets/data/disposable_domains/e.txt
+- assets/data/disposable_domains/f.txt
+- assets/data/disposable_domains/g.txt
+- assets/data/disposable_domains/h.txt
+- assets/data/disposable_domains/i.txt
+- assets/data/disposable_domains/j.txt
+- assets/data/disposable_domains/k.txt
+- assets/data/disposable_domains/l.txt
+- assets/data/disposable_domains/m.txt
+- assets/data/disposable_domains/n.txt
+- assets/data/disposable_domains/o.txt
+- assets/data/disposable_domains/p.txt
+- assets/data/disposable_domains/q.txt
+- assets/data/disposable_domains/r.txt
+- assets/data/disposable_domains/s.txt
+- assets/data/disposable_domains/t.txt
+- assets/data/disposable_domains/u.txt
+- assets/data/disposable_domains/v.txt
+- assets/data/disposable_domains/w.txt
+- assets/data/disposable_domains/x.txt
+- assets/data/disposable_domains/y.txt
+- assets/data/disposable_domains/z.txt
+- assets/data/disposable_domains/陸.txt
+- assets/data/disposable_domains/뜃.txt
+- assets/data/educational_domains/5.txt
+- assets/data/educational_domains/_prioritization.txt
+- assets/data/educational_domains/a.txt
+- assets/data/educational_domains/b.txt
+- assets/data/educational_domains/c.txt
+- assets/data/educational_domains/d.txt
+- assets/data/educational_domains/e.txt
+- assets/data/educational_domains/f.txt
+- assets/data/educational_domains/g.txt
+- assets/data/educational_domains/h.txt
+- assets/data/educational_domains/i.txt
+- assets/data/educational_domains/j.txt
+- assets/data/educational_domains/k.txt
+- assets/data/educational_domains/l.txt
+- assets/data/educational_domains/m.txt
+- assets/data/educational_domains/n.txt
+- assets/data/educational_domains/o.txt
+- assets/data/educational_domains/p.txt
+- assets/data/educational_domains/q.txt
+- assets/data/educational_domains/r.txt
+- assets/data/educational_domains/s.txt
+- assets/data/educational_domains/t.txt
+- assets/data/educational_domains/u.txt
+- assets/data/educational_domains/v.txt
+- assets/data/educational_domains/w.txt
+- assets/data/educational_domains/x.txt
+- assets/data/educational_domains/y.txt
+- assets/data/educational_domains/z.txt
+- assets/data/fastpass_domains/_prioritization.txt
+- assets/data/fastpass_domains/a.txt
+- assets/data/fastpass_domains/c.txt
+- assets/data/fastpass_domains/d.txt
+- assets/data/fastpass_domains/f.txt
+- assets/data/fastpass_domains/g.txt
+- assets/data/fastpass_domains/h.txt
+- assets/data/fastpass_domains/i.txt
+- assets/data/fastpass_domains/l.txt
+- assets/data/fastpass_domains/m.txt
+- assets/data/fastpass_domains/o.txt
+- assets/data/fastpass_domains/p.txt
+- assets/data/fastpass_domains/r.txt
+- assets/data/fastpass_domains/s.txt
+- assets/data/fastpass_domains/t.txt
+- assets/data/fastpass_domains/w.txt
+- assets/data/fastpass_domains/y.txt
 - lib/email_assessor.rb
 - lib/email_assessor/address.rb
+- lib/email_assessor/directory_domain_list.rb
+- lib/email_assessor/domain_token_set.rb
 - lib/email_assessor/email_validator.rb
+- lib/email_assessor/empty_domain_list.rb
+- lib/email_assessor/file_domain_list.rb
 - lib/email_assessor/version.rb
-- pull_mailchecker_emails.rb
-- spec/email_assessor_spec.rb
-- 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
@@ -126,10 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Advanced ActiveModel email validation
-test_files:
-- spec/email_assessor_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-.DS_STORE
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-
-sudo: false
-
-rvm:
-  - 2.4.0
-
-gemfile:
-  - gemfiles/activemodel4.gemfile

data/CHANGELOG.md

@@ -1,9 +0,0 @@
-## Version 0.3.8 (November 8th, 2016)
-- Add more disposable domains
-
-## Version 0.3
-- Refactored the logic in `EmailAssessor.domain_in_file?` to be simpler
-- Removed configurability in favor of convention over configuration
-
-## Version 0.1
-Gave this fork its very own name: EmailAssessor

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in email_assessor.gemspec
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright for portions of this project are held by Micke Lisinge, 2013, as part of valid_email2. All other copyright are held by Michael Wolfe Millard, 2016.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,132 +0,0 @@
-# EmailAssessor
-[![Build Status](https://travis-ci.org/wolfemm/email_assessor.png?branch=master)](https://travis-ci.org/wolfemm/email_assessor)
-[![Gem Version](https://badge.fury.io/rb/email_assessor.png)](http://badge.fury.io/rb/email_assessor)
-
-A fork of [Micke Lisinge](https://github.com/lisinge)'s [ValidEmail2](https://github.com/lisinge/valid_email2).
-
-ValidEmail2:
-
-* Validates emails with the help of the `mail` gem instead of some clunky regexp.
-* Aditionally validates that the domain has a MX record.
-* Optionally validates against a static [list of disposable email services](vendor/disposable_domains.txt).
-
-
-### Why?
-
-ValidEmail2 offers very comprehensive email validation, but it has a few pitfalls.
-
-For starters, it loads the entire list of blacklisted/disposable email domains into memory from a YAML file. In a never ending battle against spam, loading such an extremely large (and ever-growing) array into memory is far from ideal. Instead, EmailAssessor reads a text file line-by-line.
-
-Another pitfall is that subdomains are able to bypass the disposable and blacklist checks in ValidEmail2. EmailAssessor checks if a given domain *ends* with a blacklisted/disposable domain, preventing subdomains from masking an email that would otherwise be considered invalid.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "email_assessor"
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install email_assessor
-
-## Domain List Files
-
-Domain list files, used for blacklisting and blocking disposable emails, are plain-text files with one **lower case** domain per line.
-
-Valid domain list file:
-```
-example.com
-subdomain.example.org
-```
-
-Invalid domain list file:
-```
-http://example.com
-example.com/mail
-```
-
-Be careful with subdomains. Given the following domain list file:
-
-```
-sub.example.com
-```
-
-A user would be able to register with the email `jake@example.com` but not `tom@sub.example.com` or `jerry@deep.sub.example.com`.
-
-## Usage
-
-### Use with ActiveModel
-
-If you just want to validate that it is a valid email address:
-```ruby
-class User < ActiveRecord::Base
-  validates :email, presence: true, email: true
-end
-```
-
-To validate that the domain has a MX record:
-```ruby
-validates :email, email: { mx: true }
-```
-
-To validate that the domain is not a disposable email:
-```ruby
-validates :email, email: { disposable: true }
-```
-
-To validate that the domain is not blacklisted (via `vendor/blacklisted_domains.txt`):
-```ruby
-validates :email, email: { blacklist: true }
-```
-
-All together:
-```ruby
-validates :email, email: { mx: true, disposable: true, blacklist: true }
-```
-
-> Note that this gem will let an empty email pass through so you will need to
-> add `presence: true` if you require an email
-
-### Use without ActiveModel
-
-```ruby
-address = EmailAssessor::Address.new("lisinge@gmail.com")
-address.valid? => true
-address.disposable? => false
-address.valid_mx? => true
-```
-
-### Test environment
-
-If you are validating `mx` then your specs will fail without an internet connection.
-It is a good idea to stub out that validation in your test environment.
-Do so by adding this in your `spec_helper`:
-```ruby
-config.before(:each) do
-  allow_any_instance_of(EmailAssessor::Address).to receive(:valid_mx?) { true }
-end
-```
-
-## Requirements
-
-This gem requires Rails 3.2 or 4.0. It is tested against both versions using:
-* Ruby-1.9
-* Ruby-2.0
-* Ruby-2.1
-* Ruby-2.2
-* JRuby-1.9
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "spec/**/*_spec.rb"
-end
-
-task :default => [:spec]
-task :build => [:spec]

data/email_assessor.gemspec

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-# encoding: UTF-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "email_assessor/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "email_assessor"
-  spec.version       = EmailAssessor::VERSION
-  spec.summary       = "Advanced ActiveModel email validation"
-  spec.description   = "Advanced ActiveModel email validation with MX lookups, domain blacklisting and disposable email blocking"
-
-  spec.license = "MIT"
-
-  spec.author   = "Michael Wolfe Millard"
-  spec.email    = "wolfemm.development@gmail.com"
-  spec.homepage = "https://github.com/wolfemm/email_assessor"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.4.0"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_runtime_dependency "mail", "~> 2.5"
-  spec.add_runtime_dependency "activemodel", ">= 5.0.2"
-end

data/gemfiles/activemodel4.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "activemodel", "~> 5.0.2"
-
-gemspec path: "../"

data/pull_mailchecker_emails.rb

@@ -1,21 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "yaml"
-
-require "json"
-require "net/http"
-require "set"
-
-whitelisted_domains = %w(poczta.onet.pl fastmail.fm hushmail.com naver.com qq.com nus.edu.sg)
-
-existing_domains = File.readlines("vendor/disposable_domains.txt")
-
-url = "https://raw.githubusercontent.com/FGRibreau/mailchecker/master/list.txt"
-resp = Net::HTTP.get_response(URI.parse(url))
-
-remote_domains = (resp.body.split("\n")) - whitelisted_domains
-
-result_domains = SortedSet.new((existing_domains + remote_domains).map! { |domain| domain.strip.downcase })
-
-File.open("vendor/disposable_domains.txt", "w") { |f| f.write result_domains.to_a.join("\n") }