email_assessor 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f9f5a08d4182ed68bdc232439f615339e0f5158
-  data.tar.gz: 76309795d2dad14078647902e21191fc90af9934
+  metadata.gz: c2e86b0145f0a1eadce4c8df87b7c1172974e284
+  data.tar.gz: b226714891f60a08facb4c93f4185ad723d3d9be
 SHA512:
-  metadata.gz: 01529449a629cec7b20880b109574d9cc90d4ea1d8a3bd82908a09a82d66a7c5fbf98510246167ab9eab1cdb40e869873b276e78ea41606386b92a2bf8af87b5
-  data.tar.gz: 683e9ac09cd34379d909558672886f044d5277bda2573e9c0278b1233993731195d555278072b54d914e5f64ac64cf4d003c3613272116da511d573b20d220ac
+  metadata.gz: f0e0af20e1ec8ae109b88120c97cdb754a453771d6eecb90e88bff09897ffd2f1354ee4564353c4034923ad6ddc6b66e3db39d6d0d4f04f13df6fab689bcf93c
+  data.tar.gz: 459aa3cb6b2234535c5470930f08549064fab9eb079cf590b287cb38df26027a32df16b16771f4e73c30ea5e327da5b1302a08962e611c524912cd144db52061

data/email_assessor.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_runtime_dependency "mail", "~> 2.5"
   spec.add_runtime_dependency "activemodel", ">= 3.2"
 end

data/lib/email_assessor.rb

@@ -1,26 +1,40 @@
 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)
+    domain_in_file?(domain, configuration.disposable_domains_file_name)
   end
 
   def self.domain_is_blacklisted?(domain)
-    domain_in_file?(domain, BLACKLISTED_DOMAINS_FILE)
+    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
   end
 
   protected
 
-  def self.domain_in_file?(domain, filename)
-    return false unless File.exists?(filename)
+  def self.domain_in_file?(domain, file_name)
+    return false unless file_name.present? && File.exists?(file_name)
 
     domain = domain.downcase
     domain_matched = false
 
-    File.open(filename).each do |line|
+    File.open(file_name).each do |line|
       if domain.end_with?(line.chomp)
         domain_matched = true
         break

data/lib/email_assessor/version.rb

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

data/pull_mailchecker_emails.rb

@@ -14,8 +14,6 @@ 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

@@ -17,86 +17,128 @@ class TestUserDisallowBlacklisted < TestModel
 end
 
 describe EmailAssessor do
+  let(:plain_user) { TestUser.new(email: "") }
+  let(:disposable_user) { TestUserDisallowDisposable.new(email: "foo@gmail.com") }
+  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_domain) { File.open(blacklisted_domains_file_name, &:readline) }
+
+  let(:disposable_domains_file_name) { described_class.configuration.disposable_domains_file_name }
+  let(:disposable_domain) { File.open(disposable_domains_file_name, &:readline) }
+
   describe "basic validation" do
-    subject(:user) { TestUser.new(email: "") }
+    subject(:user) { plain_user }
 
     it "should be valid when email is empty" do
-      user.valid?.should be_true
+      is_expected.to be_valid
     end
 
     it "should not be valid when domain is missing" do
-      user = TestUser.new(email: "foo")
-      user.valid?.should be_false
+      user.email = "foo"
+      is_expected.to be_invalid
     end
 
     it "should be invalid when email is malformed" do
-      user = TestUser.new(email: "foo@bar")
-      user.valid?.should be_false
+      user.email = "foo@bar"
+      is_expected.to be_invalid
     end
 
     it "should be invalid when email contains a trailing symbol" do
-      user = TestUser.new(email: "foo@bar.com/")
-      user.valid?.should be_false
+      user.email = "foo@bar.com/"
+      is_expected.to be_invalid
     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
+      allow(Mail::Address).to receive(:new).and_raise(Mail::Field::ParseError.new(nil, nil, nil))
+      user.email = "foo@gmail.com"
+      is_expected.to be_invalid
     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
+      user.email = "foo@bar..com"
+      is_expected.to be_invalid
     end
   end
 
   describe "disposable domains" do
-    let(:disposable_domain) { disposable_domain = File.open(described_class::DISPOSABLE_DOMAINS_FILE, &:readline) }
+    subject(:user) { disposable_user }
 
     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
+      is_expected.to be_valid
     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
+      user.email = "foo@#{disposable_domain}"
+      is_expected.to be_invalid
     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
+      user.email = "foo@abc123.#{disposable_domain}"
+      is_expected.to be_invalid
     end
   end
 
   describe "blacklisted domains" do
-    let(:blacklisted_domain) { File.open(described_class::BLACKLISTED_DOMAINS_FILE, &:readline) }
+    subject(:user) { blacklist_user }
+
     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
+      is_expected.to be_valid
     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
+      user.email = "foo@#{blacklisted_domain}"
+      is_expected.to be_invalid
     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
+      user.email = "foo@abc123.#{blacklisted_domain}"
+      is_expected.to be_invalid
     end
   end
 
   describe "mx lookup" do
+    subject(:user) { mx_user }
+
     it "should be valid if mx records are found" do
-      user = TestUserMX.new(email: "foo@gmail.com")
-      user.valid?.should be_true
+      is_expected.to be_valid
     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
+      user.email = "foo@subdomain.gmail.com"
+      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/spec/fixtures/blacklisted_domains.txt

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

data/spec/fixtures/disposable_domains.txt

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

data/spec/spec_helper.rb

@@ -8,6 +8,10 @@ class TestModel
     @attributes = attributes
   end
 
+  def email=(email)
+    @attributes[:email] = email
+  end
+
   def read_attribute_for_validation(key)
     @attributes[key]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_assessor
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Michael Wolfe Millard
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,8 @@ 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
@@ -132,4 +134,6 @@ 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