email_address 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad468bd4a05991b9a99adbeabd6fdb8c40d965fcdeed1559ddeb95ad6d599d13
-  data.tar.gz: b3b678cf78737eee8ca6a9febb5ff2434edb322b6393383ca7cd50042e66833c
+  metadata.gz: 5a0acf217d99455d8e47f25dc21b4ff25478234932c8618f3d5fe0fe4629e433
+  data.tar.gz: 5da4449168ec63611c8e510efd010b12995502b3162c67d3222c46cbabbbe6e8
 SHA512:
-  metadata.gz: b453716b5ffb47f3cc9a03fd153cb38349d686bfa8830f273c9f9704736ac987c36128c788ab84472c5a3c5d483743f675c1126bf621643fd979f0235bd19f11
-  data.tar.gz: 0e5bdf1545efd28e45da88e600e7e0bf88ddbed11c1e46c516206f5a301b4e7c0a87301daa90141cf91c8403fc1ea8fcb8cd7a725e64b5d9f810428d14115fe8
+  metadata.gz: 1703377fdf988adabaaf4d728db211320a1f33cf0daeeabd68448cf4a4d02b8647fcb9aad636d0aa14250386b8c8d2ede3cb89b42b55ffa2af793b1f788a9a08
+  data.tar.gz: 15d5b84368e692e6ce08db5ad596ec1ef684f87c70a8db4d1a2d69ab977c72ed5b5f80d9945fc6cdf42af3af5581a9f3a55b26c9138370ce228ad663c758f387

data/.github/workflows/ci.yml

@@ -5,9 +5,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7, 3.0, 3.1, jruby]
+        ruby-version: [3.2, 3.3, 3.4]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-lsp

data/README.md

@@ -241,7 +241,7 @@ email.provider      #=> :google
 email.mailbox       #=> "clark.kent"
 email.tag           #=> "scoops"
 
-email.host.exchanger.first[:ip] #=> "2a00:1450:400b:c02::1a"
+email.host.exchangers.first[:ip] #=> "2a00:1450:400b:c02::1a"
 email.host.txt_hash #=> {:v=>"spf1", :redirect=>"\_spf.google.com"}
 
 EmailAddress.normal("HIRO@こんにちは世界.com")
@@ -552,7 +552,9 @@ For the mailbox (AKA account, role), without the tag
   :mx                 Ensure host is configured with DNS MX records
   :a                  Ensure host is known to DNS (A Record)
   :syntax             Validate by syntax only, no Network verification
-  :connect            Attempt host connection (Dangerous: Do not use)
+  :connect            Attempt host connection (Experimental and Dangerous: Do not use)
+                      The :host_timeout setting is the maximum number
+                      of seconds to wait during the :connect validation
 
 * host_size:          1..253,
   A range specifying the size limit of the host part,

data/email_address.gemspec

@@ -15,23 +15,26 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.5", "< 4"
   spec.files = `git ls-files`.split($/)
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "bundler" # ,      "~> 1.16.0"
   if RUBY_PLATFORM == "java"
-    spec.add_development_dependency "activerecord", "~> 5.2.6"
-    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 52.7"
+    spec.add_development_dependency "activerecord", "~> 7.2.0"
+    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 70.2"
   else
-    spec.add_development_dependency "activerecord", "~> 6.1.4"
-    spec.add_development_dependency "sqlite3"
-    spec.add_development_dependency "standard", "~> 1.5.0"
+    spec.add_development_dependency "activerecord", "~> 8.0.0"
+    spec.add_development_dependency "sqlite3", "~> 2.1"
+    spec.add_development_dependency "standard"
   end
-  # spec.add_development_dependency "net-smtp"
+  spec.add_development_dependency "net-smtp"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "bigdecimal"
+  spec.add_development_dependency "mutex_m"
+  spec.add_development_dependency "irb"
 
+  spec.add_dependency "base64"
   spec.add_dependency "simpleidn"
 end

data/lib/email_address/active_record_validator.rb

@@ -12,8 +12,12 @@ module EmailAddress
   # * field: email,
   # * fields: [:email1, :email2]
   #
+  # * code: custom error code (default: :invalid_address)
+  # * message: custom error message (default: "Invalid Email Address")
+  #
   # Default field: :email or :email_address (first found)
   #
+  #
   class ActiveRecordValidator < ActiveModel::Validator
     def initialize(options = {})
       @opt = options
@@ -35,10 +39,11 @@ module EmailAddress
       return if r[f].nil?
       e = Address.new(r[f])
       unless e.valid?
+        error_code = @opt[:code] || :invalid_address
         error_message = @opt[:message] ||
           Config.error_message(:invalid_address, I18n.locale.to_s) ||
           "Invalid Email Address"
-        r.errors.add(f, error_message)
+        r.errors.add(f, error_code, message: error_message)
       end
     end
   end

data/lib/email_address/config.rb

@@ -137,6 +137,7 @@ module EmailAddress
       host_local: false,
       host_fqdn: true,
       host_auto_append: true,
+      host_timeout: 3,
 
       address_validation: :parts, # :parts, :smtp, Proc
       address_size: 3..254,
@@ -151,7 +152,7 @@ module EmailAddress
       google: {
         host_match: %w[gmail.com googlemail.com],
         exchanger_match: %w[google.com googlemail.com],
-        local_size: 5..64,
+        local_size: 3..64,
         local_private_size: 1..64, # When hostname not in host_match (private label)
         mailbox_canonical: ->(m) { m.delete(".") }
       },

data/lib/email_address/host.rb

@@ -381,18 +381,21 @@ module EmailAddress
     # Returns true if the host name is valid according to the current configuration
     def valid?(rules = {})
       host_validation = rules[:host_validation] || @config[:host_validation] || :mx
-      dns_lookup = rules[:dns_lookup] || host_validation
+      dns_lookup = rules[:dns_lookup] || @config[:dns_lookup] || host_validation
       self.error_message = nil
+      if host_name && !host_name.empty? && !@config[:host_size].include?(host_name.size)
+        return set_error(:invalid_host)
+      end
       if ip_address
         valid_ip?
       elsif !valid_format?
         false
       elsif dns_lookup == :connect
         valid_mx? && connect
+      elsif dns_lookup == :a || host_validation == :a
+        valid_dns?
       elsif dns_lookup == :mx
         valid_mx?
-      elsif dns_lookup == :a
-        valid_dns?
       else
         true
       end
@@ -462,11 +465,15 @@ module EmailAddress
     # as an email address check, but is provided to assist in problem resolution.
     # If you abuse this, you *could* be blocked by the ESP.
     #
-    # NOTE: As of Ruby 3.1, Net::SMTP was moved from the standard library to the
-    # 'net-smtp' gem. In order to avoid adding that dependency for this experimental
-    # feature, please add the gem to your Gemfile and require it to use this feature.
-    def connect
+    # timeout is the number of seconds to wait before timing out the request and
+    # returns false as the connection was unsuccessful.
+    #
+    # > NOTE: As of Ruby 3.1, Net::SMTP was moved from the standard library to the
+    # > 'net-smtp' gem. In order to avoid adding that dependency for this *experimental*
+    # > feature, please add the gem to your Gemfile and require it to use this feature.
+    def connect(timeout = nil)
       smtp = Net::SMTP.new(host_name || ip_address)
+      smtp.open_timeout = timeout || @config[:host_timeout]
       smtp.start(@config[:helo_name] || "localhost")
       smtp.finish
       true
@@ -474,10 +481,10 @@ module EmailAddress
       set_error(:server_not_available, e.to_s)
     rescue SocketError => e
       set_error(:server_not_available, e.to_s)
+    rescue Net::OpenTimeout => e
+      set_error(:server_not_available, e.to_s)
     ensure
-      if smtp&.started?
-        smtp.finish
-      end
+      smtp.finish if smtp&.started?
     end
 
     def set_error(err, reason = nil)

data/lib/email_address/local.rb

@@ -116,7 +116,7 @@ module EmailAddress
 
     def local=(raw)
       self.original = raw
-      raw.downcase! if @config[:local_downcase].nil? || @config[:local_downcase]
+      raw = raw.downcase if @config[:local_downcase].nil? || @config[:local_downcase]
       @local = raw
 
       if @config[:local_parse].is_a?(Proc)

data/lib/email_address/version.rb

@@ -1,3 +1,3 @@
 module EmailAddress
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/test/activerecord/test_ar.rb

@@ -9,11 +9,21 @@ class TestAR < MiniTest::Test
       user = User.new(email: "Pat.Jones+ASDF#GMAIL.com")
       assert_equal false, user.valid?
       assert user.errors.messages[:email].first
+
       user = User.new(email: "Pat.Jones+ASDF@GMAIL.com")
       assert_equal true, user.valid?
     end
   end
 
+  def test_validation_error_message
+    if RUBY_PLATFORM != "java" # jruby
+      user = User.new(alternate_email: "Pat.Jones+ASDF#GMAIL.com")
+      assert_equal false, user.valid?
+      assert user.errors.messages[:alternate_email].first.include?("Check your email")
+      assert_equal :some_error_code, user.errors.details[:alternate_email].first[:error]
+    end
+  end
+
   def test_datatype
     # Disabled JRuby checks... weird CI failures. Hopefully someone can help?
     if RUBY_PLATFORM != "java" # jruby

data/test/activerecord/user.rb

@@ -48,10 +48,13 @@ class User < ApplicationRecord
   if defined?(ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 5
     attribute :email, :email_address
     attribute :canonical_email, :canonical_email_address
+    attribute :alternate_email, :email_address
   end
 
   validates_with EmailAddress::ActiveRecordValidator,
     fields: %i[email canonical_email]
+  validates_with EmailAddress::ActiveRecordValidator,
+    field: :alternate_email, code: :some_error_code, message: "Check your email"
 
   def email=(email_address)
     self[:canonical_email] = email_address

data/test/email_address/test_host.rb

@@ -52,7 +52,7 @@ class TestHost < MiniTest::Test
   def test_dmarc
     d = EmailAddress::Host.new("yahoo.com").dmarc
     assert_equal "reject", d[:p]
-    d = EmailAddress::Host.new("example.com").dmarc
+    d = EmailAddress::Host.new("calculator.net").dmarc
     assert_equal true, d.empty?
   end
 
@@ -127,7 +127,7 @@ class TestHost < MiniTest::Test
   def test_hosted_service
     # Is there a gmail-hosted domain that will continue to exist? Removing until then
     # assert EmailAddress.valid?("test@jiff.com", dns_lookup: :mx)
-    assert !EmailAddress.valid?("test@gmail.com", dns_lookup: :mx)
+    assert !EmailAddress.valid?("t@gmail.com", dns_lookup: :mx)
   end
 
   def test_yahoo_bad_tld
@@ -150,4 +150,15 @@ class TestHost < MiniTest::Test
     assert_equal EmailAddress::Host.new("[127.0.0.666]", host_allow_ip: true).error, "This is not a valid IPv4 address"
     assert_equal EmailAddress::Host.new("[IPv6::12t]", host_allow_ip: true).error, "This is not a valid IPv6 address"
   end
+
+  def test_host_size
+    assert !EmailAddress::Host.new("stackoverflow.com", {host_size: 1..3}).valid?
+  end
+
+  # When a domain is not configured to receive email (missing MX record),
+  # Though some MTA's will fallback to the A/AAAA host record
+  def test_no_mx
+    assert !EmailAddress::Host.new("zaboz.com").valid?
+    assert EmailAddress::Host.new("zaboz.com", dns_lookup: :a).valid?
+  end
 end

data/test/email_address/test_local.rb

@@ -92,7 +92,7 @@ class TestLocal < MiniTest::Test
 
   def test_hosted
     assert EmailAddress.valid?("x@exposure.co")
-    assert EmailAddress.error("xxxx+subscriber@gmail.com")
+    assert EmailAddress.error("xx+subscriber@gmail.com")
     assert EmailAddress.valid?("xxxxx+subscriber@gmail.com")
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: email_address
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Allen Fair
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-14 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,16 +57,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,19 +94,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: net-smtp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +135,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: simpleidn
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +246,6 @@ homepage: https://github.com/afair/email_address
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,22 +263,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: This gem provides a ruby language library for working with and validating
   email addresses. By default, it validates against conventional usage, the format
   preferred for user email addresses. It can be configured to validate against RFC
   “Standard” formats, common email service provider formats, and perform DNS validation.
-test_files:
-- test/activerecord/test_ar.rb
-- test/activerecord/user.rb
-- test/email_address/test_address.rb
-- test/email_address/test_config.rb
-- test/email_address/test_exchanger.rb
-- test/email_address/test_host.rb
-- test/email_address/test_local.rb
-- test/email_address/test_rewriter.rb
-- test/test_aliasing.rb
-- test/test_email_address.rb
-- test/test_helper.rb
+test_files: []