email_repair 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2478611e83b838e0f167bdc0e787c011d603ae52
+  data.tar.gz: 706c5df6c7a189c2a8286ff7cb9c9b573194ea2d
+SHA512:
+  metadata.gz: 1b989bbefba3f3ea48c011b47bda1336791e1519178df3f76cd19c41175484e986002a269948d6f184ac88b26ae1d6b92718cc8768f59aae91aa80a6a9f53109
+  data.tar.gz: b7ba04723f437e65108f05c1e0a33b143f39a4277b3fc7447327df5a8fcfda8092733acb42e7b18aab604068339f96131b192df6b4e3dd2dd48d222e58c05566

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Emics, Inc.
+
+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,31 @@
+# Email Repair
+
+[![Build Status](https://travis-ci.org/ChalkSchools/email-repair.svg?branch=master)](https://travis-ci.org/ChalkSchools/email-repair)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'email_repair'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_repair
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/email_repair/fork )
+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 a new Pull Request

data/lib/email_repair.rb

@@ -0,0 +1,3 @@
+require 'email_repair/constants'
+require 'email_repair/mechanic'
+require 'email_repair/version'

data/lib/email_repair/constants.rb

@@ -0,0 +1,12 @@
+module EmailRepair
+  class Constants
+    def self.email_regex
+      local_part_regex = "[#{email_local_part_valid_chars}]+"
+      /#{local_part_regex}@(?:[a-z0-9\-]+\.)+(?:museum|travel|[a-z]{2,4})/
+    end
+
+    def self.email_local_part_valid_chars
+      'a-z0-9_\.%\+\-\''
+    end
+  end
+end

data/lib/email_repair/mechanic.rb

@@ -0,0 +1,120 @@
+module EmailRepair
+  class Mechanic
+    def repairs
+      [
+        CommonMistakeRepair,
+        CommonDomainSuffixRepair,
+        CommonDomainPeriodAdder,
+        CommonDomainAtAdder,
+        CommonDomainSwapRepair,
+        EmailRegexRepair,
+      ]
+    end
+
+    def repair(email)
+      return unless email
+
+      repairs.each { |repair| email = repair.repair(email) }
+
+      email
+    end
+
+    class CommonMistakeRepair
+      def self.repair(email)
+        email.downcase
+          .gsub(/\s/, '')
+          .sub(/@+/, '@')
+          .sub(/\.c0m$/, '.com')
+          .sub(/,[a-z]{2,4}$/) { |m| m.sub(',', '.') }
+      end
+    end
+
+    class EmailRegexRepair
+      def self.repair(email)
+        match = email.match(/(#{EmailRepair::Constants.email_regex})/)
+        match && match.captures.first
+      end
+    end
+
+    class CommonDomainRepair
+      def self.repair(*)
+        fail 'not implemented'
+      end
+
+      def self.common_domains
+        {
+          'gmail' => 'com',
+          'yahoo' => 'com',
+          'hotmail' => 'com',
+          'att' => 'net',
+          'chalkschools' => 'com',
+          'sbcglobal' => 'net',
+          'aol' => 'com',
+          'earthlink' => 'net',
+        }
+      end
+    end
+
+    class CommonDomainSuffixRepair < CommonDomainRepair
+      def self.repair(email)
+        common_domains.each do |name, suffix|
+          email = "#{email}.#{suffix}" if email.match(/#{name}$/)
+        end
+        email
+      end
+    end
+
+    class CommonDomainPeriodAdder < CommonDomainRepair
+      def self.repair(email)
+        common_domains.each do |name, suffix|
+          regex = /#{name}#{suffix}$/
+          email = email.sub(regex, "#{name}.#{suffix}") if email.match(regex)
+        end
+        email
+      end
+    end
+
+    class CommonDomainAtAdder < CommonDomainRepair
+      def self.repair(email)
+        common_domains.each do |name, suffix|
+          punc_regex = /[.#-]#{name}.#{suffix}$/
+          if email.match(punc_regex)
+            email = email.sub(punc_regex, "@#{name}.#{suffix}")
+          elsif email.match(/[^@]#{name}.#{suffix}$/)
+            email = email.sub(/#{name}.#{suffix}$/, "@#{name}.#{suffix}")
+          end
+        end
+        email
+      end
+    end
+
+    class CommonDomainSwapRepair < CommonDomainRepair
+      def self.repair(email)
+        swapped_names.each do |swapped, real|
+          suffix = common_domains[real]
+          regex = /#{swapped}.#{suffix}$/
+          email = email.sub(regex, "#{real}.#{suffix}") if email.match(regex)
+        end
+        email
+      end
+
+      def self.swapped_names
+        @domain_keys ||= common_domains.keys
+        @swapped_names ||= @domain_keys.each_with_object({}) do |name, result|
+          swap_name(name).each { |swapped_name| result[swapped_name] = name }
+        end
+      end
+
+      def self.swap_name(str)
+        result = []
+        (str.length - 1).times do |pos|
+          beginning = str[0...pos]
+          middle = "#{str[pos + 1]}#{str[pos]}"
+          the_end = str[(pos + 2)..-1]
+          result << "#{beginning}#{middle}#{the_end}"
+        end
+        result
+      end
+    end
+  end
+end

data/lib/email_repair/version.rb

@@ -0,0 +1,3 @@
+module EmailRepair
+  VERSION = '0.0.1'
+end

data/spec/lib/email_repair/mechanic_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+module EmailRepair
+  describe Mechanic, '#repair' do
+
+    let(:mechanic) { Mechanic.new }
+
+    it 'returns clean emails as is' do
+      # Rant about apostrophe in email
+      # http://www.stuffaboutcode.com/2013/02/validating-email-address-bloody.html
+      good_emails = %w(
+        b@b.com
+        lobatifricha@gmail.com
+        mrspicy+whocares@whatevs.com
+        your.mom@the.museum
+        martin.o'hanlon@mycompany.com
+      )
+
+      good_emails.each do |good_email|
+        expect(mechanic.repair(good_email)).to eq good_email
+      end
+    end
+
+    it 'returns nil for nil email' do
+      expect(mechanic.repair(nil)).to be_nil
+    end
+
+    it 'returns nil for strings that have no email' do
+      ['', ' ', 'NOT AN EMAIL', 'b at b dot com'].each do |not_email|
+        expect(mechanic.repair(not_email)).to be_nil
+      end
+    end
+
+    it 'returns the email with the spaces stripped out' do
+      space_mails = {
+        'somebody@gmail.com ' => 'somebody@gmail.com',
+        'email withspace@blah.com' => 'emailwithspace@blah.com',
+        'emailwithspace@blah .com' => 'emailwithspace@blah.com',
+      }
+
+      space_mails.each do |in_mail, out_mail|
+        expect(mechanic.repair(in_mail)).to eq out_mail
+      end
+    end
+
+    it 'adds missing .com' do
+      no_com_mails = %w(blah@gmail bloo@yahoo blee@hotmail)
+      no_com_mails.each do |no_com_mail|
+        expect(mechanic.repair(no_com_mail)).to eq "#{no_com_mail}.com"
+      end
+    end
+
+    it 'trims extra @ signs' do
+      expect(mechanic.repair('b@@@b.com')).to eq 'b@b.com'
+    end
+
+    it 'changes c0m to com' do
+      expect(mechanic.repair('b0b@b0b.c0m')).to eq 'b0b@b0b.com'
+    end
+
+    it 'fixes a missing .' do
+      expect(mechanic.repair('who@gmailcom')).to eq 'who@gmail.com'
+      expect(mechanic.repair('what@hotmailcom')).to eq 'what@hotmail.com'
+    end
+
+    it 'fixes letter swap' do
+      expect(mechanic.repair('bloo@yhaoo.com')).to eq 'bloo@yahoo.com'
+    end
+
+    it 'adds a missing @ for common domains' do
+      dirty_emails = {
+        'blahgmailcom' => 'blah@gmail.com',
+        'blooearthlink.net' => 'bloo@earthlink.net',
+        'gooberssbcglobal.net' => 'goobers@sbcglobal.net',
+        'booger800yahoo.com' => 'booger800@yahoo.com',
+        'butt2630att.net' => 'butt2630@att.net',
+        'byjove28024aol.com' => 'byjove28024@aol.com',
+      }
+
+      dirty_emails.each do |in_mail, out_mail|
+        expect(mechanic.repair(in_mail)).to eq out_mail
+      end
+    end
+
+    it 'swaps a # for an @ for common domains' do
+      expect(mechanic.repair('pound#yahoo.com')).to eq 'pound@yahoo.com'
+    end
+
+    it 'swaps a - for an @ for common domains' do
+      dirty_emails = {
+        'chou.sa+aea-gmail.com' => 'chou.sa+aea@gmail.com',
+        'sarah+aea-chalkschools.com' => 'sarah+aea@chalkschools.com',
+      }
+      dirty_emails.each do |in_mail, out_mail|
+        expect(mechanic.repair(in_mail)).to eq out_mail
+      end
+    end
+
+    it 'replaces , with .' do
+      expect(mechanic.repair('b@b,com')).to eq 'b@b.com'
+    end
+
+    it 'grabs an email out of the string' do
+      dirty_emails = {
+        'Awesome,Test Driver,aperson@gmail.com' => 'aperson@gmail.com',
+        'one@email.com, another@email.com' => 'one@email.com',
+        'one@email.com,another@email.com' => 'one@email.com',
+        'one@email.com;another@email.com' => 'one@email.com',
+        '<one@email.com>' => 'one@email.com',
+      }
+
+      dirty_emails.each do |in_mail, out_mail|
+        expect(mechanic.repair(in_mail)).to eq out_mail
+      end
+    end
+
+    it 'downcases emails' do
+      dirty_emails = {
+        'ONE@email.com, another@email.com' => 'one@email.com',
+        'email WITHSPACE@blah.com' => 'emailwithspace@blah.com',
+        'lobatifricha@GMAIL.com' => 'lobatifricha@gmail.com',
+      }
+
+      dirty_emails.each do |in_mail, out_mail|
+        expect(mechanic.repair(in_mail)).to eq out_mail
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/email_repair'
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: email_repair
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Holman Gao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-25 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- holman@golmansax.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/email_repair.rb
+- lib/email_repair/constants.rb
+- lib/email_repair/mechanic.rb
+- lib/email_repair/version.rb
+- spec/lib/email_repair/mechanic_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ChalkSchools/email-repair
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Library to fix invalid emails
+test_files:
+- spec/lib/email_repair/mechanic_spec.rb
+- spec/spec_helper.rb