ruby_email 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695c3ef1a1b8f15a41b409e40c21a9faf29916cf
-  data.tar.gz: 9e4ca4b2e7dd6e295e6e6e883d1873a1b4adbda4
+  metadata.gz: 9336b115b34288f687047ab217a43a4386d836cc
+  data.tar.gz: 4937586b0ca515185805c253713b902413b512ab
 SHA512:
-  metadata.gz: c16f25b5502ac66803ee478512a8e917ab9701c262a2ff6029a126b0cc63803ded73d6fb34bf867a7fc1534e0597742e69145064426a589d8a0715df00d60798
-  data.tar.gz: 9be99178fe6a3b6bf55e5ae39fcd02a53fcb66347845d68bbfaf5bccd0a178593a05e84277f7618f4ab185d7418eee5299628f5067289222052d0874ad8ef9a5
+  metadata.gz: 6786779653b217743b5b80400e420df8ec57dc7804039488ad799568da425ab202145691d230f7d2ad5273f7a3e83ec46bd8c4b0b6a4946096bb17ff2bb87a20
+  data.tar.gz: bbc10d88a8309cdb754bd6a11b4fa50f91e920ae9ff40ed3e1ad57ae820d6c11baccb192a0b9932a37b6344064571961b71955508fd8ae3ea7caa914a8fe4021

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.1.4
+  * Add public features (to check if the email is valid on the internet)
+
 v0.1.3
   * Rename the gem to be standard compliant
 

data/README.md

@@ -2,7 +2,20 @@
 
 Compliant to the [rfc 5322](http://www.ietf.org/rfc/rfc5322.txt) standard.
 
-## Usage
+## Installation
+
+```sh
+gem install ruby_email
+```
+
+or in the ``Gemfile``
+
+```ruby
+gem 'ruby_email'
+```
+
+
+## Usage in Ruby
 
 ```ruby
 require 'ruby_email'
@@ -13,14 +26,31 @@ RubyEmail.match "toto@tata" # => #<MatchData "toto@tata" local:"toto" domain:"ta
 "local".is_email? # => false
 RubyEmail.validates? "toto" # => false
 RubyEmail.match "toto" # => nil
+
+"local@domain.root".is_public_email? # => true
+"local@domain".is_public_email? # => false
+RubyEmail::Public.validates? "toto@tata.com" # => true
+RubyEmail::Public.match "toto@tata.com" # => #<MatchData "toto@tata" local:"toto" domain:"tata.com">
+```
+
+
+## Usage in Ruby on Rails
+
+```ruby
+class Model < ActiveRecord::Base
+  # validates :email, format: RubyEmail::REGEXP # valid on an intranet ...
+  validates :email, format: RubyEmail::Public::REGEXP
+end
 ```
 
+
 ## Unitary tests
 
 ```sh
 rake test
 ```
 
+
 ## Contributes !
 
 Find a bug ? Want a new feature ?

data/lib/ruby_email.rb

@@ -26,6 +26,30 @@ module RubyEmail
     str.match(REGEXP)
   end
 
+  # Only valid on the public internet. "toto@toto" is not valid, but "toto@toto.toto" is good
+  module Public
+    VALIDE = "(?<local>#{DOT_ATOM_TEXT})@(?<domain>#{DOT_ATOM_TEXT}\\.#{DOT_ATOM_TEXT})"
+    REGEXP = Regexp.new "\\A#{VALIDE}\\Z"
+
+    # Check if the {::String} is a valid email on internet
+    # @param str [::String] string to match
+    # @raise [ArgumentError] if str is not a String
+    # @return [TrueClass or FalseClass]
+    def self.validates? str
+      !!match(str)
+    end
+
+    # Check if the string is a valid email on internet and details how
+    # @param str [::String] string to match
+    # @raise [ArgumentError] if str is not a String
+    # @return [MatchData or NilClass] matched email with the keys "local" and "domain"
+    def self.match str
+      raise ArgumentError, "Cannot validate a `#{str.class}`. Only `String` can be." unless str.is_a?(String)
+      str.match(REGEXP)
+    end
+  end
+
+
   # included by {::String}
   module String
     # Check if the current [::String] instance is a valid email
@@ -33,6 +57,12 @@ module RubyEmail
     def is_email?
       RubyEmail.validates? self
     end
+
+    # Check if the current [::String] instance is a valid email on internet
+    # @return [TrueClass or FalseClass]
+    def is_public_email?
+      RubyEmail::Public.validates? self
+    end
   end
 
 end

data/test/unit_test.rb

@@ -58,3 +58,15 @@ class TestRubyEmail < Test::Unit::TestCase
   end
 
 end
+
+class TestRubyEmailPublic < Test::Unit::TestCase
+  def test_simpe
+    assert RubyEmail::Public.validates?("toto@toto.toto")
+    assert RubyEmail::Public.validates?("toto@toto.toto.toto")
+    assert RubyEmail::Public.validates?("toto@toto.toto.toto.toto")
+    assert !RubyEmail::Public.validates?("toto@toto")
+    assert RubyEmail::Public.match("toto@toto.toto")
+    assert "toto@toto.toto".is_public_email?
+    assert !"toto@toto".is_public_email?
+  end
+end

data/version

@@ -1 +1 @@
-0.1.3
+0.1.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_email
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nephos (poulet_a)