mail_provider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65153d0d8c51a101d9bd30db8dd53452204352aa911d6659742aba98d0aaa215
+  data.tar.gz: 85d3cddf27da2dff07306c73fd1e91e2ee1a938260e0cf501244b0411dc6955e
+SHA512:
+  metadata.gz: 3f090082e9cd85a945c7faa6101645a1015aae1f8431e54bc29ec1f05d5196e33c94b65c4616f285fffc3dbd00074024d444d49cbbb599b149e76a5204cd4052
+  data.tar.gz: 519846a9830c2ab308c73fcff621771749d57c58c66818f5832b07f7eb6ee66a09edba363d6f83206943c135ff71340eba8cda8e579be4ee37392e9ed24b3469

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

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 me@nikhgupta.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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mail_provider.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    mail_provider (0.1.0)
+      faraday
+      hamster
+      public_suffix
+      simpleidn
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simpleidn (0.1.1)
+      unf (~> 0.1.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  mail_provider!
+  pry
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 nikhgupta
+
+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,189 @@
+# MailProvider
+
+Smartly check whether a given email/domain belongs to a free or disposable
+mail provider.
+
+There are hundreds of lists available in Github repositories or Gists that
+list various free and disposable email providers. This gem downloads a bunch
+of these scripts (pre-configured URLs) and parses them to count votes against
+each domain in the list. We, then, create a Trie structure to efficiently
+query this data with a given domain or email. For each query, you get back a
+number specifying how many sources are claiming that the domain is a free or
+disposable email provider.
+
+**This gem was written in a couple of hours, and the intention has been to
+get this working first for a project I am working on. This gem still needs
+refactoring to make the code more readable, tests, etc. PRs welcome :)**
+
+## Features
+
+- IDN/Punycode compatibility
+- should be thread-safe - immutable Trie structure.
+- really fast! Uses efficient Patricia Trie structure.
+- checks all parts of subdomain for checking an entry
+- provide your own sources for disposable/free domains list
+- 74000+ disposable domains, 9000+ free domains pre-configured
+- check email/domain for free or disposable email provider status
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail_provider'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install mail_provider
+```
+
+## Usage
+
+In simple terms, you can do:
+
+```ruby
+# Re-download and update list of domains from sources
+lib = MailProvider.new(refresh: true)
+
+# Re-use cached/parsed list from the CSV in data-directory
+lib = MailProvider.new(refresh: false)
+
+# check an email for status
+lib.check 'example@c.nut.emailfake.nut.cc'
+# => {:ascii=>"c.nut.emailfake.nut.cc",
+#     :found=>3,
+#     :unicode=>"c.nut.emailfake.nut.cc",
+#     :domain=>"nut.cc",
+#     :tld=>"cc",
+#     :match=>:entry,
+#     :summarize=>false,
+#     :free=>1,
+#     :disposable=>3,
+#     :score=>-0.0625,
+#     :data=>{"c.nut.emailfake.nut.cc"=>{:free=>1, :disposable=>3},
+#             "emailfake.nut.cc"=>{:free=>0, :disposable=>6},
+#             "nut.cc"=>{:free=>1, :disposable=>10}},
+
+lib.check "финские-вейдерсы-2019.рф"
+# => {:ascii=>"xn----2019-iofqgcb4aasj1c8cik0c5k.xn--p1ai",
+#     :found=>1,
+#     :unicode=>"финские-вейдерсы-2019.рф",
+#     :domain=>"финские-вейдерсы-2019.рф",
+#     :tld=>"рф",
+#     :data=>{"xn----2019-iofqgcb4aasj1c8cik0c5k.xn--p1ai"=>{:free=>0, :disposable=>1}},
+#     :match=>:entry,
+#     :score=>-0.0625,
+#     :free=>0,
+#     :disposable=>1}
+
+# check an email for status while summing up scores for each step in domain
+lib.check 'c.nut.emailfake.nut.cc', summarize: true
+# => {:ascii=>"c.nut.emailfake.nut.cc",
+#     :found=>3,
+#     :unicode=>"c.nut.emailfake.nut.cc",
+#     :domain=>"nut.cc",
+#     :tld=>"cc",
+#     :match=>:entry,
+#     :summarize=>true,
+#     :free=>2,
+#     :disposable=>19,
+#     :score=>-0.9375,
+#     :data=>{"c.nut.emailfake.nut.cc"=>{:free=>1, :disposable=>3},
+#             "emailfake.nut.cc"=>{:free=>0, :disposable=>6},
+#             "nut.cc"=>{:free=>1, :disposable=>10}},
+
+# check a domain for status
+lib.check 'gmail.com'
+# => {:ascii=>"gmail.com", :summarize=>false, :checked=>1, :found=>true, :unicode=>"gmail.com",
+#     :score=>1.0,:free=>8, :disposable=>0, :data=>{"gmail.com"=>{:free=>8, :disposable=>0}}}
+
+lib.check 'nick@codewithsense.com'
+# => {:ascii=>"codewithsense.com", :found=>0, :unicode=>"codewithsense.com",
+#     :domain=>"codewithsense.com", :tld=>"com", :data=>{}, :match=>nil,
+#     :summarize=>false, :score=>nil}
+```
+
+## Explaination
+
+In the above examples, `free` is the number of sources claiming that the
+given domain/email is from a free email provider, `disposable` is the number
+of sources claiming that the given domain/email is from a disposable email
+provider.
+
+`checked` is the number of domain parts checked for this email/domain for
+entries present with us. For example, for domain `subsub.sub.root.co.in`, we
+check the following strings in our records (giving us a total of 3):
+
+- subsub.sub.root.co.in
+- sub.root.co.in
+- root.co.in
+
+If `summarize` is `true`, counts for each domain parts are added starting
+from root domain.
+
+`score` is the percent of sources claiming the string to be a free provider
+minus the percent of sources claiming the string to be a disposable provider.
+This value is `nil` if the string is not found in our entries, otherwise a
+value between `-1` and `1`.
+
+## Custom sources
+
+The above uses pre-configured list of sources. To use your own list of
+sources, provide a file with one (url) line per source.
+
+We check the lists for inclusion of `gmail.com` and `mailinator.com` and
+other similar domains to decide what kind of emails they list. To improve
+efficiency, only provide sources that list EITHER free OR disposable emails,
+and not both.
+
+Afterwards, you can do:
+
+```ruby
+MailProvider.new(sources: "<path-to-file>", refresh: true)
+```
+
+The gem saves the download and parsed list as a CSV in the gem's directory.
+You can, optionally, provide a directory to save the parsed list in.
+
+```ruby
+MailProvider.new(data_directory: "<path-to-directory>")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` 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/nikhgupta/mail_provider. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MailProvider project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/nikhgupta/mail_provider/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pry'
+require 'mail_provider'
+
+# 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!)
+Pry.start

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/exe/mail_provider

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "mail_provider"

data/lib/mail_provider.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MailProvider
+  ROOT_DIR = File.dirname(File.dirname(__FILE__))
+
+  class Error < StandardError; end
+  class TrieLoadError < StandardError; end
+end
+
+require 'faraday'
+require 'simpleidn'
+require 'digest/md5'
+require 'hamster/trie'
+require 'public_suffix'
+
+require 'mail_provider/version'
+require 'mail_provider/trie'
+require 'mail_provider/parser'
+require 'mail_provider/source_manager'
+require 'mail_provider/checker'
+
+module MailProvider
+  def self.new(refresh: false, sources: nil, data_directory: nil)
+    checker = MailProvider::Checker.new sources, data_directory
+    checker.setup refresh: refresh
+  end
+end