email_typo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e88660e5189aac9b6ae40fcd5adb231927d2dee
+  data.tar.gz: 0d3954d0d96e5ba9d9fe234c249703620b0d2453
+SHA512:
+  metadata.gz: 1197d3487cfb81baea410d12ee935aa94b4dd4531ce4b0e142951ad92e26462118a6749a4d6c691a7fefd852757c2e3925dc460264ad428006c7018434386285
+  data.tar.gz: f79ea6363bfb8ef43ec3b055b601edcad0a075f5782f05abdefb9271c5d81845ffb7f8c56b089782268b66b4d5ad69d724e9026748b35e2c629c33a7b1d3ba6e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+- 2.4.1
+before_install: gem install bundler
+script: bundle exec rake
+notifications:
+  email: false
+after_success:
+- bundle exec codeclimate-test-reporter
+env:
+  global:
+    secure: NxLs+gcCgqm0cweEQ6abyZ7njE9JUNzycrSFO0OmEQUfiKl0ArIu26NrcjQvL3XvUiikmAcdzavA+5P4vMsQGFkjwqE0bwGxg+cu5a3nzNBoyhOKlQZQ+MTsWs3kX8VqADNa2VdosVkbf/n8Q9eFmV712NWZqPHGvT56HCpkQIQMo5h1/SuUJzVfbw+3P4x11++/hifodhq2xsGEzvaY0vThEk1BbVO2REeQsvnZx3Vs3m+wjmovhlpbL2PqAVBshbrlsBx6PKo55ubQjv4z0PByPAkk5bn5CY/SXw7xItw8s0camHj8bYCzJyjvsCFkLbKYiwcymy4mCAZz8SHZWf7FzKrZFYBQfPIlvcaIdN0gxYSmhUTZ+F7/Q12GS8ZNxi0QKyy7/crib1NKCYea+fYp9tX+RR+kTDRgxadzZDtHywjuwG9ttHuki8yQiL2Ma7Ecw1LbFVeKz2v/L3oxINUJ+uMHZVPOrpd+sO5+YTHN2xmuqPNbQnoOdNiT06fRQkbIPD11UfgRb1zegyxRmgc4H4n/Ps0OpuI5S4fafINFW9W0EhJjtOT/WJTy6nbKL1Rk8YeZBrK0JZSr/zZc6dt9FrZZaj2gjko9Zvb/wIP+nACXm1fV9+jIEoE2CzYdFaOQT0uAKbhQqnArZ5/RXg98nmuPoEPyjtgfWjPcINU=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fnando.vieira@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nando Vieira
+
+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,62 @@
+# EmailTypo
+
+[![Travis-CI](https://travis-ci.org/fnando/email_typo.png)](https://travis-ci.org/fnando/email_typo)
+[![Code Climate](https://codeclimate.com/github/fnando/email_typo/badges/gpa.svg)](https://codeclimate.com/github/fnando/email_typo)
+[![Test Coverage](https://codeclimate.com/github/fnando/email_typo/badges/coverage.svg)](https://codeclimate.com/github/fnando/email_typo/coverage)
+[![Gem](https://img.shields.io/gem/v/email_typo.svg)](https://rubygems.org/gems/email_typo)
+[![Gem](https://img.shields.io/gem/dt/email_typo.svg)](https://rubygems.org/gems/email_typo)
+
+EmailTypo is a Ruby gem that gives you an easy, tested method that fixes email typos.
+
+As an example: A user with the email "joe@gmail.com" accidentally enters in "joe@gmal.cmo", EmailTypo will fix it automatically.
+
+EmailTypo is concerned with incorrectly-entered data (email provider names, TLDs), not with evaluating whether a particular domain is valid, or whether a particular email address is legitimate. (That is, it's focused on fixing the part that comes after the "@" in the email address.) It works really well for helping you — and your users — when they accidentally type something in wrong.
+
+**NOTE**: This is based on https://github.com/charliepark/fat_fingers, but without polluting the `String` class and with easier extension support.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "email_typo"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_typo
+
+## Usage
+
+To fix any typos, just use `EmailTypo.fix(email)`.
+
+```ruby
+EmailTypo.fix("john.doe@gmail.co")
+#=> "john.doe@gmail.com"
+```
+
+To add/change the processors, add any object that responds to `#call(email)` to `EmailTypo.default_processors`. The following example adds a processor for `.uol.com.br`, a Brazilian email provider:
+
+```ruby
+EmailTypo.default_processors << lambda do |email|
+  email.gsub(/@uol\.com(\..*?)?/, "@uol.com.br")
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/email_typo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "email_typo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/email_typo.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "./lib/email_typo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_typo"
+  spec.version       = EmailTypo::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+
+  spec.summary       = "Clean up e-mail strings when the user's made a typo (like 'gmail.cmo')."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/email_typo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/email_typo.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "./email_typo/version"
+
+require_relative "./email_typo/add_missing_m"
+require_relative "./email_typo/add_missing_period"
+require_relative "./email_typo/aol"
+require_relative "./email_typo/different_tlds"
+require_relative "./email_typo/dot_com"
+require_relative "./email_typo/dot_net"
+require_relative "./email_typo/dot_org"
+require_relative "./email_typo/gmail"
+require_relative "./email_typo/googlemail"
+require_relative "./email_typo/hotmail"
+require_relative "./email_typo/known_dot_com"
+require_relative "./email_typo/period_around_at_sign"
+require_relative "./email_typo/providers"
+require_relative "./email_typo/remove_invalid_chars"
+require_relative "./email_typo/transposed_periods"
+require_relative "./email_typo/yahoo"
+
+module EmailTypo
+  class << self
+    # List of default processors that will be applied to fix any email's typos.
+    attr_accessor :default_processors
+  end
+
+  self.default_processors = [
+    RemoveInvalidChars,
+    TransposedPeriods,
+    PeriodAroundAtSign,
+    DifferentTlds,
+    AddMissingM,
+    AddMissingPeriod,
+    Providers,
+    Aol,
+    DotCom,
+    DotNet,
+    DotOrg,
+    Gmail,
+    Googlemail,
+    Hotmail,
+    KnownDotCom,
+    Yahoo
+  ]
+
+  def self.fix(email, processors = default_processors)
+    return unless email
+
+    processors.reduce(email.downcase) do |processed_email, processor|
+      processor.call(processed_email)
+    end
+  end
+end

data/lib/email_typo/add_missing_m.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  AddMissingM = lambda do |email|
+    email.gsub(/(aol|googlemail|gmail|hotmail|yahoo).co$/, "\\1.com")
+  end
+end

data/lib/email_typo/add_missing_period.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  AddMissingPeriod = lambda do |email|
+    email.gsub(/([^\.])(com|org|net)$/, "\\1.\\2")
+  end
+end

data/lib/email_typo/aol.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Aol = lambda do |email|
+    email.gsub(/@(ol|ao|ail)\./, "@aol.")
+  end
+end

data/lib/email_typo/different_tlds.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  DifferentTlds = lambda do |email|
+    email
+      .gsub(/\.(o\.uk|couk|co\.um)$/, ".co.uk")
+      .gsub(/\.(cojp|co\.lp)$/, ".co.jp")
+  end
+end

data/lib/email_typo/dot_com.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  DotCom = lambda do |email|
+    email
+      .gsub(/\.co[mn]\.com/, ".com")
+      .gsub(/\.com\.$/, ".com")
+      .gsub(/\.com(?!cast|\.|@).{1,3}$/, ".com")
+      .gsub(/\.co[^op]$/, ".com")
+      .gsub(/\.c*(c|ci|coi|l|m|n|o|op|cp|0)*m+o*$/, ".com")
+      .gsub(/\.(c|v|x)o+(m|n)$/, ".com")
+  end
+end

data/lib/email_typo/dot_net.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  DotNet = lambda do |email|
+    email.gsub(/\.(nte*|n*et*)$/, ".net")
+  end
+end

data/lib/email_typo/dot_org.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  # require the o, to not false-positive .gr e-mails
+  DotOrg = lambda do |email|
+    email.gsub(/\.og?r?g{0,2}$/, ".org")
+  end
+end

data/lib/email_typo/gmail.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Gmail = lambda do |email|
+    email.gsub(/@g[nm]{0,2}s?[ail]{1,2}[aiklmou]{0,3}\.(?!gov)/, "@gmail.")
+  end
+end

data/lib/email_typo/googlemail.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Googlemail = lambda do |email|
+    email
+      .gsub(/@go{0,3}g{0,2}o?le?[mn]?[ail]{1,2}m?[aikl]{0,3}\./, "@googlemail.")
+  end
+end

data/lib/email_typo/hotmail.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Hotmail = lambda do |email|
+    email.gsub(/@h(i|o|p)?y?t?o?a?m?n?t?[aikl]{1,3}l?\./, "@hotmail.")
+  end
+end

data/lib/email_typo/known_dot_com.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  KnownDotCom = lambda do |email|
+    email
+      .gsub(/@(aol|googlemail|gmail|hotmail|yahoo|icloud|outlook)\.([a-z]+)$/, "@\\1.com")
+  end
+end

data/lib/email_typo/period_around_at_sign.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  PeriodAroundAtSign = lambda do |email|
+    email.gsub(/(\.@|@\.)/, "@")
+  end
+end

data/lib/email_typo/providers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Providers = lambda do |email|
+    email
+      .gsub(/@co?(m|n)a?cas?t{0,2}\./, "@comcast.")
+      .gsub(/@sbc?gl?ob[al]{0,2}l?\./, "@sbcglobal.")
+      .gsub(/@ver?i?z?on\./, "@verizon.")
+      .gsub(/@icl{0,2}oud\./, "@icloud.")
+      .gsub(/@outl?ook?\./, "@outlook.")
+  end
+end

data/lib/email_typo/remove_invalid_chars.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  RemoveInvalidChars = lambda do |email|
+    email
+      .gsub(/(\s|\#|\'|\"|\\)*/, "")
+      .gsub(/(\,|\.\.)/, ".")
+      .gsub("@@", "@")
+  end
+end

data/lib/email_typo/transposed_periods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  # can't do "o.gr" => ".org", as ".gr" is a valid TLD
+  TransposedPeriods = lambda do |email|
+    email
+      .gsub(/c\.om$/, ".com")
+      .gsub(/n\.et$/, ".net")
+  end
+end

data/lib/email_typo/version.rb

@@ -0,0 +1,3 @@
+module EmailTypo
+  VERSION = "0.1.0"
+end

data/lib/email_typo/yahoo.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EmailTypo
+  Yahoo = lambda do |email|
+    email.gsub(/@(ya|yh|ua|ah)+h*a*o+\./, "@yahoo.")
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: email_typo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- email_typo.gemspec
+- lib/email_typo.rb
+- lib/email_typo/add_missing_m.rb
+- lib/email_typo/add_missing_period.rb
+- lib/email_typo/aol.rb
+- lib/email_typo/different_tlds.rb
+- lib/email_typo/dot_com.rb
+- lib/email_typo/dot_net.rb
+- lib/email_typo/dot_org.rb
+- lib/email_typo/gmail.rb
+- lib/email_typo/googlemail.rb
+- lib/email_typo/hotmail.rb
+- lib/email_typo/known_dot_com.rb
+- lib/email_typo/period_around_at_sign.rb
+- lib/email_typo/providers.rb
+- lib/email_typo/remove_invalid_chars.rb
+- lib/email_typo/transposed_periods.rb
+- lib/email_typo/version.rb
+- lib/email_typo/yahoo.rb
+homepage: https://github.com/fnando/email_typo
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
+test_files: []