yaag 0.0.19 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c30b61f84668afa0e65809ee40daedd23bade1abd83915f01db62b80241978
-  data.tar.gz: e85146f65486aa58c9df32b42b524121b5196be33fc66f37a620d588e128c421
+  metadata.gz: d12d4feb11b2bf161940d8925180dc1bf27a57029521197bef08bac48c5a8997
+  data.tar.gz: a26d2996a3aa9fe193a074c0f9f745b977a048f33df2e13d479a5ec5d267a87f
 SHA512:
-  metadata.gz: 92d04143a6e0592b38e19200ba796be3934f671bb3ccb5ab2b471bba34e9388740c3c0094dc17541a286c2dd5ae0ff1f71dcbf926432a4919dd6a2f95ed2300e
-  data.tar.gz: cfa7aaea9e9de5e05d51d374fbddcccc764066676aa80948c2a0418046f34692723f8bb7924dc98c6687eb17c69699c7906a5fbe7747e19a0dd3104f09b2927e
+  metadata.gz: abc264f8d2def0f837f46056fa41811ce8dbf9cdd7cc69cca56153edff8d6eb67e76b721427051a467724945cd21d771fc4dba5b03a143373dfe460735898549
+  data.tar.gz: 1ce0344f09b9c879b0d23f6ba4d055a8fbceabb06a813770033734600e6dac2fff242e3df34c4655cf009bc2fa67e54f1ee30c2e7b532beeb1bff980e3986753

data/README.md

@@ -32,10 +32,10 @@ bundle
 
 Generate the authentication components (migrations, etc):
 ```bash
-$ gem install authentication:install
+rails g authentication:install
 ```
 
-Follow the instructions post-installation.
+Follow the on-screen post-installation instructions.
 
 ## Usage
 
@@ -60,5 +60,39 @@ class MyController < ApplicationController
 end
 ```
 
+### Generators
+
+Here is a list of generator available in case any of the components of the gem need to be customized to specific application needs.
+
+For views:
+
+```bash
+rails g authentication:copy:views
+```
+
+For controllers (including concerns):
+
+```bash
+rails g authentication:copy:controllers
+```
+
+### Test helper
+
+To be able to perform tasks as an authenticated user, a helper is available to be used in tests. Add `include Yaag::Test::SessionsHelper` to access the methods `sign_in_as` and `sign_out`:
+
+```
+class MyControllerTest < ActionDispatch::IntegrationTest
+  include Yaag::Test::SessionsHelper
+  setup { sign_in_as(User.take) }
+  ...
+end
+```
+
+## Release
+
+```bash
+git tag $(bundle exec rake version | tr -d '"') && git push --tags
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,4 +7,4 @@ require "bundler/gem_tasks"
 
 task :version do
   p "v#{Yaag::VERSION}"
-end
+end

data/app/controllers/sessions_controller.rb

@@ -8,12 +8,12 @@ class SessionsController < ApplicationController
 
   def create
     start_new_session_for @user
-    redirect_to after_authentication_url
+    redirect_to after_authentication_url, notice: I18n.t("yaag.sessions.successful")
   end
 
   def destroy
     terminate_session
-    redirect_to new_signin_path, notice: I18n.t("yaag.sessions.successful"), status: :see_other
+    redirect_to new_signin_path, notice: I18n.t("yaag.sessions.destroy"), status: :see_other
   end
   private
     def set_user_by_token

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

@@ -1,8 +1,14 @@
 <%= 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>
+<div class="container w-50 ">
+  <h2>Sign In</h2>
+  <%= form_with url: signin_path do |form| %>
+    <div class="field mt-3">
+      <%= form.email_field :email_address, required: true, autofocus: true, autocomplete: "username", placeholder: t("yaag.forms.signin_placeholder"), value: params[:email_address], class: "form-control" %><br>
+    </div>
+    <div class="actions mb-3">
+      <%= form.submit t("yaag.forms.signin_button"), class: "form-control btn btn-primary" %>
+    </div>
+  <% end %>
+</div>

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

@@ -1,5 +1,6 @@
 <p>
-  You can signin <%= link_to "with this link", create_session_url(@user.email_address_login_token) %>.
-
+  Click <%= link_to "here", create_session_url(@user.email_address_login_token) %> to sign in.
+</p>
+<p>
   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

@@ -1,4 +1,5 @@
-You can signin with the following link: 
+You can sign in with the following link (copy and paste in the browser):
+
 <%= 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

@@ -9,6 +9,7 @@ en:
       signin_placeholder: "Enter your email address"
     sessions:
       successful: "Signed in successfully."
+      destroy: "Signed out successfully."
     signins:
       email_sent: "Sign in address sent to provided e-mail."
       email_subject: "Sign in link"

data/lib/generators/authentication/copy/controllers_generator.rb

@@ -0,0 +1,13 @@
+module Authentication
+  module Copy
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../", __dir__)
+
+      def copy_controllers
+        copy_file "app/controllers/concerns/authentication.rb"
+        copy_file "app/controllers/sessions_controller.rb"
+        copy_file "app/controllers/signins_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/authentication/copy/views_generator.rb

@@ -0,0 +1,14 @@
+module Authentication
+  module Copy
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../", __dir__)
+
+      def copy_views
+        copy_file "app/views/sessions/new.html.erb"
+        copy_file "app/views/signins/new.html.erb"
+        copy_file "app/views/signins_mailer/token.html.erb"
+        copy_file "app/views/signins_mailer/token.text.erb"
+      end
+    end
+  end
+end

data/lib/generators/authentication/templates/README

@@ -30,4 +30,10 @@ end
 
 ===============================================================
 
+More generators available for customizations:
+
+./bin/rails db:migrate g authentication:copy:views
+
+===============================================================
+
 See more at: https://github.com/nu12/yaag

data/lib/yaag/test/sessions_helper.rb

@@ -0,0 +1,19 @@
+module Yaag
+  module Test
+    module SessionsHelper
+      def sign_in_as(user)
+        Current.session = user.sessions.create!
+
+        ActionDispatch::TestRequest.create.cookie_jar.tap do |cookie_jar|
+          cookie_jar.signed[:session_id] = Current.session.id
+          cookies["session_id"] = cookie_jar[:session_id]
+        end
+      end
+
+      def sign_out
+        Current.session&.destroy!
+        cookies.delete("session_id")
+      end
+    end
+  end
+end

data/lib/yaag/version.rb

@@ -1,3 +1,3 @@
 module Yaag
-  VERSION = "0.0.19"
+  VERSION = "0.2.0"
 end

data/lib/yaag.rb

@@ -2,6 +2,9 @@ require "yaag/version"
 require "yaag/engine"
 
 module Yaag
+  module Test
+    autoload :SessionsHelper, "yaag/test/sessions_helper"
+  end
   module PasswordlessLogin
     extend ActiveSupport::Concern
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: yaag
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.2.0
 platform: ruby
 authors:
 - nu12
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies: []
-description: Passwordless authentication.
+description: Yet Another Authentication Gem (YAAG) provides passwordless authentication
+  for your Ruby on Rails app, all it takes is the user's e-mail address.
 email:
 - 34694287+nu12@users.noreply.github.com
 executables: []
@@ -36,11 +37,14 @@ files:
 - db/migrate/20260108164812_create_users.rb
 - db/migrate/20260108165215_create_sessions.rb
 - lib/generators/authentication/USAGE
+- lib/generators/authentication/copy/controllers_generator.rb
+- lib/generators/authentication/copy/views_generator.rb
 - 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/test/sessions_helper.rb
 - lib/yaag/version.rb
 homepage: https://github.com/nu12/yaag
 licenses:
@@ -66,5 +70,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Passwordless authentication.
+summary: Passwordless authentication for your Ruby on Rails app.
 test_files: []