email_check 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fa37a71c436036dacc36c1bf38d1fc276e3a644
-  data.tar.gz: 56c787b14b00b78172b51d0b12a58252d1de5d00
+  metadata.gz: d9b4feed89776984cfde75a1eae36c6a6d07c3b8
+  data.tar.gz: 9234e3a6758143a7db7c91fc4a3ca1651a7e32c0
 SHA512:
-  metadata.gz: 4837b5e6772915a42264e22a54e8d656cb5a30f596d899f74b0e97d199b620e68822e6eb73156a3fa5e25c9127e74af7ad4ba7b7051565f53d7da7a4b4200e32
-  data.tar.gz: e9c9d583eecec2a3395261f285fd53815875f9269539f4ae3f424faedf94c21b2a587e292b14c65c23b489a1afdd84cfe099d51ba03f018e0408994d2b909bb4
+  metadata.gz: 065585a773e9d398f905ea439e8301a2c7e36d3bc7d2d2d215b3666a265a3ea666fbde2827a0078505b8c89583f70d727ccb5a9ced43d1a791bba44b0f2ae551
+  data.tar.gz: 75bba08a31cf07117bb4db4f42f9eb601cf230a85e343423e10e26ddf63f319d8374074312aa0798667b587a10f7034f77f3208b4d7150b58bef4e4ea367024d

data/.travis.yml

@@ -7,3 +7,5 @@ rvm:
 gemfile:
   - gemfiles/activemodel4.gemfile
 
+before_install: gem install bundler
+

data/README.md

@@ -31,38 +31,49 @@ gem "check_email"
 
 ## 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"
+```
+
+This can be replaced by the validates_email_strictness helper. This turns on all the options
+     
+```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
@@ -77,6 +88,7 @@ EmailCheck.whitelisted_domains << 'gmail.com'
 EmailCheck.free_email_domains << 'thenewgmail.com'
 # Setting a domain in the blacklist also will blacklist all subdomains
 EmailCheck.blacklisted_domains << 'lvh.me'
+# Block the 'anonymous' username for all domains
 EmailCheck.blocked_usernames << 'anonymous'
 ```
 

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/lib/email_check/email_address.rb

@@ -17,11 +17,11 @@ 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)
       end
@@ -29,7 +29,7 @@ module EmailCheck
       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.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_check
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Darshan Patil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ files:
 - lib/email_check.rb
 - lib/email_check/email_address.rb
 - lib/email_check/email_validator.rb
+- lib/email_check/helper_methods.rb
 - lib/email_check/version.rb
 - vendor/blacklist.yml
 - vendor/blocked_usernames.yml