email_address 0.1.16 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46541e8de9140acd70cc23c1f60515c077ea919e0b04444a83d681e19fcbd4e1
-  data.tar.gz: 34f52f8bfa70a33d8e40c5986d1c9d4a49956a4c12d6bc69df8037705f76c417
+  metadata.gz: f9667acc31d6ce84fd3acb2e8e2f3ea04e496df5ff9dc5f89815fa148df1113e
+  data.tar.gz: e17aa2b229cb28ca80dcbf37226a5411052758db1e15cee0ddc2038d5244de42
 SHA512:
-  metadata.gz: adde7e6139b151e6759861a0b7054c7f179a7f590d8180141c31b786ebba81aba2d01657c4073158779e879ec27b3c76389679131061661dae46cf1f1c315b92
-  data.tar.gz: 3420904e9bbe4713bf6e57e7bd6d1d059c7616f529a650c07828c9e45eb1a1ce3566412d86358b8c04c335ad49f55aed1f5e715d08a7eb8e4e066a703231f28e
+  metadata.gz: 908fa1ffaa5692b07fa4e586a66a8fdf6395c1a51013ee389e0437df175d6712ecc57831b6616cfabd28463a87c7a60df9b6ba8382cba0c58d8449e4ada51c6d
+  data.tar.gz: a9f2a9bb8280118af5b21b08e8ca2273b16f3d5f700b91cb7c36b22444a7d5878e54a45292a2080243aff6fa4d31cd2ca3af4bd664f182b49d52ab42b864c711

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI Build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.6, 2.7, 3.0, jruby]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs `bundle install` and caches installed gems automatically
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in email_address.gemspec
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 # Email Address
 
 [![Gem Version](https://badge.fury.io/rb/email_address.svg)](http://rubygems.org/gems/email_address)
-[![Build Status](https://travis-ci.org/afair/email_address.svg?branch=v0.1)](https://travis-ci.org/afair/email_address)
+[![CI Build](https://github.com/afair/email_address/actions/workflows/ci.yml/badge.svg)](https://github.com/afair/email_address/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/afair/email_address/badges/gpa.svg)](https://codeclimate.com/github/afair/email_address)
 
 The `email_address` gem provides a ruby language library for working
@@ -50,7 +50,7 @@ It does not check:
 By default, MX records are required in DNS. MX or "mail exchanger" records
 tell where to deliver email for the domain. Many domains run their
 website on one provider (ISP, Heroku, etc.), and email on a different
-provider (such as Google Apps).  Note that `example.com`, while
+provider (such as G Suite).  Note that `example.com`, while
 a valid domain name, does not have MX records.
 
 ```ruby
@@ -98,7 +98,7 @@ introduces terms to distinguish types of email addresses.
     madness!."()<>[]:,;@\\\"!#$%&'*+-/=?^_`{}| ~.a(comment )"@example.org
 
 * *Base* - A unique mailbox without tags. For gmail, is uses the incoming
-  punctation, essential when building an MD5 or SHA1 to match services
+  punctation, essential when building an MD5, SHA1, or SHA256 to match services
   like Gravatar, and email address digest interchange.
 
 * *Canonical* - An unique account address, lower-cased, without the
@@ -234,6 +234,7 @@ Here are some other methods that are available.
 ```ruby
 email.redact        #=> "{bea3f3560a757f8142d38d212a931237b218eb5e}@gmail.com"
 email.sha1          #=> "bea3f3560a757f8142d38d212a931237b218eb5e"
+email.sha256        #=> "9e2a0270f2d6778e5f647fc9eaf6992705ca183c23d1ed1166586fd54e859f75"
 email.md5           #=> "c5be3597c391169a5ad2870f9ca51901"
 email.host_name     #=> "gmail.com"
 email.provider      #=> :google
@@ -248,6 +249,16 @@ EmailAddress.normal("HIRO@こんにちは世界.com")
 EmailAddress.normal("hiro@xn--28j2a3ar1pp75ovm7c.com", host_encoding: :unicode)
                     #=> "hiro@こんにちは世界.com"
 ```
+As of release 0.1.17, exchanger_match is no longer used for host provider
+determination, which designated the set of rules for that domain.
+Sometimes, as in Google-hosted domains, the address
+rules are different, notably the optional dots in mailboxes for gmail.com
+accounts do not apply to other private domains hosted at google.
+
+To access the provider service, you can now call:
+
+    EmailAddress.new("user@hosteddomain.com").host.hosted_provider
+
 
 #### Rails Validator
 
@@ -262,6 +273,25 @@ class User < ActiveRecord::Base
 end
 ```
 
+#### Rails I18n
+
+Copy and adapt `lib/email_address/messages.yaml` into your locales and
+create an after initialization callback:
+
+```ruby
+# config/initializers/email_address.rb
+
+Rails.application.config.after_initialize do
+  I18n.available_locales.each do |locale|
+    translations = I18n.t(:email_address, locale: locale)
+
+    next unless translations.is_a? Hash
+
+    EmailAddress::Config.error_messages translations.transform_keys(&:to_s), locale.to_s
+  end
+end
+```
+
 #### Rails Email Address Type Attribute
 
 Initial support is provided for Active Record 5.0 attributes API.
@@ -466,6 +496,11 @@ Full translation support would be ideal though.
   the SHA1 Digest, making it unique to your application so it can't easily be
   discovered by comparing against a known list of email/sha1 pairs.
 
+* sha256_secret -
+  This application-level secret is appended to the email_address to compute
+  the SHA256 Digest, making it unique to your application so it can't easily be
+  discovered by comparing against a known list of email/sha256 pairs.
+
 * munge_string - "*****", the string to replace into munged addresses.
 
 For local part configuration:
@@ -534,14 +569,38 @@ For the mailbox (AKA account, role), without the tag
 * address_size:       3..254,
   A range specifying the size limit of the complete address
 
-* address_local:      false,
-  Allow localhost, no domain, or local subdomains.
-
 For provider rules to match to domain names and Exchanger hosts
 The value is an array of match tokens.
 * host_match:         %w(.org example.com hotmail. user*@ sub.*.com)
 * exchanger_match:    %w(google.com 127.0.0.1 10.9.8.0/24 ::1/64)
 
+### Namespace conflict resolution
+
+If your application already uses the `EmailAddress` class name,
+it's possible to create an alias prior to loading your code:
+
+For a Rails application, you can do this in `config/application.rb`
+after the `Bundler.require` line, usually:
+
+```ruby
+Bundler.require(*Rails.groups)
+```
+
+Add these lines immediately after that point:
+
+```ruby
+EmailAddressValidator = EmailAddress
+Object.send(:remove_const, :EmailAddress)
+```
+
+Then your application loads with your EmailAddress class. You may
+then use this gem with `EmailAddressValidator` or whatever name you
+gave it above:
+
+```ruby
+EmailAddressValidator.valid?("clark.kent@gmail.com") # => true
+```
+
 ## Notes
 
 #### Internationalization

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
 
 require "bundler/setup"
-require 'rake/testtask'
+require "rake/testtask"
 
-task :default => :test
+task default: :test
 
 desc "Run the Test Suite, toot suite"
 Rake::TestTask.new do |t|

data/email_address.gemspec

@@ -1,37 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'email_address/version'
+require "email_address/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "email_address"
-  spec.version       = EmailAddress::VERSION
-  spec.authors       = ["Allen Fair"]
-  spec.email         = ["allen.fair@gmail.com"]
-  spec.description   = %q{The EmailAddress Gem to work with and validate email addresses.}
-  spec.summary       = %q{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.}
-  spec.homepage      = "https://github.com/afair/email_address"
-  spec.license       = "MIT"
+  spec.name = "email_address"
+  spec.version = EmailAddress::VERSION
+  spec.authors = ["Allen Fair"]
+  spec.email = ["allen.fair@gmail.com"]
+  spec.description = "The EmailAddress Gem to work with and validate email addresses."
+  spec.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."
+  spec.homepage = "https://github.com/afair/email_address"
+  spec.license = "MIT"
 
-  #spec.required_ruby_version = ">= 2.3.0"
-  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.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", "=  4.2.10"
-    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", '~> 1.3.24'
+  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"
   else
-    spec.add_development_dependency "activerecord", "~> 5.2.4"
+    spec.add_development_dependency "activerecord", "~> 6.1.4"
     spec.add_development_dependency "sqlite3"
   end
-  #spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "standard", "~> 1.1.1"
 
   spec.add_dependency "simpleidn"
-  spec.add_dependency "netaddr", '>= 2.0.4', '< 3'
 end

data/lib/email_address.rb

@@ -3,7 +3,6 @@
 # EmailAddress parses and validates email addresses against RFC standard,
 # conventional, canonical, formats and other special uses.
 module EmailAddress
-
   require "email_address/config"
   require "email_address/exchanger"
   require "email_address/host"
@@ -40,31 +39,30 @@ module EmailAddress
   #   secret to use in options[:secret]
   class << self
     (%i[valid? error normal redact munge canonical reference base srs] &
-     EmailAddress::Address.public_instance_methods
+     Address.public_instance_methods
     ).each do |proxy_method|
       define_method(proxy_method) do |*args, &block|
-        EmailAddress::Address.new(*args).public_send(proxy_method, &block)
+        Address.new(*args).public_send(proxy_method, &block)
       end
     end
-  end
-
 
-  # Creates an instance of this email address.
-  # This is a short-cut to Email::Address::Address.new
-  def self.new(email_address, config={})
-    EmailAddress::Address.new(email_address, config)
-  end
+    # Creates an instance of this email address.
+    # This is a short-cut to EmailAddress::Address.new
+    def new(email_address, config = {}, locale = "en")
+      Address.new(email_address, config, locale)
+    end
 
-  def self.new_redacted(email_address, config={})
-    EmailAddress::Address.new(EmailAddress::Address.new(email_address, config).redact)
-  end
+    def new_redacted(email_address, config = {}, locale = "en")
+      Address.new(Address.new(email_address, config, locale).redact)
+    end
 
-  def self.new_canonical(email_address, config={})
-    EmailAddress::Address.new(EmailAddress::Address.new(email_address, config).canonical, config)
-  end
+    def new_canonical(email_address, config = {}, locale = "en")
+      Address.new(Address.new(email_address, config, locale).canonical, config)
+    end
 
-  # Does the email address match any of the given rules
-  def self.matches?(email_address, rules, config={})
-    EmailAddress::Address.new(email_address, config).matches?(rules)
+    # Does the email address match any of the given rules
+    def matches?(email_address, rules, config = {}, locale = "en")
+      Address.new(email_address, config, locale).matches?(rules)
+    end
   end
 end

data/lib/email_address/active_record_validator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module EmailAddress
-
   # ActiveRecord validator class for validating an email
   # address with this library.
   # Note the initialization happens once per process.
@@ -16,14 +15,13 @@ module EmailAddress
   # Default field: :email or :email_address (first found)
   #
   class ActiveRecordValidator < ActiveModel::Validator
-
-    def initialize(options={})
+    def initialize(options = {})
       @opt = options
     end
 
     def validate(r)
       if @opt[:fields]
-        @opt[:fields].each {|f| validate_email(r, f) }
+        @opt[:fields].each { |f| validate_email(r, f) }
       elsif @opt[:field]
         validate_email(r, @opt[:field])
       elsif r.respond_to? :email
@@ -33,16 +31,15 @@ module EmailAddress
       end
     end
 
-    def validate_email(r,f)
+    def validate_email(r, f)
       return if r[f].nil?
-      e = EmailAddress.new(r[f])
+      e = Address.new(r[f])
       unless e.valid?
-        r.errors[f] << (@opt[:message] ||
-                       EmailAddress::Config.error_messages[:invalid_address] ||
-                       "Invalid Email Address")
+        error_message = @opt[:message] ||
+          Config.error_message(:invalid_address, I18n.locale.to_s) ||
+          "Invalid Email Address"
+        r.errors.add(f, error_message)
       end
     end
-
   end
-
 end

data/lib/email_address/address.rb

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
 
 require "digest/sha1"
+require "digest/sha2"
 require "digest/md5"
 
 module EmailAddress
   # Implements the Email Address container, which hold the Local
-  # (EmailAddress::Local) and Host (Email::AddressHost) parts.
+  # (EmailAddress::Local) and Host (EmailAddress::Host) parts.
   class Address
     include Comparable
-    include EmailAddress::Rewriter
+    include Rewriter
 
-    attr_accessor :original, :local, :host, :config, :reason
+    attr_accessor :original, :local, :host, :config, :reason, :locale
 
-    CONVENTIONAL_REGEX = /\A#{::EmailAddress::Local::CONVENTIONAL_MAILBOX_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
-    STANDARD_REGEX = /\A#{::EmailAddress::Local::STANDARD_LOCAL_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
-    RELAXED_REGEX = /\A#{::EmailAddress::Local::RELAXED_MAILBOX_WITHIN}
-                           @#{::EmailAddress::Host::DNS_HOST_REGEX}\z/x
+    CONVENTIONAL_REGEX = /\A#{Local::CONVENTIONAL_MAILBOX_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
+    STANDARD_REGEX = /\A#{Local::STANDARD_LOCAL_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
+    RELAXED_REGEX = /\A#{Local::RELAXED_MAILBOX_WITHIN}
+                           @#{Host::DNS_HOST_REGEX}\z/x
 
     # Given an email address of the form "local@hostname", this sets up the
     # instance, and initializes the address to the "normalized" format of the
     # address. The original string is available in the #original method.
-    def initialize(email_address, config = {})
-      @config = EmailAddress::Config.new(config)
+    def initialize(email_address, config = {}, locale = "en")
+      @config = Config.new(config)
       @original = email_address
+      @locale = locale
       email_address = (email_address || "").strip
       email_address = parse_rewritten(email_address) unless config[:skip_rewrite]
-      local, host = EmailAddress::Address.split_local_host(email_address)
+      local, host = Address.split_local_host(email_address)
 
-      @host = EmailAddress::Host.new(host, @config)
-      @local = EmailAddress::Local.new(local, @config, @host)
+      @host = Host.new(host, @config, locale)
+      @local = Local.new(local, @config, @host, locale)
       @error = @error_message = nil
     end
 
@@ -86,8 +88,8 @@ module EmailAddress
     def host_name
       @host.host_name
     end
-    alias right host_name
-    alias hostname host_name
+    alias_method :right, :host_name
+    alias_method :hostname, :host_name
 
     # Returns the ESP (Email Service Provider) or ISP name derived
     # using the provider configuration rules.
@@ -111,10 +113,10 @@ module EmailAddress
         "#{local}@#{host}"
       end
     end
-    alias to_s normal
+    alias_method :to_s, :normal
 
     def inspect
-      "#<EmailAddress::Address:0x#{object_id.to_s(16)} address=\"#{self}\">"
+      "#<#{self.class}:0x#{object_id.to_s(16)} address=\"#{self}\">"
     end
 
     # Returns the canonical email address according to the provider
@@ -159,50 +161,54 @@ module EmailAddress
       [local.munge, host.munge].join("@")
     end
 
-    # Returns and MD5 of the canonical address form. Some cross-system systems
+    # Returns and MD5 of the base address form. Some cross-system systems
     # use the email address MD5 instead of the actual address to refer to the
     # same shared user identity without exposing the actual address when it
     # is not known in common.
     def reference(form = :base)
       Digest::MD5.hexdigest(send(form))
     end
-    alias md5 reference
+    alias_method :md5, :reference
 
-    # This returns the SHA1 digest (in a hex string) of the canonical email
+    # This returns the SHA1 digest (in a hex string) of the base email
     # address. See #md5 for more background.
     def sha1(form = :base)
       Digest::SHA1.hexdigest((send(form) || "") + (@config[:sha1_secret] || ""))
     end
 
+    def sha256(form = :base)
+      Digest::SHA256.hexdigest((send(form) || "") + (@config[:sha256_secret] || ""))
+    end
+
     #---------------------------------------------------------------------------
     # Comparisons & Matching
     #---------------------------------------------------------------------------
 
     # Equal matches the normalized version of each address. Use the Threequal to check
     # for match on canonical or redacted versions of addresses
-    def ==(other_email)
-      to_s == other_email.to_s
+    def ==(other)
+      to_s == other.to_s
     end
-    alias eql? ==
-    alias equal? ==
+    alias_method :eql?, :==
+    alias_method :equal?, :==
 
     # Return the <=> or CMP comparison operator result (-1, 0, +1) on the comparison
     # of this addres with another, using the canonical or redacted forms.
     def same_as?(other_email)
       if other_email.is_a?(String)
-        other_email = EmailAddress::Address.new(other_email)
+        other_email = Address.new(other_email)
       end
 
       canonical == other_email.canonical ||
         redact == other_email.canonical ||
         canonical == other_email.redact
     end
-    alias include? same_as?
+    alias_method :include?, :same_as?
 
     # Return the <=> or CMP comparison operator result (-1, 0, +1) on the comparison
     # of this addres with another, using the normalized form.
-    def <=>(other_email)
-      to_s <=> other_email.to_s
+    def <=>(other)
+      to_s <=> other.to_s
     end
 
     # Address matches one of these Matcher rule patterns
@@ -214,7 +220,7 @@ module EmailAddress
 
       # Does "root@*.com" match "root@example.com" domain name
       rules.each do |r|
-        if r.match(/.+@.+/)
+        if /.+@.+/.match?(r)
           return r if File.fnmatch?(r, to_s)
         end
       end
@@ -276,7 +282,7 @@ module EmailAddress
     def set_error(err, reason = nil)
       @error = err
       @reason = reason
-      @error_message = EmailAddress::Config.error_message(err)
+      @error_message = Config.error_message(err, locale)
       false
     end