cogi_email 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d200209729f74272e98dc1b8dcebdd549ac84d0
+  data.tar.gz: 9841848a372166e0394690efc712f276df25e8e4
+SHA512:
+  metadata.gz: 154d7b0085d49df9c40b0a22700072990cb9cea25f2da5193d45bbae133bdce97192772027fc5bd5a1c97525cf13fc99005464d298f0980596c6942f99b19961
+  data.tar.gz: 57c94d16cc90a79961a0a1137448b8181b999ba675d83500182347a828271a864a195f4db5d7a181c9ddf327a52886eca6849c21c402259de609a667ad830dd3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Hoa Hoang
+
+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,82 @@
+# PhonyRails [![Build Status](https://travis-ci.org/hoahm/cogi_email.svg?branch=master)](https://travis-ci.org/hoahm/cogi_email) [![Coverage Status](https://coveralls.io/repos/github/hoahm/cogi_email/badge.svg)](https://coveralls.io/github/hoahm/cogi_email) [![GitHub issues](https://img.shields.io/github/issues/hoahm/cogi_email.svg)](https://github.com/hoahm/cogi_email/issues) [![Gem Version](https://badge.fury.io/rb/cogi_email.svg)](https://badge.fury.io/rb/cogi_email)
+
+This gem provide you library to validate, parsing and format email. Check is email is real or not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cogi_email'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install cogi_email
+```
+
+## Usage
+
+### Validation
+
+Check if a string is a valid email address.
+
+```ruby
+CogiEmail.validate? 'nobi.younet@gmail.com' # => true
+```
+
+
+### Normalization
+
+Normalize phone numer to international format.
+
+```ruby
+CogiEmail.normalize 'Nobi.younet@gmail.com' # => 'nobi.younet@gmail.com'
+CogiEmail.normalize '(Nobi)<nobi.younet@gmail.com>' # => 'nobi.younet@gmail.com'
+```
+
+### Validate email domain
+
+Check if email domain is valid by making a DNS lookup.
+
+```ruby
+CogiEmail.valid_email_domain? 'nobi.younet@gmail.com' # => true
+CogiEmail.valid_email_domain? 'nobi.younet@localhost' # => false
+```
+
+### Check if real email
+
+Check if an email address is real or not.
+
+An email address is real if:
+  - Is valid
+  - Has MX DNS record
+  - Can send a test email
+
+```ruby
+CogiEmail.real_email? 'nobi.younet@gmail.com' # => true
+CogiEmail.real_email? 'nobi.younet@localhost' # => false
+```
+
+## Credit
+
+Thank you [Kamil Ciemniewski](https://github.com/kamilc) so much for writing [email_verifier](https://github.com/kamilc/email_verifier) gem. I reference his gem to re-writing email checker for this gem.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Don't forget to add tests and run rspec before creating a pull request :)
+
+See all contributors on https://github.com/hoahm/cogi_email/graphs/contributors.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task default: :spec

data/lib/cogi_email.rb

@@ -0,0 +1,107 @@
+require 'cogi_email/checker'
+require 'cogi_email/error'
+require 'cogi_email/version'
+require 'mail'
+require 'resolv'
+
+module CogiEmail
+  # Check if a string is a valid email address.
+  #
+  # This library is so strict to ensure that all email is clean and deliverable.
+  #
+  # References:
+  #   https://www.jochentopf.com/email/
+  #   https://fightingforalostcause.net/content/misc/2006/compare-email-regex.php
+  #
+  # @param [String] email Email address
+  #
+  # @return [Boolean] True if it is in a valid email, otherwise False
+  #
+  # @example
+  #
+  #   CogiEmail.validate?('peter_brown@example.com') # => true
+  #   CogiEmail.validate?('peter-brown@example.com') # => true
+  #   CogiEmail.validate?('peter.brown@example.com') # => true
+  #   CogiEmail.validate?('peter brown@example.com') # => false
+  #   CogiEmail.validate?('peter_brown@@example.com') # => false
+  def self.validate?(email)
+    pattern = /\A\s*([-\p{L}\d+._]{1,64})@((?:[-\p{L}\d]+\.)+\p{L}{2,})\s*\z/i
+    !!(email =~ pattern)
+  end
+
+  # Normalize email address.
+  #
+  # You need to validate before normalize an email address.
+  #
+  # @param [String] email Email address
+  #
+  # @return [String] Email address in lowercase, without special characters.
+  #
+  # @raise [CogiEmail::NormalizationError] If can not normalize the email address.
+  #
+  # @example
+  #   CogiEmail.normalize('(Peter Brown)<peter_brown@example.com>') # => peter_brown@example.com
+  #   CogiEmail.normalize('peter_brown@example.com') # => peter_brown@example.com
+  #   CogiEmail.normalize('Peter_Brown@example.com') # => peter_brown@example.com
+  #   CogiEmail.normalize('peter brown@example.com') # => peter_brown@example.com
+  def self.normalize(email)
+    begin
+      m = Mail::Address.new(email)
+      m.address.downcase
+    rescue
+      raise CogiEmail::NormalizationError
+    end
+  end
+
+  # Check if email domain is valid by making a DNS lookup.
+  #
+  # An email domain is valid if it has an MX DNS record is set up to receive mail.
+  #
+  # Reference: https://www.safaribooksonline.com/library/view/ruby-cookbook/0596523696/ch01s19.html
+  #
+  # @param [String] email Email address
+  #
+  # @return [Boolean] True if email domain have valid MX DNS record, otherwise False
+  def self.valid_email_domain?(email)
+    valid = true
+
+    begin
+      m = Mail::Address.new(email)
+      hostname = m.domain
+      Resolv::DNS.new.getresource(hostname, Resolv::DNS::Resource::IN::MX)
+    rescue Resolv::ResolvError
+      valid = false
+    end
+
+    valid
+  end
+
+  # Check if an email address is real or not.
+  #
+  # An email address is real if:
+  #   Valid
+  #   Has MX DNS record
+  #   Can send test email
+  #
+  # @param [String] email Email address
+  #
+  # @return [Boolean] True if email address is real, otherwise False
+  #
+  # @example
+  #   CogiEmail.real_email?('nobi.younet@gmail.com')   # => true
+  #   CogiEmail.real_email?('nobi.younet@example.com') # => false
+  def self.real_email?(email)
+    return false unless self.validate?(email) # not a valid email address
+    result = true
+
+    begin
+      v = CogiEmail::Checker.new(email)
+      v.connect
+      v.verify
+    rescue
+      result = false
+    end
+
+    result
+  end
+end

data/lib/cogi_email/checker.rb

@@ -0,0 +1,108 @@
+require 'net/smtp'
+require 'resolv'
+
+module CogiEmail
+  class Checker
+    ##
+    # Returns server object for given email address or throws exception
+    # Object returned isn't yet connected. It has internally a list of
+    # real mail servers got from MX dns lookup
+    #
+    # Reference:
+    #   https://github.com/kamilc/email_verifier/blob/master/lib/email_verifier/checker.rb
+    def initialize(email)
+      @email = email
+      @smtp    = nil
+      @user_email = 'nobody@nonexistant.com'
+      _, @user_domain = @user_email.split "@"
+    end
+
+    def domain
+      m = Mail::Address.new(@email)
+      @domain = m.domain
+    end
+
+    def list_mxs
+      return [] unless domain
+      mxs = []
+      Resolv::DNS.open do |dns|
+        ress = dns.getresources domain, Resolv::DNS::Resource::IN::MX
+        ress.each do |r|
+          mxs << { priority: r.preference, address: r.exchange.to_s }
+        end
+      end
+
+      @servers = mxs.sort_by { |mx| mx[:priority] }
+      @servers
+    end
+
+    def is_connected
+      !@smtp.nil?
+    end
+
+    def connect
+      list_mxs
+      raise CogiEmail::NoMailServerException.new("No mail server for #{@email}") if @servers.empty?
+
+      begin
+        server = next_server
+        raise CogiEmail::OutOfMailServersException.new("Unable to connect to any one of mail servers for #{@email}") if server.nil?
+        @smtp = Net::SMTP.start server[:address], 25, @user_domain
+        return true
+      rescue CogiEmail::OutOfMailServersException => e
+        raise CogiEmail::OutOfMailServersException, e.message
+      rescue => e
+        retry
+      end
+    end
+
+    def close_connection
+      @smtp.finish if @smtp && @smtp.started?
+    end
+
+    def verify
+      mailfrom @user_email
+      rcptto(@email).tap do
+        close_connection
+      end
+    end
+
+    def next_server
+      @servers.shift
+    end
+
+    private
+
+    def ensure_connected
+      raise CogiEmail::NotConnectedException.new("You have to connect first") if @smtp.nil?
+    end
+
+    def mailfrom(address)
+      ensure_connected
+
+      ensure_250 @smtp.mailfrom(address)
+    end
+
+    def rcptto(address)
+      ensure_connected
+
+      begin
+        ensure_250 @smtp.rcptto(address)
+      rescue => e
+        if e.message[/^550/]
+          return false
+        else
+          raise CogiEmail::FailureException.new(e.message)
+        end
+      end
+    end
+
+    def ensure_250(smtp_return)
+      if smtp_return.status.to_i == 250
+        return true
+      else
+        raise CogiEmail::FailureException.new "Mail server responded with #{smtp_return.status} when we were expecting 250"
+      end
+    end
+  end
+end

data/lib/cogi_email/error.rb

@@ -0,0 +1,12 @@
+module CogiEmail
+  class NormalizationError < StandardError
+    def initialize
+      super %Q{Can not normalize the given email address. It is not an valid email address.}
+    end
+  end
+
+  class NoMailServerException < StandardError; end
+  class OutOfMailServersException < StandardError; end
+  class NotConnectedException < StandardError; end
+  class FailureException < StandardError; end
+end

data/lib/cogi_email/version.rb

@@ -0,0 +1,3 @@
+module CogiEmail
+  VERSION = '0.0.1'.freeze
+end

data/spec/cogi_email/checker_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'cogi_email/checker'
+
+describe CogiEmail::Checker do
+  describe '#verify' do
+    it 'return true if valid email address' do
+      v = CogiEmail::Checker.new('nobi.younet@gmail.com')
+      v.connect
+      expect(v.verify).to be_truthy
+    end
+
+    it 'raise error if no mail server found' do
+      v = CogiEmail::Checker.new('nobi.younet@example.com')
+      expect{ v.connect }.to raise_error(CogiEmail::NoMailServerException)
+    end
+
+    it 'raise error if not connected' do
+      v = CogiEmail::Checker.new('nobi.younet@gmail.com')
+      expect{ v.verify }.to raise_error(CogiEmail::NotConnectedException)
+    end
+  end
+end

data/spec/cogi_email_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe CogiEmail do
+  subject { CogiEmail.new }
+
+  VALID_EMAIL_ADDRESSES = [
+    "a+b@plus-in-local.com",
+    "a_b@underscore-in-local.com",
+    "user@example.com",
+    " user@example.com ",
+    "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ@letters-in-local.org",
+    "01234567890@numbers-in-local.net",
+    "a@single-character-in-local.org",
+    "one-character-third-level@a.example.com",
+    "single-character-in-sld@x.org",
+    "local@dash-in-sld.com",
+    "letters-in-sld@123.com",
+    "one-letter-sld@x.org",
+    "uncommon-tld@sld.museum",
+    "uncommon-tld@sld.travel",
+    "uncommon-tld@sld.mobi",
+    "country-code-tld@sld.uk",
+    "country-code-tld@sld.rw",
+    "local@sld.newTLD",
+    "local@sub.domains.com",
+    "aaa@bbb.co.jp",
+    "nigel.worthington@big.co.uk",
+    "f@c.com",
+    "areallylongnameaasdfasdfasdfasdf@asdfasdfasdfasdfasdf.ab.cd.ef.gh.co.ca",
+    "joe+ruby-mail@example.com"
+  ]
+
+  INVALID_EMAIL_ADDRESSES = [
+    "",
+    "f@s",
+    "f@s.c",
+    "@bar.com",
+    "test@example.com@example.com",
+    "test@",
+    "@missing-local.org",
+    "a b@space-in-local.com",
+    "! \#$%\`|@invalid-characters-in-local.org",
+    "<>@[]\`|@even-more-invalid-characters-in-local.org",
+    "missing-sld@.com",
+    "invalid-characters-in-sld@! \"\#$%(),/;<>_[]\`|.org",
+    "missing-dot-before-tld@com",
+    "missing-tld@sld.",
+    " ",
+    "missing-at-sign.net",
+    "unbracketed-IP@127.0.0.1",
+    "invalid-ip@127.0.0.1.26",
+    "another-invalid-ip@127.0.0.256",
+    "IP-and-port@127.0.0.1:25",
+    "the-local-part-is-invalid-if-it-is-longer-than-sixty-four-characters@sld.net",
+    "user@example.com\n<script>alert('hello')</script>"
+  ]
+
+  describe '#validate?' do
+    context 'valid email address' do
+      VALID_EMAIL_ADDRESSES.each do |email|
+        it "#{email.inspect} should be valid" do
+          expect(CogiEmail.validate?(email)).to be_truthy
+        end
+      end
+    end
+
+    context 'invalid email address' do
+      INVALID_EMAIL_ADDRESSES.each do |email|
+        it "#{email.inspect} should not be valid" do
+          expect(CogiEmail.validate?(email)).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#normalize' do
+    context 'valid email address' do
+      VALID_EMAIL_ADDRESSES.each do |email|
+        it "#{email.inspect} return an valid email address" do
+          expect(CogiEmail.normalize(email)).to eq(email.strip.downcase)
+        end
+      end
+
+      [
+        "",
+        "test@",
+        "@missing-local.org",
+        "a b@space-in-local.com",
+        "! \#$%\`|@invalid-characters-in-local.org",
+        "<>@[]\`|@even-more-invalid-characters-in-local.org",
+        "invalid-characters-in-sld@! \"\#$%(),/;<>_[]\`|.org",
+        "missing-tld@sld.",
+        " ",
+        "IP-and-port@127.0.0.1:25",
+        "user@example.com\n<script>alert('hello')</script>"
+      ].each do |email|
+        it "#{email.inspect} raise error" do
+          expect{ CogiEmail.normalize(email) }.to raise_error(CogiEmail::NormalizationError)
+        end
+      end
+    end
+  end
+
+  describe '#valid_email_domain?' do
+    context 'Wellknown email providers' do
+      %w(gmail.com hotmail.com outlook.com yahoo.com aol.com).each do |domain|
+        it "peter.brown@#{domain} is valid" do
+          expect(CogiEmail.valid_email_domain?("peter.brown@#{domain}")).to be_truthy
+        end
+      end
+    end
+
+    context 'Email domain do not have MX record' do
+      %w(example.com aabbbccddee.example localhost).each do |domain|
+        it "peter.brown@#{domain} is not valid" do
+          expect(CogiEmail.valid_email_domain?("peter.brown@#{domain}")).to be_falsey
+        end
+      end
+    end
+  end
+
+  describe '#real_email?' do
+    context 'real email' do
+      it 'return true' do
+        expect(CogiEmail.real_email?('nobi.younet@gmail.com')).to be_truthy
+      end
+    end
+
+    context 'fake email' do
+      it 'return false' do
+        expect(CogiEmail.real_email?('nobi.younet@example.com')).to be_falsey
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'cogi_email'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: cogi_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nobi Hoang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: This gem provide you library to validate, parsing and format email. Check
+  is email is in blacklist or not.
+email: nobi.hoa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/cogi_email.rb
+- lib/cogi_email/checker.rb
+- lib/cogi_email/error.rb
+- lib/cogi_email/version.rb
+- spec/cogi_email/checker_spec.rb
+- spec/cogi_email_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hoahm/cogi_email
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- Rake -- Ruby Make
+- "--main"
+- README
+- "--line-numbers"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This gem provide you library to validate, parsing and format email.
+test_files:
+- spec/cogi_email/checker_spec.rb
+- spec/cogi_email_spec.rb
+- spec/spec_helper.rb