spectator-validates_email 0.0.2

data/.gitignore

@@ -0,0 +1,14 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## PROJECT::GENERAL
+pkg
+rdoc
+*.gem
+
+## PROJECT::SPECIFIC
+test/debug.log

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,51 @@
+= validates_email
+
+validates_email is a Rails 3 plugin that validates email addresses against RFC 2822 and RFC 3696
+
+== Installation
+
+  rails plugin install git://github.com/spectator/validates_email.git
+
+== Usage
+
+  class User < ActiveRecord::Base
+    validates :field, :email => true
+  end
+
+As well as any other Rails 3 validation this one has the same triggers, such as <tt>:on</tt>, <tt>:if</tt>, <tt>:unless</tt>, <tt>:allow_blank</tt>, and <tt>:allow_nil</tt>.
+
+Also, you can pass your custom error message, otherwise it will use ActiveRecord's invalid error message.
+
+  class User < ActiveRecord::Base
+    validates :field, :email => { :message => 'is not an email address' }
+  end
+
+If you like to check MX Records for email, you can use <tt>:mx</tt> option.
+
+  class User < ActiveRecord::Base
+    validates :field, :email => { :mx => true }
+  end
+
+And if you like to check MX Records with fallback to A record, use <tt>:a_fallback</tt> option.
+
+  class User < ActiveRecord::Base
+    validates :field, :email => { :mx => { :a_fallback => true } }
+  end
+
+== Testing
+
+To execute unit tests run <tt>rake test</tt> within plugin folder.
+
+The unit tests for this plugin use an in-memory sqlite3 database.
+
+== Credits
+
+Most of the code were taken from Alex Dunae (dunae.ca) plugin (see http://github.com/alexdunae/validates_email_format_of/) and adopted for Rails 3, so pass all beers to him.
+
+== Contributors
+
+Petr Blaho
+
+== Notes
+
+Tested under ruby 1.9.2-rc1 and Rails 3 Edge

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "spectator-validates_email"
+    gem.summary = %Q{Gem to validate email addresses for Rails 3}
+    gem.description = %Q{validates_email is a Rails 3 plugin that validates email addresses against RFC 2822 and RFC 3696}
+    gem.email = "yury.velikanau@gmail.com"
+    gem.homepage = "http://github.com/spectator/validates_email"
+    gem.authors = ["Yury Velikanau"]
+    gem.add_development_dependency "activerecord", ">= 3.0.0.beta"
+    gem.add_development_dependency "activesupport", ">= 3.0.0.beta"
+    gem.add_development_dependency "sqlite3-ruby", ">= 1.3.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesEmail'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/init.rb

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

data/lib/validates_email.rb

@@ -0,0 +1,40 @@
+class EmailValidator < ActiveModel::EachValidator
+
+  LocalPartSpecialChars = Regexp.escape('!#$%&\'*-/=?+-^_`{|}~')
+  LocalPartUnquoted = '(([[:alnum:]' + LocalPartSpecialChars + ']+[\.\+]+))*[[:alnum:]' + LocalPartSpecialChars + '+]+'
+  LocalPartQuoted = '\"(([[:alnum:]' + LocalPartSpecialChars + '\.\+]*|(\\\\[\x00-\xFF]))*)\"'
+  Regex = Regexp.new('^((' + LocalPartUnquoted + ')|(' + LocalPartQuoted + ')+)@(((\w+\-+[^_])|(\w+\.[^_]))*([a-z0-9-]{1,63})\.[a-z]{2,6}$)', Regexp::EXTENDED | Regexp::IGNORECASE, 'n')
+
+  def validates_email_format(email)
+    # local part max is 64 chars, domain part max is 255 chars
+    # TODO: should this decode escaped entities before counting?
+    begin
+      local, domain = email.split('@', 2)
+    rescue
+      return false
+    end
+
+    email =~ Regex and not email =~ /\.\./ and domain.length <= 255 and local.length <= 64
+  end
+
+  def validates_email_domain(email, options)
+    require 'resolv'
+    a_fallback = options.is_a?(Hash) ? options[:a_fallback] : nil
+    domain = email.match(/\@(.+)/)[1]
+    Resolv::DNS.open do |dns|
+      @mx = dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
+      @mx.push(*dns.getresources(domain, Resolv::DNS::Resource::IN::A)) if a_fallback
+    end
+    @mx.size > 0 ? true : false
+  end
+
+  def validate_each(record, attribute, value)
+    unless validates_email_format(value)
+      record.errors[attribute] << (options[:message] || I18n.t(:invalid, :scope => [:activerecord, :errors, :messages]))
+    end
+    if options[:mx] && !validates_email_domain(value, options[:mx])
+      record.errors[attribute] << (options[:mx_message] || I18n.t(:mx_invalid, :scope => [:activerecord, :errors, :messages]))
+    end
+  end
+
+end

data/test/database.yml

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

data/test/schema.rb

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

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_support/core_ext/logger'
+
+def load_schema
+  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['plugin_test'])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../init.rb'
+end

data/test/validates_email_test.rb

@@ -0,0 +1,157 @@
+require 'test_helper'
+
+class ValidatesEmailTest < ActiveSupport::TestCase
+  load_schema
+
+  class Person < ActiveRecord::Base
+    validates :email, :email => { :message => 'fails with custom message' }
+  end
+
+  class MxRecord < ActiveRecord::Base
+    validates :email, :email => { :mx => true,
+                                  :mx_message => 'fails with custom mx message' }
+  end
+
+  class MxFallback < ActiveRecord::Base
+    validates :email, :email => { :mx => { :a_fallback => true },
+                                  :mx_message => 'fails with custom mx message' }
+  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',
+      # 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, email)
+    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',
+      'invalidexample.com',
+      'invalid@example.'
+    ].each do |email|
+      p = create_person(:email => email)
+      save_fails(p, email)
+    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, email)
+    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, email)
+    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, email)
+    end
+  end
+
+  def test_should_allow_custom_error_message
+    p = create_person(:email => @invalid_email)
+    save_fails(p)
+    # Object.errors[:field] returns array now
+    assert_equal ['fails with custom message'], p.errors[:email]
+  end
+
+  def test_should_validate_email_with_mx
+    valid_email = 'test@gmail.com'
+    p = MxRecord.new(:email => valid_email)
+    save_passes(p, valid_email)
+
+    invalid_email = 'test@example.com'
+    p = MxRecord.new(:email => invalid_email)
+    save_fails(p, invalid_email)
+  end
+
+  def test_should_validate_with_mx_fallback
+    valid_email = 'test@gmail.com'
+    p = MxFallback.new(:email => valid_email)
+    save_passes(p, valid_email)
+
+    invalid_email = 'test@example.com'
+    p = MxFallback.new(:email => invalid_email)
+    save_passes(p, invalid_email)
+  end
+
+  protected
+
+  def create_person(params)
+    Person.new(params)
+  end
+
+  def save_passes(p, email = '')
+    assert p.valid?, " validating #{email}"
+    assert p.save
+    assert_empty p.errors[:email]
+  end
+
+  def save_fails(p, email = '')
+    assert !p.valid?, " validating #{email}"
+    assert !p.save
+    assert_not_empty p.errors[:email]
+  end
+
+end

data/validates_email.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validates_email}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Yury Velikanau"]
+  s.date = %q{2010-08-06}
+  s.description = %q{validates_email is a Rails 3 plugin that validates email addresses against RFC 2822 and RFC 3696}
+  s.email = %q{yury.velikanau@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/validates_email.rb",
+     "test/database.yml",
+     "test/schema.rb",
+     "test/test_helper.rb",
+     "test/validates_email_test.rb",
+     "validates_email.gemspec"
+  ]
+  s.homepage = %q{http://github.com/spectator/validates_email}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gem to validate email addresses for Rails 3}
+  s.test_files = [
+    "test/schema.rb",
+     "test/test_helper.rb",
+     "test/validates_email_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+      s.add_development_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0.beta"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+  end
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: spectator-validates_email
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Yury Velikanau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-06 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id003
+description: validates_email is a Rails 3 plugin that validates email addresses against RFC 2822 and RFC 3696
+email: yury.velikanau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/validates_email.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+- test/validates_email_test.rb
+- validates_email.gemspec
+has_rdoc: true
+homepage: http://github.com/spectator/validates_email
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Gem to validate email addresses for Rails 3
+test_files: 
+- test/schema.rb
+- test/test_helper.rb
+- test/validates_email_test.rb