simple_auth-magic_link 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1db6e4dd1f065742e9b94a0e1c617b26fb72546c8b492ba555563586c62d3bea
+  data.tar.gz: 2cd9d5f2496cdd1f38acc16b01dd218caba4ffca1f983118939fc6b85455102f
+SHA512:
+  metadata.gz: 76dcc931ee1084fae469bef697184761b644249ff636735dcaa3bf124d1966cea33b5d6ef2d47f46210b0a74be3bfed8bdf5d70c8cdfd5cf5260ffc8645f1088
+  data.tar.gz: 97f72c2ab9dcf34c7c360798c2421ec99c9d8e496614882b5dbb1f23619b597ade34042888ace29fb94558892ebfa86282387006116b59ff064f71b73ff579b8

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

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+---
+github: [fnando]
+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 simple_auth-magic_link
+    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/config.yml

@@ -0,0 +1,5 @@
+---
+contact_links:
+  - name: "🤨 Q&A"
+    url: https://github.com/fnando/simple_auth-magic_link/discussions/new?category=q-a
+    about: Have a question? Ask it away 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/ruby-tests.yml

@@ -0,0 +1,52 @@
+---
+name: ruby-tests
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1"]
+        gemfile:
+          - Gemfile
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.log
+*.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+Naming/FileName:
+  Exclude:
+    - lib/simple_auth-magic_link.rb

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+<!--
+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.
+-->
+
+## Unreleased
+
+- Initial release.

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@fnando.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to simple_auth-magic_link
+
+👍🎉 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/simple_auth-magic_link/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/simple_auth-magic_link/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/) simple_auth-magic_link
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
+7. 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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2022 me@fnando.com
+
+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,127 @@
+# simple_auth-magic_link
+
+[![Tests](https://github.com/fnando/simple_auth-magic_link/workflows/ruby-tests/badge.svg)](https://github.com/fnando/simple_auth-magic_link)
+[![Gem](https://img.shields.io/gem/v/simple_auth-magic_link.svg)](https://rubygems.org/gems/simple_auth-magic_link)
+[![Gem](https://img.shields.io/gem/dt/simple_auth-magic_link.svg)](https://rubygems.org/gems/simple_auth-magic_link)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+Passwordless authentication for
+[simple_auth](https://github.com/fnando/simple_auth).
+
+## Installation
+
+```bash
+gem install simple_auth-magic_link
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "simple_auth-magic_link"
+```
+
+## Usage
+
+First, you need to copy the migration files and apply the migrations to your
+database.
+
+```console
+$ rails simple_auth_magic_link_engine:install:migrations
+$ rails db:migrate
+```
+
+You can configure the magic link's ttl, code generator and default purpose by
+setting these options directly to `SimpleAuth::MagicLink`:
+
+```ruby
+SimpleAuth::MagicLink.tap do |magic_link|
+  # Optional. By default uses <https://github.com/fnando/haikunate>
+  magic_link.code = -> { SecureRandom.hex(10) }
+
+  # Optional. By default, links expires 3 minutes from now.
+  magic_link.ttl = 1.minute
+
+  # Optional. By default, uses "default".
+  magic_link.purpose = :generic
+
+  # Required. The lambda that will be used to generate the magic link.
+  # This will require the default url options like in
+  # `Rails.application.routes.default_url_options = {host: "example.com"}`
+  magic_link.url = -> { verify_email_url }
+
+  # Required. The keyring that will be used to encrypt the user's email.
+  # Generate the keyring secret and digest salt with the following command:
+  # dd if=/dev/urandom bs=32 count=1 2>/dev/null | openssl base64 -A
+  keyring = {"1" => "<32 bytes>"}
+  magic_link.attr_keyring keyring, digest_salt: "<32 bytes>"
+end
+```
+
+Then, you can create magic links by using
+`magic_link = SimpleAuth::MagicLink.create!(options)`, where `options` can be:
+
+- `email`: required. The email tied to this magic link.
+- `purpose`: optional. A string that identifies the purpose of the magic link.
+  Defaults to `default`. You can use this to discern links that will be used for
+  other purposes (e.g. confirm an action, login, signup, etc).
+- `expires_at`: optional. The code's expiration time. Defaults to three minutes
+  from now.
+- `code`: optional. The code that tied to this magic link. Defaults to
+  [haikunate](https://github.com/fnando/haikunate).
+
+After you create a link, you can send it by email by using `magic_link.url`.
+
+To verify the magic link, you can use
+`email = SimpleAuth::MagicLink.verify(request.original_url, **options)`, where
+options can be:
+
+- `purpose`: required. The purpose of the code being verified.
+
+If the url is valid (i.e. it hasn't been tempered and it hasn't expired), then
+you'll get the email tied to the token back. Otherwise, you'll get `nil`. Notice
+that verified tokens are automatically removed upon verification.
+
+You can also verify the magic link by using just the code (maybe you sent this
+by SMS instead). In this case, you need to call something like
+`email = SimpleAuth::MagicLink.verify_code(code, **options)`. It expects the
+same options as `SimpleAuth::MagicLink.verify`.
+
+To remove expires links, use `SimpleAuth::MagicLink.clean!`.
+
+Notice that this plugin doesn't implement any mailers, so you'll need to handle
+that yourself. For example, a complete flow for a login/signup process would be
+something like this:
+
+1. User fills in log-in form with email address
+2. You call `magic_link = SimpleAuth::MagicLink.create!(email: params[:email])`
+3. You then pass this in to your mailer with something like
+   `Mailer.login(magic_link).send_later`
+4. On your mailer, you can then have access to the user email via
+   `magic_link.email`, the code via `magic_link.code` and the signed url via
+   `magic_link.url`.
+
+## Maintainer
+
+- [me@fnando.com](https://github.com/fnando)
+
+## Contributors
+
+- <https://github.com/fnando/simple_auth-magic_link/contributors>
+
+## Contributing
+
+For more details about how to contribute, please read
+<https://github.com/fnando/simple_auth-magic_link/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/simple_auth-magic_link/blob/main/LICENSE.md>.
+
+## Code of Conduct
+
+Everyone interacting in the simple_auth-magic_link project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/simple_auth-magic_link/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simple_auth-magic_link"
+
+# 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.
+
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,10 @@
+#!/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/db/migrate/001_create_magic_links.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreateMagicLinks < ActiveRecord::Migration[7.0]
+  def change
+    create_table :magic_links do |t|
+      t.integer  :keyring_id, null: false
+      t.text     :code_digest, null: false
+      t.text     :email_digest, null: false
+      t.text     :purpose, null: false
+      t.binary   :encrypted_code, null: false
+      t.binary   :encrypted_email, null: false
+      t.datetime :expires_at, null: false
+      t.datetime :created_at, null: false
+    end
+
+    add_index :magic_links, :code_digest, unique: true
+    add_index :magic_links, %i[purpose email_digest], unique: true
+  end
+end

data/lib/simple_auth/magic_link/code_verifier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module MagicLink
+    class CodeVerifier < Verifier
+      def self.call(code, purpose, time)
+        new.call(code, purpose, time)
+      end
+
+      def call(code, purpose, time)
+        verify_model(code, purpose, time)
+      end
+    end
+  end
+end

data/lib/simple_auth/magic_link/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module MagicLink
+    class Engine < Rails::Engine
+    end
+  end
+end

data/lib/simple_auth/magic_link/model.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module MagicLink
+    class Model < ActiveRecord::Base
+      include AttrKeyring.active_record
+
+      self.table_name = "magic_links"
+
+      attr_encrypt :code, :email
+
+      def url
+        url = Rails.application.routes.url_helpers.instance_eval(&MagicLink.url)
+
+        SignedURL.call(
+          url,
+          key: MagicLink.keyring.current_key.encryption_key,
+          expires: expires_at,
+          params: {code:, purpose:}
+        )
+      end
+    end
+  end
+end

data/lib/simple_auth/magic_link/templates/migration.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateMagicLinks < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
+  def change
+    create_table :magic_links do |t|
+      t.integer  :keyring_id, null: false
+      t.text     :code_digest, null: false
+      t.binary   :encrypted_code, null: false
+      t.datetime :expires_at, null: false
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/lib/simple_auth/magic_link/verifier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module MagicLink
+    class Verifier
+      def self.call(url, purpose, time)
+        new.call(url, purpose, time)
+      end
+
+      def call(url, purpose, time)
+        return unless SignedURL.verified?(url, key: MagicLink.encryption_key)
+
+        uri = URI(url)
+        params = Rack::Utils.parse_query(uri.query)
+        code = params.fetch("code")
+
+        verify_model(code, purpose, time)
+      end
+
+      def verify_model(code, purpose, time)
+        magic_link = MagicLink
+                     .model
+                     .where("expires_at >= ?", time)
+                     .find_by(
+                       code_digest: MagicLink.keyring.digest(code),
+                       purpose:
+                     )
+
+        return unless magic_link
+
+        magic_link.destroy!
+
+        magic_link.email
+      end
+    end
+  end
+end

data/lib/simple_auth/magic_link/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SimpleAuth
+  module MagicLink
+    VERSION = "0.0.1"
+  end
+end

data/lib/simple_auth/magic_link.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "attr_keyring"
+require "defaults"
+require "haikunate"
+require "url_signature"
+require "rails/engine"
+
+require_relative "magic_link/engine"
+require_relative "magic_link/model"
+require_relative "magic_link/version"
+require_relative "magic_link/verifier"
+require_relative "magic_link/code_verifier"
+
+module SimpleAuth
+  module MagicLink
+    class << self
+      attr_accessor :code, :ttl, :purpose, :url
+
+      delegate :attr_keyring, :keyring, to: :model
+    end
+
+    def self.default_code
+      lambda do
+        Haikunate.call(variant: -> { SecureRandom.hex(3) })
+      end
+    end
+
+    def self.encryption_key
+      MagicLink.keyring.current_key.encryption_key
+    end
+
+    def self.model
+      Model
+    end
+
+    def self.create!(
+      email:,
+      code: MagicLink.code.call,
+      purpose: MagicLink.purpose,
+      expires_at: Time.now.utc + MagicLink.ttl
+    )
+      model.where(
+        email_digest: model.keyring.digest(email),
+        purpose:
+      ).delete_all
+
+      model.create!(
+        email:,
+        code:,
+        purpose:,
+        expires_at:
+      )
+    end
+
+    def self.verify(
+      url,
+      time: Time.current,
+      purpose: MagicLink.purpose,
+      verifier: Verifier
+    )
+      verifier.call(url, purpose, time)
+    end
+
+    def self.verify_code(
+      code,
+      time: Time.current,
+      purpose: MagicLink.purpose,
+      verifier: CodeVerifier
+    )
+      verifier.call(code, purpose, time)
+    end
+
+    def self.restore_defaults!
+      self.code = default_code
+      self.ttl = 3.minutes
+      self.purpose = "default"
+      self.url = proc { raise "please set the url" }
+    end
+
+    def self.clean!
+      model.where("expires_at < ?", Time.current).delete_all
+    end
+
+    restore_defaults!
+  end
+end

data/lib/simple_auth-magic_link.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "simple_auth/magic_link"

data/simple_auth-magic_link.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "lib/simple_auth/magic_link/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "simple_auth-magic_link"
+  spec.version = SimpleAuth::MagicLink::VERSION
+  spec.authors = ["me@fnando.com"]
+  spec.email   = ["me@fnando.com"]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  spec.summary     = "Passwordless sign-in for simple_auth."
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
+
+  github_url = "https://github.com/fnando/simple_auth-magic_link"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|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_dependency "activerecord"
+  spec.add_dependency "attr_keyring"
+  spec.add_dependency "defaults"
+  spec.add_dependency "haikunate"
+  spec.add_dependency "simple_auth"
+  spec.add_dependency "url_signature"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,303 @@
+--- !ruby/object:Gem::Specification
+name: simple_auth-magic_link
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- me@fnando.com
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_keyring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: defaults
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haikunate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: url_signature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mocha
+  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: rails
+  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: rubocop
+  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: rubocop-fnando
+  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: sqlite3
+  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: Passwordless sign-in for simple_auth.
+email:
+- me@fnando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/migrate/001_create_magic_links.rb
+- lib/simple_auth-magic_link.rb
+- lib/simple_auth/magic_link.rb
+- lib/simple_auth/magic_link/code_verifier.rb
+- lib/simple_auth/magic_link/engine.rb
+- lib/simple_auth/magic_link/model.rb
+- lib/simple_auth/magic_link/templates/migration.erb
+- lib/simple_auth/magic_link/verifier.rb
+- lib/simple_auth/magic_link/version.rb
+- simple_auth-magic_link.gemspec
+homepage: https://github.com/fnando/simple_auth-magic_link
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/fnando/simple_auth-magic_link
+  bug_tracker_uri: https://github.com/fnando/simple_auth-magic_link/issues
+  source_code_uri: https://github.com/fnando/simple_auth-magic_link/tree/v0.0.1
+  changelog_uri: https://github.com/fnando/simple_auth-magic_link/tree/v0.0.1/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/simple_auth-magic_link/tree/v0.0.1/README.md
+  license_uri: https://github.com/fnando/simple_auth-magic_link/tree/v0.0.1/LICENSE.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Passwordless sign-in for simple_auth.
+test_files: []