rails_email_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e99f8a15584efbbfe72bdd987c0b536ca53873dfab58d581c79c37107161754
+  data.tar.gz: 03b26be23b4bb692781c43396526df1d4ecce7cf450c0da24c90b7ad60db2286
+SHA512:
+  metadata.gz: 8adb0084265a8b35e5c9d581f42c5691014690e9de2f8f343f164a06e26b172e75f39185abc6b3326e59c0f446030643b7d4306a18585824b53df97a578704fc
+  data.tar.gz: 0a3b2e0618d0bf19c99972986fe7f54a82101aebd58f53a0860011d5549acdbd313ef4b44f68e9ffef60e5d20fa31e979ed2e5bead04246f935a23d4f3c0aa0c

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE
+/.idea
+.idea/workspace.xml
+.rakeTasks
+.generators
+
+# Gem
+*.gem
+
+# Logs
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  IgnoredPatterns: ['(\A|\s)#']
+  Max: 100
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 35
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_email_checker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    rails_email_checker (0.1.0)
+      activemodel (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    minitest (5.14.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tins (1.24.1)
+      sync
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8)
+  rails_email_checker!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 OpenGems
+
+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,39 @@
+# RailsEmailChecker
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_email_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_email_checker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_email_checker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_email_checker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rails_email_checker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_email_checker.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_email_checker/configuration'
+require 'rails_email_checker/constant'
+require 'rails_email_checker/email_validator'
+require 'rails_email_checker/helper_methods'
+require 'rails_email_checker/address'
+
+module RailsEmailChecker
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def address(value)
+      Address.new(value)
+    end
+  end
+end

data/lib/rails_email_checker/address.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'resolv'
+
+module RailsEmailChecker
+  class Address
+    attr_reader :address
+
+    def initialize(address)
+      @address = address
+      raise AddressArgument, "Invalid address #{address}" unless valid?(address)
+    end
+
+    def whitelisted?
+      domain_include?(configuration.whitelist_domains)
+    end
+
+    def blacklisted?
+      domain_include?(configuration.blacklist_domains)
+    end
+
+    def recorded?
+      !records.nil? && records.any?
+    end
+
+    def formatted?
+      !(address =~ configuration.regex_email).nil?
+    end
+
+    def sub_addressed?
+      address.include?('+')
+    end
+
+    private
+
+    def valid?(value)
+      value.is_a?(String) && !value.nil? && !value.empty?
+    end
+
+    def domain_include?(list)
+      list.include?(domain)
+    end
+
+    def domain
+      @domain ||= address.gsub(/.+@/, '\1')
+    end
+
+    def records
+      @records ||= dns
+    end
+
+    def configuration
+      @configuration ||= RailsEmailChecker.configuration
+    end
+
+    def dns
+      Resolv::DNS.open do |dns|
+        dns.timeouts = configuration.timeouts || 2
+        dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
+      end
+    rescue Resolv::ResolvError, Resolv::ResolvTimeout
+      nil
+    end
+  end
+end

data/lib/rails_email_checker/configuration.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RailsEmailChecker
+  class Configuration
+    attr_accessor :regex_email,
+                  :blacklist_domains,
+                  :whitelist_domains,
+                  :timeouts
+
+    def initialize
+      @regex_email = REGEX_EMAIL
+      @blacklist_domains = default_blacklist_domains
+      @whitelist_domains = default_whitelist_domains
+      @timeouts = 2
+    end
+
+    def add_blacklist_domains(path: nil, domains: nil)
+      raise ListArgument, 'Path & domains are nil' if valid_argument?(path, domains)
+      @blacklist_domains << load_domains(path) unless path.nil?
+      unless domains.nil?
+        @blacklist_domains.concat(domains) if domains.is_a?(Array)
+        @blacklist_domains << domains if domains.is_a?(String)
+      end
+    end
+
+    def add_whitelist_domains(path: nil, domains: nil)
+      raise ListArgument, 'Path & domains are nil' if valid_argument?(path, domains)
+      @whitelist_domains << load_domains(path) unless path.nil?
+      unless domains.nil?
+        @whitelist_domains.concat(domains) if domains.is_a?(Array)
+        @whitelist_domains << domains if domains.is_a?(String)
+      end
+    end
+
+    private
+
+    def valid_argument?(path, domains)
+      path.nil? && domains.nil?
+    end
+
+    def default_blacklist_domains
+      @default_blacklist_domains ||= load_domains(BLACKLIST_FILE)
+    end
+
+    def default_whitelist_domains
+      @default_whitelist_domains ||= load_domains(WHITELIST_FILE)
+    end
+
+    def load_domains(path)
+      domains = []
+      file = File.open(path, 'r')
+      file.each_line do |line|
+        domain = line.strip
+        domains << domain unless domain.nil?
+      end
+      domains
+    rescue StandardError => e
+      raise FileNotFound, "File not found: #{e}"
+    end
+  end
+end

data/lib/rails_email_checker/constant.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RailsEmailChecker
+  FileNotFound = Class.new(StandardError)
+  ListArgument = Class.new(StandardError)
+  AddressArgument = Class.new(StandardError)
+
+  REGEX_EMAIL = /\b[A-Z0-9._%a-z\-]+@(?:[A-Z0-9a-z\-]+\.)+[A-Za-z]{2,6}\z/.freeze
+
+  BLACKLIST_FILE = 'vendor/blacklist.txt'
+  WHITELIST_FILE = 'vendor/whitelist.txt'
+end

data/lib/rails_email_checker/email_validator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'active_model/validations'
+require 'rails_email_checker'
+
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if !value.present? || value.nil?
+      add_error(record, attribute, :blank)
+      return
+    end
+
+    address = RailsEmailChecker::Address.new(value)
+
+    return if address.whitelisted?
+
+    if options[:formatted] && !address.formatted?
+      add_error(record, attribute)
+      return
+    end
+
+    if options[:blacklisted] && address.blacklisted?
+      add_error(record, attribute)
+      return
+    end
+
+    if options[:no_sub_addressed] && address.sub_addressed?
+      add_error(record, attribute)
+      return
+    end
+
+    if options[:recorded] && !address.recorded?
+      add_error(record, attribute)
+      nil
+    end
+  end
+
+  private
+
+  def add_error(record, attribute, key = :invalid)
+    record.errors.add(attribute, options[:message] || key)
+  end
+end