email_inquire 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4d6c692446838e7123938c97e1fe109517a59c
-  data.tar.gz: 15e35d56d46e72e3eed50d19f61c2c0cce594da8
+  metadata.gz: 8791dcafc0744b953fdccdbe7ff3f5497c85d91d
+  data.tar.gz: 4770b7ddbdbfddcb0851410cda5d87ad4a50f927
 SHA512:
-  metadata.gz: 929052741ff20a1d7b991aa2ebcc52ff5a61e62de2bf4a7f4049af67c14065ad68ee651ad2c25c0af5300997d24d813cf9f4fe1a55840b79190d54461e85bc7e
-  data.tar.gz: f49c66b8bdb2cb6eed4be7227d140016d543bec1e0797e364b3ec6b2af482554fb2d9c231fe4860791028f91e2a470a9c566615d1a15034d8e71e682ad3c1ac1
+  metadata.gz: d5372d89873571ac06412c1128cf060740c02cb17cd502ff46d5ae0373c115b2f7c097dfcfa7e870bcedbe8a6568cae067a9f30d9402cb3df7b95c548eeb0ac0
+  data.tar.gz: 17d939729cbeea8a348127da0aaa19517012961801d341171e42e8c398d0d9277edd185331a1445b85e93ba97125b4bd79e01e0ea3eedb1f6444f6e5f7197af3

data/.rubocop.yml

@@ -0,0 +1,83 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 20 # default: 15
+
+Metrics/CyclomaticComplexity:
+  Enabled: false # todo
+  Max: 10 # default: 6
+
+Metrics/LineLength:
+  Enabled: false # todo
+  Max: 100 # default: 80
+
+Metrics/MethodLength:
+  Exclude:
+    - "db/migrate/*"
+  Max: 12 # default: 10
+
+Metrics/PerceivedComplexity:
+  Enabled: false # todo
+  Max: 10 # default: 7
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+Style/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.1
+  - 2.1.8
+  - 2.2.5
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7
+bundler_args: --without local

data/Gemfile

@@ -1,4 +1,11 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in email_inquire.gemspec
 gemspec
+
+group :local do
+  # Guard
+  gem "guard-rspec", require: false
+  gem "terminal-notifier-guard", require: false # OS X
+end

data/Guardfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,7 +1,53 @@
 # EmailInquire
 
+[![Gem Version](https://badge.fury.io/rb/email_inquire.svg)](https://badge.fury.io/rb/email_inquire) [![Build Status](https://travis-ci.org/maximeg/email_inquire.svg?branch=master)](https://travis-ci.org/maximeg/email_inquire)
+
 EmailInquire is a library to validate email for common typos and one-time email provider.
 
+## Why?
+
+Before an user is an user, it's a visitor. And he must register to be so. What if he makes a typo while
+entering its email address during the registration ?
+If he didn't notice, you just lost him. He won't be able to sign in next time.
+
+Your users :
+
+- may not be as tech saavy as you;
+- may not remember exactly their email address;
+- may make a typo while typing their email address (very very common on a mobile keyboard).
+
+While we can't do so much for the name part of the email address, for the domain part, we can be smart!
+
+### Supported cases
+
+One char typo for common email providers of France, United Kingdom and USA:
+
+- `gmil.com` => hint `gmail.com`
+- `hitmail.com` => hint `hotmail.com`
+- `outloo.com` => hint `outlook.com`
+- `virinmedia.com` => hint `virginmedia.com`
+
+United Kingdom `.xx.uk`:
+
+- `foo.couk` => hint `foo.co.uk`
+- `fooco.uk` => hint `foo.co.uk`
+- `foo.uk` => hint `foo.co.uk`
+- `foo.judiciary.uk` => ok!
+
+Provider with an unique TLD domain:
+
+- `gmail.fr` => hint `gmail.com`
+- `gmail.de` => hint `gmail.com`
+- `google.com` => hint `gmail.com`
+- `free.com` => hint `free.fr`
+- `laposte.com` => hint `laposte.net`
+- `laposte.fr` => hint `laposte.net`
+
+One time email providers:
+
+- `yopmail.com` => invalid
+- more to come.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +66,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use `EmailInquire.validate(email)`, you'll get a `EmailInquire::Response` that represents weither
+or not the email address is valid or may contain a mistake.
+
+Methods of `EmailInquire::Response`:
+
+| Method | Description | Possible values |
+| --- | --- | --- |
+| `#email` | The validated email address | `"john.doe@gnail.com"` |
+| `#status` | The status of the validation | `:valid` `:invalid` or `:hint` |
+| `#valid?` | Is the email valid ? | `true` or `false` |
+| `#invalid?` | Is the email invalid ? | `true` or `false` |
+| `#hint?` | Is there a possible mistake and you have to show an hint to the user ? | `true` or `false` |
+| `#replacement` | A proposal replacement email address for when status is `:hint` | `"john.doe@gmail.com"` or nil |
+
+### Examples
+
+A valid case:
+
+```ruby
+response = EmailInquire.validate("john.doe@gmail.com")
+response.status # :valid
+response.valid? # true
+```
+
+An invalid case:
+
+```ruby
+response = EmailInquire.validate("john.doe@yopmail.com")
+response.status   # :invalid
+response.valid?   # false
+response.invalid? # true
+```
+
+A hint case:
+
+```ruby
+response = EmailInquire.validate("john.doe@gmail.co")
+response.status      # :hint
+response.valid?      # false
+response.hint?       # true
+response.replacement # "john.doe@gmail.com"
+```
+
+### Hint
+
+I think it's important to just offer a hint to the user and to not automatically replace the
+**maybe** faulty email address in the form.
+
+A _"Did you mean xxx@yyy.zzz ?"_ has the following advantages:
+
+- user remains in charge: we could have hinted against a perfectly valid email;
+- user is educated;
+- mini whaoo effect;
+
+This _"Did you mean xxx@yyy.zzz ?"_ is better being actionable, and appearing to be so: a click or tap on it should replace the email by the suggestion.
+
+```
+  +---------------------------------------+  +---------+
+  | john.doe@yaho.com                     |  | Sign Up |
+  +---------------------------------------+  +---------+
+    Did you mean john.doe@yahoo.com ?
+```
+
+Note that you could even have this validation for your Sign In forms...
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/email_inquire.gemspec

@@ -1,7 +1,8 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'email_inquire/version'
+require "email_inquire/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "email_inquire"
@@ -16,14 +17,17 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "damerau-levenshtein", "~> 1.2"
+
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.47"
 end

data/lib/email_inquire/inquirer.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+require "damerau-levenshtein"
+
+module EmailInquire
+
+  class Inquirer
+
+    def initialize(email)
+      @email = email.downcase
+      response.email = email
+
+      parse_email
+    end
+
+    attr_reader :domain, :email, :name
+
+    def validate
+      validate_typos
+
+      response
+    end
+
+    private
+
+    def parse_email
+      @name, @domain = email.split("@")
+    end
+
+    def response
+      @response ||= Response.new
+    end
+
+    def validate_typos
+      [
+        :validate_common_domains,
+        :validate_one_time_providers,
+        :validate_common_domain_mistakes,
+        :validate_uk_tld,
+        :validate_common_tld_mistakes,
+        :validate_domains_with_unique_tld,
+      ].each do |validator|
+        send(validator)
+        break if response.valid? || response.invalid?
+      end
+
+      # default
+      response.valid! unless response.status?
+    end
+
+    COMMON_DOMAIN_MISTAKES = {
+      /google(?!mail)/ => "gmail.com",
+      /windows.*\.com/ => "live.com",
+    }.freeze
+
+    def validate_common_domain_mistakes
+      COMMON_DOMAIN_MISTAKES.each do |mistake, reference|
+        break if domain == reference # valid!
+
+        if mistake =~ domain
+          response.hint!(domain: reference)
+          break
+        end
+      end
+    end
+
+    COMMON_DOMAINS = %w(
+      aim.com
+      aliceadsl.fr
+      aol.co.uk
+      aol.com
+      att.net
+      bbox.fr
+      bellsouth.net
+      blueyonder.co.uk
+      btinternet.com
+      charter.net
+      cox.net
+      free.fr
+      gmail.com
+      gmx.fr
+      googlemail.com
+      hotmail.co.uk
+      hotmail.com
+      hotmail.fr
+      icloud.com
+      laposte.net
+      live.co.uk
+      live.com
+      live.fr
+      me.com
+      msn.com
+      neuf.fr
+      ntlworld.com
+      numericable.fr
+      orange.fr
+      outlook.com
+      outlook.fr
+      rocketmail.com
+      sbcglobal.net
+      sfr.fr
+      sky.com
+      talktalk.net
+      verizon.net
+      virginmedia.com
+      wanadoo.fr
+      yahoo.co.uk
+      yahoo.com
+      yahoo.fr
+      ymail.com
+    ).freeze
+
+    def validate_common_domains
+      return response.valid! if COMMON_DOMAINS.include?(domain)
+
+      COMMON_DOMAINS.each do |reference|
+        distance = ::DamerauLevenshtein.distance(domain, reference, 2, 3)
+        if distance <= 1
+          response.hint!(domain: reference)
+          break
+        end
+      end
+    end
+
+    COMMON_TLD_MISTAKES = {
+      ".couk" => ".co.uk",
+      ".com.com" => ".com",
+    }.freeze
+
+    def validate_common_tld_mistakes
+      COMMON_TLD_MISTAKES.each do |mistake, reference|
+        break if !mistake.end_with?(reference) && domain.end_with?(reference)
+
+        if domain.end_with?(mistake)
+          response.hint!(domain: domain.gsub(/#{mistake}\z/, reference))
+          break
+        end
+      end
+    end
+
+    VALID_UK_TLD = %w(
+      .ac.uk
+      .co.uk
+      .gov.uk
+      .judiciary.uk
+      .ltd.uk
+      .me.uk
+      .mod.uk
+      .net.uk
+      .nhs.uk
+      .nic.uk
+      .org.uk
+      .parliament.uk
+      .plc.uk
+      .police.uk
+      .sch.uk
+    ).freeze
+
+    def validate_uk_tld
+      return unless domain.end_with?(".uk")
+
+      return if VALID_UK_TLD.any? do |reference|
+        domain.end_with?(reference)
+      end
+
+      new_domain = domain.dup
+      new_domain.gsub!(/(?<!\.)co\.uk\z/, ".co.uk")
+      new_domain.gsub!(/\.c[^o]\.uk\z/, ".co.uk")
+      new_domain.gsub!(/\.[^c]o\.uk\z/, ".co.uk")
+      new_domain.gsub!(/(?<!co)\.uk\z/, ".co.uk")
+
+      response.hint!(domain: new_domain) if new_domain != domain
+    end
+
+    UNIQUE_TLD_DOMAINS = %w(
+      free.fr
+      gmail.com
+      laposte.net
+      sfr.fr
+      wanadoo.fr
+    ).freeze
+
+    def validate_domains_with_unique_tld
+      base, tld = domain.split(".")
+
+      UNIQUE_TLD_DOMAINS.each do |reference|
+        reference_base, reference_tld = reference.split(".")
+
+        if base == reference_base && tld != reference_tld
+          response.hint!(domain: reference)
+          break
+        end
+      end
+    end
+
+    # https://github.com/wesbos/burner-email-providers
+    ONE_TIME_EMAIL_PROVIDERS = %w(
+      yopmail.com
+    ).freeze
+
+    def validate_one_time_providers
+      response.invalid! if ONE_TIME_EMAIL_PROVIDERS.include?(domain)
+    end
+
+  end
+
+end

data/lib/email_inquire/response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module EmailInquire
+
+  class Response
+
+    attr_accessor :email, :replacement, :status
+
+    def hint!(domain: nil)
+      self.status = :hint
+
+      old_name, _old_domain = email.split("@")
+      self.replacement = "#{old_name}@#{domain}" if domain
+    end
+
+    def hint?
+      status == :hint
+    end
+
+    def invalid!
+      self.status = :invalid
+    end
+
+    def invalid?
+      status == :invalid
+    end
+
+    def status?
+      !status.nil?
+    end
+
+    def valid!
+      self.status = :valid
+    end
+
+    def valid?
+      status == :valid
+    end
+
+  end
+
+end

data/lib/email_inquire/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module EmailInquire
 
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 
 end

data/lib/email_inquire.rb

@@ -1,5 +1,13 @@
+# frozen_string_literal: true
 require "email_inquire/version"
+require "email_inquire/inquirer"
+require "email_inquire/response"
 
 module EmailInquire
-  # Your code goes here...
+
+  def self.validate(email)
+    inquirer = Inquirer.new(email)
+    inquirer.validate
+  end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: email_inquire
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Maxime Garcia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: damerau-levenshtein
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 description: Library to validate email for common typos and one-time email provider
 email:
 - maxime.garcia@gmail.com
@@ -61,8 +89,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,6 +100,8 @@ files:
 - bin/setup
 - email_inquire.gemspec
 - lib/email_inquire.rb
+- lib/email_inquire/inquirer.rb
+- lib/email_inquire/response.rb
 - lib/email_inquire/version.rb
 homepage: https://github.com/maximeg/email_inquire
 licenses:
@@ -91,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Library to validate email for common typos and one-time email provider