email_address 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3825a1fafdf4659a5bc444b2bea01e83d4a52a0ae3faf57042c2cf83cae0d364
-  data.tar.gz: e9c2f046f52648f7f7f2e0326457f1aaa11f36e075e87d40818a34de7a84f2f3
+  metadata.gz: b7864361d639e8c0d2609782b1d4d02a2d8c497bf3080a6bb563e5a8eac7bdc6
+  data.tar.gz: 1145528c90a7845ce092fae5791a8dde9d81a66709188d3a53eb9310a8e49e7e
 SHA512:
-  metadata.gz: 39f199aab0bd33b42a57841df03a033142217aa5a39fe0652b779c4522509d450660178fc51eee23bc3111905a967475ac3625718d020d275ef9d697b672fe79
-  data.tar.gz: e3ee79489ea98a0b6c11a3b438e84087833ce9782f16bf3865d7169514cd9a939f383a17e6ef2b695273351cbd427de2f36332d0d63e693c99c6f3fa7173430b
+  metadata.gz: a04d299269c34d29dc630335462bd8a6b778c9ce4eefa12ee5bb5a5f0e22fb6e435b4c84f413f6f194f8a2e8e4d94831d96f0cee3eef7fd28e8028bd839ffc85
+  data.tar.gz: 44184ef5b1c631e9a7cde11b8570c49473cceda7649cc625a386bd6c5ec8cd9fae5b024db82c06a99d237b025a249db92835492f99cc781a44654fb56d6999cf

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - ruby-head
-  - 2.2.2
+  - 2.3.7
   - jruby-9.0.4.0
   #- rbx
 

data/README.md

@@ -22,6 +22,9 @@ address validator and attributes API custom datatypes.
 
 Requires Ruby 2.0 or later.
 
+Looking for a Javascript version of this library? Check out the
+[email_address](https://www.npmjs.com/package/email_address) npm module.
+
 ## Quick Start
 
 To quickly validate email addresses, use the valid? and error helpers.

data/email_address.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest",     "~> 5.11"
-  spec.add_development_dependency "bundler",      "~> 1.3"
+  spec.add_development_dependency "bundler",      "~> 1.16.0"
   if RUBY_PLATFORM == 'java'
-    spec.add_development_dependency "activerecord", "=  4.2.5"
-    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", '=1.3.19'
+    spec.add_development_dependency "activerecord", "=  4.2.10"
+    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter", '~> 1.3.24'
   else
-    spec.add_development_dependency "activerecord", "~> 5.2.0.rc2"
+    spec.add_development_dependency "activerecord", "~> 5.2.0"
     spec.add_development_dependency "sqlite3"
   end
   spec.add_development_dependency "codeclimate-test-reporter"

data/lib/email_address.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 
+# EmailAddress parses and validates email addresses against RFC standard,
+# conventional, canonical, formats and other special uses.
 module EmailAddress
 
   require "email_address/config"

data/lib/email_address/active_record_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailAddress
 
   # ActiveRecord validator class for validating an email

data/lib/email_address/address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha1'
 require 'digest/md5'
 
@@ -30,6 +32,7 @@ module EmailAddress
       @host         = EmailAddress::Host.new(host, config)
       @config       = @host.config
       @local        = EmailAddress::Local.new(local, @config, @host)
+      @error        = @error_message = nil
     end
 
     # Given an email address, this returns an array of [local, host] parts
@@ -228,7 +231,7 @@ module EmailAddress
     def valid?(options={})
       @error = nil
       unless self.local.valid?
-        return set_error :invalid_mailbox
+        return set_error self.local.error
       end
       unless self.host.valid?
         return set_error self.host.error_message
@@ -259,7 +262,7 @@ module EmailAddress
         smtp.start(@config[:smtp_helo_name] || 'localhost')
         smtp.mailfrom @config[:smtp_mail_from] || 'postmaster@localhost'
         smtp.rcptto self.to_s
-        p [:connect]
+        #p [:connect]
         smtp.finish
         true
       rescue Net::SMTPUnknownError => e
@@ -277,17 +280,18 @@ module EmailAddress
     end
 
     def set_error(err, reason=nil)
-      @error = EmailAddress::Config.error_messages.fetch(err) { err }
+      @error = err
       @reason= reason
+      @error_message = EmailAddress::Config.error_message(err)
       false
     end
 
     def error_message
-      @error
+      @error_message
     end
 
     def error
-      self.valid? ? nil : @error
+      self.valid? ? nil : @error_message
     end
 
   end

data/lib/email_address/canonical_email_address_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ################################################################################
 # ActiveRecord v5.0 Custom Type
 #

data/lib/email_address/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailAddress
   # Global configurations and for default/unknown providers. Settings are:
   #
@@ -92,6 +94,8 @@ module EmailAddress
   # * exchanger_match:    %w(google.com 127.0.0.1 10.9.8.0/24 ::1/64)
   #
 
+  require 'yaml'
+
   class Config
     @config = {
       dns_lookup:         :mx,  # :mx, :a, :off
@@ -121,6 +125,7 @@ module EmailAddress
       address_fqdn_domain: nil, # Fully Qualified Domain Name = [host].[domain.tld]
     }
 
+    # 2018-04: AOL and Yahoo now under "oath.com", owned by Verizon. Keeping separate for now
     @providers = {
       aol: {
         host_match:       %w(aol. compuserve. netscape. aim. cs.),
@@ -142,14 +147,10 @@ module EmailAddress
       },
     }
 
-    @errors = {
-      invalid_address:    "Invalid Email Address",
-      invalid_mailbox:    "Invalid Recipient/Mailbox",
-      invalid_host:       "Invalid Host/Domain Name",
-      exceeds_size:       "Address too long",
-      not_allowed:        "Address is not allowed",
-      incomplete_domain:  "Domain name is incomplete",
-    }
+
+    # Loads messages: {"en"=>{"email_address"=>{"invalid_address"=>"Invalid Email Address",...}}}
+    # Rails/I18n gem: t(email_address.error, scope: "email_address")
+    @errors = YAML.load_file(File.dirname(__FILE__)+"/messages.yaml")
 
     # Set multiple default configuration settings
     def self.configure(config={})
@@ -177,6 +178,10 @@ module EmailAddress
       @providers[name]
     end
 
+    def self.error_message(name, locale="en")
+      @errors[locale]["email_address"][name.to_s] || name.to_s
+    end
+
     # Customize your own error message text.
     def self.error_messages(hash=nil)
       @errors = @errors.merge(hash) if hash

data/lib/email_address/email_address_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ################################################################################
 # ActiveRecord v5.0 Custom Type
 #

data/lib/email_address/exchanger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'resolv'
 require 'netaddr'
 require 'socket'
@@ -6,7 +8,7 @@ module EmailAddress
   class Exchanger
     include Enumerable
 
-    def self.cached(host)
+    def self.cached(host, config={})
       @host_cache ||= {}
       @cache_size ||= ENV['EMAIL_ADDRESS_CACHE_SIZE'].to_i || 100
       if @host_cache.has_key?(host)
@@ -14,9 +16,9 @@ module EmailAddress
         @host_cache[host] = o # LRU cache, move to end
       elsif @host_cache.size >= @cache_size
         @host_cache.delete(@host_cache.keys.first)
-        @host_cache[host] = new(host)
+        @host_cache[host] = new(host, config)
       else
-        @host_cache[host] = new(host)
+        @host_cache[host] = new(host, config)
       end
     end
 
@@ -44,7 +46,11 @@ module EmailAddress
 
     # Returns: [["mta7.am0.yahoodns.net", "66.94.237.139", 1], ["mta5.am0.yahoodns.net", "67.195.168.230", 1], ["mta6.am0.yahoodns.net", "98.139.54.60", 1]]
     # If not found, returns []
+    # Returns a dummy record when dns_lookup is turned off since it may exists, though
+    # may not find provider by MX name or IP. I'm not sure about the "0.0.0.0" ip, it should
+    # be good in this context, but in "listen" context it means "all bound IP's"
     def mxers
+      return [["example.com", "0.0.0.0", 1]] if @config[:dns_lookup] == :off
       @mxers ||= Resolv::DNS.open do |dns|
         ress = dns.getresources(@host, Resolv::DNS::Resource::IN::MX)
         records = ress.map do |r|
@@ -69,6 +75,7 @@ module EmailAddress
 
     # Returns an array of MX IP address (String) for the given email domain
     def mx_ips
+      return ["0.0.0.0"] if @config[:dns_lookup] == :off
       mxers.map {|m| m[1] }
     end
 

data/lib/email_address/host.rb

@@ -1,3 +1,4 @@
+
 require 'simpleidn'
 require 'resolv'
 require 'netaddr'
@@ -88,6 +89,7 @@ module EmailAddress
       @original            = host_name ||= ''
       config[:host_type] ||= :email
       @config              = config
+      @error               = @error_message = nil
       parse(host_name)
     end
 
@@ -334,6 +336,7 @@ module EmailAddress
 
     # Returns: [official_hostname, alias_hostnames, address_family, *address_list]
     def dns_a_record
+      @_dns_a_record = "0.0.0.0" if @config[:dns_lookup] == :off
       @_dns_a_record ||= Socket.gethostbyname(self.dns_name)
     rescue SocketError # not found, but could also mean network not work
       @_dns_a_record ||= []
@@ -343,7 +346,7 @@ module EmailAddress
     # The array will be empty if none are configured.
     def exchangers
       return nil if @config[:host_type] != :email || !self.dns_enabled?
-      @_exchangers ||= EmailAddress::Exchanger.cached(self.dns_name)
+      @_exchangers ||= EmailAddress::Exchanger.cached(self.dns_name, @config)
     end
 
     # Returns a DNS TXT Record
@@ -398,11 +401,6 @@ module EmailAddress
       end
     end
 
-    # The inverse of valid? -- Returns nil (falsey) if valid, otherwise error message
-    def error
-      valid? ? nil : @error_message
-    end
-
     # True if the host name has a DNS A Record
     def valid_dns?
       bool = dns_a_record.size > 0 || set_error(:domain_unknown)
@@ -414,7 +412,9 @@ module EmailAddress
 
     # True if the host name has valid MX servers configured in DNS
     def valid_mx?
-      if self.exchangers.mx_ips.size > 0
+      if self.exchangers.blank?
+        set_error(:domain_unknown)
+      elsif self.exchangers.mx_ips.size > 0
         if self.localhost? && !@config[:host_local]
           set_error(:domain_no_localhost)
         else
@@ -457,11 +457,11 @@ module EmailAddress
       if self.ip_address
         rel =
           if self.ip_address.include?(":")
-            NetAddr::IPv6Net.parse("::1").rel(
+            NetAddr::IPv6Net.parse(""+"::1").rel(
               NetAddr::IPv6Net.parse(self.ip_address)
             )
           else
-            NetAddr::IPv4Net.parse("127.0.0.0/8").rel(
+            NetAddr::IPv4Net.parse(""+"127.0.0.0/8").rel(
               NetAddr::IPv4Net.parse(self.ip_address)
             )
           end
@@ -492,10 +492,16 @@ module EmailAddress
     end
 
     def set_error(err, reason=nil)
-      @error_message = EmailAddress::Config.error_messages.fetch(err) { err }
+      @error         = err
       @reason        = reason
+      @error_message = EmailAddress::Config.error_message(err)
       false
     end
 
+    # The inverse of valid? -- Returns nil (falsey) if valid, otherwise error message
+    def error
+      self.valid? ? nil : @error_message
+    end
+
   end
 end

data/lib/email_address/local.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailAddress
   ##############################################################################
   # EmailAddress Local part consists of
@@ -103,6 +105,7 @@ module EmailAddress
       self.config   = config.empty? ? EmailAddress::Config.all_settings : config
       self.local    = local
       @host         = host
+      @error        = @error_message = nil
     end
 
     def local=(raw)
@@ -189,7 +192,7 @@ module EmailAddress
         self.conventional
       elsif form == :canonical
         self.canonical
-      elsif form == :relax
+      elsif form == :relaxed
         self.relax
       elsif form == :standard
         self.standard
@@ -301,21 +304,23 @@ module EmailAddress
     end
 
     def valid_size?
+      return set_error(:local_size_long) if self.local.size > STANDARD_MAX_SIZE
       if @host && @host.hosted_service?
-        return false if @config[:local_private_size] &&
-                      !@config[:local_private_size].include?(self.local.size)
-      else
-        return false if @config[:local_size] &&
-                       !@config[:local_size].include?(self.local.size)
+        return false if @config[:local_private_size] && !valid_size_checks(@config[:local_private_size])
       end
-      return false if @config[:mailbox_size] && !@config[:mailbox_size].include?(self.mailbox.size)
-      return false if self.local.size > STANDARD_MAX_SIZE
+      return false if @config[:local_size] && !valid_size_checks(@config[:local_size])
+      return false if @config[:mailbox_size] && !valid_size_checks(@config[:mailbox_size])
+      true
+    end
+
+    def valid_size_checks(range)
+      return set_error(:local_size_short) if self.mailbox.size < range.first
+      return set_error(:local_size_long)  if self.mailbox.size > range.last
       true
     end
 
     def valid_encoding?(enc=@config[:local_encoding]||:ascii)
       return false if enc == :ascii && self.unicode?
-      #return false if enc == :unicode && self.ascii?
       true
     end
 
@@ -365,5 +370,21 @@ module EmailAddress
       end
       false
     end
+
+    def set_error(err, reason=nil)
+      @error = err
+      @reason= reason
+      @error_message = EmailAddress::Config.error_message(err)
+      false
+    end
+
+    def error_message
+      @error_message
+    end
+
+    def error
+      self.valid? ? nil : @error
+    end
+
   end
 end

data/lib/email_address/messages.yaml

@@ -0,0 +1,20 @@
+en:
+  email_address:
+    address_unknown: "Unknown Email Address"
+    domain_does_not_accept_email: "This domain is not configured to accept email"
+    domain_invalid: "Invalid Domain Name"
+    domain_no_localhost: "localhost is not allowed for your domain name"
+    domain_unknown: "Domain name not registered"
+    exceeds_size: "Address too long"
+    incomplete_domain: "Domain name is incomplete"
+    invalid_address: "Invalid Email Address"
+    invalid_host: "Invalid Host/Domain Name"
+    invalid_mailbox: "Invalid Mailbox"
+    ip_address_forbidden: "IP Addresses are not allowed"
+    ip_address_no_localhost: "Localhost IP addresses are not allowed"
+    ipv4_address_invalid: "This is not a valid IPv4 address"
+    ipv6_address_invalid: "This is not a valid IPv6 address"
+    local_size_long: "Mailbox name too long"
+    local_size_short: "Mailbox name too short"
+    not_allowed: "Address is not allowed"
+    server_not_available: "The remote email server is not available"

data/lib/email_address/rewriter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 module EmailAddress::Rewriter

data/lib/email_address/version.rb

@@ -1,3 +1,3 @@
 module EmailAddress
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/test/email_address/test_address.rb

@@ -77,9 +77,9 @@ class TestAddress < Minitest::Test
     e = EmailAddress.new("User+tag.gmail.ws") # No domain means localhost
     assert_equal '', e.hostname
     assert_equal false, e.valid? # localhost not allowed by default
-    assert_equal EmailAddress.error("user1"), :domain_invalid
-    assert_equal EmailAddress.error("user1", host_local:true), :domain_does_not_accept_email
-    assert_equal EmailAddress.error("user1@localhost", host_local:true), :domain_does_not_accept_email
+    assert_equal EmailAddress.error("user1"), "Invalid Domain Name"
+    assert_equal EmailAddress.error("user1", host_local:true), "This domain is not configured to accept email"
+    assert_equal EmailAddress.error("user1@localhost", host_local:true), "This domain is not configured to accept email"
     assert_nil EmailAddress.error("user2@localhost", host_local:true, dns_lookup: :off, host_validation: :syntax)
   end
 
@@ -112,4 +112,8 @@ class TestAddress < Minitest::Test
     assert ! EmailAddress.valid?('example.user@foo.com/')
   end
 
+  def test_relaxed_normal
+    assert ! EmailAddress.new('a.c.m.e.-industries@foo.com').valid?
+    assert true, EmailAddress.new('a.c.m.e.-industries@foo.com', local_format: :relaxed).valid?
+  end
 end

data/test/email_address/test_host.rb

@@ -114,12 +114,12 @@ class TestHost < MiniTest::Test
 
   def test_errors
     assert_nil EmailAddress::Host.new("yahoo.com").error
-    assert_equal EmailAddress::Host.new("example.com").error, :domain_does_not_accept_email
-    assert_equal EmailAddress::Host.new("yahoo.wtf").error, :domain_unknown
+    assert_equal EmailAddress::Host.new("example.com").error, "This domain is not configured to accept email"
+    assert_equal EmailAddress::Host.new("yahoo.wtf").error, "Domain name not registered"
     assert_nil EmailAddress::Host.new("ajsdfhajshdfklasjhd.wtf", host_validation: :syntax).error
-    assert_equal EmailAddress::Host.new("ya  hoo.com", host_validation: :syntax).error, :domain_invalid
-    assert_equal EmailAddress::Host.new("[127.0.0.1]").error, :ip_address_forbidden
-    assert_equal EmailAddress::Host.new("[127.0.0.666]", host_allow_ip:true).error, :ipv4_address_invalid
-    assert_equal EmailAddress::Host.new("[IPv6::12t]", host_allow_ip:true).error, :ipv6_address_invalid
+    assert_equal EmailAddress::Host.new("ya  hoo.com", host_validation: :syntax).error, "Invalid Domain Name"
+    assert_equal EmailAddress::Host.new("[127.0.0.1]").error, "IP Addresses are not allowed"
+    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_address
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Allen Fair
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0.rc2
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0.rc2
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,7 @@ files:
 - lib/email_address/exchanger.rb
 - lib/email_address/host.rb
 - lib/email_address/local.rb
+- lib/email_address/messages.yaml
 - lib/email_address/rewriter.rb
 - lib/email_address/version.rb
 - test/activerecord/test_ar.rb
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This gem provides a ruby language library for working with and validating