email_inquire 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14209d0b6b0f04fc0b236b425432cce860f0ef7f
-  data.tar.gz: b0a266ddf3aa51dfbb63e725fba356e6004040e9
+  metadata.gz: 1cc6da6d04f9d91202fac7e069e7a32cdd4dac56
+  data.tar.gz: d80e50d52a21208143d1ae9ed4bdd26117d293eb
 SHA512:
-  metadata.gz: dccb794f40ba3360c7e1b7e547ccd1a164f5e7da65e8d66690b30ccf0f67a2cb6fbf06d6e94fe48d56146a2cd8d62d2ed4165f9b1e6da7ed45e080ed9932a187
-  data.tar.gz: e4b418ef9e26d1b041f363fb0e8c3aedf413904db5dfffd792d453a8b944176ffb86ac438dc916059035c15785183858e12dc7ca2eb02beacaff8d10fd8fd181
+  metadata.gz: 119f06284f5d36e51a5e8496a40fa9203796b17692a7983f9732ae7a91cc07ede53362d19cf8db0a40d3f6bfefa4b636209aa2754a7c873edd821438f8cd98bb
+  data.tar.gz: 8674574dde20545502ab0e8181dd51fecbe9941b0ad4e1a57ac4fe8fe39b3cb1d5ac33685ae8f5d53ee9d947a1ee6df82d9f0b05417dd45b95570261ed5b51fc

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in email_inquire.gemspec

data/Guardfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 guard :rspec, cmd: "bundle exec rspec" do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)

data/README.md

@@ -2,7 +2,7 @@
 
 [![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) [![Code Climate](https://codeclimate.com/github/maximeg/email_inquire/badges/gpa.svg)](https://codeclimate.com/github/maximeg/email_inquire)
 
-EmailInquire is a library to validate email for common typos and one-time email providers.
+EmailInquire is a library to validate email for format, common typos and one-time email providers.
 
 ## Why?
 
@@ -22,7 +22,20 @@ And also, we don't want for users to use one-time email addresses (also called b
 
 ### Supported cases
 
-One char typo for 43 common email providers of France, United Kingdom and USA:
+Format error. This doesn't strictly follow RFC 5322, it aims at validating email that will be
+deliverable on Internet. It also takes into account length of email, name part and domain part as
+per SMTP specification.
+
+- `foo@example..com` => invalid
+- `foo@example..foo.com` => invalid
+- `foo@example--foo.com` => invalid
+- `foo@localhost` => invalid
+- `foo@123.123.123.123` => invalid
+- `secrétariat@example.com` => invalid
+- `foo+test@example.com` => valid
+- ...
+
+One char typo for 43 common email providers (worldwide and from France, United Kingdom and USA):
 
 - `gmil.com` => hint `gmail.com`
 - `hitmail.com` => hint `hotmail.com`
@@ -30,7 +43,7 @@ One char typo for 43 common email providers of France, United Kingdom and USA:
 - `virinmedia.com` => hint `virginmedia.com`
 - ...
 
-United Kingdom `.xx.uk` domains:
+ccTLD specificity, like United Kingdom `.xx.uk` domains:
 
 - `foo.couk` => hint `foo.co.uk`
 - `fooco.uk` => hint `foo.co.uk`
@@ -38,6 +51,8 @@ United Kingdom `.xx.uk` domains:
 - `foo.judiciary.uk` => ok!
 - ...
 
+...and same thing with `.co.jp` domains.
+
 Providers with an unique domain:
 
 - `gmail.fr` => hint `gmail.com`

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/email_inquire.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 # frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "email_inquire/version"
@@ -10,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Maxime Garcia"]
   spec.email         = ["maxime.garcia@gmail.com"]
 
-  spec.summary       = "Library to validate email for common typos and one-time email provider"
-  spec.description   = "Library to validate email for common typos and one-time email provider"
+  spec.summary       = "Library to validate email for format, common typos and one-time email providers"
+  spec.description   = "Library to validate email for format, common typos and one-time email providers"
   spec.homepage      = "https://github.com/maximeg/email_inquire"
   spec.license       = "MIT"
 
@@ -29,5 +30,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rubocop", "~> 0.48"
 end

data/lib/email_inquire.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require "email_inquire/version"
+require "email_inquire/email_validator"
 require "email_inquire/inquirer"
 require "email_inquire/response"
 

data/lib/email_inquire/email_validator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module EmailInquire
+
+  class EmailValidator
+
+    def initialize(email)
+      @email = email.downcase
+    end
+
+    attr_reader :email
+
+    def valid?
+      return false unless email.count("@") == 1
+      return false if email.length > 255
+      name, domain = email.split("@", 2)
+
+      name_valid?(name) && domain_valid?(domain)
+    end
+
+    private
+
+    DOMAIN_REGEXP = /
+      \A
+      (?:
+        (?=
+          [a-z0-9-]{1,63}
+          \.
+        )
+        [a-z0-9]+
+        (?:
+          -
+          [a-z0-9]+
+        )*
+        \.
+      ){1,8}
+      [a-z]{2,63}
+      \z
+    /x
+
+    def domain_valid?(domain)
+      return false if domain == ""
+      return false unless domain =~ DOMAIN_REGEXP
+
+      true
+    end
+
+    NAME_REGEXP = /
+      \A
+      [a-z0-9]
+      [a-z0-9._%+-]{0,63}
+      \z
+    /x
+
+    def name_valid?(name)
+      return false if name == ""
+      return false if name.length > 64
+      return false unless name =~ NAME_REGEXP
+
+      true
+    end
+
+  end
+
+end

data/lib/email_inquire/inquirer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "damerau-levenshtein"
 require "set"
 
@@ -28,8 +29,29 @@ module EmailInquire
 
     attr_reader :domain, :email, :name
 
+    VALIDATORS = %i(
+      validate_common_domains
+      validate_one_time_providers
+      validate_common_domain_mistakes
+      validate_cc_tld
+      validate_common_tld_mistakes
+      validate_domains_with_unique_tld
+    ).freeze
+
     def validate
-      validate_typos
+      email_validator = EmailValidator.new(email)
+      unless email_validator.valid?
+        response.invalid!
+        return response
+      end
+
+      VALIDATORS.each do |validator|
+        send(validator)
+        break if response.valid? || response.invalid?
+      end
+
+      # default
+      response.valid! unless response.status?
 
       response
     end
@@ -46,25 +68,6 @@ module EmailInquire
       end
     end
 
-    VALIDATORS = [
-      :validate_common_domains,
-      :validate_one_time_providers,
-      :validate_common_domain_mistakes,
-      :validate_cc_tld,
-      :validate_common_tld_mistakes,
-      :validate_domains_with_unique_tld,
-    ].freeze
-
-    def validate_typos
-      VALIDATORS.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",
@@ -112,26 +115,25 @@ module EmailInquire
       end
     end
 
-    VALID_JP_TLD = load_data("jp_tld").freeze
-    VALID_UK_TLD = load_data("uk_tld").freeze
-    VALID_CC_TLDs = [
-      [".jp", ".co.jp", VALID_JP_TLD],
-      [".uk", ".co.uk", VALID_UK_TLD],
+    VALID_CC_TLDS = [
+      [".jp", ".co.jp", load_data("jp_tld").freeze],
+      [".uk", ".co.uk", load_data("uk_tld").freeze],
     ].freeze
 
     def validate_cc_tld
-      VALID_CC_TLDs.each do |tld, sld, valid_tld|
+      VALID_CC_TLDS.each do |tld, sld, valid_tlds|
         next unless domain.end_with?(tld)
 
-        next if valid_tld.any? do |reference|
+        next if valid_tlds.any? do |reference|
           domain.end_with?(reference)
         end
 
+        _, com, tld_without_dot = sld.split(".")
+
         new_domain = domain.dup
-        tld_without_dot = tld[1..-1]
-        new_domain.gsub!(/\.[a-z]{2}\.#{tld_without_dot}\z/, sld)
-        new_domain.gsub!(/(?<!\.)co\.#{tld_without_dot}\z/, sld)
-        new_domain.gsub!(/(?<!\.co)\.#{tld_without_dot}\z/, sld)
+        new_domain.gsub!(/\.[a-z]{2,#{com.length}}\.#{tld_without_dot}\z/, sld)
+        new_domain.gsub!(/(?<!\.)#{com}\.#{tld_without_dot}\z/, sld)
+        new_domain.gsub!(/(?<!\.#{com})\.#{tld_without_dot}\z/, sld)
         response.hint!(domain: new_domain) if new_domain != domain
       end
     end

data/lib/email_inquire/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module EmailInquire
 
   class Response

data/lib/email_inquire/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module EmailInquire
 
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_inquire
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxime Garcia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: damerau-levenshtein
@@ -72,15 +72,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.48'
   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
+        version: '0.48'
+description: Library to validate email for format, common typos and one-time email
+  providers
 email:
 - maxime.garcia@gmail.com
 executables: []
@@ -105,6 +106,7 @@ files:
 - data/unique_domain_providers.txt
 - email_inquire.gemspec
 - lib/email_inquire.rb
+- lib/email_inquire/email_validator.rb
 - lib/email_inquire/inquirer.rb
 - lib/email_inquire/response.rb
 - lib/email_inquire/version.rb
@@ -131,5 +133,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Library to validate email for common typos and one-time email provider
+summary: Library to validate email for format, common typos and one-time email providers
 test_files: []