email_checker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6187abcb5b21a81b97d88b4f77879d237abb301
-  data.tar.gz: 3288b04c61442116a410264f2f36634c6b47f87c
+  metadata.gz: 4ce0e55f098f2eed3764851101fc8d5390944d73
+  data.tar.gz: 28b06a5b98b0fd9c9732a2af2cc0c05d3daba2c8
 SHA512:
-  metadata.gz: db83aa157497c79588ad6763b7fe7589593a4ad58dd0e87578bf678cef9ac9c34ab4f678f8f09756e3ac0d8b712b25b21daa68ab7c65dd3a143495bf540dbf2b
-  data.tar.gz: aa6251f1b167ebb547bc43523d256b448e406d157657b422a3b82b83c1bfe0aa5a3aee2d9f39b52942af1b09d74e12ed7f92cd4adabbd1a31145c211d3a6d927
+  metadata.gz: c9959ff3f032bcc13010933308c5a6771e26ac46c99964a507bb78813f6f4754c52dabe3cafbe40fe73f9160adbab4cd6b09b243a8332c3032fa4fe1edef87e5
+  data.tar.gz: fab981bf91741391cfbe9374fbb7014f6c787908e18b431e541d51bb09779cbc8e421de9a44d71ea408a605aa023573fb1290abe586facc4f03bb34b3e549157

data/lib/email_checker/checker.rb

@@ -2,14 +2,22 @@ require 'net/smtp'
 
 module EmailChecker
   class Checker
+
+    # @return [Domain]
     attr_reader :domain
 
+    # Returns a new instance of Checker
+    #
+    # @param email [String] The email to Check
     def initialize(email)
       @email = email
       email_m = email.match(EMAIL_PATTERN)
       @domain = Domain.new(email_m[2])
     end
 
+    # Checks if the email exists in the mail provider.
+    #
+    # @return [Boolean]
     def email_exists_in_server?
       mailfrom if EmailChecker.config.verifier_domain
       rcptto.tap do
@@ -28,6 +36,7 @@ module EmailChecker
           break if @smtp
         end
         fail EmailChecker::ServerConnectionError, "Unable to connect to any of the mail servers for #{@email}" unless @smtp
+        @smtp
       end
 
       def connect(address)

data/lib/email_checker/domain.rb

@@ -1,12 +1,19 @@
+# @author Genaro Madrid
 module EmailChecker
   class Domain
+
+    # Returns a new instance of Domain
+    #
+    # @param domain [String] The domain name.
+    #
+    # @example EmailChecker::Domain.new('google.com')
     def initialize(domain)
       @domain = domain
     end
 
-    # Checks if the domian exists and has valid MX and A records
+    # Checks if the domian exists and has valid MX and A records.
     #
-    # @return [type] [description]
+    # @return [Boolean]
     def valid?
       return false unless @domain
       Timeout.timeout(SERVER_TIMEOUT) do
@@ -17,7 +24,7 @@ module EmailChecker
       false
     end
 
-    # Check if it has valid MX records and it can receive emails.
+    # Check if the domian has valid MX records and it can receive emails.
     # The MX server exists and it has valid A records.
     #
     # @return [Boolean]
@@ -29,21 +36,31 @@ module EmailChecker
       false
     end
 
-    # Check if the domain exists validation that has at least 1 A record.
+    # Validates that has at least 1 A record.
+    # Check if the domain exists.
     #
     # @return [Boolean]
     def a_records?
       a_records.any?
     end
 
+    # The A records for the domain.
+    #
+    # @return [Array<Resolv::DNS::Resource::IN::A>]
     def a_records
       @a_records ||= dns.getresources(@domain, Resolv::DNS::Resource::IN::A)
     end
 
+    # The MX records of the domain.
+    #
+    # @return [Array<Resolv::DNS::Resource::IN::MX>]
     def mx_records
       @mx_records ||= dns.getresources(@domain, Resolv::DNS::Resource::IN::MX).sort_by(&:preference)
     end
 
+    # The servers that this domian MX records point at.
+    #
+    # @return [Array<Hash>] Array of type { preference: 1, address: '127.0.0.1' }
     def mx_servers
       return @mx_servers if @mx_servers
       @mx_servers = []

data/lib/email_checker/version.rb

@@ -1,3 +1,3 @@
 module EmailChecker
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_checker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Genaro Madrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler