mailshield 1.6 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951a883218a7b24ca485ad6e34755a420a754931ebb5590438e5ae3715ba385a
-  data.tar.gz: 74522e2cc5992814083ebb6235a849ff0429f9482bcdec848911526511a386cf
+  metadata.gz: 18604539d1e37e6bb2be57844fc3f4655db6aad98fd6f8d8509264b55ab9cf8a
+  data.tar.gz: 55fc76651d319aa7f5c7289270dcfb13d7fbacfa0c1ca9ca5d8fdf19c268f14d
 SHA512:
-  metadata.gz: fbc024e630f232ff8bb84fff735076c0f8b9c698a12874dc622b4fda4885b4daf7574a830a8acd109d2b3e57fc9265b877516556de71b936b9e3c22f32d01a7e
-  data.tar.gz: 87b6a352c1e0307983ffae13f9675e97712d7c786ce39a84a4e09c0a9c6d3764a1c756fdd18ca4aabdb8fd08c11667d5dcdf8e8beaf0fd08322dc657bd13ff77
+  metadata.gz: 3b2ab77713d4d23a5836419b01df0c804bcc66291f5efb259dc437e9584fc7ee6ef933401701332e4105877e56da3beea02b51c7b1f06ccc49f958cac6ba9cc2
+  data.tar.gz: 53771549f5c3c334906acbeea35df4277581431a8fbe83636ace180ab25e7ae4bb0e80ebcbab87a28cd45c813665a29b731017966ad160ab4ec89ee18c83b287

data/lib/mailshield/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailshield
-  VERSION = '1.6'
+  VERSION = '1.7'
 end

data/lib/mailshield.rb

@@ -8,8 +8,10 @@ require 'csv'
 require 'net/smtp'
 
 module MailShield
+  # Regex pattern for validating email formats
   EMAIL_REGEX = /\A[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}\z/.freeze
 
+  # Custom error classes for various validation failures
   class ValidationError < StandardError; end
   class InvalidFormatError < ValidationError; end
   class DomainNotFoundError < ValidationError; end
@@ -17,57 +19,94 @@ module MailShield
   class DMARCError < ValidationError; end
   class SMTPError < ValidationError; end
   class TemporaryDomainError < ValidationError; end
+  
   class << self
     attr_accessor :dns_cache, :smtp_cache, :whitelist, :blacklist
 
+    # Configuration method for initializing and yielding settings
     def configure
-      @whitelist ||= []
-      @blacklist ||= []
-      yield self
+      initialize_lists
+      yield self if block_given?
     end
 
+    # Validate the structure and existence of the provided email
     def validate_email(email)
       reset_caches
-
       domain = extract_domain(email)
 
-      return { valid: false, reason: 'Email domain is blacklisted.' } if blacklist.include?(domain)
+      return { valid: false, reason: 'Email domain is blacklisted.' } if blacklist && blacklist.include?(domain)
 
-      if !whitelist.empty? && !whitelist.include?(domain)
+      if whitelist && !whitelist.empty? && !whitelist.include?(domain)
         return { valid: false, reason: 'Email domain is not whitelisted.' }
       end
 
-      begin
-        validate_known_disposal_domain?(domain)
-        validate_format!(email)
-        validate_domain!(domain)
-        validate_spf!(domain)
-        validate_dmarc!(domain)
-        validate_smtp!(email)
-      rescue ValidationError => e
-        return { valid: false, reason: e.message }
-      end
-
-      { valid: true }
+      # Perform comprehensive validation checks
+      perform_validations(email, domain)
     end
 
-    # Added Support for verifying email existance in real world
     def email_exists?(email)
       smtp_verify_email(email)
     end
 
-    # Added Support for Email Format Validation
     def valid_format?(email)
       valid_email_format?(email)
     end
 
     private
 
+    # Initialize lists for whitelisting and blacklisting
+    def initialize_lists
+      @whitelist ||= []
+      @blacklist ||= []
+    end
+
     def reset_caches
       @dns_cache = {}
       @smtp_cache = {}
     end
 
+    def blacklisted?(domain)
+      blacklist.include?(domain)
+    end
+
+    def handle_blacklist(domain)
+      {
+        valid: false,
+        reason: 'Email domain is blacklisted.'
+      }
+    end
+
+    def whitelisted?(domain)
+      !whitelist.empty? && whitelist.include?(domain)
+    end
+
+    def handle_whitelist(domain)
+      {
+        valid: false,
+        reason: 'Email domain is not whitelisted.'
+      }
+    end
+
+    # Perform all necessary validations for the given email
+    def perform_validations(email, domain)
+      begin
+        validate_known_disposal_domain?(domain) # Custom method to check for disposable domains
+        validate_format!(email)
+        validate_domain!(domain)
+        validate_spf!(domain)
+        validate_dmarc!(domain)
+        validate_smtp!(email)
+      rescue ValidationError => e
+        return handle_validation_error(e)
+      end
+
+      { valid: true }
+    end
+
+    def handle_validation_error(error)
+      { valid: false, reason: error.message }
+    end
+
     def validate_format!(email)
       raise InvalidFormatError, 'The email address format is invalid.' unless valid_email_format?(email)
     end
@@ -96,6 +135,7 @@ module MailShield
       EMAIL_REGEX.match?(email)
     end
 
+    # Fetch MX records for the given domain
     def fetch_mx_records(domain)
       Resolv::DNS.open do |dns|
         dns.getresources(domain, Resolv::DNS::Resource::IN::MX).map(&:exchange).map(&:to_s)
@@ -104,16 +144,19 @@ module MailShield
       []
     end
 
+    # Check if SPF records are available for the domain
     def spf_record?(domain)
       spf_records = fetch_txt_records(domain)
       spf_records.any? { |record| record.include?('v=spf1') }
     end
 
+    # Check if DMARC records are available for the domain
     def dmarc_record?(domain)
       dmarc_records = fetch_txt_records("_dmarc.#{domain}")
       dmarc_records.any? { |record| record.include?('v=DMARC1') }
     end
 
+    # Fetch TXT records for the domain
     def fetch_txt_records(domain)
       Resolv::DNS.open do |dns|
         records = dns.getresources(domain, Resolv::DNS::Resource::IN::TXT)
@@ -123,6 +166,7 @@ module MailShield
       []
     end
 
+    # Verify the email address using SMTP
     def smtp_verify_email(email)
       domain = extract_domain(email)
       smtp_server = get_smtp_server(domain)
@@ -134,13 +178,18 @@ module MailShield
           smtp.helo('localhost')
           smtp.mailfrom('test@example.com')
           response = smtp.rcptto(email)
-          response.status == '250' || response.status == '250 OK'
+          smtp_response_status(response)
         end
       rescue Net::SMTPFatalError, Net::SMTPServerBusy, Net::SMTPSyntaxError, Errno::ECONNREFUSED
         false
       end
     end
 
+    def smtp_response_status(response)
+      response.status == '250' || response.status == '250 OK'
+    end
+
+    # Retrieve the SMTP server for the specified domain
     def get_smtp_server(domain)
       mx_records = fetch_mx_records(domain)
       mx_records.first
@@ -150,6 +199,7 @@ end
 
 module ActiveModel
   module Validations
+    # Validator for secure email verification
     class SecureEmailValidator < ::MailShield::SecureEmailValidator
       def initialize(options = {})
         super

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mailshield
 version: !ruby/object:Gem::Version
-  version: '1.6'
+  version: '1.7'
 platform: ruby
 authors:
 - jana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-10-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-smtp
   requirement: !ruby/object:Gem::Requirement