email_assessor 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b062226fbe0f1a213b49179aaf6e986f5dfed6f
-  data.tar.gz: 3f46d3807934367d3762aa7e163b314a52bf2d2a
+  metadata.gz: 8e6bbdf20e2b76943db2c9957b2b3e689c6d4956
+  data.tar.gz: 744a37974466b6c82744821b93bc7ec66362482c
 SHA512:
-  metadata.gz: 93a11b96ec1a773e71f76299ae61f729a40b71d6a5bda59fe35fbcea10fcc7e93828a33d0a0e25b94640b77fae0d4ed7f8854676e133a2f7ad381a67ace2b0d7
-  data.tar.gz: f1597c569b67261bab09298eb40f3c2e1ab5db514fe5f1a0e99c46e0e57be5dadd9732b39eefe85f4ca712aa76476725f3d7707e43d80a032389ae2ced074aab
+  metadata.gz: 1712d4c2ed8d66046fc707830954c3b1a406e2f27e7a6f7f0eb089e3fe2cc2c24d19fe8e5f7ed0bc171e3b0ef5d800b36f40e2bf276ca838d3223e9012092904
+  data.tar.gz: 5ce7e6899e887a555d654defcf2429aa9bbc3b4a6da102baeed3d120c5c932d7075374bf9016396c499a90237c20506f03ec9d0e9240f0b2aa238f481e77f480

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+## 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/README.md

@@ -1,8 +1,8 @@
-# ValidEmail2
+# 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 of the wonderful [ValidEmail2](https://github.com/lisinge/valid_email2) by [Micke Lisinge](https://github.com/lisinge).
+A fork of [Micke Lisinge](https://github.com/lisinge)'s [ValidEmail2](https://github.com/lisinge/valid_email2).
 
 ValidEmail2:
 
@@ -36,6 +36,30 @@ 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
@@ -57,14 +81,14 @@ To validate that the domain is not a disposable email:
 validates :email, email: { disposable: true }
 ```
 
-To validate that the domain is not blacklisted (under vendor/blacklisted_domains.txt):
+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 }
+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

data/lib/email_assessor.rb

@@ -1,46 +1,23 @@
 require "email_assessor/email_validator"
 
 module EmailAssessor
+  DISPOSABLE_DOMAINS_FILE_NAME = File.expand_path("../../vendor/disposable_domains.txt", __FILE__)
+  BLACKLISTED_DOMAINS_FILE_NAME = File.expand_path("vendor/blacklisted_domains.txt")
+
   def self.domain_is_disposable?(domain)
-    domain_in_file?(domain, configuration.disposable_domains_file_name)
+    domain_in_file?(domain, DISPOSABLE_DOMAINS_FILE_NAME)
   end
 
   def self.domain_is_blacklisted?(domain)
-    domain_in_file?(domain, configuration.blacklisted_domains_file_name)
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration) if block_given?
-  end
-
-  class Configuration
-    attr_accessor :disposable_domains_file_name, :blacklisted_domains_file_name
-
-    def initialize
-      @disposable_domains_file_name = File.expand_path("../../vendor/disposable_domains.txt", __FILE__)
-      @blacklisted_domains_file_name = File.expand_path("vendor/blacklisted_domains.txt")
-    end
+    domain_in_file?(domain, BLACKLISTED_DOMAINS_FILE_NAME)
   end
 
   protected
 
   def self.domain_in_file?(domain, file_name)
-    return false unless file_name.present? && File.exists?(file_name)
-
+    file_name ||= ""
     domain = domain.downcase
-    domain_matched = false
-
-    File.open(file_name).each do |line|
-      if domain.end_with?(line.chomp)
-        domain_matched = true
-        break
-      end
-    end
 
-    domain_matched
+    File.open(file_name).each_line.any? { |line| domain.end_with?(line) }
   end
 end

data/lib/email_assessor/version.rb

@@ -1,3 +1,3 @@
 module EmailAssessor
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

data/pull_mailchecker_emails.rb

@@ -5,7 +5,7 @@ require "yaml"
 require "json"
 require "net/http"
 
-whitelisted_domains = %w(poczta.onet.pl fastmail.fm hushmail.com naver.com)
+whitelisted_domains = %w(poczta.onet.pl fastmail.fm hushmail.com naver.com qq.com)
 
 existing_domains = File.readlines("vendor/disposable_domains.txt")
 

data/spec/email_assessor_spec.rb

@@ -22,10 +22,10 @@ describe EmailAssessor do
   let(:blacklist_user) { TestUserDisallowBlacklisted.new(email: "foo@gmail.com") }
   let(:mx_user) { TestUserMX.new(email: "foo@gmail.com") }
 
-  let(:blacklisted_domains_file_name) { described_class.configuration.blacklisted_domains_file_name }
+  let(:blacklisted_domains_file_name) { described_class::BLACKLISTED_DOMAINS_FILE_NAME }
   let(:blacklisted_domain) { File.open(blacklisted_domains_file_name, &:readline) }
 
-  let(:disposable_domains_file_name) { described_class.configuration.disposable_domains_file_name }
+  let(:disposable_domains_file_name) { described_class::DISPOSABLE_DOMAINS_FILE_NAME }
   let(:disposable_domain) { File.open(disposable_domains_file_name, &:readline) }
 
   describe "basic validation" do
@@ -110,35 +110,4 @@ describe EmailAssessor do
       is_expected.to be_invalid
     end
   end
-
-  describe "configuration" do
-    subject(:configuration) { described_class.configuration }
-    let(:disposable_domains_file_name) { File.expand_path("../fixtures/disposable_domains.txt", __FILE__) }
-    let(:blacklisted_domains_file_name) { File.expand_path("../fixtures/blacklisted_domains.txt", __FILE__) }
-
-    before do
-      described_class.configure do |config|
-        config.disposable_domains_file_name = disposable_domains_file_name
-        config.blacklisted_domains_file_name = blacklisted_domains_file_name
-      end
-    end
-
-    it "sets the disposable domains file" do
-      is_expected.to have_attributes disposable_domains_file_name: disposable_domains_file_name
-    end
-
-    it "sets the blacklisted domains file" do
-      is_expected.to have_attributes blacklisted_domains_file_name: blacklisted_domains_file_name
-    end
-
-    it "uses the configured disposable domains file" do
-      disposable_user.email = disposable_domain
-      expect(disposable_user).to be_invalid
-    end
-
-    it "uses the configured blacklisted domains file" do
-      blacklist_user.email = blacklisted_domain
-      expect(blacklist_user).to be_invalid
-    end
-  end
 end

data/vendor/blacklisted_domains.txt

@@ -1 +1 @@
-blacklisted-test.com
+blacklist.example.com

data/vendor/disposable_domains.txt

@@ -1306,7 +1306,6 @@ qipmail.net
 qisdo.com
 qisoa.com
 qoika.com
-qq.com
 quadrafit.com
 quickinbox.com
 quickmail.nl

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_assessor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Michael Wolfe Millard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,8 +103,6 @@ files:
 - lib/email_assessor/version.rb
 - pull_mailchecker_emails.rb
 - spec/email_assessor_spec.rb
-- spec/fixtures/blacklisted_domains.txt
-- spec/fixtures/disposable_domains.txt
 - spec/spec_helper.rb
 - vendor/blacklisted_domains.txt
 - vendor/disposable_domains.txt
@@ -134,6 +132,4 @@ specification_version: 4
 summary: Advanced ActiveModel email validation
 test_files:
 - spec/email_assessor_spec.rb
-- spec/fixtures/blacklisted_domains.txt
-- spec/fixtures/disposable_domains.txt
 - spec/spec_helper.rb

data/spec/fixtures/blacklisted_domains.txt

@@ -1 +0,0 @@
-rspec-blacklisted.txt

data/spec/fixtures/disposable_domains.txt

@@ -1 +0,0 @@
-rspec-disposable.txt