valid_email2 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d3456e7cb1c7feb85fdff2260fd595711cd2a9f
-  data.tar.gz: 36f3e8a848db9bbb0abb3ea5c30cd5b85d182f8b
+  metadata.gz: c31c962fd50265d3f322c486870d78a569838374
+  data.tar.gz: b35f54c7e817503ef2142b1fda7a22762a4f7b2d
 SHA512:
-  metadata.gz: 2bfb2d8ceaeba93622137e87ebf5fb2c990d04419dd3f5bd0e0f063022459859f2520f617a8ef943c120cc54034f242f946d337e6870ca803c700a410640c61c
-  data.tar.gz: 10eabac3bb4f6be94139d7820182598908ec4c721a282148aef741914603555608116d89eae4dd339ef7338df593688e80852381c7d6cef97cc2e6d9ac88f578
+  metadata.gz: b7554c788ed305803a85e6a9a7a2cb05f33ae1e161fb2b1a9e75fe114e452d9b7d2e68e8dc9dc59e190996de941cbb280f393ef2197918e1d6093e9dc0c91fe9
+  data.tar.gz: 0d8cbff9a1ede7b3d8ae87d71d08c682dd996cf6a57fbd5e198b9de628390eda1a209fd766678a2c95eab214f02e9d035fc35a94996c5372adb8a2b459d595e1

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_STORE
 *.gem
 *.rbc
 .bundle

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
+  - 1.9.2
   - jruby-19mode
   - jruby-20mode
   - rbx-19mode
@@ -10,3 +11,8 @@ rvm:
 gemfile:
   - gemfiles/activemodel3.gemfile
   - gemfiles/activemodel4.gemfile
+
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/activemodel4.gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 1.0.0
+
+Moved EmailValidator to seperate file

data/README.md

@@ -1,17 +1,31 @@
 # ValidEmail2
 [![Build Status](https://travis-ci.org/lisinge/valid_email2.png?branch=master)](https://travis-ci.org/lisinge/valid_email2)
+[![Gem Version](https://badge.fury.io/rb/valid_email2.png)](http://badge.fury.io/rb/valid_email2)
 [![Coverage Status](https://coveralls.io/repos/lisinge/valid_email2/badge.png)](https://coveralls.io/r/lisinge/valid_email2)
 [![Code Climate](https://codeclimate.com/github/lisinge/valid_email2.png)](https://codeclimate.com/github/lisinge/valid_email2)
 [![Dependency Status](https://gemnasium.com/lisinge/valid_email2.png)](https://gemnasium.com/lisinge/valid_email2)
 
-Validate emails without regexp but with the help of the `mail` gem and MX server lookup.  
-Optionally validate against a list of disposable email domains.
+Validate emails with the help of the `mail` gem instead of some cluncy regexp.
+Aditionally validate that the domain has a MX record.  
+Optionally validate against a static [list of disposable email services](vendor/disposable_emails.yml).
+
+
+### Why?
+
+There are lots of other gems and libraries that validates email adresses but most of them use some cluncy regexp.  
+I also saw a need to be able to validate that the email address is not coming from a "disposable email" provider.
+
+### Is it production ready?
+
+Yes, it is used in several production apps.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'valid_email2'
+```ruby
+gem "valid_email2"
+```
 
 And then execute:
 
@@ -23,7 +37,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Use with ActiveModel
+
+If you just want to validate that it is a valid email address:
+```ruby
+class User < ActiveRecord::Base
+  validates :email, presence: true, email: true
+end
+```
+
+To validate that the domain has a MX record:  
+```ruby
+validates :email, email: { mx: true }
+```
+
+To validate that the domain is not a disposable email:  
+```ruby
+validates :email, email: { disposable: true }
+```
+
+All together:  
+```ruby
+validates :email, email: { mx: true, disposable: true }
+```
+
+> Note that this gem will let an empty email pass through so you will need to
+> add `presence: true` if you require an email
+
+### Use without ActiveModel
+
+```ruby
+address = ValidEmail2::Address.new("lisinge@gmail.com")
+address.valid? => true
+address.disposable? => false
+address.valid_mx? => true
+```
+
+## Requirements
+
+This gem requires Rails 3.2 or 4.0. It is tested against both versions under:
+* Ruby-1.9
+* Ruby-2.0
+* JRuby-1.9
+* JRuby-2.0
+* Rubinius-1.9
 
 ## Contributing
 

data/lib/valid_email2/address.rb

@@ -1,3 +1,4 @@
+require "valid_email2"
 require "resolv"
 require "mail"
 
@@ -7,9 +8,9 @@ module ValidEmail2
 
     def initialize(address)
       @parse_error = false
+      @raw_address = address
 
       begin
-        @raw_address = address
         @address = Mail::Address.new(address)
       rescue Mail::Field::ParseError
         @parse_error = true

data/lib/valid_email2/email_validator.rb

@@ -0,0 +1,30 @@
+require "valid_email2/address"
+require "active_model"
+require "active_model/validations"
+
+class EmailValidator < ActiveModel::EachValidator
+  def default_options
+    { regex: true, disposable: false, mx: false }
+  end
+
+  def validate_each(record, attribute, value)
+    return unless value.present?
+    options = default_options.merge(self.options)
+
+    address = ValidEmail2::Address.new(value)
+
+    error(record, attribute) && return unless address.valid?
+
+    if options[:disposable]
+      error(record, attribute) && return if address.disposable?
+    end
+
+    if options[:mx]
+      error(record, attribute) && return unless address.valid_mx?
+    end
+  end
+
+  def error(record, attribute)
+    record.errors.add(attribute, options[:message] || :invalid)
+  end
+end

data/lib/valid_email2.rb

@@ -1,37 +1,9 @@
-require "valid_email2/version"
-require "valid_email2/address"
-require "active_model"
-require "active_model/validations"
+require "valid_email2/email_validator"
 
 module ValidEmail2
+  VERSION = "1.0.0"
+
   def self.disposable_emails
     @@disposable_emails ||= YAML.load_file(File.expand_path("../../vendor/disposable_emails.yml",__FILE__))
   end
 end
-
-class EmailValidator < ActiveModel::EachValidator
-  def default_options
-    { regex: true, disposable: false, mx: false }
-  end
-
-  def validate_each(record, attribute, value)
-    return unless value.present?
-    options = default_options.merge(self.options)
-
-    address = ValidEmail2::Address.new(value)
-
-    error(record, attribute) && return unless address.valid?
-
-    if options[:disposable]
-      error(record, attribute) && return if address.disposable?
-    end
-
-    if options[:mx]
-      error(record, attribute) && return unless address.valid_mx?
-    end
-  end
-
-  def error(record, attribute)
-    record.errors.add(attribute, options[:message] || :invalid)
-  end
-end

data/spec/valid_email2_spec.rb

@@ -20,6 +20,11 @@ describe ValidEmail2 do
       user.valid?.should be_true
     end
 
+    it "should not be valid when domain is missing" do
+      user = TestUser.new(email: "foo")
+      user.valid?.should be_false
+    end
+
     it "should be invalid when email is malformed" do
       user = TestUser.new(email: "foo@bar")
       user.valid?.should be_false

data/valid_email2.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'valid_email2/version'
+require "valid_email2"
 
 Gem::Specification.new do |spec|
   spec.name          = "valid_email2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,7 +113,7 @@ files:
 - gemfiles/activemodel4.gemfile
 - lib/valid_email2.rb
 - lib/valid_email2/address.rb
-- lib/valid_email2/version.rb
+- lib/valid_email2/email_validator.rb
 - spec/spec_helper.rb
 - spec/valid_email2_spec.rb
 - valid_email2.gemspec

data/lib/valid_email2/version.rb

@@ -1,3 +0,0 @@
-module ValidEmail2
-  VERSION = "0.0.4"
-end