email_data 1605293459 → 1605671224

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ffbd05126735ef87e3acb077987454c1d2d261af5f1f8416362e59c47017d5
-  data.tar.gz: eedd08764a8cf1baba4a9fc4e8382f70f21acafab0f1f4623abda335ad701db8
+  metadata.gz: 8f78471393cd5a69fca89d9a6250d8ec333854c6ef4938029851420b4bdf64df
+  data.tar.gz: 942973f41973e229441d887bb6ddf7e52f837c2eef35c2521dcc8f62c31718e3
 SHA512:
-  metadata.gz: 7161233238b3b00d0ff7dd7bc24f59a76ae1f3fe4a5632ca517c3f01ce657581cf876b319277cebe008fe7330d0f1127346a3afee0961c9582e62dc9ac0d61bb
-  data.tar.gz: 9ec4d1e0a47c24a5778af797c3765f88a01505c6d17d9d8035a1bfa787f9cff79edc0d918d43c97f788dcc5b69246017796cabfd709752d042e6480246398d60
+  metadata.gz: 7c7e94dd8604a643668910b1316b306c2752d54cdb8d1e86f3d22fd500af37b78011edbf9bc7bbd2d711f9edbd15736714c065c07c3baee1ffe2746f40868171
+  data.tar.gz: 4c64bf7c3cf4fa882b4ce29f4f8b339e1f58fb685f4901d9e4079327a354470e2a4c3c9a1d06fae9d59dc03540c3eb58b8b4552be5581e142af40f378402b8da

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -1,3 +1,4 @@
----
+# These are supported funding model platforms
+
 github: [fnando]
-custom: ["https://www.paypal.me/nandovieira/🍕"]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of email_data
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/{tests.yml → ruby-tests.yml}

@@ -1,4 +1,4 @@
-name: Tests
+name: ruby-tests
 
 on:
   pull_request:
@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7.x", "2.6.x", "2.5.x"]
+        ruby: ["2.7.x", "2.6.x"]
 
     services:
       postgres:
@@ -26,7 +26,7 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
 
       - uses: actions/cache@v2
         with:

data/.rubocop.yml

@@ -3,18 +3,14 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   NewCops: enable
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/AbcSize:
-  Exclude:
-    - test/support/**/*
+  Enabled: false
 
 Metrics/MethodLength:
-  Exclude:
-    - test/support/**/*
-
-Metrics/BlockLength:
-  Exclude:
-    - email_data.gemspec
-    - test/support/**/*
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing to email_data
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/email_data/blob/main/CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## Contributing with code
+
+Before making any radicals changes, please make sure you discuss your intention
+by [opening an issue on Github](https://github.com/fnando/email_data/issues).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) email_data
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Push to your branch - `git push origin my_branch`
+5. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
+6. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `rake`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+### JavaScript code
+
+- This project uses [ESLint](https://eslint.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `yarn test:ci`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.

data/Gemfile

@@ -2,5 +2,4 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in email_data.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    email_data (1605293459)
+    email_data (1605671224)
 
 GEM
   remote: https://rubygems.org/
@@ -38,9 +38,10 @@ GEM
     rake (13.0.1)
     regexp_parser (1.8.2)
     rexml (3.2.4)
-    root_domain (0.1.0)
+    root_domain (0.1.2)
+      email_data
       simpleidn
-    rubocop (1.3.0)
+    rubocop (1.3.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2020 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

@@ -1,14 +1,11 @@
-# EmailData
-
-- Ruby:
-  [![Tests](https://github.com/fnando/email_data/workflows/Tests/badge.svg)](https://github.com/fnando/email_data/actions?query=workflow%3ATests)
-  [![Gem](https://img.shields.io/gem/v/email_data.svg)](https://rubygems.org/gems/email_data)
-  [![Gem](https://img.shields.io/gem/dt/email_data.svg?label=gems%20downloads)](https://rubygems.org/gems/email_data)
-- NPM:
-  [![NPM package version](https://img.shields.io/npm/v/@fnando/email_data.svg)](https://www.npmjs.com/package/@fnando/email_data)
-  [![NPM Downloads](https://img.shields.io/npm/dt/@fnando/email_data?label=npm%20downloads)](https://www.npmjs.com/package/@fnando/email_data)
-- License:
-  ![License](https://img.shields.io/static/v1?label=License&message=MIT&color=4da3dd)
+# email_data
+
+[![Tests](https://github.com/fnando/email_data/workflows/ruby-tests/badge.svg)](https://github.com/fnando/email_data)
+[![Code Climate](https://codeclimate.com/github/fnando/email_data/badges/gpa.svg)](https://codeclimate.com/github/fnando/email_data)
+[![Gem version](https://img.shields.io/gem/v/email_data.svg?label=Gem%20version)](https://rubygems.org/gems/email_data)
+[![Gem downloads](https://img.shields.io/gem/dt/email_data.svg?label=Gem%20downloads)](https://rubygems.org/gems/email_data)
+[![NPM version](https://img.shields.io/npm/v/%40fnando%2Femail_data.svg?label=NPM%20version)](https://npmjs.org/package/@fnando/email_data)
+[![NPM downloads](https://img.shields.io/npm/dt/%40fnando%2Femail_data.svg?label=NPM%20downloads)](https://npmjs.org/package/@fnando/email_data)
 
 This project is a compilation of datasets related to emails.
 
@@ -20,25 +17,21 @@ This project is a compilation of datasets related to emails.
 The data is compiled from several different sources, so thank you all for making
 this data available.
 
-## Installation
+## Ruby
+
+### Installation
 
-### Ruby
+```bash
+gem install email_data
+```
 
-Add this line to your application's Gemfile:
+Or add the following line to your project's Gemfile:
 
 ```ruby
 gem "email_data"
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install email_data
-
-#### Usage
+### Usage
 
 ```ruby
 require "email_data"
@@ -58,6 +51,18 @@ EmailData.free_email_domains
 
 # List of roles. Can be used to filter out emails like info@ or all@.
 EmailData.roles
+
+# List of private relays like Apple's Hide My Email.
+EmailData.private_relays
+
+# List of country tlds.
+EmailData.country_tlds
+
+# List of official tlds.
+EmailData.tlds
+
+# List of second-level domains.
+EmailData.slds
 ```
 
 #### Data sources
@@ -98,6 +103,12 @@ class SetupEmailData < ActiveRecord::Migration[6.1]
 
     add_index :tlds, :name, unique: true
 
+    create_table :slds do |t|
+      t.citext :name, null: false
+    end
+
+    add_index :slds, :name, unique: true
+
     create_table :country_tlds do |t|
       t.citext :name, null: false
     end
@@ -127,6 +138,12 @@ class SetupEmailData < ActiveRecord::Migration[6.1]
     end
 
     add_index :roles, :name, unique: true
+
+    create_table :private_relays do |t|
+      t.citext :name, null: false
+    end
+
+    add_index :private_relays, :name, unique: true
   end
 end
 ```
@@ -155,11 +172,13 @@ The you can load each dataset using `COPY`:
 
 ```sql
 COPY tlds (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/tlds.txt';
+COPY slds (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/slds.txt';
 COPY country_tlds (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/country_tlds.txt';
 COPY disposable_emails (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/disposable_emails.txt';
 COPY disposable_domains (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/disposable_domains.txt';
 COPY free_email_domains (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/free_email_domains.txt';
 COPY roles (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/roles.txt';
+COPY private_relays (name) FROM '/usr/local/ruby/2.7.1/lib/ruby/gems/2.7.0/gems/email_data-1601479967/data/private_relays.txt';
 ```
 
 Alternatively, you could create a migrate that executes that same command; given
@@ -181,16 +200,20 @@ class LoadEmailData < ActiveRecord::Migration[6.1]
     end
 
     copy.call(:tlds)
+    copy.call(:slds)
     copy.call(:country_tlds)
     copy.call(:disposable_emails)
     copy.call(:disposable_domains)
     copy.call(:free_email_domains)
     copy.call(:roles)
+    copy.call(:private_relays)
   end
 end
 ```
 
-### Node.js
+## Node.js
+
+### Installation
 
 ```console
 $ yarn add @fnando/email_data
@@ -202,13 +225,17 @@ or
 $ npm install @fnando/email_data
 ```
 
-#### Usage
+### Usage
 
 ```js
 const disposableEmails = require("@fnando/email_data/data/json/disposable_emails.json");
 const disposableDomains = require("@fnando/email_data/data/json/disposable_domains.json");
 const freeEmailDomains = require("@fnando/email_data/data/json/free_email_domains.json");
 const roles = require("@fnando/email_data/data/json/roles.json");
+const privateRelays = require("@fnando/email_data/data/json/private_relays.json");
+const tlds = require("@fnando/email_data/data/json/tlds.json");
+const slds = require("@fnando/email_data/data/json/slds.json");
+const cctlds = require("@fnando/email_data/data/json/country_tlds.json");
 ```
 
 ## Dataset
@@ -224,34 +251,30 @@ like to add, please make a pull request against the files `data/manual/*.txt`.
 - `data/manual/free_email_domains.txt`: only free email services must go here.
 - `data/manual/roles.txt`: list of role-based user names like `info` or
   `no-reply`.
+- `data/manual/private_relays.txt`: list of private relay services, like Apple's
+  Hide My Email.
 
-## Development
+## Maintainer
 
-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.
+- [Nando Vieira](https://github.com/fnando)
 
-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).
+## Contributors
+
+- https://github.com/fnando/email_data/contributors
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/fnando/email_data. This project is intended to be a safe,
-welcoming space for collaboration, and contributors are expected to adhere to
-the
-[code of conduct](https://github.com/fnando/email_data/blob/main/CODE_OF_CONDUCT.md).
+For more details about how to contribute, please read
+https://github.com/fnando/email_data/blob/main/CONTRIBUTING.md.
 
 ## License
 
 The gem is available as open source under the terms of the
-[MIT License](https://opensource.org/licenses/MIT).
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/email_data/blob/main/LICENSE.md.
 
 ## Code of Conduct
 
-Everyone interacting in the EmailData project's codebases, issue trackers, chat
+Everyone interacting in the email_data project's codebases, issue trackers, chat
 rooms and mailing lists is expected to follow the
 [code of conduct](https://github.com/fnando/email_data/blob/main/CODE_OF_CONDUCT.md).