email_check 0.1.4 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fa37a71c436036dacc36c1bf38d1fc276e3a644
-  data.tar.gz: 56c787b14b00b78172b51d0b12a58252d1de5d00
+SHA256:
+  metadata.gz: be0cba5ca74845cdd02da6697b576bd3a38947116123179123dae393fd0247e3
+  data.tar.gz: 865c687b2a7c627da107d4157057d9a3dbb6d9de0203b94c90b0ccd40abf6578
 SHA512:
-  metadata.gz: 4837b5e6772915a42264e22a54e8d656cb5a30f596d899f74b0e97d199b620e68822e6eb73156a3fa5e25c9127e74af7ad4ba7b7051565f53d7da7a4b4200e32
-  data.tar.gz: e9c9d583eecec2a3395261f285fd53815875f9269539f4ae3f424faedf94c21b2a587e292b14c65c23b489a1afdd84cfe099d51ba03f018e0408994d2b909bb4
+  metadata.gz: c1afee8e164514a3f5f74dddf556b494be9a4fffc459322765a808bd4a944b4e8452b308016d864299d50bb15dc40a10ec513d38c12971577d246fec69e2aaa0
+  data.tar.gz: 90c4f836d99891b514b9aee8da286af6ffa3910bc10d5312df949dde633cb7c13c76733cf023b70224f608abfc195934bdf8f216cf6ab989976769b6d3a2eb3c

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '16 2 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.travis.yml

@@ -1,9 +1,18 @@
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
+  - 2.3.0
+  - 2.5.0
 
 gemfile:
   - gemfiles/activemodel4.gemfile
+  - gemfiles/activemodel5.gemfile
+  - gemfiles/activemodel6.gemfile
 
+matrix:
+  exclude:
+    - rvm: 2.3.0
+      gemfile: gemfiles/activemodel6.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/activemodel4.gemfile
+
+before_install: gem install bundler

data/README.md

@@ -7,7 +7,7 @@
 [![Coverage Status][CS img]][Coverage Status]
 
 ## Description
-This was built for [Anonybuzz](https://anonybuzz.com). 
+This was originally built for [Anonybuzz](https://anonybuzz.com) and is now used at [StarTalent](https://startalent.io). 
 This gem provides a robust mechanism to validate email addresses and restrict account creation to corporate email accounts.
 
 This gem also ships with a data-set of free and [disposable](http://en.wikipedia.org/wiki/Disposable_email_address)
@@ -26,46 +26,57 @@ You can also block certain usernames from creating accounts. Examples: admin, ro
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
-gem "check_email"
+gem "email_check"
 ```
 
 ## Usage
 ### Use with ActiveModel
-To validate just the email address:
+To validate just the format of the email address
 ```ruby
 class User < ActiveRecord::Base
-  validates :email, email: true
+  validates_email :email
 end
 ```
 To validate that the domain has a MX record:
 ```ruby
-validates :email, email: { mx: true }
+validates_email :email, check_mx: true
 ```
 To validate that the email is not from a disposable or free email provider:
 ```ruby
-validates :email, email: { disposable:true, free:true }
+validates_email :email, not_disposable:true, not_free:true
 ```
 To validate that the domain is not blacklisted:
 ```ruby
-validates :email, email: { blacklist:true}
+validates_email :email, not_blacklisted:true
 ```
 
 To validate that the username is not blocked
 ```ruby
-validates :email, email: { blocked_usernames:true }
+validates_email :email, block_special_usernames:true
+```
 
 Everything together:
 ```ruby
-validates :email, email: { 
-    mx: true, 
-    disposable:true, 
-    free:true, 
-    blacklist:true,
-    blocked_usernames:true,
-    message: "Please register with your corporate email" }
+validates_email :email,
+    check_mx: true, 
+    not_disposable:true, 
+    not_free:true, 
+    not_blacklisted:true,
+    block_special_usernames:true,
+    message: "Please register with your corporate email"
+```
+
+To turn everything on by default, you can use the validates_email_strictness helper. 
+     
+```ruby
+# Example above
+validates_email_strictness :email
+
+# Everything but allow free emails. This is what most people would want to use
+validates_email_strictness :email, not_free:false
 ```
 
-### Modifying inbuilt lists
+### Modifying the inbuilt lists
 The lists are exposed as assignable arrays so you can customize them or load whatever data you please.
 
 Add a config/intializers/email_check.rb
@@ -75,16 +86,21 @@ EmailCheck.disposable_email_domains = ['freemail.org']
 # Append to the whitelist
 EmailCheck.whitelisted_domains << 'gmail.com'
 EmailCheck.free_email_domains << 'thenewgmail.com'
-# Setting a domain in the blacklist also will blacklist all subdomains
+# Setting a domain in the blacklist will also blacklist all subdomains
 EmailCheck.blacklisted_domains << 'lvh.me'
+# Block the 'anonymous' username for all domains
 EmailCheck.blocked_usernames << 'anonymous'
 ```
 
 ## Requirements
 This gem is tested with Rails 4.0+. Ruby versions tested:
-- Ruby 2.0
-- Ruby 2.1
-- Ruby 2.2
+- Ruby 2.3
+- Ruby 2.5
+
+Rails versions tested:
+Rails 4.0
+Rails 5.0
+Rails 6.0
 
 ## Credits
 - This code is heavily based upon: [lisinge/valid_email2](https://github.com/lisinge/valid_email2) 

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.2   | :white_check_mark: |
+| 1.0.1   | :x:                |
+| 1.0.0   | :x: |
+
+

data/email_check.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec","~> 3.2"
   spec.add_development_dependency "simplecov", "~> 0.10.0"
   spec.add_development_dependency "coveralls", "~> 0.8.1"

data/gemfiles/activemodel5.gemfile

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

data/gemfiles/activemodel6.gemfile

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

data/lib/email_check/email_address.rb

@@ -17,19 +17,19 @@ module EmailCheck
       EmailCheck.disposable_email_domains.include?(@email.domain)
     end
 
-    def free?
+    def free_email_provider?
       EmailCheck.free_email_domains.include?(@email.domain)
     end
 
-    def blacklisted?
+    def blacklisted_domain?
       EmailCheck.blacklisted_domains.each do |domain|
-        return true if @email.domain.include?(domain)
+        return true if @email.domain&.include?(domain)
       end
 
       false
     end
 
-    def whitelisted?
+    def whitelisted_domain?
       EmailCheck.whitelisted_domains.include?(@email.domain)
     end
 
@@ -39,10 +39,11 @@ module EmailCheck
 
     def domain_has_mx?
       return false unless format_valid?
-
+      val = false
       Resolv::DNS.open do |dns|
-        return dns.getresources(@email.domain, Resolv::DNS::Resource::IN::MX).any?
+        val = dns.getresources(@email.domain, Resolv::DNS::Resource::IN::MX).any?
       end
+      return val
     end
 
     private

data/lib/email_check/email_validator.rb

@@ -1,40 +1,54 @@
 require 'active_model'
 require 'active_model/validations'
 require 'email_check/email_address'
+require 'pp'
 
 class EmailValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    error(record, attribute) unless value.present?
 
-    address = EmailCheck::EmailAddress.new(value)
+    unless value.present?
+      add_error(record, attribute)
+      return
+    end
 
-    error(record, attribute) && return unless address.format_valid?
+    address = EmailCheck::EmailAddress.new(value)
 
-    return if address.whitelisted?
+    unless address && address.format_valid?
+      add_error(record, attribute)
+      return
+    end
 
-    if options[:blocked_usernames]
-      error(record, attribute) && return if address.blocked_username?
+    if options[:block_special_usernames] && address.blocked_username?
+      add_error(record, attribute)
+      return
     end
 
-    if options[:disposable]
-      error(record, attribute) && return if address.disposable?
+    return if address.whitelisted_domain?
+
+    if options[:not_disposable] && address.disposable?
+      add_error(record, attribute)
+      return
     end
 
-    if options[:blacklist]
-      error(record, attribute) && return if address.blacklisted?
+    if options[:not_blacklisted] && address.blacklisted_domain?
+      add_error(record, attribute)
+      return
     end
 
-    if options[:free]
-      error(record, attribute) && return if address.free?
+    if options[:not_free] && address.free_email_provider?
+      add_error(record, attribute)
+      return
     end
 
-    if options[:mx]
-      error(record, attribute) && return unless address.domain_has_mx?
+    # TODO: Add a callback to bypass this if the domain is already known
+    if options[:check_mx] && address.domain_has_mx? == false
+      add_error(record, attribute)
+      return
     end
   end
 
   private
-  def error(record, attribute)
+  def add_error(record, attribute)
     record.errors.add(attribute, options[:message] || :invalid)
   end
 end

data/lib/email_check/helper_methods.rb

@@ -0,0 +1,27 @@
+module ActiveModel
+  module Validations
+    module HelperMethods
+      # Validates email
+      #
+      # Configuration options:
+      # * <tt>:check_mx</tt> - Check MX record for domain
+      # * <tt>:not_disposable</tt> - Check that this is not a disposable email
+      # * <tt>:not_free</tt> - Not a free email (ex. gmail.com, hotmail.com)
+      # * <tt>:not_blacklisted</tt> -  If domain is on the blacklist, reject it
+      # * <tt>:block_special_usernames</tt> - If the username is one of the special usernames, reject it
+      def validates_email(*attr_names)
+        validates_with EmailValidator, _merge_attributes(attr_names)
+      end
+
+      # Turn everything on..
+      def validates_email_strictness(*attr_names)
+        validates_with EmailValidator, _merge_attributes(attr_names).merge(
+                                         :check_mx => true,
+                                         :not_disposable => true,
+                                         :not_free => true,
+                                         :not_blacklisted => true,
+                                         :block_special_usernames => true)
+      end
+    end
+  end
+end

data/lib/email_check/version.rb

@@ -1,3 +1,3 @@
 module EmailCheck
-  VERSION = "0.1.4"
+  VERSION = "1.0.2"
 end

data/lib/email_check.rb

@@ -1,5 +1,6 @@
 require "email_check/version"
 require "email_check/email_validator"
+require 'email_check/helper_methods'
 
 module EmailCheck
   # Load the data

data/vendor/blacklist.yml

@@ -4,3 +4,4 @@
 - freeservers.com
 - zzn.com
 - lvh.me
+- acccounts.com