email_checker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 287b145d67ecd07f435e662d23557d5383365e9e
+  data.tar.gz: 91062933ded8f2ff2e4081cf148cde5eac0bf137
+SHA512:
+  metadata.gz: 5eacfdcdb7e892fec853b94e8d880161a379c76e806785b2530693825473360c6a72742440432479ae0dc9aef17569c1a2bbe2e40432b68af783f7ae12b791a2
+  data.tar.gz: df4ae4f2a51a082e59451dd631060bf5d37fcb2367b93337ec9ba66c81b668b33f0a1a280f890a822cabaecb55b5a4f29f333738cde212d677270cfc484f6887

data/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Style/IndentationConsistency:
+  Enabled: false
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 1000

data/.ruby-gemset

@@ -0,0 +1 @@
+email_checker

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_checker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genaro Madrid
+
+MIT License
+
+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,64 @@
+# Email Checker
+
+Check if an email address is can receive E-mails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_checker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_checker
+
+## How do this gem works
+
+For an email address to receive e-mails, it has to meet the following:
+
+1. The domain must have MX records.
+2. The MX records must point to a valid server and
+3. That server must have the corresponding A records.
+
+Now, that does not ensure that the email actually exists in the server, for that, we have to *pretend* to send an e-mail and check if the seerver is OK with it (respond with status 250). 
+If you want to read more about it you can read the [RFC 821](https://tools.ietf.org/html/rfc821).
+
+For this gem to *pretend* to send an email you have to provide a valid email address from whitch the email "will be sent". If you don't, the server might reject the message without checking if the email exists. In this gem that is the `verifier_email`.
+
+It is noteworthy that this method can result in your server being blacklisted since its known as a spamming technique.
+
+## Usage
+
+You can provide the `verifier_email` by passign it to the `check` method in the second parameter:
+
+```ruby
+  EmailChecker.check(email, verifier_email=nil)
+```
+
+Or in an initializer:
+
+```ruby
+  EmailChecker.config do |config|
+    config.verifier_email = 'realname@realdomain.com'
+  end
+
+  EmailChecker.check(email)
+```
+
+## Contributors
+
+`email_checker` it's inspired on [Kamilc](https://github.com/kamilc) [email_verifier](https://github.com/kamilc/email_verifier) gem. The diference is that `email_checker` validates the domain MX records and its server before it pretends to send an email, this way it is less posible that your server get blacklisted.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/email_checker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+task :console do
+  exec 'irb -r email_checker -I ./lib'
+end
+

data/bump

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+import re, glob, sys, os
+
+__USAGE__ = \
+"""BUMP is a semantic versioning bump script which accepts the following
+mutually exclusive arguments:
+   -m - a "major" version bump equal to +1.0.0
+   -n - a "minor" version bump equal to +0.1.0
+   -p - a "patch" version bump equal to +0.0.1
+   -h - a "hot fix" version bump equal to +0.0.1
+
+   All of these options allow for the -r flag, which indicates that the state
+   is a RELEASE not a SNAPSHOT. If -r is not specified, then -SNAPSHOT is
+   appended to the updated version string."""
+
+__INITIAL__ = ['0', '0', '1']
+
+
+if __name__ == "__main__":
+    v = []
+    try:
+        version_file = glob.glob("lib/*/version.rb")[0]
+        raw_v = re.search(r'VERSION = \'(.*)\'', open(version_file).read(), re.M|re.I|re.S).group(1)
+        v = re.split(re.compile("\.|-"), raw_v)
+        v = v[0:3]
+        map(int, v)
+
+    except ValueError:
+        print("failed to parse the existing VERSION file, assuming v 0.0.1")
+        v = ['0', '0', '1']
+
+    except FileNotFoundError:
+        print("failed to find a VERSION file, assuming v 0.0.0")
+        v = ['0', '0', '0']
+
+    op = ''
+    try:
+        op = sys.argv[1]
+    except:
+        print(__USAGE__)
+        sys.exit(-1)
+
+    if(op == '-m'):
+        v = [str(int(v[0])+1), '0', '0']
+
+    elif(op == '-n'):
+        v = [v[0], str(int(v[1])+1), '0']
+
+    elif(op == '-p' or op == '-h'):
+        v = [v[0], v[1], str(int(v[2])+1)]
+
+    else:
+        print(__USAGE__)
+        sys.exit(-1)
+
+    v = '.'.join(v)
+
+    if(op == '-h'):
+      os.system("git checkout -b hotfix/v%s master" % v)
+
+    else:
+      os.system("git checkout -b release/v%s develop" % v)
+
+    os.system("bump set %s" % v)
+
+    v += "\n"
+
+    print(v)
+
+    sys.exit(0)

data/email_checker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'email_checker'
+  spec.version       = EmailChecker::VERSION
+  spec.authors       = ['Genaro Madrid']
+  spec.email         = ['genmadrid@gmail.com']
+  spec.summary       = %q{Check if an email address is can receive E-mails.}
+  spec.description   = %q{Validates, at some degree, that the email you want to send to it's valid and exists.}
+  spec.homepage      = 'https://github.com/genaromadrid/email_checker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.7'
+  spec.add_development_dependency 'pry', '~> 0.10', '>= 0.10.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3', '>= 3.3.0'
+  spec.add_development_dependency 'bump', '~> 0.5', '>= 0.5.3'
+end

data/lib/email_checker/checker.rb

@@ -0,0 +1,65 @@
+require 'net/smtp'
+
+module EmailChecker
+  class Checker
+    attr_reader :domain
+
+    def initialize(email)
+      @email = email
+      email_m = email.match(EMAIL_PATTERN)
+      @domain = Domain.new(email_m[2])
+    end
+
+    def email_exists_in_server?
+      mailfrom if EmailChecker.config.verifier_domain
+      rcptto.tap do
+        close_connection
+      end
+    ensure
+      close_connection
+    end
+
+    private
+
+      def smtp
+        return @smtp if @smtp
+        tries ||= 5
+        domain.mx_servers.each do |server|
+          @smtp = Net::SMTP.start(server[:address], 25, EmailChecker.config.verifier_domain)
+          return @smtp if @smtp
+        end
+        fail EmailChecker::ServerConnectionError, "Unable to connect to any of the mail servers for #{@email}"
+      rescue EmailChecker::ServerConnectionError => e
+        fail EmailChecker::ServerConnectionError, e.message
+      rescue => e
+        if (tries -= 1) > 0
+          retry
+        else
+          fail EmailChecker::FailureError, e.message
+        end
+      end
+
+      def mailfrom
+        ensure_250(smtp.mailfrom(EmailChecker.config.verifier_email))
+      end
+
+      def rcptto
+        ensure_250(smtp.rcptto(@email))
+      rescue => e
+        if e.message[/^550/]
+          return false
+        else
+          fail EmailChecker::FailureError, e.message
+        end
+      end
+
+      def ensure_250(smtp_return)
+        return true if smtp_return.status.to_i == 250
+        fail EmailChecker::FailureError, "Mail server responded with #{smtp_return.status} when we were expecting 250"
+      end
+
+      def close_connection
+        smtp.finish if smtp && smtp.started?
+      end
+  end
+end

data/lib/email_checker/config.rb

@@ -0,0 +1,24 @@
+module EmailChecker
+  module Config
+    class << self
+      attr_accessor :verifier_email,
+                    :test_mode
+      attr_reader :verifier_domain
+
+      def reset
+        @verifier_email = nil
+        @test_mode = false
+        if defined?(Rails) && defined?(Rails.env) && Rails.env.test?
+          @test_mode = true
+        end
+      end
+
+      def verifier_email=(verifier_email)
+        @verifier_email = verifier_email
+        @verifier_domain = verifier_email.split('@').last
+      end
+    end
+
+    self.reset
+  end
+end

data/lib/email_checker/domain.rb

@@ -0,0 +1,63 @@
+module EmailChecker
+  class Domain
+
+    def initialize(domain)
+      @domain = domain
+    end
+
+    # Checks if the domian exists and has valid MX and A records
+    #
+    # @return [type] [description]
+    def valid?
+      return false unless @domain
+      Timeout::timeout(SERVER_TIMEOUT) do
+        return true if valid_mx_records?
+        return true if a_records?
+      end
+    rescue Timeout::Error, Errno::ECONNREFUSED
+      false
+    end
+
+    # Check if it has valid MX records and it can receive emails.
+    # The MX server exists and it has valid A records.
+    #
+    # @return [Boolean]
+    def valid_mx_records?
+      mx_servers.each do |server|
+        exchange_a_records = dns.getresources(server[:address], Resolv::DNS::Resource::IN::A)
+        return true if exchange_a_records.any?
+      end
+      false
+    end
+
+    # Check if the domain exists validation that has at least 1 A record.
+    #
+    # @return [Boolean]
+    def a_records?
+      a_records.any?
+    end
+
+    def a_records
+      @a_records ||= dns.getresources(@domain, Resolv::DNS::Resource::IN::A)
+    end
+
+    def mx_records
+      @mx_records ||= dns.getresources(@domain, Resolv::DNS::Resource::IN::MX).sort_by {|mx| mx.preference}
+    end
+
+    def mx_servers
+      return @mx_servers if @mx_servers
+      @mx_servers = []
+      mx_records.each do |mx|
+        @mx_servers.push(preference: mx.preference, address: mx.exchange.to_s)
+      end
+      @mx_servers
+    end
+
+    private
+
+      def dns
+        @dns ||= Resolv::DNS.new
+      end
+  end
+end

data/lib/email_checker/errors.rb

@@ -0,0 +1,4 @@
+module EmailChecker
+  ServerConnectionError = Class.new StandardError
+  FailureError = Class.new StandardError
+end

data/lib/email_checker/version.rb

@@ -0,0 +1,3 @@
+module EmailChecker
+  VERSION = '0.0.1'
+end

data/lib/email_checker.rb

@@ -0,0 +1,28 @@
+require 'resolv'
+require 'email_checker/version'
+
+module EmailChecker
+  require 'email_checker/errors'
+
+  autoload :Config, 'email_checker/config'
+  autoload :Checker, 'email_checker/checker'
+  autoload :Domain, 'email_checker/domain'
+
+  EMAIL_PATTERN = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+  SERVER_TIMEOUT = 5000
+
+  def self.check(email, verifier_email=nil)
+    config.verifier_email = verifier_email if verifier_email
+    checker = EmailChecker::Checker.new(email)
+    return false unless checker.domain.valid?
+    checker.email_exists_in_server?
+  end
+
+  def self.config
+    if block_given?
+      yield(EmailChecker::Config)
+    else
+      EmailChecker::Config
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: email_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Genaro Madrid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: Validates, at some degree, that the email you want to send to it's valid
+  and exists.
+email:
+- genmadrid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bump
+- email_checker.gemspec
+- lib/email_checker.rb
+- lib/email_checker/checker.rb
+- lib/email_checker/config.rb
+- lib/email_checker/domain.rb
+- lib/email_checker/errors.rb
+- lib/email_checker/version.rb
+homepage: https://github.com/genaromadrid/email_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Check if an email address is can receive E-mails.
+test_files: []