email_repair 0.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d81deac964185bcd7e75e10d32bb25af1e591250
-  data.tar.gz: d8001888aac57df3008c145e4c5ea344fa760efa
+SHA256:
+  metadata.gz: 5ee85877aa4e7df7d05e7084df4553209c6de6f4d555fe16ddd13070628f5ca5
+  data.tar.gz: e1ace67bbe8264421ae9c73dd77a7dde04097d694a90fcfae608b21e49d8e3be
 SHA512:
-  metadata.gz: ab4bce6136b84fae7ea1ab9c3cc8ca95b7e5dfc6e7053286cdc93b5eed6a26668c9ea6d1d9188024aceb7fd5e578327452e3cc91ec07f720dd0e56e16cce9a68
-  data.tar.gz: cd70ccc7af7c13ec14628a58c36c0d964679b7a3ed8f5f4a08fb2f7273085d00935d27501af85a83c99017a38de66721a051848dfbda239c47ed0fe2f9555b49
+  metadata.gz: 58d21040563feed012c9218fb37f94173b895718ba103ff7d626e4dc3edb9c3c2c76f1f4395462522045b8eb88ad2ba393c81e995e709daaf663657a617c6e17
+  data.tar.gz: 66a4f543f9db2cf547dacfdb4eed8d55d1e9a98a9d6a9b7a2d5ca3ad9461769857458ccf18f02ff3faedc9b508634e0b36e4db13e681ea6f3444786d0fa133fe

data/README.md

@@ -4,7 +4,8 @@
 [![Build Status](https://travis-ci.org/ChalkSchools/email-repair.svg?branch=master)](https://travis-ci.org/ChalkSchools/email-repair)
 [![Coverage Status](https://img.shields.io/coveralls/ChalkSchools/email-repair.svg)](https://coveralls.io/r/ChalkSchools/email-repair?branch=master)
 
-TODO: Write a gem description
+Email Repair is a utility for sanitizing and validating user-provided email
+address.
 
 ## Installation
 
@@ -22,7 +23,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'email_repair'
+require 'ostruct'
+
+EmailRepair::Mechanic.new.repair('blah@gmail')
+# "blah@gmail.com"
+
+EmailRepair::Mechanic.new.repair_all(%w[One@@two.com bleep@blop plooooooop])
+# <OpenStruct sanitized_emails=["one@two.com"], invalid_emails=["bleep@blop", "plooooooop"]>
+```
+
+### Public Methods
+
+#### EmailRepair::Mechanic#repair(email)
+
+Takes a single email address, applies the available repairs to it and returns
+the repaired email. If the email cannot be repaired, `nil` is returned instead.
+
+#### EmailRepair::Mechanic#repair_all(emails)
+
+Takes an array of emails, applies available repairs to each email and returns an
+`OpenStruct` containing keys `sanitized_emails:` with a unique array of the
+emails that were able to be repaired, and `invalid_emails:` with unique array of
+the emails that were unable to be repaired
+
+#### EmailRepair::Constants::email_regex
+
+Returns a regular expression to be used to validate user-supplied email
+addresses.
+
+### Available Repairs
+
+#### CommonMistakeRepair
+
+Repairs common email typos:
+* downcases the email
+* removes white space
+* removes duplicate @ symbols
+* replaces `.c0m` with `.com`
+* replaces commas with periods
+
+#### CommonDomainSuffixRepair
+
+Adds missing top-level domain for common email domains. For example, it replaces
+`blah@gmail` with `blah@gmail.com`.
+
+#### CommonDomainPeriodAdder
+
+Adds missing period between the domain and top-level domain for common email
+domains. For example, it replaces `blah@gmailcom` with `blah@gmail.com`.
+
+#### CommonDomainAtAdder
+
+Replaces '#', '.', or '-', with '@', or adds missing @ symbol for common
+domains. For example, it replaces `blahgmail.com` and `blah#gmail.com` with
+`blah@gmail.com`.
+
+#### CommonDomainSwapRepair
+
+Fixes swapped letters ('ia' instead of 'ai') in common domains. For example, it
+replaces `blah@gmial.com` with `blah@gmail.com`.
+
+#### EmailRegexRepair
+
+Extracts the email address from strings that contain other text. For example, it
+replaces `blah <blah@email.com>` with `blah@email.com`.
 
 ## Contributing
 

data/lib/email_repair/constants.rb

@@ -4,7 +4,7 @@ module EmailRepair
       def email_regex
         local_part_regex = "[#{valid_chars}]" \
           "([#{valid_chars_with_dot}]*[#{valid_chars}])?"
-        /#{local_part_regex}@(?:[a-z0-9\-]+\.)+(?:[a-z]{2,24})/
+        /#{local_part_regex}@(?:[a-zA-Z0-9\-]+\.)+(?:[a-zA-Z]{2,24})/
       end
 
     private
@@ -14,7 +14,7 @@ module EmailRepair
       end
 
       def valid_chars
-        'a-z0-9_%\+\-\''
+        'a-zA-Z0-9_%\+\-\''
       end
     end
   end

data/lib/email_repair/mechanic.rb

@@ -42,10 +42,10 @@ module EmailRepair
     class CommonMistakeRepair
       def self.repair(email)
         email.downcase
-          .gsub(/\s/, '')
-          .sub(/@+/, '@')
-          .sub(/\.c0m$/, '.com')
-          .sub(/,[a-z]{2,24}$/) { |m| m.sub(',', '.') }
+             .gsub(/\s/, '')
+             .sub(/@+/, '@')
+             .sub(/\.c0m$/, '.com')
+             .sub(/,[a-z]{2,24}$/) { |m| m.sub(',', '.') }
       end
     end
 
@@ -58,7 +58,7 @@ module EmailRepair
 
     class CommonDomainRepair
       def self.repair(*)
-        fail 'not implemented'
+        raise 'not implemented'
       end
 
       def self.common_domains
@@ -78,7 +78,7 @@ module EmailRepair
     class CommonDomainSuffixRepair < CommonDomainRepair
       def self.repair(email)
         common_domains.each do |name, suffix|
-          email = "#{email}.#{suffix}" if email.match(/#{name}$/)
+          email = "#{email}.#{suffix}" if email.match?(/#{name}$/)
         end
         email
       end
@@ -100,7 +100,7 @@ module EmailRepair
           punc_regex = /[.#-]#{name}.#{suffix}$/
           if email.match(punc_regex)
             email = email.sub(punc_regex, "@#{name}.#{suffix}")
-          elsif email.match(/[^@]#{name}.#{suffix}$/)
+          elsif email.match?(/[^@]#{name}.#{suffix}$/)
             email = email.sub(/#{name}.#{suffix}$/, "@#{name}.#{suffix}")
           end
         end

data/lib/email_repair/version.rb

@@ -1,3 +1,3 @@
 module EmailRepair
-  VERSION = '0.2.0'
+  VERSION = '2.0.0'.freeze
 end

data/spec/lib/email_repair/constants_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+module EmailRepair
+  describe Constants, '.email_regex' do
+    it 'allows capital letters' do
+      expect('ICan.CaPitAliZe@hOwI.WanT')
+        .to match(/\A#{EmailRepair::Constants.email_regex}\z/)
+    end
+  end
+end

data/spec/lib/email_repair/mechanic_spec.rb

@@ -2,12 +2,11 @@ require 'spec_helper'
 
 module EmailRepair
   describe Mechanic, '#repair_all' do
-
     it 'sanitizes an array of emails and returns bulk results' do
       mechanic = Mechanic.new
-      salvageable_emails = %w(One@@two.com three@four.com one@twO.com)
-      sanitized_emails = %w(one@two.com three@four.com)
-      bad_emails = %w(bleep@blop plooooooop plooOOooop)
+      salvageable_emails = %w[One@@two.com three@four.com one@twO.com]
+      sanitized_emails = %w[one@two.com three@four.com]
+      bad_emails = %w[bleep@blop plooooooop plooOOooop]
 
       result = mechanic.repair_all(salvageable_emails + bad_emails)
       expect(result.sanitized_emails).to match_array sanitized_emails
@@ -23,7 +22,6 @@ module EmailRepair
       expect(result.sanitized_emails).to eq ['bleep@bloop.com']
       expect(result.invalid_emails).to eq []
     end
-
   end
 
   describe Mechanic, '#repair' do
@@ -34,7 +32,7 @@ module EmailRepair
       # http://www.stuffaboutcode.com/2013/02/validating-email-address-bloody.html
       # List of longest TLDs
       # https://jasontucker.blog/8945/what-is-the-longest-tld-you-can-get-for-a-domain-name
-      good_emails = %w(
+      good_emails = %w[
         b@b.com
         lobatifricha@gmail.com
         mrspicy+whocares@whatevs.com
@@ -43,7 +41,7 @@ module EmailRepair
         b@mps.school
         b@kickstarter.engineering
         b@joyful.christmas
-      )
+      ]
 
       good_emails.each do |good_email|
         expect(mechanic.repair(good_email)).to eq good_email
@@ -73,7 +71,7 @@ module EmailRepair
     end
 
     it 'adds missing .com' do
-      no_com_mails = %w(blah@gmail bloo@yahoo blee@hotmail)
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_repair
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Holman Gao
@@ -9,8 +9,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
-dependencies: []
+date: 2023-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.2
 description: 
 email:
 - holman@golmansax.com
@@ -25,6 +81,7 @@ files:
 - lib/email_repair/constants.rb
 - lib/email_repair/mechanic.rb
 - lib/email_repair/version.rb
+- spec/lib/email_repair/constants_spec.rb
 - spec/lib/email_repair/mechanic_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ChalkSchools/email-repair
@@ -46,11 +103,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Library to fix invalid emails
 test_files:
-- spec/spec_helper.rb
+- spec/lib/email_repair/constants_spec.rb
 - spec/lib/email_repair/mechanic_spec.rb
+- spec/spec_helper.rb