yaag 0.0.1 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5392a92361ab06888e9a382e419a2fd2a9c2eb550073476aa255ebafae4093a3
-  data.tar.gz: d3783baaf6d30da9bf568c7ce585824880c1ca25e6f62f98758f57e7bc0ad47f
+  metadata.gz: 38c30b61f84668afa0e65809ee40daedd23bade1abd83915f01db62b80241978
+  data.tar.gz: e85146f65486aa58c9df32b42b524121b5196be33fc66f37a620d588e128c421
 SHA512:
-  metadata.gz: ccfec1abfd5f86d6be13cef7b367fe8f774cfa9e8f00cf94d20ab595dc3a9577a51163cf71070470d79b3773c4efdde016a906e4cb62ba4391b14b7ae08e01a2
-  data.tar.gz: 45aa07c8b3c8cac0f0063604f4350aaabc43ddf81dc7a2d3e7c43c63177ae136e021df87b0fcf53ead546400b0d992c6a65171c5e412428bf48c56b640a791a1
+  metadata.gz: 92d04143a6e0592b38e19200ba796be3934f671bb3ccb5ab2b471bba34e9388740c3c0094dc17541a286c2dd5ae0ff1f71dcbf926432a4919dd6a2f95ed2300e
+  data.tar.gz: cfa7aaea9e9de5e05d51d374fbddcccc764066676aa80948c2a0418046f34692723f8bb7924dc98c6687eb17c69699c7906a5fbe7747e19a0dd3104f09b2927e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 
+
+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,35 +1,64 @@
-# Yaag
+# Yet Another Authentication Gem
 
-TODO: Delete this and the text below, and describe your gem
+Yet Another Authentication Gem (YAAG) provides passwordless authentication for your rails app, all it takes is the user's e-mail address. 
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yaag`. To experiment with that code, run `bin/console` for an interactive prompt.
+No password. No e-mail confirmation. No registration.
 
-## Installation
+## TL;DR
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```
+bundle add yaag
+bundle install
 
-Install the gem and add to the application's Gemfile by executing:
+rails g authentication:install
+rails db:migrate
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## How it works
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+It's the same mechanics of password reset in traditional authentication: the user provides an e-amil address and receives a link with a token to sign in. At its core, it implements the same logic of the built-in rails authentication (in fact most of the gem's code came from the rails library).
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Installation
+Add this line to your application's Gemfile:
 
-## Usage
+```bash
+bundle add yaag
+```
 
-TODO: Write usage instructions here
+And then execute:
+```bash
+bundle
+```
 
-## Development
+Generate the authentication components (migrations, etc):
+```bash
+$ gem install authentication:install
+```
 
-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.
+Follow the instructions post-installation.
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Usage
 
-## Contributing
+By default, all controllers require signing in via the inclusion of `include Authentication` in the `ApplicationController`. If you have a route that doesn't require signing in, add `allow_unauthenticated_access` to it:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yaag.
+```
+class GuestController < ApplicationController
+  allow_unauthenticated_access only: %i[ index ]
+  ...
+end
+```
 
-## License
+Get the current user with `Current.user` and the current session with `Current.session`
+
+```
+class MyController < ApplicationController
+  def something
+    user = Current.user
+    session = Current.session
+    ...
+  end 
+end
+```
 
+## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
+require "bundler/gem_tasks"
 
-task default: %i[test rubocop]
+task :version do
+  p "v#{Yaag::VERSION}"
+end

data/app/controllers/concerns/authentication.rb

@@ -0,0 +1,52 @@
+module Authentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :require_authentication
+    helper_method :authenticated?
+  end
+
+  class_methods do
+    def allow_unauthenticated_access(**options)
+      skip_before_action :require_authentication, **options
+    end
+  end
+
+  private
+    def authenticated?
+      resume_session
+    end
+
+    def require_authentication
+      resume_session || request_authentication
+    end
+
+    def resume_session
+      Current.session ||= find_session_by_cookie
+    end
+
+    def find_session_by_cookie
+      Session.find_by(id: cookies.signed[:session_id]) if cookies.signed[:session_id]
+    end
+
+    def request_authentication
+      session[:return_to_after_authenticating] = request.url
+      redirect_to new_signin_path
+    end
+
+    def after_authentication_url
+      session.delete(:return_to_after_authenticating) || root_url
+    end
+
+    def start_new_session_for(user)
+      user.sessions.create!(user_agent: request.user_agent, ip_address: request.remote_ip).tap do |session|
+        Current.session = session
+        cookies.signed.permanent[:session_id] = { value: session.id, httponly: true, same_site: :lax }
+      end
+    end
+
+    def terminate_session
+      Current.session.destroy
+      cookies.delete(:session_id)
+    end
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,24 @@
+class SessionsController < ApplicationController
+  allow_unauthenticated_access only: %i[ new create ]
+  before_action :set_user_by_token, only: %i[ create ]
+  rate_limit to: 10, within: 3.minutes, only: :create, with: -> { redirect_to new_session_path, alert: I18n.t("yaag.errors.rate_limit") }
+
+  def new
+  end
+
+  def create
+    start_new_session_for @user
+    redirect_to after_authentication_url
+  end
+
+  def destroy
+    terminate_session
+    redirect_to new_signin_path, notice: I18n.t("yaag.sessions.successful"), status: :see_other
+  end
+  private
+    def set_user_by_token
+      @user = User.find_by_email_address_login_token!(params[:token])
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect_to new_signin_path, alert: I18n.t("yaag.errors.invalid_token"), status: :see_other
+    end
+end

data/app/controllers/signins_controller.rb

@@ -0,0 +1,12 @@
+class SigninsController < ApplicationController
+  allow_unauthenticated_access
+  rate_limit to: 10, within: 3.minutes, only: :create, with: -> { redirect_to new_signin_path, alert: I18n.t("yaag.errors.rate_limit") }
+  def new
+  end
+
+  def create
+    user = User.find_or_create_by(email_address: params[:email_address])
+    SigninsMailer.token(user).deliver_now
+    redirect_to new_session_path, notice: I18n.t("yaag.signins.email_sent"), status: :see_other
+  end
+end

data/app/mailers/signins_mailer.rb

@@ -0,0 +1,6 @@
+class SigninsMailer < ApplicationMailer
+  def token(user)
+    @user = user
+    mail subject: I18n.t("yaag.signins.email_subject"), to: user.email_address
+  end
+end

data/app/models/current.rb

@@ -0,0 +1,4 @@
+class Current < ActiveSupport::CurrentAttributes
+  attribute :session
+  delegate :user, to: :session, allow_nil: true
+end

data/app/models/session.rb

@@ -0,0 +1,3 @@
+class Session < ApplicationRecord
+  belongs_to :user
+end

data/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < ApplicationRecord
+  include Yaag::PasswordlessLogin
+  has_passwordless_login
+  has_many :sessions, dependent: :destroy
+
+  normalizes :email_address, with: ->(e) { e.strip.downcase }
+end

data/app/views/sessions/new.html.erb

@@ -0,0 +1,2 @@
+<%= tag.div(flash[:alert], style: "color:red") if flash[:alert] %>
+<%= tag.div(flash[:notice], style: "color:green") if flash[:notice] %>

data/app/views/signins/new.html.erb

@@ -0,0 +1,8 @@
+<%= tag.div(flash[:alert], style: "color:red") if flash[:alert] %>
+<%= tag.div(flash[:notice], style: "color:green") if flash[:notice] %>
+
+<%= form_with url: signin_path do |form| %>
+  <%= form.email_field :email_address, required: true, autofocus: true, autocomplete: "username", placeholder: t("yaag.forms.signin_placeholder"), value: params[:email_address] %><br>
+  <%= form.submit t("yaag.forms.signin_button") %>
+<% end %>
+<br>

data/app/views/signins_mailer/token.html.erb

@@ -0,0 +1,5 @@
+<p>
+  You can signin <%= link_to "with this link", create_session_url(@user.email_address_login_token) %>.
+
+  This link will expire in <%= distance_of_time_in_words(0, @user.email_address_login_token_expires_in) %>.
+</p>

data/app/views/signins_mailer/token.text.erb

@@ -0,0 +1,4 @@
+You can signin with the following link: 
+<%= create_session_url(@user.email_address_login_token) %>
+
+This link will expire in <%= distance_of_time_in_words(0, @user.email_address_login_token_expires_in) %>.

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+
+en:
+  yaag:
+    errors:
+      invalid_token: "Signin link is invalid or has expired."
+      rate_limit: "Try again later."
+    forms:
+      signin_button: "Sign in" 
+      signin_placeholder: "Enter your email address"
+    sessions:
+      successful: "Signed in successfully."
+    signins:
+      email_sent: "Sign in address sent to provided e-mail."
+      email_subject: "Sign in link"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  resource :signin, only: [ :new, :create ]
+  resource :session, only: [ :new, :destroy ] do
+    get "/:token/create" => "sessions#create", as: :create
+  end
+end

data/db/migrate/20260108164812_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration[8.1]
+  def change
+    create_table :users do |t|
+      t.string :email_address, null: false
+
+      t.timestamps
+    end
+    add_index :users, :email_address, unique: true
+  end
+end

data/db/migrate/20260108165215_create_sessions.rb

@@ -0,0 +1,11 @@
+class CreateSessions < ActiveRecord::Migration[8.1]
+  def change
+    create_table :sessions do |t|
+      t.references :user, null: false, foreign_key: true
+      t.string :ip_address
+      t.string :user_agent
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/authentication/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates a basic passwordless authentication system with users and sessions.
+
+Example:
+    bin/rails generate authentication:install
+

data/lib/generators/authentication/install_generator.rb

@@ -0,0 +1,18 @@
+module Authentication
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def configure_application_controller
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  include Authentication\n"
+    end
+
+    def generate_migrations
+      generate "migration", "CreateUsers", "email_address:string!:uniq", "--force"
+      generate "migration", "CreateSessions", "user:references ip_address:string user_agent:string", "--force"
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+  end
+end

data/lib/generators/authentication/templates/README

@@ -0,0 +1,33 @@
+
+Yet Another Authentication Gem (YAAG)
+
+===============================================================
+
+To complete the installation, run a database migration:
+
+./bin/rails db:migrate
+
+===============================================================
+
+Make sure root route is present in config/routes.rb. Example:
+
+Rails.application.routes.draw do
+  ...
+  root "controller#action"
+  ...
+end
+
+===============================================================
+
+By default, all controllers require user signin.
+
+To allow unauthenticated access, add allow_unauthenticated_access to your controller. Example:
+
+class MyController < ApplicationController
+  allow_unauthenticated_access only: %i[ index ]
+  ...
+end
+
+===============================================================
+
+See more at: https://github.com/nu12/yaag

data/lib/tasks/yaag_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :yaag do
+#   # Task goes here
+# end

data/lib/yaag/engine.rb

@@ -0,0 +1,4 @@
+module Yaag
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/yaag/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Yaag
-  VERSION = "0.0.1"
+  VERSION = "0.0.19"
 end

data/lib/yaag.rb

@@ -1,8 +1,51 @@
-# frozen_string_literal: true
-
-require_relative "yaag/version"
+require "yaag/version"
+require "yaag/engine"
 
 module Yaag
-  class Error < StandardError; end
-  # Your code goes here...
+  module PasswordlessLogin
+    extend ActiveSupport::Concern
+
+    DEFAULT_LOGIN_TOKEN_EXPIRES_IN = 15.minutes
+
+    class << self
+    end
+
+    module ClassMethods
+      def has_passwordless_login(attribute = :email_address)
+        include InstanceMethodsOnActivation.new(attribute)
+
+        if respond_to?(:generates_token_for)
+          login_token_expires_in = DEFAULT_LOGIN_TOKEN_EXPIRES_IN
+
+          silence_redefinition_of_method(:"#{attribute}_login_token_expires_in")
+          define_method(:"#{attribute}_login_token_expires_in") { login_token_expires_in }
+
+          generates_token_for :"#{attribute}_login", expires_in: login_token_expires_in do
+            public_send(:"#{attribute}")&.first(10)
+          end
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            silence_redefinition_of_method :find_by_#{attribute}_login_token
+            def self.find_by_#{attribute}_login_token(token)
+              find_by_token_for(:#{attribute}_login, token)
+            end
+
+            silence_redefinition_of_method :find_by_#{attribute}_login_token!
+            def self.find_by_#{attribute}_login_token!(token)
+              find_by_token_for!(:#{attribute}_login, token)
+            end
+          RUBY
+        end
+      end
+    end
+
+    class InstanceMethodsOnActivation < Module
+      def initialize(attribute)
+        # attr_accessor attribute
+        define_method("#{attribute}_login_token") do
+          generate_token_for(:"#{attribute}_login")
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.19
 platform: ruby
 authors:
 - nu12
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-27 00:00:00.000000000 Z
+date: 2026-01-09 00:00:00.000000000 Z
 dependencies: []
 description: Passwordless authentication.
 email:
@@ -17,14 +17,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/concerns/authentication.rb
+- app/controllers/sessions_controller.rb
+- app/controllers/signins_controller.rb
+- app/mailers/signins_mailer.rb
+- app/models/current.rb
+- app/models/session.rb
+- app/models/user.rb
+- app/views/sessions/new.html.erb
+- app/views/signins/new.html.erb
+- app/views/signins_mailer/token.html.erb
+- app/views/signins_mailer/token.text.erb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20260108164812_create_users.rb
+- db/migrate/20260108165215_create_sessions.rb
+- lib/generators/authentication/USAGE
+- lib/generators/authentication/install_generator.rb
+- lib/generators/authentication/templates/README
+- lib/tasks/yaag_tasks.rake
 - lib/yaag.rb
+- lib/yaag/engine.rb
 - lib/yaag/version.rb
-- mise.toml
-- sig/yaag.rbs
 homepage: https://github.com/nu12/yaag
 licenses:
 - MIT

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 TODO: Write your name
-
-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/mise.toml

@@ -1,2 +0,0 @@
-[tools]
-ruby = "3.2.8"

data/sig/yaag.rbs

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