mailshield 0.1.0 → 1.1

data/lib/mailshield/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailshield
-  VERSION = "0.1.0"
+  VERSION = "1.1"
 end

data/lib/mailshield.rb

@@ -1,64 +1,131 @@
 # frozen_string_literal: true
 
-require_relative "mailshield/version"
+require_relative 'mailshield/version'
 require 'resolv'
+require 'csv'
+require 'net/smtp'
 
 module MailShield
-  class DomainChecker
-    TEMP_DOMAINS = %w[mailinator.com tempmail.com guerrillamail.com].freeze # If any one want to contribute, please add the known more domains here.
+  EMAIL_REGEX = /\A[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}\z/.freeze
+
+  class ValidationError < StandardError; end
+  class InvalidFormatError < ValidationError; end
+  class DomainNotFoundError < ValidationError; end
+  class SPFError < ValidationError; end
+  class DMARCError < ValidationError; end
+  class SMTPError < ValidationError; end
+
+  class << self
+    attr_accessor :dns_cache, :smtp_cache
+
+    def validate_email(email, verify_by_send: false)
+      reset_caches
 
-    def self.temporary_email?(email)
       domain = extract_domain(email)
-      return true if known_temp_domain?(domain)
 
-      mx_records = fetch_mx_records(domain)
-      return true if suspicious_mx_records?(mx_records)
+      begin
+        validate_format!(email)
+        validate_domain!(domain)
+        validate_spf!(domain)
+        validate_dmarc!(domain)
+        validate_smtp!(email) if verify_by_send
+      rescue ValidationError => e
+        return { valid: false, issues: [e.message] }
+      end
+
+      { valid: true, issues: [] }
+    end
 
-      return true unless spf_record?(domain)
-      return true unless dmarc_record?(domain)
 
-      false
+    def verify_address(email)
+      smtp_verify_email(email)
     end
+    private
 
-    def self.extract_domain(email)
-      email.split('@').last.downcase
+    def reset_caches
+      @dns_cache = {}
+      @smtp_cache = {}
     end
 
-    def self.known_temp_domain?(domain)
-      TEMP_DOMAINS.include?(domain)
+    def validate_format!(email)
+      raise InvalidFormatError, 'The email address format is invalid.' unless valid_email_format?(email)
     end
 
-    def self.fetch_mx_records(domain)
-      Resolv::DNS.open do |dns|
-        mx_records = dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
-        mx_records.map(&:exchange).map(&:to_s)
-      end
-    rescue Resolv::ResolvError
-      []
+    def validate_domain!(domain)
+      raise DomainNotFoundError, 'Email Not Found.' if fetch_mx_records(domain).empty?
+    end
+
+    def validate_spf!(domain)
+      raise SPFError, 'Temporary / Disposable Email' unless spf_record?(domain)
+    end
+
+    def validate_dmarc!(domain)
+      raise DMARCError, 'Temporary / Disposable Email' unless dmarc_record?(domain)
+    end
+
+    def validate_smtp!(email)
+      raise SMTPError, 'Email Address Not Found' unless smtp_verify_email(email)
     end
 
-    def self.suspicious_mx_records?(mx_records)
-      suspicious_patterns = [/mailinator/, /tempmail/, /guerrillamail/]
-      mx_records.any? { |mx| suspicious_patterns.any? { |pattern| mx.match?(pattern) } }
+    def extract_domain(email)
+      email.split('@').last.downcase
+    end
+
+    def valid_email_format?(email)
+      EMAIL_REGEX.match?(email)
+    end
+
+    def fetch_mx_records(domain)
+      dns_cache[domain] ||= begin
+        Resolv::DNS.open do |dns|
+          dns.getresources(domain, Resolv::DNS::Resource::IN::MX).map(&:exchange).map(&:to_s)
+        end
+      rescue Resolv::ResolvError
+        []
+      end
     end
 
-    def self.spf_record?(domain)
+    def spf_record?(domain)
       spf_records = fetch_txt_records(domain)
       spf_records.any? { |record| record.include?('v=spf1') }
     end
 
-    def self.dmarc_record?(domain)
+    def dmarc_record?(domain)
       dmarc_records = fetch_txt_records("_dmarc.#{domain}")
       dmarc_records.any? { |record| record.include?('v=DMARC1') }
     end
 
-    def self.fetch_txt_records(domain)
-      Resolv::DNS.open do |dns|
-        records = dns.getresources(domain, Resolv::DNS::Resource::IN::TXT)
-        records.map(&:data)
+    def fetch_txt_records(domain)
+      dns_cache[domain] ||= begin
+        Resolv::DNS.open do |dns|
+          dns.getresources(domain, Resolv::DNS::Resource::IN::TXT).map(&:data)
+        end
+      rescue Resolv::ResolvError
+        []
       end
-    rescue Resolv::ResolvError
-      []
+    end
+
+    def smtp_verify_email(email)
+      domain = extract_domain(email)
+      smtp_server = smtp_cache[domain] ||= get_smtp_server(domain)
+
+      return false unless smtp_server
+
+      begin
+        Net::SMTP.start(smtp_server, 25, 'localhost') do |smtp|
+          smtp.helo('localhost')
+          smtp.mailfrom('test@example.com')
+          response = smtp.rcptto(email)
+          response == '250 OK'
+        end
+      rescue Net::SMTPFatalError, Net::SMTPServerBusy, Net::SMTPSyntaxError, Errno::ECONNREFUSED => e
+        false
+      end
+    end
+
+    def get_smtp_server(domain)
+      mx_records = fetch_mx_records(domain)
+      mx_records.first
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailshield
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '1.1'
 platform: ruby
 authors:
 - jana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies: []
 description: MailShield helps secure your application by identifying temporary or
   disposable email domains.
@@ -19,6 +19,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mailshield.rb
+- lib/mailshield/docs/mailshield.png
+- lib/mailshield/secure_email_validator.rb
+- lib/mailshield/temp_domains.yml
 - lib/mailshield/version.rb
 homepage: https://github.com/janarthanan-shanmugam/mailshield
 licenses:
@@ -43,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: A gem to detect temporary or disposable email domains.