email_detected 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79315f08dcc21055770445254efa77c8fc327cf9
+  data.tar.gz: 856b108d3eddf128133cad9418176e38f2089ebc
+SHA512:
+  metadata.gz: 2f64c8b4661656aaa8ad5b690aed1d05fff285c352056da0588190d1a9d574a4b5cca9c636c0ce3c956c9289a71a5d8d9de5fd86212836d6606bb3b58dd6c218
+  data.tar.gz: 24e1f0889957a65fc66cb3ddd2bd1ac621db02930b77be33c96a56e823723d579f1eb01b8eb7afba8c840963706c6732fcb0722b702400feef6f2d58c4524f74

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at quanmn.libra@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nguyen Quan
+
+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,43 @@
+# EmailDetected
+
+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/email_detected`. 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 'email_detected'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_detected
+
+## 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]/email_detected. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EmailDetected project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/email_detected/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "email_detected"
+
+# 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/email_detected.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_detected/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_detected"
+  spec.version       = EmailDetected::VERSION
+  spec.authors       = ["Nguyen Quan"]
+  spec.email         = ["quannguyen@bestcoder.info"]
+
+  spec.summary       = %q{Email Detected help checking email address is real.}
+  spec.description   = %q{Email Detected is a simple tool for verifying an email address exists. It's free and quite easy to use :smile: .Many times as developers we were putting validation statements for checking email addresses format. This gem will complete your existing setups with validator that actually connects with a given mail server and asks if the address in question exists for real.}
+  spec.homepage      = "https://github.com/minhquan4080/email_detected"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/email_detected.rb

@@ -0,0 +1,31 @@
+require "email_detected/version"
+
+module EmailDetected
+  require 'email_detected/config'
+  require 'email_detected/checker'
+  require 'email_detected/messages'
+  require 'email_detected/validates_exist_email'
+
+  VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+
+  def self.exist?(email)
+    return true if config.test_mode
+    return { status: false, errors: ['The email address invalid.'] } unless email.match VALID_EMAIL_REGEX
+    email_detected = EmailDetected::Checker.run(email)
+    if email_detected.invalid?
+      resp = { status: false, message: email_detected.errors.first }
+    else
+      resp = { status: true, message: 'The email address has already been registered.' }
+    end
+    resp
+  end
+
+  def self.config(&block)
+    if block_given?
+      block.call(EmailDetected::Config)
+    else
+      EmailDetected::Config
+    end
+  end
+
+end

data/lib/email_detected/checker.rb

@@ -0,0 +1,103 @@
+require 'resolv'
+require 'net/smtp'
+
+class EmailDetected::Checker < Net::SMTP
+
+  class MailCheckStatus
+    attr_accessor :errors
+
+    def self.rcpt_responses
+      @@rcpt_responses ||=
+          {
+              -1  => :fail,        # Validation failed (non-SMTP)
+              250 => :valid,       # Requested mail action okay, completed
+              251 => :dunno,       # User not local; will forward to <forward-path>
+              550 => :invalid,     # Requested action not taken:, mailbox unavailable
+              551 => :dunno,       # User not local; please try <forward-path>
+              552 => :valid,       # Requested mail action aborted:, exceeded storage allocation
+              553 => :invalid,     # Requested action not taken:, mailbox name not allowed
+              450 => :valid_fails, # Requested mail action not taken:, mailbox unavailable
+              451 => :valid_fails, # Requested action aborted:, local error in processing
+              452 => :valid_fails, # Requested action not taken:, insufficient system storage
+              500 => :fail,        # Syntax error, command unrecognised
+              501 => :invalid,     # Syntax error in parameters or arguments
+              503 => :fail,        # Bad sequence of commands
+              521 => :invalid,     # <domain> does not accept mail [rfc1846]
+              421 => :fail,        # <domain> Service not available, closing transmission channel
+          }
+    end
+
+    def initialize(response_code, error = nil)
+      errors = Array.new
+      unless error.nil?
+        errors.push(EmailDetected::MESSAGES[response_code])
+      end
+      @response = (self.class.rcpt_responses.has_key?(response_code) ?
+          response_code : -1)
+      @errors = errors
+    end
+
+    # Symbolic status of mail address verification.
+    #
+    # :fail::        Verification failed
+    # :dunno::       Verification succeeded, but can't tell about validity
+    # :valid::       address known to be valid
+    # :valid_fails:: address known to be valid, delivery would have failed temporarily
+    # :invalid::     address known to be invalid
+    def status
+      @@rcpt_responses[@response]
+    end
+
+    # true if verified address is known to be valid
+    def valid?
+      [:valid, :valid_fails].include? self.status
+    end
+
+    # true if verified address is known to be invalid
+    def invalid?
+      self.status == :invalid
+    end
+  end
+
+  def self.run(addr, server = nil, decoy_from = nil)
+    # FIXME: needs a better mail address parser
+    server = get_mail_server(addr[(addr.index('@')+1)..-1]) if server.nil?
+
+    # This only needs to be something the receiving SMTP server
+    # accepts.  We aren't actually sending any mail.
+    decoy_from ||= EmailDetected.config.verifier_email
+    ret = nil
+    begin
+      EmailDetected::Checker.start(server) do |smtp|
+        ret = smtp.check_mail_addr(addr, decoy_from)
+        ret = MailCheckStatus.new(ret.status.to_i)
+      end
+    rescue Net::SMTPAuthenticationError,
+        Net::SMTPServerBusy,
+        Net::SMTPSyntaxError,
+        Net::SMTPFatalError,
+        Net::SMTPUnknownError => error
+      ret = MailCheckStatus.new(error.to_s[0..2].to_i, error)
+    rescue IOError, TimeoutError, ArgumentError => error
+      ret = MailCheckStatus.new(-1, error)
+    end
+    return ret
+  end
+
+  def check_mail_addr(to_addr, decoy_from = nil)
+    raise IOError, 'closed session' unless @socket
+    raise ArgumentError, 'mail destination not given' if to_addr.empty?
+    mailfrom decoy_from
+    rcptto to_addr
+  end
+
+  def self.get_mail_server(host)
+    res = Resolv::DNS.new.getresources(host, Resolv::DNS::Resource::IN::MX)
+    unless res.empty?
+      # FIXME: should return the whole list
+      return res.sort {|x,y| x.preference <=> y.preference}.first.exchange.to_s
+    end
+    nil
+  end
+
+end

data/lib/email_detected/config.rb

@@ -0,0 +1,19 @@
+module EmailDetected
+  module Config
+    class << self
+      attr_accessor :verifier_email
+      attr_accessor :test_mode
+
+      def reset
+        # This only needs to be something the receiving SMTP server
+        # accepts.  We aren't actually sending any mail.
+        @verifier_email = ENV['EMAIL_DETECTED'] || "nobody@nonexistant.com"
+        @test_mode = false
+        if defined?(Rails) and defined?(Rails.env) and Rails.env.test?
+          @test_mode = true
+        end
+      end
+    end
+    self.reset
+  end
+end

data/lib/email_detected/messages.rb

@@ -0,0 +1,19 @@
+module EmailDetected
+  MESSAGES = {
+    -1 =>  'Validation failed (non-SMTP)',
+    250 => 'Requested mail action okay, completed',
+    251 => 'User not local; will forward to <forward-path>',
+    550 => 'Requested action not taken:, mailbox unavailable',
+    551 => 'User not local; please try <forward-path>',
+    552 => 'Requested mail action aborted:, exceeded storage allocation',
+    553 => 'Requested action not taken:, mailbox name not allowed',
+    450 => 'Requested mail action not taken:, mailbox unavailable',
+    451 => 'Requested action aborted:, local error in processing',
+    452 => 'Requested action not taken:, insufficient system storage',
+    500 => 'Syntax error, command unrecognised',
+    501 => 'Syntax error in parameters or arguments',
+    503 => 'Bad sequence of commands',
+    521 => '<domain> does not accept mail [rfc1846]',
+    421 => '<domain> Service not available, closing transmission channel'
+  }
+end

data/lib/email_detected/validates_exist_email.rb

@@ -0,0 +1,36 @@
+if defined?(ActiveSupport)
+  ActiveSupport.on_load(:active_record) do
+    module EmailDetected
+      module ValidatesExistEmail
+        module Validator
+          require 'mail'
+
+          class EmailExistValidator < ActiveModel::EachValidator
+            def validate_each(record, attribute, value)
+              begin
+                m = Mail::Address.new(value)
+                r = m.domain!=nil && m.domain.match('\.') && m.address == value
+                r = EmailDetected.exist? m.address
+                r = r[:status]
+              rescue
+                r = false
+              end
+              record.errors[attribute] << (options[:message] || "does not exist") unless r
+            end
+          end
+
+        end
+
+        module ClassMethods
+          def validates_exist_email_of(*attr_names)
+            validates_with ActiveRecord::Base::EmailExistValidator, _merge_attributes(attr_names)
+          end
+        end
+
+      end
+    end
+
+    ActiveRecord::Base.send(:include, EmailDetected::ValidatesExistEmail::Validator)
+    ActiveRecord::Base.send(:extend,  EmailDetected::ValidatesExistEmail::ClassMethods)
+  end
+end

data/lib/email_detected/version.rb

@@ -0,0 +1,3 @@
+module EmailDetected
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: email_detected
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nguyen Quan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Email Detected is a simple tool for verifying an email address exists.
+  It''s free and quite easy to use :smile: .Many times as developers we were putting
+  validation statements for checking email addresses format. This gem will complete
+  your existing setups with validator that actually connects with a given mail server
+  and asks if the address in question exists for real.'
+email:
+- quannguyen@bestcoder.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- email_detected.gemspec
+- lib/email_detected.rb
+- lib/email_detected/checker.rb
+- lib/email_detected/config.rb
+- lib/email_detected/messages.rb
+- lib/email_detected/validates_exist_email.rb
+- lib/email_detected/version.rb
+homepage: https://github.com/minhquan4080/email_detected
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Email Detected help checking email address is real.
+test_files: []