email_detected 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79315f08dcc21055770445254efa77c8fc327cf9
-  data.tar.gz: 856b108d3eddf128133cad9418176e38f2089ebc
+  metadata.gz: 347e647a4741ba319e4af10c64e7efd367bf8d5d
+  data.tar.gz: 1267dab70b3fbdce14049bed1380978ad0c67494
 SHA512:
-  metadata.gz: 2f64c8b4661656aaa8ad5b690aed1d05fff285c352056da0588190d1a9d574a4b5cca9c636c0ce3c956c9289a71a5d8d9de5fd86212836d6606bb3b58dd6c218
-  data.tar.gz: 24e1f0889957a65fc66cb3ddd2bd1ac621db02930b77be33c96a56e823723d579f1eb01b8eb7afba8c840963706c6732fcb0722b702400feef6f2d58c4524f74
+  metadata.gz: 447f8551a3cf83e5dfe843a6d70e073980ed1c8459f2ac9761c1811c0d2ce5a349af17a491578dbb70482b246123e3696cdf9f00bef82caeeb68aafcec1b3654
+  data.tar.gz: b0e2086071e5f9a358334402b3b943c31a6ef68c47510fe5baf1fbb306cbdd771e3e5007792741b4474f227bce2d4e34046d4440d52ed9cfb5d96fa70e37cd1d

data/README.md

@@ -1,8 +1,8 @@
-# EmailDetected
+# Email Detected
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/email_detected`. To experiment with that code, run `bin/console` for an interactive prompt.
+Email Detected is a simple tool for verifying an email address exists. It's free and quite easy to use :smile: .
 
-TODO: Delete this and the text above, and describe your gem
+Many times as developers we were putting validation statements for checking email addresses format. This gem will complete your existing setups with validator that actually connects with a given mail server and asks if the address in question exists for real.
 
 ## Installation
 
@@ -22,7 +22,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To get info about realness of given email address, email_detected connects with a mail server that email's domain points to and pretends to send an email. Some smtp servers will not allow you to do this if you will not present yourself as a real user.
+
+This only needs to be something the receiving SMTP server. We aren't actually sending any mail.
+
+First thing you need to set up is placing something like this either in initializer or in application.rb file:
+
+```ruby
+EmailDetected.config do |config|
+  config.verifier_email = "quannguyen@bestcoder.info"
+end
+```
+
+Then just put this in your model e. g:
+
+```ruby
+validates_exist_email_of :email
+```
+Or - if you'd like to use it outside of your models:
+
+```ruby
+EmailDetected.exist?(youremail)
+```
+
+This method will return with status `true || false` and `message` look like:
+```
+{:status=>true, :message=>"The email address has already been registered."} 
+```
+
+```
+{:status=>false, :message=>"The email address invalid."} 
+```
+or will throw an exception with nicely detailed info about what's wrong.
 
 ## Development
 

data/lib/email_detected/version.rb

@@ -1,3 +1,3 @@
 module EmailDetected
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/email_detected.rb

@@ -10,7 +10,7 @@ module EmailDetected
 
   def self.exist?(email)
     return true if config.test_mode
-    return { status: false, errors: ['The email address invalid.'] } unless email.match VALID_EMAIL_REGEX
+    return { status: false, message: 'The email address invalid.' } unless email.match VALID_EMAIL_REGEX
     email_detected = EmailDetected::Checker.run(email)
     if email_detected.invalid?
       resp = { status: false, message: email_detected.errors.first }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_detected
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nguyen Quan