email_check 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bf533c13a6a88356fa0a63c9b0a28c615c7cb83
-  data.tar.gz: 9733241a0b509581d08337596b1d85791c3f3a31
+  metadata.gz: 2fa37a71c436036dacc36c1bf38d1fc276e3a644
+  data.tar.gz: 56c787b14b00b78172b51d0b12a58252d1de5d00
 SHA512:
-  metadata.gz: 2f7475efee8831a063a73743191bbf8bb0cb151c0280fe28a032cbd2e0bafce7e94c51a24001dc288e3e774b20c1a1ab468e28d9c1803685aa07fe811d3466a9
-  data.tar.gz: 42c62d74ddf63ce8969966def0032cc5644676d38984fbfc496f97d338b2d958975f3cebc58515f4dc61e7706f68225b36f18cc74fc69b58273a4c91723d1bbc
+  metadata.gz: 4837b5e6772915a42264e22a54e8d656cb5a30f596d899f74b0e97d199b620e68822e6eb73156a3fa5e25c9127e74af7ad4ba7b7051565f53d7da7a4b4200e32
+  data.tar.gz: e9c9d583eecec2a3395261f285fd53815875f9269539f4ae3f424faedf94c21b2a587e292b14c65c23b489a1afdd84cfe099d51ba03f018e0408994d2b909bb4

data/README.md

@@ -13,6 +13,8 @@ This gem provides a robust mechanism to validate email addresses and restrict ac
 This gem also ships with a data-set of free and [disposable](http://en.wikipedia.org/wiki/Disposable_email_address)
 email domains which are used for validation checks.
 
+You can also block certain usernames from creating accounts. Examples: admin, root
+
 ### Validation mechanisms
 - Uses the mail gem. 
 - Checks the domain's MX record
@@ -47,9 +49,20 @@ To validate that the domain is not blacklisted:
 ```ruby
 validates :email, email: { blacklist:true}
 ```
+
+To validate that the username is not blocked
+```ruby
+validates :email, email: { blocked_usernames:true }
+
 Everything together:
 ```ruby
-validates :email, email: { mx: true, disposable:true, free:true, blacklist:true}
+validates :email, email: { 
+    mx: true, 
+    disposable:true, 
+    free:true, 
+    blacklist:true,
+    blocked_usernames:true,
+    message: "Please register with your corporate email" }
 ```
 
 ### Modifying inbuilt lists
@@ -64,17 +77,18 @@ 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'
+EmailCheck.blocked_usernames << 'anonymous'
 ```
 
 ## Requirements
-This gem is tested with Rails 4.0. Ruby versions tested:
+This gem is tested with Rails 4.0+. Ruby versions tested:
 - Ruby 2.0
 - Ruby 2.1
 - Ruby 2.2
 
 ## Credits
-This code is heavily based upon: [lisinge/valid_email2](https://github.com/lisinge/valid_email2)
-Data is from: [lavab/disposable](https://github.com/lavab/disposable/blob/master/domains.txt) and
+- This code is heavily based upon: [lisinge/valid_email2](https://github.com/lisinge/valid_email2) 
+- Data is from: [lavab/disposable](https://github.com/lavab/disposable/blob/master/domains.txt) and
               [willwhite/freemail](https://github.com/willwhite/freemail/blob/master/data/free.txt)
 
 [Gem Version]: https://rubygems.org/gems/email_check

data/lib/email_check.rb

@@ -6,6 +6,7 @@ module EmailCheck
   @@disposable_email_domains ||= YAML.load_file(File.expand_path("../../vendor/disposable.yml", __FILE__))
   @@free_email_domains ||= YAML.load_file(File.expand_path("../../vendor/free.yml", __FILE__))
   @@blacklisted_domains ||= YAML.load_file(File.expand_path("../../vendor/blacklist.yml", __FILE__))
+  @@blocked_usernames ||= YAML.load_file(File.expand_path("../../vendor/blocked_usernames.yml", __FILE__))
 
   # Disposable email providers
   def self.disposable_email_domains
@@ -42,4 +43,12 @@ module EmailCheck
   def self.whitelisted_domains=(list)
     @@whitelisted_domains = list
   end
+
+  def self.blocked_usernames
+    @@blocked_usernames ||= []
+  end
+
+  def self.blocked_usernames=(list)
+    @@blocked_usernames = list
+  end
 end

data/lib/email_check/email_address.rb

@@ -33,6 +33,10 @@ module EmailCheck
       EmailCheck.whitelisted_domains.include?(@email.domain)
     end
 
+    def blocked_username?
+      EmailCheck.blocked_usernames.include?(@email.local.downcase)
+    end
+
     def domain_has_mx?
       return false unless format_valid?
 

data/lib/email_check/email_validator.rb

@@ -12,6 +12,10 @@ class EmailValidator < ActiveModel::EachValidator
 
     return if address.whitelisted?
 
+    if options[:blocked_usernames]
+      error(record, attribute) && return if address.blocked_username?
+    end
+
     if options[:disposable]
       error(record, attribute) && return if address.disposable?
     end

data/lib/email_check/version.rb

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

data/vendor/blocked_usernames.yml

@@ -0,0 +1,21 @@
+---
+- abuse
+- admin
+- api
+- create
+- delete
+- destroy
+- feedback
+- help
+- hostmaster
+- index
+- new
+- noreply
+- postmaster
+- root
+- show
+- support
+- unsubscribe
+- unknown
+- update
+- workfeed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_check
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Darshan Patil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - lib/email_check/email_validator.rb
 - lib/email_check/version.rb
 - vendor/blacklist.yml
+- vendor/blocked_usernames.yml
 - vendor/disposable.yml
 - vendor/free.yml
 homepage: https://github.com/dapatil/email_check