Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/email_typo
Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
https://github.com/fnando/email_typo
email-typo ruby scrubber
Last synced: 27 days ago
JSON representation
Clean up e-mail strings when the user's made a typo (like 'gmail.cmo').
- Host: GitHub
- URL: https://github.com/fnando/email_typo
- Owner: fnando
- License: mit
- Created: 2017-06-15T18:16:56.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-10-14T09:03:42.000Z (about 2 years ago)
- Last Synced: 2024-04-26T17:13:39.507Z (7 months ago)
- Topics: email-typo, ruby, scrubber
- Language: Ruby
- Homepage:
- Size: 62.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# email_typo
[](https://github.com/fnando/email_typo)
[](https://codeclimate.com/github/fnando/email_typo)
[](https://rubygems.org/gems/email_typo)
[](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 "[email protected]" accidentally enters in
"[email protected]", 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
```bash
gem install email_typo
```
Or add the following line to your project's Gemfile:
```ruby
gem "email_typo"
```
## Usage
To fix any typos, just use `EmailTypo.call(email)`.
```ruby
EmailTypo.call("[email protected]")
#=> "[email protected]"
```
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
```
## Maintainer
- [Nando Vieira](https://github.com/fnando)
## Contributors
- https://github.com/fnando/email_typo/contributors
## Contributing
For more details about how to contribute, please read
https://github.com/fnando/email_typo/blob/main/CONTRIBUTING.md.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
found at https://github.com/fnando/email_typo/blob/main/LICENSE.md.
## Code of Conduct
Everyone interacting in the email_typo project's codebases, issue trackers, chat
rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/fnando/email_typo/blob/main/CODE_OF_CONDUCT.md).