validates_email_whitelist_of 1.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :gemcutter
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    validates_email_whitelist_of (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.11)
+      activesupport (= 2.3.11)
+    activesupport (2.3.11)
+    diff-lcs (1.1.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.11)
+  rspec (~> 2.4.0)
+  sqlite3
+  validates_email_whitelist_of!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [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.markdown

@@ -0,0 +1,41 @@
+validates_email_whitelist_of
+============================
+
+Plugin for ActiveRecord for validating email format and whitelisting the domain.
+
+Works on Rails 2+, Rails 3+ and Ruby 1.8+.
+
+Usage
+=====
+
+Add the gem to your Rails Gemfile
+
+    gem 'validates_email_whitelist_of'
+
+	class User < ActiveRecord::Base
+	  validates_email_whitelist_of :email, :whitelist => ['example.com', 'google.com']
+	end
+
+On ActiveRecord 3.0+ you can do
+
+	class User < ActiveRecord::Base
+	  validates :email, :whitelist => true
+	end
+
+If you want to use I18n, make sure you add the scope
+
+  `activerecord.errors.messages.invalid_email`
+  `activerecord.errors.messages.invalid_whitelist`
+
+or
+
+  `errors.messages.invalid_email`
+  `errors.messages.invalid_whitelist`
+
+The following locales are builtin:
+
+* pt
+* pt-BR
+* en
+
+Copyright (c) 2011 Ruben Fonseca, released under the MIT license

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  activerecord:
+    errors:
+      messages:
+        invalid_email: "is not a valid address"
+        invalid_whitelist: "is not an allowed email"
+  errors:
+    messages:
+      invalid_email: "is not a valid e-mail"
+      invalid_whitelist: "is not an allowed email"

data/config/locales/pt.yml

@@ -0,0 +1,16 @@
+pt: &pt
+  activerecord:
+    errors:
+      messages:
+        invalid_email: "não parece ser um e-mail válido"
+        invalid_whitelist: "não é um e-mail permitido"
+  errors:
+    messages:
+      invalid_email: "não parece ser um e-mail válido"
+      invalid_whitelist: "não é um e-mail permitido"
+
+pt-BR:
+  <<: *pt
+
+pt-PT:
+  <<: *pt

data/init.rb

@@ -0,0 +1 @@
+require "validates_email_whitelist_of"

data/lib/rails2/validates_email_whitelist_of.rb

@@ -0,0 +1,28 @@
+module SimplesIdeias
+  module ValidatesEmailWhitelistOf
+    def validates_email_whitelist_of(*attr_names)
+      options = {
+        :on          => :save,
+        :allow_nil   => false,
+        :allow_blank => false,
+        :whitelist   => []
+      }
+
+      options.update(attr_names.pop) if attr_names.last.kind_of?(Hash)
+
+      validates_each(attr_names, options) do |record, attr_name, value|
+        if value.to_s =~ EMAIL_FORMAT
+          message = ::I18n.t(:invalid_whitelist, :scope => 'activerecord.errors.messages')
+          record.errors.add(attr_name, message) unless options[:whitelist].include?($2)
+        else
+          message = ::I18n.translate(options[:message], :default => [:"activerecord.errors.messages.invalid_email", "is not a valid address"])
+          record.errors.add(attr_name, message)
+        end
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend SimplesIdeias::ValidatesEmailWhitelistOf
+end

data/lib/rails3/validates_email_whitelist_of.rb

@@ -0,0 +1,21 @@
+module ActiveModel
+  module Validations
+    class EmailWhitelistValidator < EachValidator
+      def validate_each(record, attribute, value)
+        if value.to_s !~ SimplesIdeias::ValidatesEmailWhitelistOf::EMAIL_FORMAT
+          record.errors.add(attribute, :invalid_email, :default => options[:message], :value => value)
+        else
+          unless (options[:whitelist] || []).include?($2)
+            record.errors.add(attribute, :invalid_whitelist, :default => options[:message], :value => value)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def validates_email_whitelist_of(*attr_names)
+        validates_with EmailWhitelistValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/validates_email_whitelist_of.rb

@@ -0,0 +1,13 @@
+module SimplesIdeias
+  module ValidatesEmailWhitelistOf
+    EMAIL_FORMAT = /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+  end
+end
+
+I18n.load_path += Dir[File.dirname(__FILE__) + "/../config/locales/*.yml"]
+
+if ActiveRecord::VERSION::STRING >= "3.0"
+  require "rails3/validates_email_whitelist_of"
+else
+  require "rails2/validates_email_whitelist_of"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/.."
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+
+require "rubygems"
+require "bundler/setup"
+
+require "active_record"
+require "active_record/migration"
+require "init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :email, :corporate_email
+  end
+end
+
+::I18n.backend.__send__ :init_translations
+
+INVALID_EMAILS = [
+  '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.',
+  # from http://tools.ietf.org/html/rfc3696, page 5
+  # corrected in http://www.rfc-editor.org/errata_search.php?rfc=3696
+  'Fred\ Bloggs_@example.com',
+  'Abc\@def+@example.com',
+  'Joe.\\Blow@example.com'
+]
+
+VALID_EMAILS = [
+  '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",
+  # '"Abc\@def"@example.com',
+  # from http://www.rfc-editor.org/errata_search.php?rfc=3696
+  # '"Fred\ Bloggs"@example.com',
+  '"Joe.\\Blow"@example.com'
+]
+
+WHITELIST = [
+  'example.com',
+  'test.example.com',
+  'test.example.co.uk',
+  'test.example.com.au',
+  'example.co.uk',
+  'example.info',
+  'example.ca',
+  'example.org',
+  'example.travel',
+  'example.museum',
+  'example.mobi'
+]

data/spec/validates_email_format_of_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "validates email format of" do
+  class User < ActiveRecord::Base
+    validates_email_whitelist_of :email, :corporate_email, :allow_blank => false, :whitelist => WHITELIST
+  end
+
+  class Buyer < ActiveRecord::Base
+    set_table_name :users
+    validates_email_whitelist_of :email, :message => "is not a valid e-mail", :whitelist => WHITELIST
+  end
+
+  before do
+    I18n.locale = :en
+  end
+
+  VALID_EMAILS.each do |email|
+    it "should accept #{email.inspect} as a valid email" do
+      user = User.new(:email => email, :corporate_email => email)
+      user.should be_valid
+    end
+  end
+
+  INVALID_EMAILS.each do |email|
+    it "should reject #{email.inspect} as a valid email" do
+      user = User.new(:email => "invalid", :corporate_email => "invalid")
+      user.should_not be_valid
+    end
+  end
+
+  it "should reject a not whitelisted email" do
+    user = User.new(:email => "foo@notwhitelisted.com")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["is not an allowed email"]
+  end
+
+  it "should use default error message" do
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["is not a valid address"]
+  end
+
+  it "should reject nil value" do
+    user = User.new(:email => nil)
+    user.should_not be_valid
+    errors_for(user, :email).should_not be_empty
+  end
+
+  it "should reject empty value" do
+    user = User.new(:email => "")
+    user.should_not be_valid
+    errors_for(user, :email).should_not be_empty
+  end
+
+  it "should validate multiple attributes" do
+    user = User.new(:corporate_email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :corporate_email).should == ["is not a valid address"]
+  end
+
+  it "should use custom error message as :message options" do
+    buyer = Buyer.new(:email => "invalid")
+    buyer.should_not be_valid
+    errors_for(buyer, :email).should == ["is not a valid address"]
+  end
+
+  it "should use I18n string as error message [pt]" do
+    I18n.locale = :pt
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["não parece ser um e-mail válido"]
+  end
+
+  it "should use I18n string as error message [pt-BR]" do
+    I18n.locale = :'pt-BR'
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["não parece ser um e-mail válido"]
+  end
+
+  it "should use I18n string as error message [pt-PT]" do
+    I18n.locale = :'pt-PT'
+    user = User.new(:email => "invalid")
+    user.should_not be_valid
+    errors_for(user, :email).should == ["não parece ser um e-mail válido"]
+  end
+
+  if ActiveRecord::VERSION::STRING >= "3.0"
+    context "ActiveRecord 3.0+" do
+      class Person < ActiveRecord::Base
+        set_table_name :users
+        validates :email, :email => true
+      end
+
+      VALID_EMAILS.each do |email|
+        it "should accept #{email.inspect} as a valid email" do
+          user = Person.new(:email => email)
+          user.should be_valid
+        end
+      end
+
+      INVALID_EMAILS.each do |email|
+        it "should reject #{email.inspect} as a valid email" do
+          user = Person.new(:email => "invalid")
+          user.should_not be_valid
+        end
+      end
+    end
+  end
+
+  def errors_for(record, attr_name)
+    [record.errors[attr_name]].flatten.compact
+  end
+end

data/validates_email_whitelist_of.gemspec

@@ -0,0 +1,24 @@
+spec = Gem::Specification.new do |s|
+  s.name = 'validates_email_whitelist_of'
+
+  s.version = '1.0.1'
+  s.summary = 'Validates e-mail address format (RFC2822 and RFC3696) and whitelist the domain part.'
+  s.description  = "Rails 2 and Rails 3 plugin. #{s.summary}"
+  s.homepage = 'https://github.com/rubenfonseca/validates_email_whitelist_of'
+  s.extra_rdoc_files = ['README.markdown', 'MIT-LICENSE']
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.require_path = 'lib'
+  s.rdoc_options << '--title' << 'validates_email_whitelist_of'
+
+  s.authors = ['Ruben Fonseca']
+  s.email = 'fonseka@gmail.com'
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_development_dependency "activerecord", "~> 2.3.11"
+  s.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: validates_email_whitelist_of
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ruben Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Rails 2 and Rails 3 plugin. Validates e-mail address format (RFC2822 and RFC3696) and whitelist the domain part.
+email: fonseka@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- MIT-LICENSE
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.markdown
+- config/locales/en.yml
+- config/locales/pt.yml
+- init.rb
+- lib/rails2/validates_email_whitelist_of.rb
+- lib/rails3/validates_email_whitelist_of.rb
+- lib/validates_email_whitelist_of.rb
+- spec/spec_helper.rb
+- spec/validates_email_format_of_spec.rb
+- validates_email_whitelist_of.gemspec
+homepage: https://github.com/rubenfonseca/validates_email_whitelist_of
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- validates_email_whitelist_of
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Validates e-mail address format (RFC2822 and RFC3696) and whitelist the domain part.
+test_files: 
+- spec/spec_helper.rb
+- spec/validates_email_format_of_spec.rb