nondisposable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b423ab4d910c50439d17398fcb84d95013ecd20be9c281f540c7b4540f79cb22
+  data.tar.gz: b09ff53a1ac0cf5d47f4b597e89f30e6522836d6fbdcd0bd3de4ed564edfa69f
+SHA512:
+  metadata.gz: 6506a82600a139b2ac20b2abb8e84e2215f08af55eacbb43fac4d4524b7feb3b338dfd4cc73e7808957bbc9243f9d72c90fa3c28bc4b248ece56ea6f7d240ba2
+  data.tar.gz: d840467aa4befe4c934883cc18bfc33ba847889d4808dd94e633f84ef6a5c690b5c9b93e5d1fbc0a5e45daa5d1524f3534fce9db52aea3939a9ef01a490c18ef

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Javi R
+
+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,137 @@
+# 🗑️ `nondisposable` - Block disposable email addresses from signing up to your Rails app
+
+`nondisposable` is a Ruby gem that prevents users from signing up to your Rails app with disposable email addresses.
+
+Simply add to your User model:
+
+```ruby
+validates :email, nondisposable: true
+```
+
+That's it! You're done.
+
+The gem also provides a job you can run daily to keep your disposable domain list up to date.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nondisposable'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+After installing the gem, run the installation generator:
+
+```bash
+rails generate nondisposable:install
+```
+
+This will create the necessary migration file, initializer, and a job for scheduled updates. Run the migration:
+
+```bash
+rails db:migrate
+```
+
+Finally, populate the initial list of disposable domains:
+
+```ruby
+Nondisposable::DomainListUpdater.update
+```
+
+## Usage
+
+To use `nondisposable` in your models, simply add the validation:
+
+```ruby
+class User < ApplicationRecord
+  validates :email, nondisposable: true
+end
+```
+
+You can customize the error message:
+```ruby
+class User < ApplicationRecord
+  validates :email, nondisposable: { message: "is a disposable email address, please use a permanent email address." }
+end
+```
+
+The validation works seamlessly with other Rails validations:
+```ruby
+class User < ApplicationRecord
+  validates :email,
+            presence: true,
+            format: { with: URI::MailTo::EMAIL_REGEXP },
+            nondisposable: true
+end
+```
+
+If you're validating a different attribute name:
+```ruby
+class User < ApplicationRecord
+  validates :backup_email, nondisposable: true
+end
+```
+
+### Configuration
+
+You can customize the gem's behavior by creating an initializer:
+
+```ruby
+# config/initializers/nondisposable.rb
+
+Nondisposable.configure do |config|
+  config.error_message = "provider is not allowed. Please use a non-disposable email address."
+  config.additional_domains = ['custom-disposable-domain.com']
+  config.excluded_domains = ['false-positive-domain.com']
+end
+```
+
+### Direct Check
+
+You can also check if an email is disposable directly:
+
+```ruby
+Nondisposable.disposable?('user@example.com') # => false
+Nondisposable.disposable?('user@disposable-email.com') # => true
+```
+
+## Updating disposable domains
+
+To manually update the list of disposable domains, run:
+
+```ruby
+Nondisposable::DomainListUpdater.update
+```
+
+It's important you keep your disposable domain list up to date. `nondisposable` will read from the latest version of the [`disposable-email-domains`](https://github.com/disposable-email-domains/disposable-email-domains) list, which is typically updated every few days.
+
+For this, `nondisposable` provides you with an Active Job (`DisposableEmailDomainListUpdateJob`) that you can use to schedule daily updates. How you do that, exactly, depends on the queueing system you're using.
+
+If you're using `solid_queue` (the Rails 8 default), you can easily add it to your schedule in the `config/recurring.yml` file like this:
+```yaml
+production:
+  refresh_disposable_domains:
+    class: DisposableEmailDomainListUpdateJob
+    queue: default
+    schedule: every day at 3am US/Pacific
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rameerez/nondisposable. Our code of conduct is: just be nice and make your mom proud of what you do and post online.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/app/models/nondisposable/disposable_domain.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nondisposable
+  class DisposableDomain < ApplicationRecord
+    validates :name, presence: true, uniqueness: { case_sensitive: false }
+
+    class << self
+      def disposable?(domain)
+        return false if domain.blank?
+        domain = domain.to_s.downcase
+        Nondisposable.configuration.additional_domains.include?(domain) ||
+          (where(name: domain).exists? && !Nondisposable.configuration.excluded_domains.include?(domain))
+      end
+    end
+
+  end
+end

data/lib/generators/nondisposable/install_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module Nondisposable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      def create_migration_file
+        migration_template 'create_nondisposable_disposable_domains.rb.erb', File.join(db_migrate_path, "create_nondisposable_disposable_domains.rb")
+      end
+
+      def create_initializer
+        template 'nondisposable.rb', 'config/initializers/nondisposable.rb'
+      end
+
+      def create_database_refresh_job
+        template 'disposable_email_domain_list_update_job.rb', 'app/jobs/disposable_email_domain_list_update_job.rb'
+      end
+
+      def display_post_install_message
+        say "\tThe `nondisposable` gem has been successfully installed!", :green
+        say "\nTo complete the setup:"
+        say "  1. Run 'rails db:migrate' to create the necessary tables."
+        say "  2. Run 'Nondisposable::DomainListUpdater.update' to populate the initial list of disposable domains."
+        say "  3. Add 'validates :email, nondisposable: true' to your User model (or any model with an email field)."
+        say "  4. Configure your recurrent job according to the README, and make sure you have a functional queuing system (like solid_queue) that can run jobs properly so the disposable emails list is updated regularly."
+        say "\nEnjoy your new `nondisposable` users!", :green
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::STRING.to_f}]"
+      end
+
+    end
+  end
+end

data/lib/generators/nondisposable/templates/create_nondisposable_disposable_domains.rb.erb

@@ -0,0 +1,21 @@
+class CreateNondisposableDisposableDomains < ActiveRecord::Migration<%= migration_version %>
+  def change
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :nondisposable_disposable_domains, id: primary_key_type do |t|
+      t.string :name, null: false, index: { unique: true }
+
+      t.timestamps
+    end
+  end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
+end

data/lib/generators/nondisposable/templates/disposable_email_domain_list_update_job.rb

@@ -0,0 +1,7 @@
+class DisposableEmailDomainListUpdateJob < ApplicationJob
+  queue_as :default
+
+  def perform(*args)
+    Nondisposable::DomainListUpdater.update
+  end
+end

data/lib/generators/nondisposable/templates/nondisposable.rb

@@ -0,0 +1,10 @@
+Nondisposable.configure do |config|
+  # Customize the error message if needed
+  # config.error_message = "is not allowed. Please use a non-disposable email address."
+  #
+  # Add custom domains you want to be considered as disposable
+  # config.additional_domains = ['custom-disposable-domain.com']
+  #
+  # Exclude domains that are considered disposable but you want to allow anyways
+  # config.excluded_domains = ['false-positive-domain.com']
+end

data/lib/nondisposable/domain_list_updater.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'net/http'
+
+module Nondisposable
+  class DomainListUpdater
+
+    def self.update
+      Rails.logger.info "Refreshing list of disposable domains..."
+
+      url = 'https://raw.githubusercontent.com/disposable-email-domains/disposable-email-domains/master/disposable_email_blocklist.conf'
+
+      begin
+        uri = URI(url)
+        response = Net::HTTP.get_response(uri)
+
+        if response.is_a?(Net::HTTPSuccess)
+          downloaded_domains = response.body.split("\n")
+          raise "The list is empty. This might indicate a problem with the format." if downloaded_domains.empty?
+
+          Rails.logger.info "Downloaded list of disposable domains..."
+
+          domains = (downloaded_domains + Nondisposable.configuration.additional_domains).uniq
+          domains -= Nondisposable.configuration.excluded_domains
+
+          ActiveRecord::Base.transaction do
+            Rails.logger.info "Updating disposable domains..."
+            Nondisposable::DisposableDomain.delete_all
+
+            domains.each { |domain| Nondisposable::DisposableDomain.create(name: domain.downcase) }
+          end
+
+          Rails.logger.info "Finished updating disposable domains. Total domains: #{domains.count}"
+          true
+        else
+          Rails.logger.error "Failed to download the list. HTTP Status: #{response.code}"
+          false
+        end
+      rescue SocketError => e
+        Rails.logger.error "Network error occurred: #{e.message}"
+        false
+      rescue StandardError => e
+        Rails.logger.error "An error occurred when trying to update the list of disposable domains: #{e.message}"
+        false
+      end
+    end
+  end
+end

data/lib/nondisposable/email_validator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class NondisposableValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank?
+
+        begin
+          domain = value.to_s.split('@').last&.downcase
+          return if domain.nil? # Invalid email format
+
+          if Nondisposable::DisposableDomain.disposable?(domain)
+            record.errors.add(attribute, options[:message] || Nondisposable.configuration.error_message)
+          end
+        rescue StandardError => e
+          Rails.logger.error "Nondisposable validation error: #{e.message}"
+          record.errors.add(attribute, "is an invalid email address, cannot check if it's disposable")
+        end
+      end
+    end
+
+    module HelperMethods
+      # Kept for backwards compatibility
+      def validates_nondisposable_email(*attr_names)
+        validates_with NondisposableValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/nondisposable/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nondisposable
+  class Engine < ::Rails::Engine
+    isolate_namespace Nondisposable
+
+    initializer "nondisposable.assets.precompile" do |app|
+      app.config.assets.precompile += %w( nondisposable/application.css nondisposable/application.js )
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+  end
+end

data/lib/nondisposable/railtie.rb

@@ -0,0 +1,9 @@
+module Nondisposable
+  class Railtie < Rails::Railtie
+    initializer 'nondisposable.add_validator' do
+      ActiveSupport.on_load(:active_record) do
+        include ActiveModel::Validations::NondisposableValidator
+      end
+    end
+  end
+end

data/lib/nondisposable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nondisposable
+  VERSION = "0.1.0"
+end

data/lib/nondisposable.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "nondisposable/version"
+require_relative "nondisposable/engine"
+require_relative "nondisposable/email_validator"
+require_relative "nondisposable/domain_list_updater"
+module Nondisposable
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.disposable?(email)
+    return false if email.nil? || !email.include?('@')
+    domain = email.to_s.split('@').last.downcase
+    DisposableDomain.disposable?(domain)
+  end
+
+  class Configuration
+    attr_accessor :error_message, :additional_domains, :excluded_domains
+
+    def initialize
+      @error_message = "provider is not allowed"
+      @additional_domains = []
+      @excluded_domains = []
+    end
+  end
+end

data/sig/nondisposable.rbs

@@ -0,0 +1,4 @@
+module Nondisposable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: nondisposable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rameerez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Block disposable email addresses from signing up to your Rails app. Comes
+  with a job so you can automatically update the database of disposable email domains
+  on a regular basis (daily, weekly, etc).
+email:
+- rubygems@rameerez.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/nondisposable/disposable_domain.rb
+- lib/generators/nondisposable/install_generator.rb
+- lib/generators/nondisposable/templates/create_nondisposable_disposable_domains.rb.erb
+- lib/generators/nondisposable/templates/disposable_email_domain_list_update_job.rb
+- lib/generators/nondisposable/templates/nondisposable.rb
+- lib/nondisposable.rb
+- lib/nondisposable/domain_list_updater.rb
+- lib/nondisposable/email_validator.rb
+- lib/nondisposable/engine.rb
+- lib/nondisposable/railtie.rb
+- lib/nondisposable/version.rb
+- sig/nondisposable.rbs
+homepage: https://github.com/rameerez/nondisposable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rameerez/nondisposable
+  source_code_uri: https://github.com/rameerez/nondisposable
+  changelog_uri: https://github.com/rameerez/nondisposable/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Block disposable emails from signing up to your Rails app
+test_files: []