email_address 0.1.20 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89deebff7a17e3e90d1bfc92f8f22e1ab489d8c284c5d8070503e12b44345a72
-  data.tar.gz: 558ae5a8cff2abd326b1f6dddf6e6c01b4ef91bd0a94a55c44dea817696e4b31
+  metadata.gz: f9667acc31d6ce84fd3acb2e8e2f3ea04e496df5ff9dc5f89815fa148df1113e
+  data.tar.gz: e17aa2b229cb28ca80dcbf37226a5411052758db1e15cee0ddc2038d5244de42
 SHA512:
-  metadata.gz: 25850ded8a4ecb0ecb093e0f4583ee657fa134f93e976a2a44af829ab755487be9dd181fb15512af9e041854619dfa4c9cb8b0c009462cd6a7111d35808678ab
-  data.tar.gz: 26562889a56d1ddf32812c5f98948238672ba201072797db16e63b7f52ef03e022fe8b73a06096702a1f2a68905873f31420b17a457466da0e550f9cc3a168a0
+  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
@@ -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
@@ -272,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.
@@ -476,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:

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"
@@ -49,21 +48,21 @@ module EmailAddress
 
     # Creates an instance of this email address.
     # This is a short-cut to EmailAddress::Address.new
-    def new(email_address, config={})
-      Address.new(email_address, config)
+    def new(email_address, config = {}, locale = "en")
+      Address.new(email_address, config, locale)
     end
 
-    def new_redacted(email_address, config={})
-      Address.new(Address.new(email_address, config).redact)
+    def new_redacted(email_address, config = {}, locale = "en")
+      Address.new(Address.new(email_address, config, locale).redact)
     end
 
-    def new_canonical(email_address, config={})
-      Address.new(Address.new(email_address, config).canonical, config)
+    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 matches?(email_address, rules, config={})
-      Address.new(email_address, config).matches?(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,17 +31,15 @@ module EmailAddress
       end
     end
 
-    def validate_email(r,f)
+    def validate_email(r, f)
       return if r[f].nil?
       e = Address.new(r[f])
       unless e.valid?
         error_message = @opt[:message] ||
-                        Config.error_messages[:invalid_address] ||
-                        "Invalid Email Address"
+          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,6 +1,7 @@
 # frozen_string_literal: true
 
 require "digest/sha1"
+require "digest/sha2"
 require "digest/md5"
 
 module EmailAddress
@@ -10,7 +11,7 @@ module EmailAddress
     include Comparable
     include Rewriter
 
-    attr_accessor :original, :local, :host, :config, :reason
+    attr_accessor :original, :local, :host, :config, :reason, :locale
 
     CONVENTIONAL_REGEX = /\A#{Local::CONVENTIONAL_MAILBOX_WITHIN}
                            @#{Host::DNS_HOST_REGEX}\z/x
@@ -22,15 +23,16 @@ module EmailAddress
     # 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 = {})
+    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 = Address.split_local_host(email_address)
 
-      @host = Host.new(host, @config)
-      @local = 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,7 +113,7 @@ module EmailAddress
         "#{local}@#{host}"
       end
     end
-    alias to_s normal
+    alias_method :to_s, :normal
 
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} address=\"#{self}\">"
@@ -159,32 +161,36 @@ 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.
@@ -197,12 +203,12 @@ module EmailAddress
         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 = Config.error_message(err)
+      @error_message = Config.error_message(err, locale)
       false
     end
 

data/lib/email_address/config.rb

@@ -17,6 +17,11 @@ module EmailAddress
   #   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.
+  #
   # For local part configuration:
   # * local_downcase:     true
   #   Downcase the local part. You probably want this for uniqueness.
@@ -104,6 +109,7 @@ module EmailAddress
       dns_lookup: :mx, # :mx, :a, :off
       dns_timeout: nil,
       sha1_secret: "",
+      sha256_secret: "",
       munge_string: "*****",
 
       local_downcase: true,
@@ -188,9 +194,14 @@ module EmailAddress
     # Customize your own error message text.
     def self.error_messages(hash = {}, locale = "en", *extra)
       hash = extra.first if extra.first.is_a? Hash
-      unless hash.empty?
+
+      @errors[locale] ||= {}
+      @errors[locale]["email_address"] ||= {}
+
+      unless hash.nil? || hash.empty?
         @errors[locale]["email_address"] = @errors[locale]["email_address"].merge(hash)
       end
+
       @errors[locale]["email_address"]
     end
 

data/lib/email_address/exchanger.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "resolv"
-require "netaddr"
 require "socket"
 
 module EmailAddress
@@ -58,8 +57,8 @@ module EmailAddress
 
         ress = begin
           dns.getresources(@host, Resolv::DNS::Resource::IN::MX)
-               rescue Resolv::ResolvTimeout
-                 []
+        rescue Resolv::ResolvTimeout
+          []
         end
 
         records = ress.map { |r|
@@ -105,22 +104,9 @@ module EmailAddress
 
     # Given a cidr (ip/bits) and ip address, returns true on match. Caches cidr object.
     def in_cidr?(cidr)
-      if cidr.include?(":")
-        c = NetAddr::IPv6Net.parse(cidr)
-        return true if mx_ips.find do |ip|
-          next unless ip.include?(":")
-          rel = c.rel NetAddr::IPv6Net.parse(ip)
-          !rel.nil? && rel >= 0
-        end
-      elsif cidr.include?(".")
-        c = NetAddr::IPv4Net.parse(cidr)
-        return true if mx_ips.find do |ip|
-          next if ip.include?(":")
-          rel = c.rel NetAddr::IPv4Net.parse(ip)
-          !rel.nil? && rel >= 0
-        end
-      end
-      false
+      net = IPAddr.new(cidr)
+      found = mx_ips.detect { |ip| net.include?(IPAddr.new(ip)) }
+      !!found
     end
   end
 end