email_domain_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 946d5e9368662216b21d1dfa1434edbdbe992b6c1354d3b53b73a62e8d262a06
+  data.tar.gz: 9e47f0583115b145f461d7fcbc2cda5a4db3abe263a8edab82df98d160242431
+SHA512:
+  metadata.gz: c333b2f6dd62889860581493a2453ee0f16db2f9db024f3f3ff8db88c2496e4d438221ff31a55d8fc2fd3174d5aec834615e221a2e49b377c22dc4bc3c569ed3
+  data.tar.gz: 2fd79606ecdf91e1c665b71ccb343f2b3703082db2c5d63085919435fabc7955f89cae73d2a66a8fefb9c8d4d26611b25346e06c4b69f6e1958852f2228f8b0e

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - "bin/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-11-4
+
+### Added
+- Initial release
+- Email format validation using `email_address` gem
+- Domain validation with MX and A record checks
+- Email normalization and canonicalization
+- Email redaction for privacy
+- Module-level convenience methods
+- Configurable default options
+- DNS resolver with timeout support
+- Comprehensive test coverage
+
+### Features
+- `EmailDomainChecker::Checker` class for detailed validation
+- `EmailDomainChecker.valid?` for quick validation
+- `EmailDomainChecker.format_valid?` for format-only checks
+- `EmailDomainChecker.domain_valid?` for domain-only checks
+- `EmailDomainChecker.normalize` for email normalization
+- `EmailDomainChecker.configure` for global configuration

data/README.md

@@ -0,0 +1,96 @@
+# EmailDomainChecker
+
+Email address validation and domain checking library to prevent mail server reputation degradation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_domain_checker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install email_domain_checker
+
+## Usage
+
+### Module-level convenience methods
+
+```ruby
+require 'email_domain_checker'
+
+# Quick validation
+EmailDomainChecker.valid?("user@example.com", validate_domain: false) # => true
+
+# Format validation only
+EmailDomainChecker.format_valid?("user@example.com") # => true
+
+# Domain validation only
+EmailDomainChecker.domain_valid?("user@example.com", check_mx: true) # => true/false
+
+# Normalize email
+EmailDomainChecker.normalize("User@Example.COM") # => "user@example.com"
+
+# Configure default options globally
+EmailDomainChecker.configure(timeout: 10, check_mx: true)
+```
+
+### Using Checker class
+
+```ruby
+require 'email_domain_checker'
+
+# Basic validation
+checker = EmailDomainChecker::Checker.new("user@example.com")
+if checker.valid?
+  puts "Valid email with valid domain"
+end
+
+# Check format only
+checker = EmailDomainChecker::Checker.new("user@example.com", validate_domain: false)
+checker.format_valid? # => true
+
+# Check domain with MX records
+checker = EmailDomainChecker::Checker.new("user@example.com", check_mx: true)
+checker.domain_valid? # => true if MX records exist
+
+# Get normalized email
+checker = EmailDomainChecker::Checker.new("User@Example.COM")
+checker.normalized_email # => "user@example.com"
+
+# Get canonical email
+checker = EmailDomainChecker::Checker.new("user.name+tag@gmail.com")
+checker.canonical_email # => "username@gmail.com"
+
+# Get redacted email (for privacy)
+checker = EmailDomainChecker::Checker.new("user@example.com")
+checker.redacted_email # => "{hash}@example.com"
+```
+
+### Configuration Options
+
+- `validate_format`: Validate email format using email_address gem (default: true)
+- `validate_domain`: Validate domain existence (default: true)
+- `check_mx`: Check MX records for domain (default: true)
+- `check_a`: Check A records for domain (default: false)
+- `timeout`: DNS lookup timeout in seconds (default: 5)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/email_domain_checker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/email_domain_checker.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/email_domain_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_domain_checker"
+  spec.version       = EmailDomainChecker::VERSION
+  spec.authors       = ["Koki Tatematsu"]
+  spec.email         = ["koki.tatematsu@gmail.com"]
+
+  spec.summary       = "Email address validation and domain checking library"
+  spec.description   = "A library to validate email addresses and check domain validity to prevent mail server reputation degradation"
+  spec.homepage      = "https://github.com/tatematsu-k/email_domain_checker"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "email_address", "~> 0.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+end

data/lib/email_domain_checker/checker.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "normalizer"
+require_relative "domain_validator"
+require_relative "email_address_adapter"
+
+module EmailDomainChecker
+  class Checker
+    attr_reader :email, :options
+
+    def initialize(email, options = {})
+      @email = Normalizer.normalize(email)
+      @options = Config.default_options.merge(options)
+      @domain_validator = DomainValidator.new(
+        check_mx: @options[:check_mx],
+        check_a: @options[:check_a],
+        timeout: @options[:timeout]
+      )
+    end
+
+    def valid?
+      return false if email.empty?
+
+      format_valid? && domain_valid?
+    end
+
+    def format_valid?
+      return true unless options[:validate_format]
+
+      email_adapter.valid?
+    end
+
+    def domain_valid?
+      return true unless options[:validate_domain]
+
+      domain = extract_domain
+      @domain_validator.valid?(domain)
+    end
+
+    def normalized_email
+      return nil unless format_valid?
+
+      email_adapter.normalized
+    end
+
+    def canonical_email
+      return nil unless format_valid?
+
+      email_adapter.canonical
+    end
+
+    def redacted_email
+      return nil unless format_valid?
+
+      email_adapter.redacted
+    end
+
+    private
+
+    def email_adapter
+      @email_adapter ||= EmailAddressAdapter.new(email)
+    end
+
+    def extract_domain
+      parts = email.split("@", 2)
+      return nil if parts.length != 2
+
+      domain = parts[1].to_s.strip
+      domain.empty? ? nil : domain
+    end
+  end
+end

data/lib/email_domain_checker/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module EmailDomainChecker
+  class Config
+    DEFAULT_OPTIONS = {
+      validate_format: true,
+      validate_domain: true,
+      check_mx: true,
+      check_a: false,
+      timeout: 5
+    }.freeze
+
+    class << self
+      attr_accessor :default_options
+
+      def configure(options = {})
+        @default_options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def reset
+        @default_options = DEFAULT_OPTIONS.dup
+      end
+    end
+
+    reset
+  end
+end

data/lib/email_domain_checker/dns_resolver.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "resolv"
+
+module EmailDomainChecker
+  class DnsResolver
+    attr_reader :timeout
+
+    def initialize(timeout: 5)
+      @timeout = timeout
+    end
+
+    def has_mx_record?(domain)
+      check_dns_record(domain, Resolv::DNS::Resource::IN::MX)
+    end
+
+    def has_a_record?(domain)
+      check_dns_record(domain, Resolv::DNS::Resource::IN::A)
+    end
+
+    private
+
+    def check_dns_record(domain, resource_type)
+      resolver = create_resolver
+
+      begin
+        records = resolver.getresources(domain, resource_type)
+        !records.empty?
+      rescue Resolv::ResolvError, Resolv::ResolvTimeout
+        false
+      end
+    end
+
+    def create_resolver
+      resolver = Resolv::DNS.new
+      resolver.timeouts = [timeout]
+      resolver
+    end
+  end
+end

data/lib/email_domain_checker/domain_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "dns_resolver"
+
+module EmailDomainChecker
+  class DomainValidator
+    attr_reader :options, :dns_resolver
+
+    def initialize(options = {})
+      @options = {
+        check_mx: true,
+        check_a: false,
+        timeout: 5
+      }.merge(options)
+      @dns_resolver = DnsResolver.new(timeout: @options[:timeout])
+    end
+
+    def valid?(domain)
+      return false if domain.nil? || domain.empty?
+
+      check_domain_records(domain)
+    end
+
+    private
+
+    def check_domain_records(domain)
+      if options[:check_mx]
+        return false unless dns_resolver.has_mx_record?(domain)
+      end
+
+      if options[:check_a]
+        return false unless dns_resolver.has_a_record?(domain)
+      end
+
+      true
+    end
+  end
+end

data/lib/email_domain_checker/email_address_adapter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "email_address"
+
+module EmailDomainChecker
+  class EmailAddressAdapter
+    attr_reader :email_address
+
+    def initialize(email)
+      @email_address = EmailAddress.new(email)
+    end
+
+    def valid?
+      email_address.valid?
+    end
+
+    def normalized
+      email_address.normal
+    end
+
+    def canonical
+      email_address.canonical
+    end
+
+    def redacted
+      email_address.redact
+    end
+
+    def to_s
+      email_address.to_s
+    end
+  end
+end

data/lib/email_domain_checker/normalizer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EmailDomainChecker
+  class Normalizer
+    def self.normalize(raw)
+      return "" if raw.nil? || raw.to_s.strip.empty?
+
+      email_str = raw.to_s.strip
+      return "" if email_str.empty?
+
+      # Basic normalization: lowercase and IDN handling
+      local, domain = email_str.downcase.split("@", 2)
+      return email_str unless local && domain && !local.empty? && !domain.empty?
+
+      # IDN (Internationalized Domain Name) conversion
+      domain = idn_to_ascii(domain)
+      "#{local}@#{domain}"
+    end
+
+    def self.idn_to_ascii(domain)
+      # Simple IDN conversion using built-in methods
+      # For production, consider using the 'simpleidn' gem
+      begin
+        # Try to encode as IDN if it contains non-ASCII characters
+        if domain.match?(/[^\x00-\x7F]/)
+          # Fallback: return as-is if IDN conversion fails
+          # In production, use: SimpleIDN.to_ascii(domain)
+          domain
+        else
+          domain
+        end
+      rescue StandardError
+        domain
+      end
+    end
+  end
+end

data/lib/email_domain_checker/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EmailDomainChecker
+  VERSION = "0.1.0"
+end
+

data/lib/email_domain_checker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "email_domain_checker/version"
+require_relative "email_domain_checker/config"
+require_relative "email_domain_checker/normalizer"
+require_relative "email_domain_checker/dns_resolver"
+require_relative "email_domain_checker/domain_validator"
+require_relative "email_domain_checker/email_address_adapter"
+require_relative "email_domain_checker/checker"
+
+module EmailDomainChecker
+  class Error < StandardError; end
+
+  # Convenience method for quick validation
+  def self.valid?(email, options = {})
+    Checker.new(email, options).valid?
+  end
+
+  # Convenience method for format validation only
+  def self.format_valid?(email)
+    Checker.new(email, validate_domain: false).format_valid?
+  end
+
+  # Convenience method for domain validation only
+  def self.domain_valid?(email, options = {})
+    Checker.new(email, validate_format: false, **options).domain_valid?
+  end
+
+  # Convenience method for normalization
+  def self.normalize(email)
+    Normalizer.normalize(email)
+  end
+
+  # Configure default options
+  def self.configure(options = {})
+    Config.configure(options)
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: email_domain_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koki Tatematsu
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: email_address
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A library to validate email addresses and check domain validity to prevent
+  mail server reputation degradation
+email:
+- koki.tatematsu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- email_domain_checker.gemspec
+- lib/email_domain_checker.rb
+- lib/email_domain_checker/checker.rb
+- lib/email_domain_checker/config.rb
+- lib/email_domain_checker/dns_resolver.rb
+- lib/email_domain_checker/domain_validator.rb
+- lib/email_domain_checker/email_address_adapter.rb
+- lib/email_domain_checker/normalizer.rb
+- lib/email_domain_checker/version.rb
+homepage: https://github.com/tatematsu-k/email_domain_checker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tatematsu-k/email_domain_checker
+  source_code_uri: https://github.com/tatematsu-k/email_domain_checker
+  changelog_uri: https://github.com/tatematsu-k/email_domain_checker/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Email address validation and domain checking library
+test_files: []