email_address 0.0.3 → 0.1.0

data/lib/email_address/canonical_email_address_type.rb

@@ -0,0 +1,46 @@
+################################################################################
+# ActiveRecord v5.0 Custom Type
+#
+# 1) Register your types
+#
+#    # config/initializers/email_address.rb
+#    ActiveRecord::Type.register(:email_address, EmailAddress::Address)
+#    ActiveRecord::Type.register(:canonical_email_address,
+#                                EmailAddress::CanonicalEmailAddressType)
+#
+# 2) Define your email address columns in your model class
+#
+#    class User < ApplicationRecord
+#      attribute :email, :email_address
+#      attribute :canonical_email, :canonical_email_address
+#
+#      def email=(email_address)
+#        self[:canonical_email] = email_address
+#        self[:email] = email_address
+#      end
+#    end
+#
+# 3) Profit!
+#
+#    user = User.new(email:"Pat.Smith+registrations@gmail.com")
+#    user.email           #=> "pat.smith+registrations@gmail.com"
+#    user.canonical_email #=> "patsmith@gmail.com"
+################################################################################
+
+class EmailAddress::CanonicalEmailAddressType < ActiveRecord::Type::Value
+
+  # From user input, setter
+  def cast(value)
+    super(EmailAddress.canonical(value))
+  end
+
+  # From a database value
+  def deserialize(value)
+    value && EmailAddress.normal(value)
+  end
+
+  # To a database value (string)
+  def serialize(value)
+    value && EmailAddress.normal(value)
+  end
+end

data/lib/email_address/config.rb

@@ -1,83 +1,167 @@
 module EmailAddress
+  # Global configurations and for default/unknown providers. Settings are:
+  #
+  # * dns_lookup:         :mx, :a, :off
+  #   Enables DNS lookup for validation by
+  #   :mx       - DNS MX Record lookup
+  #   :a        - DNS A Record lookup (as some domains don't specify an MX incorrectly)
+  #   :off      - Do not perform DNS lookup (Test mode, network unavailable)
+  #
+  # * sha1_secret         ""
+  #   This application-level secret is appended to the email_address to compute
+  #   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.
+  #
+  # For local part configuration:
+  # * local_downcase:     true
+  #   Downcase the local part. You probably want this for uniqueness.
+  #   RFC says local part is case insensitive, that's a bad part.
+  #
+  # * local_fix:          true,
+  #   Make simple fixes when available, remove spaces, condense multiple punctuations
+  #
+  # * local_encoding:     :ascii, :unicode,
+  #   Enable Unicode in local part. Most mail systems do not yet support this.
+  #   You probably want to stay with ASCII for now.
+  #
+  # * local_parse:        nil, ->(local) { [mailbox, tag, comment] }
+  #   Specify an optional lambda/Proc to parse the local part. It should return an
+  #   array (tuple) of mailbox, tag, and comment.
+  #
+  # * local_format:       :conventional, :relaxed, :redacted, :standard, Proc
+  #   :conventional       word ( puncuation{1} word )*
+  #   :relaxed            alphanum ( allowed_characters)* alphanum
+  #   :standard           RFC Compliant email addresses (anything goes!)
+  #
+  # * local_size:         1..64,
+  #   A Range specifying the allowed size for mailbox + tags + comment
+  #
+  # * tag_separator:      nil, character (+)
+  #   Nil, or a character used to split the tag from the mailbox
+  #
+  # For the mailbox (AKA account, role), without the tag
+  # * mailbox_size:       1..64
+  #   A Range specifying the allowed size for mailbox
+  #
+  # * mailbox_canonical:  nil, ->(mailbox) { mailbox }
+  #   An optional lambda/Proc taking a mailbox name, returning a canonical
+  #   version of it. (E.G.: gmail removes '.' characters)
+  #
+  # * mailbox_validator:  nil, ->(mailbox) { true }
+  #   An optional lambda/Proc taking a mailbox name, returning true or false.
+  #
+  # * host_encoding:      :punycode,  :unicode,
+  #   How to treat International Domain Names (IDN). Note that most mail and
+  #   DNS systems do not support unicode, so punycode needs to be passed.
+  #   :punycode           Convert Unicode names to punycode representation
+  #   :unicode            Keep Unicode names as is.
+  #
+  # * host_validation:
+  #   :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 (not implemented, BAD!)
+  #
+  # * host_size:          1..253,
+  #   A range specifying the size limit of the host part,
+  #
+  # * host_allow_ip:      false,
+  #   Allow IP address format in host: [127.0.0.1], [IPv6:::1]
+  #
+  # * address_validation: :parts, :smtp, ->(address) { true }
+  #   Address validation policy
+  #   :parts              Validate local and host.
+  #   :smtp               Validate via SMTP (not implemented, BAD!)
+  #   A lambda/Proc taking the address string, returning true or false
+  #
+  # * 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)
+
   class Config
-    @options = {
-       downcase_mailboxes: true,
-       check_dns:          true,
+    @config = {
+      dns_lookup:         :mx,  # :mx, :a, :off
+      sha1_secret:        "",
+      munge_string:       "*****",
+
+      local_downcase:     true,
+      local_fix:          true,
+      local_encoding:     :ascii, # :ascii, :unicode,
+      local_parse:        nil,   # nil, Proc
+      local_format:       :conventional, # :conventional, :relaxed, :redacted, :standard, Proc
+      local_size:         1..64,
+      tag_separator:      '+', # nil, character
+      mailbox_size:       1..64, # without tag
+      mailbox_canonical:  nil, # nil,  Proc
+      mailbox_validator:  nil, # nil,  Proc
+
+      host_encoding:      :punycode || :unicode,
+      host_validation:    :mx || :a || :connect,
+      host_size:          1..253,
+      host_allow_ip:      false,
+
+      address_validation: :parts, # :parts, :smtp, Proc
+      address_size:       3..254,
+      address_localhost:  false,
     }
 
     @providers = {
-       default: {
-         domains:           [],
-         exchangers:        [],
-         tag_separator:     '+',
-         case_sensitive:    false,
-         address_size:      3..254,
-         local_size:        1..64,
-         domain_size:       1..253,
-         mailbox_size:      1..64,
-         mailbox_unicode:   false,
-         canonical_mailbox: ->(m) {m},
-         valid_mailbox:     nil,  # :legible, :rfc, ->(m) {true}
-       },
-       aol: {
-         registration_names: %w(aol compuserve netscape aim cs)
-       },
-       google: {
-         domains:           %w(gmail.com googlemail.com),
-         exchangers:        %w(google.com),
-         local_size:        5..64,
-         canonical_mailbox: ->(m) {m.gsub('.','')},
-         #valid_mailbox:    ->(local) { local.mailbox =~ /\A[a-z0-9][\.a-z0-9]{5,29}\z/i},
-       },
-       msn: {
-         valid_mailbox:    ->(m) { m =~ /\A[a-z0-9][\.\-a-z0-9]{5,29}\z/i},
-       },
-       yahoo: {
-         domains:          %w(yahoo ymail rocketmail),
-         exchangers:       %w(yahoodns yahoo-inc),
-       },
+      aol: {
+        host_match:       %w(aol. compuserve. netscape. aim. cs.),
+      },
+      google: {
+        host_match:       %w(gmail.com googlemail.com),
+        exchanger_match:  %w(google.com),
+        local_size:       5..64,
+        mailbox_canonical: ->(m) {m.gsub('.','')},
+      },
+      msn: {
+        host_match:       %w(msn. hotmail. outlook. live.),
+        mailbox_validator: ->(m,t) { m =~ /\A[a-z0-9][\.\-a-z0-9]{5,29}\z/i},
+      },
+      yahoo: {
+        host_match:       %w(yahoo. ymail. rocketmail.),
+        exchanger_match:  %w(yahoodns yahoo-inc),
+      },
     }
 
-    def self.providers
-      @providers
+    # Set multiple default configuration settings
+    def self.configure(config={})
+      @config.merge!(config)
     end
 
-    #def provider(name, defn={})
-    #  EmailAddress::Config.providers[name] = defn
-    #end
-
-    def self.options
-      @options
+    def self.setting(name, *value)
+      name = name.to_sym
+      @config[name] = value.first if value.size > 0
+      @config[name]
     end
 
-    def self.provider(name)
-      @providers[:default].merge(@providers.fetch(name) { Hash.new })
+    # Returns the hash of Provider rules
+    def self.providers
+      @providers
     end
 
-    class Setup
-      attr_reader :providers
-
-      def initialize
-        @providers = {}
-      end
-
-      def do_block(&block)
-        instance_eval(&block)
-      end
-
-      def provider(name, defn={})
-        EmailAddress::Config.providers[name] = defn
-      end
-
-      def option(name, value)
-        EmailAddress::Config.options[name.to_sym] = value
+    # Configure or lookup a provider by name.
+    def self.provider(name, config={})
+      name = name.to_sym
+      if config.size > 0
+        @providers[name] ||= @config.clone
+        @providers[name].merge!(config)
       end
+      @providers[name]
     end
 
-    def self.setup(&block)
-      @setup ||= Setup.new
-      @setup.do_block(&block) if block_given?
-      @setup
+    def self.all_settings(*configs)
+      config = @config.clone
+      configs.each {|c| config.merge!(c) }
+      config
     end
   end
 end

data/lib/email_address/email_address_type.rb

@@ -1,28 +1,30 @@
 ################################################################################
 # ActiveRecord v5.0 Custom Type
-# This class is not automatically loaded by the gem.
-#-------------------------------------------------------------------------------
-# 1) Register this type
 #
-#    # config/initializers.types.rb
-#    require "email_address/email_address_type"
+# 1) Register your types
+#
+#    # config/initializers/email_address.rb
 #    ActiveRecord::Type.register(:email_address, EmailAddress::Address)
 #    ActiveRecord::Type.register(:canonical_email_address,
 #                                EmailAddress::CanonicalEmailAddressType)
 #
 # 2) Define your email address columns in your model class
 #
-#    class User < ActiveRecord::Base
+#    class User < ApplicationRecord
 #      attribute :email, :email_address
-#      attribute :unique_email, :canonical_email_address
+#      attribute :canonical_email, :canonical_email_address
+#
+#      def email=(email_address)
+#        self[:canonical_email] = email_address
+#        self[:email] = email_address
+#      end
 #    end
 #
 # 3) Profit!
 #
-#    user = User.new(email:"Pat.Smith+registrations@gmail.com",
-#                    unique_email:"Pat.Smith+registrations@gmail.com")
-#    user.email        #=> "pat.smith+registrations@gmail.com"
-#    user.unique_email #=> "patsmith@gmail.com"
+#    user = User.new(email:"Pat.Smith+registrations@gmail.com")
+#    user.email           #=> "pat.smith+registrations@gmail.com"
+#    user.canonical_email #=> "patsmith@gmail.com"
 ################################################################################
 
 class EmailAddress::EmailAddressType < ActiveRecord::Type::Value
@@ -34,29 +36,11 @@ class EmailAddress::EmailAddressType < ActiveRecord::Type::Value
 
   # From a database value
   def deserialize(value)
-    EmailAddress.normal(value)
+    value && EmailAddress.normal(value)
   end
   #
   # To a database value (string)
   def serialize(value)
-    EmailAddress.normal(value)
-  end
-end
-
-class CanonicalEmailAddressType < EmailAddress::EmailAddressType
-
-  # From user input, setter
-  def cast(value)
-    super(EmailAddress.canonical(value))
-  end
-
-  # From a database value
-  def deserialize(value)
-    EmailAddress.canonical(value)
-  end
-
-  # To a database value (string)
-  def serialize(value)
-    EmailAddress.canonical(value)
+    value && EmailAddress.normal(value)
   end
 end

data/lib/email_address/exchanger.rb

@@ -20,9 +20,9 @@ module EmailAddress
       end
     end
 
-    def initialize(host, options={})
+    def initialize(host, config={})
       @host = host
-      @options = options
+      @config = config
     end
 
     def each(&block)
@@ -33,24 +33,13 @@ module EmailAddress
 
     # Returns the provider name based on the MX-er host names, or nil if not matched
     def provider
-      base = EmailAddress::Config.providers[:default]
-      EmailAddress::Config.providers.each do |name, defn|
-        defn = base.merge(defn)
-        self.each do |m|
-         return name if DomainMatcher.matches?(m[:host], defn[:exchangers])
+      return @provider if @provider
+      EmailAddress::Config.providers.each do |provider, config|
+        if config[:exchanger_match] && self.matches?(config[:exchanger_match])
+          return @provider = provider
         end
       end
-      nil
-    end
-
-    def has_dns_a_record?
-      dns_a_record.size > 0 ? true : false
-    end
-
-    def dns_a_record
-      @_dns_a_record ||= Socket.gethostbyname(@host)
-    rescue SocketError # not found, but could also mean network not work
-      @_dns_a_record ||= []
+      @provider = :default
     end
 
     # 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]]
@@ -66,7 +55,7 @@ module EmailAddress
 
     # Returns Array of domain names for the MX'ers, used to determine the Provider
     def domains
-      mxers.map {|m| EmailAddress::DomainParser.new(m.first).domain_name}.sort.uniq
+      @_domains ||= mxers.map {|m| EmailAddress::Host.new(m.first).domain_name }.sort.uniq
     end
 
     # Returns an array of MX IP address (String) for the given email domain
@@ -74,26 +63,34 @@ module EmailAddress
       mxers.map {|m| m[1] }
     end
 
+    # Simple matcher, takes an array of CIDR addresses (ip/bits) and strings.
+    # Returns true if any MX IP matches the CIDR or host name ends in string.
+    # Ex: match?(%w(127.0.0.1/32 0:0:1/64 .yahoodns.net))
+    # Note: Your networking stack may return IPv6 addresses instead of IPv4
+    # when both are available. If matching on IP, be sure to include both
+    # IPv4 and IPv6 forms for matching for hosts running on IPv6 (like gmail).
+    def matches?(rules)
+      rules = Array(rules)
+      rules.each do |rule|
+        if rule.include?("/")
+          return rule if self.in_cidr?(rule)
+        else
+          self.each {|mx| return rule if mx[:host].end_with?(rule) }
+        end
+      end
+      false
+    end
+
     # Given a cidr (ip/bits) and ip address, returns true on match. Caches cidr object.
     def in_cidr?(cidr)
+      c = NetAddr::CIDR.create(cidr)
       if cidr.include?(":")
-        in_ipv6_cidr?(cidr)
+        mx_ips.find { |ip| ip.include?(":") && c.matches?(ip) } ? true : false
+      elsif cidr.include?(".")
+        mx_ips.find { |ip| !ip.include?(":") && c.matches?(ip) } ? true : false
       else
-        in_ipv4_cidr?(cidr)
+        false
       end
     end
-
-    private
-
-    def in_ipv4_cidr?(cidr)
-      cidr = NetAddr::CIDR.create(cidr)
-      mx_ips.find { |ip| !ip.include?(":") && cidr.matches?(ip) } ? true : false
-    end
-
-    def in_ipv6_cidr?(cidr)
-      cidr = NetAddr::CIDR.create(cidr)
-      mx_ips.find { |ip| ip.include?(":") && cidr.matches?(ip) } ? true : false
-    end
-
   end
 end