email_address 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aecafb936eb2bce2258d43020087efa6fb7a352b
-  data.tar.gz: 9db91ef371beae264be3ddbc8e50b8e3cbbfb02e
+  metadata.gz: b6a59891931ddfd551f8ead37a376795d22e70eb
+  data.tar.gz: 8b71384418e8b1a4eb505faa5e95e021f0b30b7d
 SHA512:
-  metadata.gz: e715c704ca4c78fc6dbce5e77e3545a7ba3dea40278dc114e79315dfced08af8088c711507569e0a98ad5738e7088727e961300426966a12180d20880e4a2fed
-  data.tar.gz: 0f07a721fff632161f1d30893acf30f423162371d18be4be54a381c4211b18605a16dfd994ef1320e54102df6922361c19427fd43f21d934805d36a2265225a3
+  metadata.gz: 62af3189a51354059a4d05e03c294e12a3e76839bb4cafd0697231fae638cbe5959324034cbdeea4d83f8a10303e6f7e6bad4c7aa0d2bd90bd7ef3bbafc0c930
+  data.tar.gz: 34d7af8021c044f4cc4e1e00c4d2aa0e0066881178f7300c6322ccad52dd7787448b0929efb1148cfc582e6b073d9ae318fe515937bab9085a94e6ddfa98ab3b

data/README.md

@@ -365,6 +365,21 @@ configuration options:
     EmailAddress::Config.provider(:github,
            host_match: %w(github.com), local_format: :standard)
 
+#### Override Error Messaegs
+
+You can override the default error messages as follows:
+
+    EmailAddress::Config.error_messages(
+      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")
+
+Full translation support would be ideal though.
+
+
 ### Available Configuration Settings
 
 * dns_lookup: Enables DNS lookup for validation by

data/email_address.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest",     "~> 5.8.3"
   spec.add_development_dependency "bundler",      "~> 1.3"
-  spec.add_development_dependency "activerecord", "~> 5.0.0.beta1"   if RUBY_PLATFORM != 'java'
+  spec.add_development_dependency "activerecord", "~> 5.0.1"         if RUBY_PLATFORM != 'java'
   spec.add_development_dependency "activerecord", "~> 4.2.5"         if RUBY_PLATFORM == 'java'
   spec.add_development_dependency "sqlite3"                          if RUBY_PLATFORM != 'java'
   spec.add_development_dependency "activerecord-jdbcsqlite3-adapter" if RUBY_PLATFORM == 'java'

data/lib/email_address/active_record_validator.rb

@@ -34,7 +34,11 @@ module EmailAddress
     def validate_email(r,f)
       return if r[f].nil?
       e = EmailAddress.new(r[f])
-      r.errors[f] << "Email Address Not Valid" unless e.valid?
+      unless e.valid?
+        r.errors[f] << (@opt[:message] ||
+                       EmailAddress::Config.error_messages[:invalid_address] ||
+                       "Invalid Email Address")
+      end
     end
 
   end

data/lib/email_address/address.rb

@@ -6,12 +6,14 @@ module EmailAddress
   # (EmailAddress::Local) and Host (Email::AddressHost) parts.
   class Address
     include Comparable
-    attr_accessor :original, :local, :host, :config, :error
+    attr_accessor :original, :local, :host, :config
 
     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
 
     # Given an email address of the form "local@hostname", this sets up the
     # instance, and initializes the address to the "normalized" format of the
@@ -109,7 +111,9 @@ module EmailAddress
     # spaves and comments and tags, and any extraneous part of the address
     # not considered a unique account by the provider.
     def canonical
-      [self.local.canonical, @host.canonical].join('@')
+      c = self.local.canonical
+      c += "@" + self.host.canonical if self.host.canonical && self.host.canonical > " "
+      c
     end
 
     # True if the given address is already in it's canonical form.
@@ -119,9 +123,13 @@ module EmailAddress
 
     # Returns the redacted form of the address
     # This format is defined by this libaray, and may change as usage increases.
-    def redact
+    # Takes either :sha1 (default) or :md5 as the argument
+    def redact(digest=:sha1)
+      raise "Unknown Digest type: #{digest}" unless %i(sha1 md5).include?(digest)
       return self.to_s if self.local.redacted?
-      %Q({#{self.sha1}}@#{self.host.to_s})
+      r = %Q({#{send(digest)}})
+      r += "@" + self.host.to_s if self.host.to_s && self.host.to_s > " "
+      r
     end
 
     # True if the address is already in the redacted state.
@@ -147,7 +155,7 @@ module EmailAddress
     # This returns the SHA1 digest (in a hex string) of the canonical email
     # address. See #md5 for more background.
     def sha1
-      Digest::SHA1.hexdigest(canonical + @config[:sha1_secret])
+      Digest::SHA1.hexdigest((canonical||"") + (@config[:sha1_secret]||""))
     end
 
     #---------------------------------------------------------------------------
@@ -204,35 +212,35 @@ module EmailAddress
     # Returns true if this address is considered valid according to the format
     # configured for its provider, It test the normalized form.
     def valid?(options={})
-      self.error = nil
+      @error = nil
       unless self.local.valid?
-        self.error = "Invalid Mailbox"
-        return false
+        return set_error :invalid_mailbox
       end
       unless self.host.valid?
-        self.error = "Invalid Host"
-        return false
+        return set_error :invalid_host
       end
       if @config[:address_size] && !@config[:address_size].include?(self.to_s.size)
-        self.error = "Exceeds size"
-        return false
+        return set_error :exceeds_size
       end
       if @config[:address_validation].is_a?(Proc)
         unless @config[:address_validation].call(self.to_s)
-          self.error = "Not allowed"
-          return false
+          return set_error :not_allowed
         end
       else
         return false unless self.local.valid?
         return false unless self.host.valid?
       end
       if !@config[:address_local] && !self.hostname.include?(".")
-        self.error = "Incomplete Domain"
-        return false
+        return set_error :incomplete_domain
       end
       true
     end
 
+    def set_error(err)
+      @error = EmailAddress::Config.error_messages[err] || err
+      false
+    end
+
     def error
       self.valid? ? nil : @error
     end

data/lib/email_address/config.rb

@@ -84,6 +84,7 @@ module EmailAddress
   # 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)
+  #
 
   class Config
     @config = {
@@ -132,6 +133,15 @@ 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",
+    }
+
     # Set multiple default configuration settings
     def self.configure(config={})
       @config.merge!(config)
@@ -158,6 +168,12 @@ module EmailAddress
       @providers[name]
     end
 
+    # Customize your own error message text.
+    def self.error_messages(hash=nil)
+      @errors = @errors.merge(hash) if hash
+      @errors
+    end
+
     def self.all_settings(*configs)
       config = @config.clone
       configs.each {|c| config.merge!(c) }

data/lib/email_address/exchanger.rb

@@ -33,7 +33,7 @@ module EmailAddress
 
     # Returns the provider name based on the MX-er host names, or nil if not matched
     def provider
-      return @provider if @provider
+      return @provider if defined? @provider
       EmailAddress::Config.providers.each do |provider, config|
         if config[:exchanger_match] && self.matches?(config[:exchanger_match])
           return @provider = provider
@@ -47,10 +47,15 @@ module EmailAddress
     def mxers
       @mxers ||= Resolv::DNS.open do |dns|
         ress = dns.getresources(@host, Resolv::DNS::Resource::IN::MX)
-        ress.map { |r| [r.exchange.to_s, IPSocket::getaddress(r.exchange.to_s), r.preference] }
+        records = ress.map do |r|
+          begin
+            [r.exchange.to_s, IPSocket::getaddress(r.exchange.to_s), r.preference]
+          rescue SocketError # not found, but could also mean network not work or it could mean one record doesn't resolve an address
+            nil
+          end
+        end
+        records.compact
       end
-    rescue SocketError # not found, but could also mean network not work
-      @_dns_a_record ||= []
     end
 
     # Returns Array of domain names for the MX'ers, used to determine the Provider

data/lib/email_address/host.rb

@@ -30,7 +30,8 @@ module EmailAddress
   # that provider.
   ##############################################################################
   class Host
-    attr_accessor :host_name, :dns_name, :domain_name, :registration_name,
+    attr_reader :host_name
+    attr_accessor :dns_name, :domain_name, :registration_name,
                   :tld, :tld2, :subdomains, :ip_address, :config, :provider,
                   :comment
     MAX_HOST_LENGTH = 255

data/lib/email_address/local.rb

@@ -65,7 +65,8 @@ module EmailAddress
   #                        [CFWS]
   ############################################################################
   class Local
-    attr_accessor :mailbox, :comment, :tag, :local, :config, :original
+    attr_reader   :local
+    attr_accessor :mailbox, :comment, :tag, :config, :original
     attr_accessor :syntax
 
     # RFC-2142: MAILBOX NAMES FOR COMMON SERVICES, ROLES AND FUNCTIONS
@@ -79,19 +80,20 @@ module EmailAddress
     STANDARD_MAX_SIZE  = 64
 
     # Conventional : word([.-+'_]word)*
-    CONVENTIONAL_MAILBOX_REGEX  = /\A [\p{L}\p{N}]+ ( [\.\-\+\'_] [\p{L}\p{N}]+ )* \z/x
-    CONVENTIONAL_MAILBOX_WITHIN = /[\p{L}\p{N}]+ ( [\.\-\+\'_] [\p{L}\p{N}]+ )*/x
+    CONVENTIONAL_MAILBOX_REGEX  = /\A [\p{L}\p{N}]+ (?: [\.\-\+\'_] [\p{L}\p{N}]+ )* \z/x
+    CONVENTIONAL_MAILBOX_WITHIN = /[\p{L}\p{N}]+ (?: [\.\-\+\'_] [\p{L}\p{N}]+ )*/x
 
     # Relaxed: same characters, relaxed order
-    RELAXED_MAILBOX_REGEX = /\A [\p{L}\p{N}]+ ( [\.\-\+\'_]+ [\p{L}\p{N}]+ )* \z/x
+    RELAXED_MAILBOX_WITHIN = /[\p{L}\p{N}]+ (?: [\.\-\+\'_]+ [\p{L}\p{N}]+ )*/x
+    RELAXED_MAILBOX_REGEX = /\A [\p{L}\p{N}]+ (?: [\.\-\+\'_]+ [\p{L}\p{N}]+ )* \z/x
 
     # RFC5322 Token: token."token".token (dot-separated tokens)
     #   Quoted Token can also have: SPACE \" \\ ( ) , : ; < > @ [ \ ] .
     STANDARD_LOCAL_WITHIN = /
-      ( [\p{L}\p{N}\!\#\$\%\&\'\*\+\-\/\=\?\^\_\`\{\|\}\~\(\)]+
-        | \" ( \\[\" \\] | [\x20 \! \x23-\x5B \x5D-\x7E \p{L} \p{N}] )+ \" )
-      ( \.  ( [\p{L}\p{N}\!\#\$\%\&\'\*\+\-\/\=\?\^\_\`\{\|\}\~\(\)]+
-              | \" ( \\[\" \\] | [\x20 \! \x23-\x5B \x5D-\x7E \p{L} \p{N}] )+ \" ) )* /x
+      (?: [\p{L}\p{N}\!\#\$\%\&\'\*\+\-\/\=\?\^\_\`\{\|\}\~\(\)]+
+        | \" (?: \\[\" \\] | [\x20 \! \x23-\x5B \x5D-\x7E \p{L} \p{N}] )+ \" )
+      (?: \.  (?: [\p{L}\p{N}\!\#\$\%\&\'\*\+\-\/\=\?\^\_\`\{\|\}\~\(\)]+
+              | \" (?: \\[\" \\] | [\x20 \! \x23-\x5B \x5D-\x7E \p{L} \p{N}] )+ \" ) )* /x
     STANDARD_LOCAL_REGEX = /\A #{STANDARD_LOCAL_WITHIN} \z/x
 
     REDACTED_REGEX = /\A \{ [0-9a-f]{40} \} \z/x # {sha1}

data/lib/email_address/version.rb

@@ -1,3 +1,3 @@
 module EmailAddress
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/activerecord/test_ar.rb

@@ -7,6 +7,7 @@ class TestAR < MiniTest::Test
   def test_validation
     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

data/test/email_address/test_address.rb

@@ -31,6 +31,7 @@ class TestAddress < Minitest::Test
     assert_equal "user+tag@example.com", a.to_s
     assert_equal "user@example.com", a.canonical
     assert_equal "{63a710569261a24b3766275b7000ce8d7b32e2f7}@example.com", a.redact
+    assert_equal "{b58996c504c5638798eb6b511e6f49af}@example.com", a.redact(:md5)
     assert_equal "b58996c504c5638798eb6b511e6f49af", a.reference
   end
 
@@ -55,6 +56,14 @@ class TestAddress < Minitest::Test
     assert_equal 'user*@gmail*',  a.matches?('user*@gmail*')
   end
 
+  def test_empty_address
+    a = EmailAddress.new("")
+    assert_equal "{da39a3ee5e6b4b0d3255bfef95601890afd80709}", a.redact
+    assert_equal "", a.to_s
+    assert_equal "", a.canonical
+    assert_equal "d41d8cd98f00b204e9800998ecf8427e", a.reference
+  end
+
   # VALIDATION
   def test_valid
     assert EmailAddress.valid?("User+tag@example.com", dns_lookup: :a), "valid 1"
@@ -73,6 +82,7 @@ class TestAddress < Minitest::Test
     assert "First.Last+TAG@example.com".match(EmailAddress::Address::STANDARD_REGEX)
     assert_equal nil, "First.Last+TAGexample.com".match(EmailAddress::Address::STANDARD_REGEX)
     assert_equal nil, "First#Last+TAGexample.com".match(EmailAddress::Address::CONVENTIONAL_REGEX)
+    assert "aasdf-34-.z@example.com".match(EmailAddress::Address::RELAXED_REGEX)
   end
 
 end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'active_record'
 require 'rubygems'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_address
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Allen Fair
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta1
+        version: 5.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta1
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: This gem provides a ruby language library for working with and validating