Class: Mailcheck

Inherits:
Object
  • Object
show all
Defined in:
lib/mailcheck.rb,
lib/mailcheck/version.rb

Constant Summary collapse

THRESHOLD = 
3
DOMAINS = 
['yahoo.com', 'google.com', 'hotmail.com', 'gmail.com', 'me.com', 'aol.com', 'mac.com', 'live.com', 'comcast.net', 'googlemail.com', 'msn.com', 'hotmail.co.uk', 'yahoo.co.uk', 'facebook.com', 'verizon.net', 'sbcglobal.net', 'att.net', 'gmx.com', 'mail.com']
TOP_LEVEL_DOMAINS = 
['co.uk', 'com', 'net', 'org', 'info', 'edu', 'gov', 'mil']
VERSION = 
"1.0.0"

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Mailcheck

Returns a new instance of Mailcheck.



11
12
13
14
 
# File 'lib/mailcheck.rb', line 11

def initialize(opts = {})
  @domains = opts[:domains] || DOMAINS
  @top_level_domains = opts[:top_level_domains] || TOP_LEVEL_DOMAINS
end

Instance Method Details

#find_closest_domain(domain, domains) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/mailcheck.rb', line 44

def find_closest_domain(domain, domains)
  min_dist = 99
  closest_domain = nil
  return nil if domains.nil? || domains.size == 0

  domains.each do |dmn|
    return domain if domain == dmn
    dist = sift_3distance(domain, dmn)
    if dist < min_dist
      min_dist = dist
      closest_domain = dmn
    end
  end

  if min_dist <= THRESHOLD && closest_domain
    closest_domain
  else
    nil
  end
end

#sift_3distance(s1, s2) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/mailcheck.rb', line 65

def sift_3distance(s1, s2)
  # sift3: http:#siderite.blogspot.com/2007/04/super-fast-and-accurate-string-distance.html

  c = 0
  offset1 = 0
  offset2 = 0
  lcs = 0
  max_offset = 5

  while (c + offset1 < s1.length) && (c + offset2 < s2.length) do
    if s1[c + offset1] == s2[c + offset2]
      lcs += 1
    else
      offset1 = 0
      offset2 = 0
      max_offset.times do |i|
        if c + i < s1.length && s1[c + i] == s2[c]
          offset1 = i
          break
        end
        if c + i < s2.length && s1[c] == s2[c + i]
          offset2 = i
          break
        end
      end
    end
    c += 1
  end
  (s1.length + s2.length) / 2.0 - lcs
end

#split_email(email) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/mailcheck.rb', line 96

def split_email(email)
  parts = email.split('@')

  return false if parts.length < 2 || parts.any?{ |p| p == '' }

  domain = parts.pop
  domain_parts = domain.split('.')

  return false if domain_parts.length == 0

  {
    :top_level_domain => domain_parts[1..-1].join('.'),
    :domain => domain,
    :address => parts.first
  }
end

#suggest(email) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/mailcheck.rb', line 16

def suggest(email)
  email_parts = split_email(email.downcase)

  return false unless email_parts

  closest_domain = find_closest_domain(email_parts[:domain], @domains)

  if closest_domain
    if closest_domain != email_parts[:domain]
      # The email address closely matches one of the supplied domains return a suggestion
      return { :address => email_parts[:address], :domain => closest_domain, :full => "#{email_parts[:address]}@#{closest_domain}" }
    end
  else
    # The email address does not closely match one of the supplied domains
    closest_top_level_domain = find_closest_domain(email_parts[:top_level_domain], @top_level_domains)
    if email_parts[:domain] && closest_top_level_domain && closest_top_level_domain != email_parts[:top_level_domain]
      # The email address may have a mispelled top-level domain return a suggestion
      domain = email_parts[:domain]
      closest_domain = domain[0, domain.rindex(email_parts[:top_level_domain])] + closest_top_level_domain
      return { :address => email_parts[:address], :domain => closest_domain, :full => "#{email_parts[:address]}@#{closest_domain}" }
    end
  end
  # The email address exactly matches one of the supplied domains, does not closely
  # match any domain and does not appear to simply have a mispelled top-level domain,
  # or is an invalid email address do not return a suggestion.
  false
end