mailcheck 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailcheck.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Scott Becker
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Mailcheck
+
+A ruby translation of the [Kicksend mailcheck](https://github.com/Kicksend/mailcheck) javascript library which suggests a right domain when your users misspell it in an email address.
+
+When your user types in "user@hotnail.con", Mailcheck will suggest "user@hotmail.com".
+
+Mailcheck will offer up suggestions for top level domains too, and suggest ".com" when a user types in "user@hotmail.cmo".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailcheck'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailcheck
+
+## Usage
+
+```ruby
+> require 'mailcheck'
+
+> mailcheck = Mailcheck.new
+> mailcheck.suggest("user@hotma.com")
+# => {
+#   :address =>"user",
+#   :domain  =>"hotmail.com",
+#   :full    =>"user@hotmail.com"
+# }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+* [Mailcheck.js](https://github.com/Kicksend/mailcheck): the original idea
+* [This gist](https://gist.github.com/mmmaia/3715790), by [mmmaia](https://github.com/mmmaia) - an initial port to Ruby

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/mailcheck.rb

@@ -0,0 +1,136 @@
+require "mailcheck/version"
+
+class Mailcheck
+
+  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']
+
+  def initialize(opts={})
+    @domains = opts[:domains] || DOMAINS
+    @top_level_domains = opts[:top_level_domains] || TOP_LEVEL_DOMAINS
+  end
+
+  def suggest(email)
+    email_parts = split_email(email.downcase)
+
+    return false if email_parts == false
+
+    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
+
+  def find_closest_domain(domain, domains)
+    min_dist = 99
+
+    for i in 0...domains.length do
+      if domain === domains[i]
+        return domain
+      end
+      dist = sift_3distance(domain, domains[i])
+      if dist < min_dist
+        min_dist = dist
+        closest_domain = domains[i]
+      end
+    end
+
+    if min_dist <= THRESHOLD && closest_domain
+      closest_domain
+    else
+      false
+    end
+  end
+
+  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
+        for i in 0...max_offset do
+          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
+    return (s1.length + s2.length) / 2 - lcs
+  end
+
+  def split_email(email)
+
+    parts = email.split('@')
+
+    if parts.length < 2
+      return false
+    end
+
+    for i in 0...parts.length do
+      if parts[i] === ''
+        return false
+      end
+    end
+
+    domain = parts.pop
+    domain_parts = domain.split('.')
+    tld = ''
+
+    if domain_parts.length == 0
+      # The address does not have a top-level domain
+      return false
+    elsif domain_parts.length == 1
+      # The address has only a top-level domain (valid under RFC)
+      tld = domain_parts[0]
+    else
+      # The address has a domain and a top-level domain
+      for i in 1...domain_parts.length do
+        tld << "#{domain_parts[i]}."
+      end
+      if domain_parts.length >= 2
+        tld = tld[0, tld.length - 1]
+      end
+    end
+
+    {
+      :top_level_domain => tld,
+      :domain => domain,
+      :address => parts.join('@')
+    }
+  end
+end

data/lib/mailcheck/version.rb

@@ -0,0 +1,3 @@
+class Mailcheck
+  VERSION = "0.0.1"
+end

data/mailcheck.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mailcheck/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Scott Becker"]
+  gem.email         = ["becker.scott@gmail.com"]
+  gem.description   = %q{A ruby translation of the Kicksend mailcheck javascript library (https://github.com/Kicksend/mailcheck) which suggests a right domain when your users misspell it in an email address.}
+  gem.summary       = %q{When your user types in "user@hotnail.con", Mailcheck will suggest "user@hotmail.com". Mailcheck will offer up suggestions for top level domains too, and suggest ".com" when a user types in "user@hotmail.cmo".}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mailcheck"
+  gem.require_paths = ["lib"]
+  gem.version       = Mailcheck::VERSION
+  gem.add_development_dependency 'rspec', '~> 2.12'
+end

data/spec/mailcheck_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Mailcheck do
+
+  before do
+    @domains = ['yahoo.com', 'yahoo.com.tw', 'google.com','hotmail.com', 'gmail.com', 'emaildomain.com', 'comcast.net', 'facebook.com', 'msn.com', 'gmx.com']
+    @top_level_domains = ['co.uk', 'com', 'org', 'info']
+    @mailcheck = Mailcheck.new
+  end
+
+  describe "#suggest" do
+    it "returns a hash of the address, domain, and full email address when there's a suggestion" do
+      suggestion = @mailcheck.suggest("user@hotma.com")
+
+      suggestion[:address].should == 'user'
+      suggestion[:domain].should  == 'hotmail.com'
+      suggestion[:full].should    == 'user@hotmail.com'
+    end
+
+    it "is false when there's no suggestion" do
+      @mailcheck.suggest("user@hotmail.com").should be_false
+    end
+
+    it "is false when an imcomplete email is provided" do
+      @mailcheck.suggest("contact").should be_false
+    end
+  end
+
+  describe "cases" do
+    it "passes" do
+      mailcheck = Mailcheck.new :domains => @domains, :top_level_domains => @top_level_domains
+
+      mailcheck.suggest('test@emaildomain.co')[:domain].should == 'emaildomain.com'
+      mailcheck.suggest('test@gmail.con')[:domain].should == 'gmail.com'
+      mailcheck.suggest('test@gnail.con')[:domain].should == 'gmail.com'
+      mailcheck.suggest('test@GNAIL.con')[:domain].should == 'gmail.com'
+      mailcheck.suggest('test@#gmail.com')[:domain].should == 'gmail.com'
+      mailcheck.suggest('test@comcast.com')[:domain].should == 'comcast.net'
+      mailcheck.suggest('test@homail.con')[:domain].should == 'hotmail.com'
+      mailcheck.suggest('test@hotmail.co')[:domain].should == 'hotmail.com'
+      mailcheck.suggest('test@fabecook.com')[:domain].should == 'facebook.com'
+      mailcheck.suggest('test@yajoo.com')[:domain].should == 'yahoo.com'
+      mailcheck.suggest('test@randomsmallcompany.cmo')[:domain].should == 'randomsmallcompany.com'
+      mailcheck.suggest('test@yahoo.com.tw').should be_false
+      mailcheck.suggest('').should be_false
+      mailcheck.suggest('test@').should be_false
+      mailcheck.suggest('test').should be_false
+
+      # This test is for illustrative purposes as the splitEmail function should return a better
+      # representation of the true top-level domain in the case of an email address with subdomains.
+      # mailcheck will be unable to return a suggestion in the case of this email address.
+      #
+      mailcheck.suggest('test@mail.randomsmallcompany.cmo').should be_false
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'mailcheck'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: mailcheck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: A ruby translation of the Kicksend mailcheck javascript library (https://github.com/Kicksend/mailcheck)
+  which suggests a right domain when your users misspell it in an email address.
+email:
+- becker.scott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mailcheck.rb
+- lib/mailcheck/version.rb
+- mailcheck.gemspec
+- spec/mailcheck_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: When your user types in "user@hotnail.con", Mailcheck will suggest "user@hotmail.com".
+  Mailcheck will offer up suggestions for top level domains too, and suggest ".com"
+  when a user types in "user@hotmail.cmo".
+test_files:
+- spec/mailcheck_spec.rb
+- spec/spec_helper.rb