vjt-email_validator 1.5.1

data/CHANGELOG.rdoc

@@ -0,0 +1,45 @@
+= CHANGELOG
+
+== Version 1.4.4
+
+* https://github.com/alexdunae/validates_email_format_of/compare/1.4.3...1.4.4
+
+== Version 1.4.3
+
+* https://github.com/alexdunae/validates_email_format_of/compare/1.4.2...1.4.3
+
+== Version 1.4.2
+
+* See https://github.com/alexdunae/validates_email_format_of/compare/1.4.1...1.4.2
+
+== Version 1.4.1 (the George Anderson and 'history' edition)
+ * don't allow domains with underscores
+ * removed extra spaces in validation messages
+ * updated tests for Rails 2.3+
+
+== Version 1.4 (the Denis Ahearn edition)
+ * added ability to run validation tests without touching ActiveRecord or a database
+
+== Version 1.3.1 (the Github edition)
+ * updated for github
+
+== Version 1.3 (the Travis Sinnott edition)
+ * added optional MX record check
+ * now available as a gem
+
+== Version 1.2.1 (the RTFM edition)
+ * added support for quoted local parts
+ * added length checks for domain and local parts
+ * corrected escaped character support for RFC 3696 Errata
+ * added :allow_blank option
+ * added :unless option
+
+== Version 1.2 (the Ismael Santos Kafeltz and Michael MacDonald edition)
+ * added support for un-escaped and escaped special characters in the local part, per RFC 3696
+ * added :allow_nil option
+
+== Version 1.1 (the Francis Hwang edition)
+ * moved Regexp out of class methods into the ValidatesEmailFormatOf module
+
+== Version 1.0
+ * initial version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-11 Alex Dunae
+
+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.rdoc

@@ -0,0 +1,67 @@
+= email_validator ActiveModel::EachValidator
+
+Validate e-mail addresses against RFC 2822 and RFC 3696.
+
+== Installation
+
+  gem 'vjt-email_validator', :git => 'git://github.com/vjt/email_validator'
+
+== Usage
+
+Standalone:
+
+  EmailValidator.valid?(email) # => true or false
+
+Inside an ActiveRecord model:
+
+  class Person < ActiveRecord::Base
+    validates :email, :email => true
+  end
+
+=== Options
+
+Giving `:email => true` to the `validate` method uses the following default options.
+Customize them using `:email => { .. }`; E.g. `:email => {:check_mx => true}`
+
+  :message
+     String. A custom error message (default is: "does not appear to be a valid e-mail address")
+  :mx_message
+     String. A custom error message displayed when there is no MX for the given e-mail address
+     (default is: "is not routable")
+  :multiple_message
+     String. A custom error message displayed when one of the e-mail addresses in the record
+     is invalid (default is "appears to contain an invalid e-mail address)
+  :multiple
+     Boolean. Allows multiple email addresses separated by space and/or comma/colon
+  :check_mx
+     Boolean. Check domain for a valid MX record (default is false)
+  :local_length
+    Maximum number of characters allowed in the local part (default is 64)
+  :domain_length
+    Maximum number of characters allowed in the domain part (default is 255)
+
+== Testing
+
+To execute the unit tests run <tt>rake test</tt>.
+
+The unit tests for this plugin use an in-memory sqlite3 database.
+
+== Resources
+
+* Based on http://github.com/alexdunae/validates_email_format_of
+* http://github.com/vjt/email_validator
+
+== Original Credits
+
+Written by Alex Dunae (dunae.ca), 2006-11.
+
+Many thanks to the plugin's recent contributors: https://github.com/alexdunae/validates_email_format_of/contributors
+
+Thanks to Francis Hwang (http://fhwang.net/) at Diversion Media for creating the 1.1 update.
+Thanks to Travis Sinnott for creating the 1.3 update.
+Thanks to Denis Ahearn at Riverock Technologies (http://www.riverocktech.com/) for creating the 1.4 update.
+Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.
+
+== Rewrite
+
+Rewrote by Marcello Barnaba (vjt@openssl.it), 2011-02 as an ActiveModel::EachValidator

data/init.rb

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

data/lib/email_validator.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+require 'active_model'
+require 'resolv'
+
+class EmailValidator < ActiveModel::EachValidator
+
+  local_part_special_chars = Regexp.escape('!#$%&\'*-/=?+-^_`{|}~')
+  local_part_unquoted      = '(?:[[:alnum:]'   + local_part_special_chars + ']+[\.\+])*[[:alnum:]' + local_part_special_chars + '+]'
+  local_part_quoted        = '\"(?:[[:alnum:]' + local_part_special_chars + '\.]|\\\\[\x00-\xFF])*\"'
+  domain_part              = '@(?:(?:(?:\w+\-+[^_])|(?:\w+\.[a-z0-9-]*))*(?:[a-z0-9-]{1,63})\.[a-z]{2,6}(?:\.[a-z]{2,6})?'
+  Pattern   = Regexp.new('\A(?:' + local_part_unquoted + '+|' + local_part_quoted + '+)' + domain_part + '\Z)', Regexp::EXTENDED | Regexp::IGNORECASE, 'n').freeze
+  Separator = /[;,\s]\s*/.freeze # for multiple e-mail addresses
+  Defaults  = {
+    :message          => I18n.t(:invalid_email_address,    :scope => [:activerecord, :errors, :messages], :default => 'does not appear to be a valid e-mail address'),
+    :multiple_message => I18n.t(:invalid_multiple_email,   :scope => [:activerecord, :errors, :messages], :default => 'appears to contain an invalid e-mail address'),
+    :mx_message       => I18n.t(:unroutable_email_address, :scope => [:activerecord, :errors, :messages], :default => 'is not routable'),
+    :check_mx         => false,
+    :with             => Pattern,
+    :local_length     => 64,
+    :domain_length    => 255
+  }.freeze
+
+  # Validates whether the specified value is a valid email address,
+  # and uses record.errors.add() to add the error if the provided
+  # value is not valid.
+  #
+  # Configuration options:
+  # * <tt>message</tt>          - A custom error message
+  #                               (default: "does not appear to be a valid e-mail address")
+  # * <tt>check_mx</tt>         - Check for MX records
+  #                               (default: false)
+  # * <tt>mx_message</tt>       - A custom error message when an MX record validation fails
+  #                               (default: "is not routable.")
+  # * <tt>with</tt>             - The regex to use for validating the format of the email address
+  #                               (default: +Pattern+)</tt>
+  # * <tt>multiple</tt>         - Allow multiple e-mail addresses, separated by +Separator+
+  #                               (default: false)
+  # * <tt>multiple_message</tt> - A custom error message shown when there are 2 or more addresses
+  #                               to validate and one or more is invalid
+  #                               (default: "appears to contain an invalid e-mail address)
+  # * <tt>local_length</tt>     - Maximum number of characters allowed in the local part
+  #                               (default: 64)
+  # * <tt>domain_length</tt>    - Maximum number of characters allowed in the domain part
+  #                               (default: 255)
+  def validate_each(record, attribute, value)
+    return if value.blank? # Use :presence => true
+    error = self.class.errors_on(value, self.options)
+    record.errors.add(attribute, :invalid, :message => error, :value => value) if error
+  end
+
+  class << self
+    def valid?(email, options = {})
+      errors_on(email, options).nil?
+    end
+
+    def errors_on(email, options)
+      options = Defaults.merge(options)
+      options[:multiple] ? validate_many(email, options) : validate_one(email, options)
+    end
+
+  private
+    def validate_many(value, options)
+      emails = value.split(Separator)
+      errors = emails.map {|addr| validate_one(addr, options)}
+      errors.compact!
+      options[emails.size == 1 ? :message : :multiple_message] unless errors.empty?
+    end
+
+    def validate_one(value, options)
+      local, domain = value.split('@', 2)
+      if local.nil?  || local.length  > options[:local_length]  or
+         domain.nil? || domain.length > options[:domain_length] or
+         value !~ options[:with]
+        options[:message]
+
+      elsif options[:check_mx] && !validate_email_domain(domain)
+        options[:mx_message]
+
+      end
+    end
+
+    def validate_email_domain(domain)
+      Resolv::DNS.open do |dns|
+        dns.getresources(domain, Resolv::DNS::Resource::IN::MX).size > 0
+      end
+
+    rescue Errno::ECONNREFUSED, NoMethodError
+      # DNS is not available - thus return true
+      true
+    end
+
+  end
+end

data/rakefile.rb

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'pathname'
+
+desc 'Default: run unit tests.'
+task :default => [:clean, :test]
+
+desc 'Remove the old log file'
+task :clean do
+  Pathname(__FILE__).dirname.join('test', 'debug.log').unlink rescue nil
+end
+
+desc 'Test the email validator.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the email validator.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'email_validator'
+  rdoc.options << '--line-numbers --inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('TODO')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+plugin_test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/email_validator_test.rb

@@ -0,0 +1,165 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class EmailValidatorTest < TEST_CASE
+  fixtures :people
+
+  def setup
+    @valid_email = 'valid@example.com'
+    @invalid_email = 'invalid@example.'
+  end
+
+  def test_should_allow_valid_email_addresses
+    ['valid@example.com',
+     'Valid@test.example.com',
+     'valid+valid123@test.example.com',
+     'valid_valid123@test.example.com',
+     'valid-valid+123@test.example.co.uk',
+     'valid-valid+1.23@test.example.com.au',
+     'valid@example.co.uk',
+     'v@example.com',
+     'valid@example.ca',
+     'valid_@example.com',
+     'valid123.456@example.org',
+     'valid123.456@example.travel',
+     'valid123.456@example.museum',
+     'valid@example.mobi',
+     'valid@example.info',
+     'valid-@example.com',
+  # allow single character domain parts
+     'valid@mail.x.example.com',
+     'valid@x.com',
+     'valid@example.w-dash.sch.uk',
+  # from RFC 3696, page 6
+     'customer/department=shipping@example.com',
+     '$A12345@example.com',
+     '!def!xyz%abc@example.com',
+     '_somename@example.com',
+  # apostrophes
+     "test'test@example.com",
+     ].each do |email|
+      p = create_person(:email => email)
+      save_passes(p)
+    end
+  end
+
+  def test_should_not_allow_invalid_email_addresses
+    ['invalid@example-com',
+  # period can not start local part
+     '.invalid@example.com',
+  # period can not end local part
+     'invalid.@example.com',
+  # period can not appear twice consecutively in local part
+     'invali..d@example.com',
+  # should not allow underscores in domain names
+     'invalid@ex_mple.com',
+     'invalid@example.com.',
+     'invalid@example.com_',
+     'invalid@example.com-',
+     'invalid-example.com',
+     'invalid@example.b#r.com',
+     'invalid@example.c',
+     'invali d@example.com',
+  # unclosed quote
+     "\"a-17180061943-10618354-1993365053",
+  # too many special chars used to cause the regexp to hang
+     "-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++@foo",
+     'invalidexample.com',
+  # should not allow special chars after a period in the domain
+     'local@sub.)domain.com',
+     'local@sub.#domain.com',
+  # one at a time
+     "foo@example.com\nexample@gmail.com",
+     'invalid@example.'].each do |email|
+      p = create_person(:email => email)
+      save_fails(p)
+    end
+  end
+
+  # from http://www.rfc-editor.org/errata_search.php?rfc=3696
+  def test_should_allow_quoted_characters
+    ['"Abc\@def"@example.com',
+     '"Fred\ Bloggs"@example.com',
+     '"Joe.\\Blow"@example.com',
+     ].each do |email|
+      p = create_person(:email => email)
+      save_passes(p)
+    end
+  end
+
+  # from http://tools.ietf.org/html/rfc3696, page 5
+  # corrected in http://www.rfc-editor.org/errata_search.php?rfc=3696
+  def test_should_not_allow_escaped_characters_without_quotes
+    ['Fred\ Bloggs_@example.com',
+     'Abc\@def+@example.com',
+     'Joe.\\Blow@example.com'
+     ].each do |email|
+      p = create_person(:email => email)
+      save_fails(p)
+    end
+  end
+
+  def test_should_check_length_limits
+    ['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@example.com',
+     'test@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.com'
+     ].each do |email|
+      p = create_person(:email => email)
+      save_fails(p)
+    end
+  end
+
+  def test_should_respect_validate_on_option
+    p = create_person(:email => @valid_email)
+    save_passes(p)
+
+    # we only asked to validate on :create so this should fail
+    assert p.update_attributes(:email => @invalid_email)
+    assert_equal @invalid_email, p.email
+  end
+
+  def test_should_allow_custom_error_message
+    p = create_person(:email => @invalid_email)
+    save_fails(p)
+    assert_equal ['fails with custom message'], p.errors[:email]
+  end
+
+  def test_should_allow_nil
+    p = create_person(:email => nil)
+    save_passes(p)
+  end
+
+  # TODO: find a future-proof way to check DNS records
+  def test_check_mx
+    pmx = MxRecord.new(:email => 'test@dunae.ca')
+    save_passes(pmx)
+
+    pmx = MxRecord.new(:email => 'test@somethingthathasntbeenregistered.com')
+    save_fails(pmx)
+  end
+
+  def test_should_be_usable_standalone
+    assert_equal true,  EmailValidator.valid?('vjt@openssl.it')
+    assert_equal false, EmailValidator.valid?('antani')
+  end
+
+  def test_overriding_length_checks
+    assert_equal false, EmailValidator.valid?('valid@example.com', :local_length  => 1)
+    assert_equal false, EmailValidator.valid?('valid@example.com', :domain_length => 1)
+  end
+
+  protected
+    def create_person(params)
+      Person.new(params)
+    end
+
+    def save_passes(p)
+      assert p.valid?, " validating #{p.email}"
+      assert p.save
+      assert_equal [], p.errors[:email]
+    end
+
+    def save_fails(p)
+      assert !p.valid?, " validating #{p.email}"
+      assert !p.save
+      assert_equal 1, p.errors[:email].size
+    end
+end

data/test/fixtures/people.yml

@@ -0,0 +1,3 @@
+existing:
+  id: 1
+  email: test@example.com

data/test/fixtures/person.rb

@@ -0,0 +1,9 @@
+class Person < ActiveRecord::Base
+  validates :email, :email => {:message => 'fails with custom message'},
+                    :on    => :create
+end
+
+class MxRecord < ActiveRecord::Base
+  validates :email, :email => {:check_mx => true},
+                    :on    => :create
+end

data/test/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :people, :force => true do |t|
+    t.column "email", :string
+  end
+
+  create_table :mx_records, :force => true do |t|
+    t.column "email", :string
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require "#{File.dirname(__FILE__)}/../init"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'plugin_test'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+if ActiveSupport.const_defined?(:TestCase)
+  ActiveSupport::TestCase.send(:include, ActiveRecord::TestFixtures)
+  TEST_CASE = ActiveSupport::TestCase
+else
+  TEST_CASE = Test::Unit::TestCase
+end
+
+TEST_CASE.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$:.unshift(TEST_CASE.fixture_path)
+
+class TEST_CASE #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(TEST_CASE.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(TEST_CASE.fixture_path, table_names)
+    end
+  end
+
+  self.use_transactional_fixtures = false
+  
+  self.use_instantiated_fixtures  = false
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: vjt-email_validator
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: 
+  segments: 
+  - 1
+  - 5
+  - 1
+  version: 1.5.1
+platform: ruby
+authors: 
+- Marcello Barnaba
+- Alex Dunae
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: ActiveModel::EachValidator to check for valid e-mail addresses
+email: vjt@openssl.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- init.rb
+- rakefile.rb
+- CHANGELOG.rdoc
+- README.rdoc
+- lib/email_validator.rb
+- test/email_validator_test.rb
+- test/fixtures/person.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/database.yml
+- test/fixtures/people.yml
+has_rdoc: true
+homepage: http://github.com/vjt/email_validator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- email_validator
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Validate e-mail addresses against RFC 2822 and RFC 3696.
+test_files: 
+- test/email_validator_test.rb
+- test/fixtures/person.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/database.yml
+- test/fixtures/people.yml