email_assessor 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f9f5a08d4182ed68bdc232439f615339e0f5158
+  data.tar.gz: 76309795d2dad14078647902e21191fc90af9934
+SHA512:
+  metadata.gz: 01529449a629cec7b20880b109574d9cc90d4ea1d8a3bd82908a09a82d66a7c5fbf98510246167ab9eab1cdb40e869873b276e78ea41606386b92a2bf8af87b5
+  data.tar.gz: 683e9ac09cd34379d909558672886f044d5277bda2573e9c0278b1233993731195d555278072b54d914e5f64ac64cf4d003c3613272116da511d573b20d220ac

data/.gitignore

@@ -0,0 +1,18 @@
+.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

@@ -0,0 +1,14 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+
+gemfile:
+  - gemfiles/activemodel3.gemfile
+  - gemfiles/activemodel4.gemfile

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## Version 0.1
+Gave this fork its very own name: EmailAssessor

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,108 @@
+# ValidEmail2
+[![Build Status](https://travis-ci.org/lisinge/email_assessor.png?branch=master)](https://travis-ci.org/lisinge/email_assessor)
+[![Gem Version](https://badge.fury.io/rb/email_assessor.png)](http://badge.fury.io/rb/email_assessor)
+
+A fork of of the wonderful [ValidEmail2](https://github.com/lisinge/valid_email2) by [Micke Lisinge](https://github.com/lisinge).
+
+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
+
+## 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 (under vendor/blacklisted_domains.txt):
+```ruby
+validates :email, email: { blacklist: true }
+```
+
+All together:
+```ruby
+validates :email, email: { mx: true, disposable: 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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,30 @@
+# coding: 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   = "ActiveModel email validation with MX lookups, domain blacklisting and disposable email-domain 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 = ">= 1.9.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_runtime_dependency "mail", "~> 2.5"
+  spec.add_runtime_dependency "activemodel", ">= 3.2"
+end

data/gemfiles/activemodel3.gemfile

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

data/gemfiles/activemodel4.gemfile

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

data/lib/email_assessor.rb

@@ -0,0 +1,32 @@
+require "email_assessor/email_validator"
+
+module EmailAssessor
+  DISPOSABLE_DOMAINS_FILE = File.expand_path("../../vendor/disposable_domains.txt", __FILE__)
+  BLACKLISTED_DOMAINS_FILE = File.expand_path("../../vendor/blacklisted_domains.txt", __FILE__)
+
+  def self.domain_is_disposable?(domain)
+    domain_in_file?(domain, DISPOSABLE_DOMAINS_FILE)
+  end
+
+  def self.domain_is_blacklisted?(domain)
+    domain_in_file?(domain, BLACKLISTED_DOMAINS_FILE)
+  end
+
+  protected
+
+  def self.domain_in_file?(domain, filename)
+    return false unless File.exists?(filename)
+
+    domain = domain.downcase
+    domain_matched = false
+
+    File.open(filename).each do |line|
+      if domain.end_with?(line.chomp)
+        domain_matched = true
+        break
+      end
+    end
+
+    domain_matched
+  end
+end

data/lib/email_assessor/address.rb

@@ -0,0 +1,52 @@
+require "email_assessor"
+require "resolv"
+require "mail"
+
+module EmailAssessor
+  class Address
+    attr_accessor :address
+
+    def initialize(address)
+      @parse_error = false
+      @raw_address = address
+
+      begin
+        @address = Mail::Address.new(address)
+      rescue Mail::Field::ParseError
+        @parse_error = true
+      end
+    end
+
+    def valid?
+      return false if @parse_error
+
+      if address.domain && address.address == @raw_address
+        domain = address.domain
+        # Valid address needs to have a dot in the domain
+        !!domain.match(/\./) && !domain.match(/\.{2,}/) && domain.match(/[a-z]\Z/i)
+      else
+        false
+      end
+    end
+
+    def disposable?
+      valid? && EmailAssessor.domain_is_disposable?(address.domain)
+    end
+
+    def blacklisted?
+      valid? && EmailAssessor.domain_is_blacklisted?(address.domain)
+    end
+
+    def valid_mx?
+      return false unless valid?
+
+      mx = []
+
+      Resolv::DNS.open do |dns|
+        mx.concat dns.getresources(address.domain, Resolv::DNS::Resource::IN::MX)
+      end
+
+      mx.any?
+    end
+  end
+end

data/lib/email_assessor/email_validator.rb

@@ -0,0 +1,34 @@
+require "email_assessor/address"
+require "active_model"
+require "active_model/validations"
+
+class EmailValidator < ActiveModel::EachValidator
+  def default_options
+    { regex: true, disposable: false, mx: false }
+  end
+
+  def validate_each(record, attribute, value)
+    return unless value.present?
+    options = default_options.merge(self.options)
+
+    address = EmailAssessor::Address.new(value)
+
+    error(record, attribute) && return unless address.valid?
+
+    if options[:disposable]
+      error(record, attribute) && return if address.disposable?
+    end
+
+    if options[:blacklist]
+      error(record, attribute) && return if address.blacklisted?
+    end
+
+    if options[:mx]
+      error(record, attribute) && return unless address.valid_mx?
+    end
+  end
+
+  def error(record, attribute)
+    record.errors.add(attribute, options[:message] || :invalid)
+  end
+end

data/lib/email_assessor/version.rb

@@ -0,0 +1,3 @@
+module EmailAssessor
+  VERSION = "0.1"
+end

data/pull_mailchecker_emails.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+
+require "json"
+require "net/http"
+
+whitelisted_domains = %w(poczta.onet.pl fastmail.fm hushmail.com naver.com)
+
+existing_domains = File.readlines("vendor/disposable_domains.txt")
+
+url = "https://raw.githubusercontent.com/FGRibreau/mailchecker/master/list.json"
+resp = Net::HTTP.get_response(URI.parse(url))
+
+remote_domains = JSON.parse(resp.body).flatten - whitelisted_domains
+
+puts "New domains found: #{(remote_domains - existing_domains).join(', ')}"
+
+result_domains = (existing_domains + remote_domains).map { |domain| domain.strip.downcase }.uniq.sort
+
+File.open("vendor/disposable_domains.txt", "w") { |f| f.write result_domains.join("\n") }

data/spec/email_assessor_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+class TestUser < TestModel
+  validates :email, email: true
+end
+
+class TestUserMX < TestModel
+  validates :email, email: { mx: true }
+end
+
+class TestUserDisallowDisposable < TestModel
+  validates :email, email: { disposable: true }
+end
+
+class TestUserDisallowBlacklisted < TestModel
+  validates :email, email: { blacklist: true }
+end
+
+describe EmailAssessor do
+  describe "basic validation" do
+    subject(:user) { TestUser.new(email: "") }
+
+    it "should be valid when email is empty" do
+      user.valid?.should be_true
+    end
+
+    it "should not be valid when domain is missing" do
+      user = TestUser.new(email: "foo")
+      user.valid?.should be_false
+    end
+
+    it "should be invalid when email is malformed" do
+      user = TestUser.new(email: "foo@bar")
+      user.valid?.should be_false
+    end
+
+    it "should be invalid when email contains a trailing symbol" do
+      user = TestUser.new(email: "foo@bar.com/")
+      user.valid?.should be_false
+    end
+
+    it "should be invalid if Mail::AddressListsParser raises exception" do
+      user = TestUser.new(email: "foo@gmail.com")
+      Mail::Address.stub(:new).and_raise(Mail::Field::ParseError.new(nil, nil, nil))
+      user.valid?.should be_false
+    end
+
+    it "shouldn't be valid if the domain constains consecutives dots" do
+      user = TestUser.new(email: "foo@bar..com")
+      user.valid?.should be_false
+    end
+  end
+
+  describe "disposable domains" do
+    let(:disposable_domain) { disposable_domain = File.open(described_class::DISPOSABLE_DOMAINS_FILE, &:readline) }
+
+    it "should be valid when email is not in the list of disposable domains" do
+      user = TestUserDisallowDisposable.new(email: "foo@gmail.com")
+      user.valid?.should be_true
+    end
+
+    it "should be invalid when email is in the list of disposable domains" do
+      user = TestUserDisallowDisposable.new(email: "foo@#{disposable_domain}")
+      user.valid?.should be_false
+    end
+
+    it "should be invalid when email is in the list of disposable domains regardless of subdomain" do
+      user = TestUserDisallowDisposable.new(email: "foo@abc123.#{disposable_domain}")
+      user.valid?.should be_false
+    end
+  end
+
+  describe "blacklisted domains" do
+    let(:blacklisted_domain) { File.open(described_class::BLACKLISTED_DOMAINS_FILE, &:readline) }
+    it "should be valid when email domain is not in the blacklist" do
+      user = TestUserDisallowBlacklisted.new(email: "foo@gmail.com")
+      user.valid?.should be_true
+    end
+
+    it "should be invalid when email domain is in the blacklist" do
+      user = TestUserDisallowBlacklisted.new(email: "foo@#{blacklisted_domain}")
+      user.valid?.should be_false
+    end
+
+    it "should be invalid when email domain is in the blacklist regardless of subdomain" do
+      user = TestUserDisallowBlacklisted.new(email: "foo@abc123.#{blacklisted_domain}")
+      user.valid?.should be_false
+    end
+  end
+
+  describe "mx lookup" do
+    it "should be valid if mx records are found" do
+      user = TestUserMX.new(email: "foo@gmail.com")
+      user.valid?.should be_true
+    end
+
+    it "should be invalid if no mx records are found" do
+      user = TestUserMX.new(email: "foo@subdomain.gmail.com")
+      user.valid?.should be_false
+    end
+  end
+end