email_domain_checker 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946d5e9368662216b21d1dfa1434edbdbe992b6c1354d3b53b73a62e8d262a06
-  data.tar.gz: 9e47f0583115b145f461d7fcbc2cda5a4db3abe263a8edab82df98d160242431
+  metadata.gz: 9482f21ae74333979292271bf830aa22164a859388ba73b29a090118185ac797
+  data.tar.gz: 12fa14a045d73af82ff4d179c55d9f7c425ec25a1bc171d3328e60f5045f92de
 SHA512:
-  metadata.gz: c333b2f6dd62889860581493a2453ee0f16db2f9db024f3f3ff8db88c2496e4d438221ff31a55d8fc2fd3174d5aec834615e221a2e49b377c22dc4bc3c569ed3
-  data.tar.gz: 2fd79606ecdf91e1c665b71ccb343f2b3703082db2c5d63085919435fabc7955f89cae73d2a66a8fefb9c8d4d26611b25346e06c4b69f6e1958852f2228f8b0e
+  metadata.gz: ab00a7b94993e50f3e5e8c4b7d7fa74c270a77778c4bd7c5796f84420fe1ffb0c929ec3efa4999d573ba38325e431cca20359e55dcfe68d4b73f67367f57a92d
+  data.tar.gz: 7a1f651e88f540389f8d213e381a37047c96370d3ff2bb1b4bd8a3655045ac9bb9cf749695ca8c774d2cca38050028e11468f181c883ff6b391abaf57f1d544a

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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.2] - 2025-11-05
+
+### Added
+- Test mode feature to skip DNS checks during testing with block syntax support for configuration ([#4](https://github.com/tatematsu-k/email_domain_checker/pull/4))
+
+## [0.1.1] - 2025-11-04
+
+### Added
+- ActiveModel/ActiveRecord validator integration (`DomainCheckValidator`) ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+- Automatic email normalization option in validator ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+- Ruby 3.4+ compatibility support for ActiveModel integration ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+- Comprehensive test coverage for ActiveModel validator ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+
+### Changed
+- CI: Added ActiveRecord version matrix testing for better compatibility testing ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+
+### Documentation
+- Added ActiveModel integration documentation with usage examples ([#3](https://github.com/tatematsu-k/email_domain_checker/pull/3))
+
 ## [0.1.0] - 2025-11-4
 
 ### Added

data/README.md

@@ -39,6 +39,11 @@ EmailDomainChecker.normalize("User@Example.COM") # => "user@example.com"
 
 # Configure default options globally
 EmailDomainChecker.configure(timeout: 10, check_mx: true)
+
+# Enable test mode (skips DNS checks)
+EmailDomainChecker.configure do |config|
+  config.test_mode = true
+end
 ```
 
 ### Using Checker class
@@ -73,6 +78,51 @@ checker = EmailDomainChecker::Checker.new("user@example.com")
 checker.redacted_email # => "{hash}@example.com"
 ```
 
+### ActiveModel/ActiveRecord Integration
+
+When ActiveModel is available, you can use the `DomainCheckValidator` for easy validation and normalization in your models:
+
+```ruby
+class User < ActiveRecord::Base
+  validates :email, domain_check: { check_mx: true, timeout: 3 }, normalize: true
+end
+```
+
+#### Options
+
+- `domain_check`: Hash of options for domain validation
+  - `check_mx`: Check MX records (default: `true`)
+  - `check_a`: Check A records (default: `false`)
+  - `timeout`: DNS query timeout in seconds (default: `5`)
+  - `validate_format`: Validate email format (default: `true`)
+  - `validate_domain`: Validate domain (default: `true`)
+- `normalize`: Normalize email before validation (default: `false`)
+- `message`: Custom error message
+
+#### Examples
+
+```ruby
+# Basic validation with domain check
+class User < ActiveRecord::Base
+  validates :email, domain_check: { check_mx: true, timeout: 3 }
+end
+
+# Format validation only (skip domain check)
+class User < ActiveRecord::Base
+  validates :email, domain_check: { validate_domain: false }
+end
+
+# With automatic normalization
+class User < ActiveRecord::Base
+  validates :email, domain_check: { check_mx: true }, normalize: true
+end
+
+# With custom error message
+class User < ActiveRecord::Base
+  validates :email, domain_check: { check_mx: true }, message: "Invalid email address"
+end
+```
+
 ### Configuration Options
 
 - `validate_format`: Validate email format using email_address gem (default: true)
@@ -80,6 +130,25 @@ checker.redacted_email # => "{hash}@example.com"
 - `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)
+- `test_mode`: Skip DNS checks (useful for testing with dummy data) (default: false)
+
+### Test Mode
+
+When writing tests, you may want to skip DNS checks to avoid external requests. Enable test mode to skip all DNS validations (MX and A record checks):
+
+```ruby
+# In spec_helper.rb or test_helper.rb
+EmailDomainChecker.configure do |config|
+  config.test_mode = true
+end
+
+# Or in a before block
+before do
+  EmailDomainChecker::Config.test_mode = true
+end
+```
+
+When test mode is enabled, domain validation will always return `true` without making any DNS requests, allowing you to use dummy email addresses in your tests without external dependencies.
 
 ## Development
 

data/lib/email_domain_checker/active_model_validator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+require_relative "checker"
+require_relative "normalizer"
+
+module EmailDomainChecker
+  # ActiveModel validator for email domain checking
+  #
+  # Usage:
+  #   class User < ActiveRecord::Base
+  #     validates :email, domain_check: { check_mx: true, timeout: 3 }, normalize: true
+  #   end
+  #
+  # Options:
+  #   - domain_check: Hash of options for domain validation
+  #     * check_mx: Boolean (default: true) - Check MX records
+  #     * check_a: Boolean (default: false) - Check A records
+  #     * timeout: Integer (default: 5) - DNS query timeout in seconds
+  #     * validate_format: Boolean (default: true) - Validate email format
+  #     * validate_domain: Boolean (default: true) - Validate domain
+  #   - normalize: Boolean (default: false) - Normalize email before validation
+  #   - message: String or Symbol - Custom error message
+  class DomainCheckValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      return if value.blank?
+
+      # ActiveModel passes domain_check hash contents directly to options
+      # when using validates :email, domain_check: { normalize: false }
+      # So options will be { validate_domain: false, normalize: false } etc.
+      normalize_option = options[:normalize] == true
+
+      original_value = value.is_a?(String) ? value : value.to_s
+      normalized_value = normalize_option ? Normalizer.normalize(original_value) : original_value
+
+      if normalize_option && normalized_value != original_value
+        record.public_send("#{attribute}=", normalized_value)
+      end
+
+      validation_options = build_validation_options(record, attribute)
+      value_for_checker = normalize_option ? normalized_value : original_value
+      checker = Checker.new(value_for_checker, validation_options)
+
+      unless checker.valid?
+        error_message = error_message_for(record, attribute, checker)
+        record.errors.add(attribute, error_message[:key], message: error_message[:message])
+      end
+    end
+
+    private
+
+    def build_validation_options(record, attribute)
+      default_options = {
+        validate_format: true,
+        validate_domain: true,
+        check_mx: true,
+        check_a: false,
+        timeout: 5
+      }
+
+      # ActiveModel passes domain_check hash contents directly to options
+      # Exclude normalize and message from validation options
+      domain_check_options = options.reject { |k, _v| k == :normalize || k == :message }
+      default_options.merge(domain_check_options)
+    end
+
+    def error_message_for(record, attribute, checker)
+      message_option = options[:message]
+      if message_option
+        return {
+          key: :invalid,
+          message: message_option.is_a?(Symbol) ? record.errors.generate_message(attribute, message_option) : message_option
+        }
+      end
+
+      unless checker.format_valid?
+        return {
+          key: :invalid_format,
+          message: i18n_message("errors.messages.invalid_email_format", "is not a valid email format")
+        }
+      end
+
+      unless checker.domain_valid?
+        return {
+          key: :invalid_domain,
+          message: i18n_message("errors.messages.invalid_email_domain", "has an invalid domain")
+        }
+      end
+
+      {
+        key: :invalid,
+        message: i18n_message("errors.messages.invalid_email", "is not a valid email address")
+      }
+    end
+
+    def i18n_message(key, default)
+      return default unless defined?(I18n)
+
+      I18n.t(key, default: default)
+    rescue StandardError
+      default
+    end
+  end
+end
+
+DomainCheckValidator = EmailDomainChecker::DomainCheckValidator unless defined?(DomainCheckValidator)

data/lib/email_domain_checker/config.rb

@@ -11,15 +11,43 @@ module EmailDomainChecker
     }.freeze
 
     class << self
-      attr_accessor :default_options
+      attr_accessor :default_options, :test_mode
 
-      def configure(options = {})
-        @default_options = DEFAULT_OPTIONS.merge(options)
+      def configure(options = {}, &block)
+        if block_given?
+          config_instance = new
+          block.call(config_instance)
+          @default_options = DEFAULT_OPTIONS.merge(options)
+          config_instance
+        else
+          @default_options = DEFAULT_OPTIONS.merge(options)
+          new
+        end
       end
 
       def reset
         @default_options = DEFAULT_OPTIONS.dup
+        @test_mode = false
       end
+
+      def test_mode=(value)
+        @test_mode = value
+      end
+
+      def test_mode?
+        @test_mode == true
+      end
+    end
+
+    attr_accessor :test_mode
+
+    def initialize
+      @test_mode = self.class.test_mode || false
+    end
+
+    def test_mode=(value)
+      @test_mode = value
+      self.class.test_mode = value
     end
 
     reset

data/lib/email_domain_checker/domain_validator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "dns_resolver"
+require_relative "config"
 
 module EmailDomainChecker
   class DomainValidator
@@ -18,6 +19,9 @@ module EmailDomainChecker
     def valid?(domain)
       return false if domain.nil? || domain.empty?
 
+      # Skip DNS checks if test mode is enabled
+      return true if Config.test_mode?
+
       check_domain_records(domain)
     end
 

data/lib/email_domain_checker/version.rb

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

data/lib/email_domain_checker.rb

@@ -8,6 +8,17 @@ require_relative "email_domain_checker/domain_validator"
 require_relative "email_domain_checker/email_address_adapter"
 require_relative "email_domain_checker/checker"
 
+# Conditionally load ActiveModel integration if ActiveModel is available
+begin
+  # Require logger gem for older Rails/ActiveModel versions on Ruby 3.4+
+  # This is needed because logger was removed from Ruby standard library in 3.4+
+  require "logger" if RUBY_VERSION >= "3.4"
+  require "active_model"
+  require_relative "email_domain_checker/active_model_validator"
+rescue LoadError
+  # ActiveModel is not available, skip integration
+end
+
 module EmailDomainChecker
   class Error < StandardError; end
 
@@ -32,7 +43,7 @@ module EmailDomainChecker
   end
 
   # Configure default options
-  def self.configure(options = {})
-    Config.configure(options)
+  def self.configure(options = {}, &block)
+    Config.configure(options, &block)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_domain_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Koki Tatematsu
@@ -79,6 +79,7 @@ files:
 - Rakefile
 - email_domain_checker.gemspec
 - lib/email_domain_checker.rb
+- lib/email_domain_checker/active_model_validator.rb
 - lib/email_domain_checker/checker.rb
 - lib/email_domain_checker/config.rb
 - lib/email_domain_checker/dns_resolver.rb