dymk/redux-scraper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit for devise and user auth

Browse Source
This commit is contained in:
Dylan Knutson
2024-12-27 19:03:08 +00:00
parent 7e19e78073
commit 18b9bf531c
31 changed files with 1027 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Gemfile
View File

@@ -145,3 +145,9 @@ end
gem "cssbundling-rails", "~> 1.4"
gem "tailwindcss-rails", "~> 3.0"
# Authentication
gem "devise", "~> 4.9"
# Authorization
gem "pundit", "~> 2.4"

17
Gemfile.lock
View File

@@ -104,6 +104,7 @@ GEM
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
base64 (0.2.0)
bcrypt (3.1.20)
benchmark (0.4.0)
bigdecimal (3.1.8)
bindex (0.8.1)
@@ -139,6 +140,12 @@ GEM
irb (~> 1.10)
reline (>= 0.3.8)
debug_inspector (1.1.0)
devise (4.9.4)
bcrypt (~> 3.0)
orm_adapter (~> 0.1)
railties (>= 4.1.0)
responders
warden (~> 1.2.3)
diff-lcs (1.5.1)
diffy (3.4.2)
discard (1.2.1)
@@ -237,6 +244,7 @@ GEM
mini_portile2 (~> 2.8.2)
racc (~> 1.4)
numo-narray (0.9.2.1)
orm_adapter (0.5.0)
parallel (1.26.3)
parallel_tests (4.7.2)
parallel
@@ -260,6 +268,8 @@ GEM
public_suffix (5.0.1)
puma (5.6.5)
nio4r (~> 2.0)
pundit (2.4.0)
activesupport (>= 3.0.0)
raabro (1.4.0)
racc (1.8.1)
rack (2.2.10)
@@ -329,6 +339,9 @@ GEM
regexp_parser (2.6.2)
reline (0.6.0)
io-console (~> 0.5)
responders (3.1.1)
actionpack (>= 5.2)
railties (>= 5.2)
rexml (3.2.5)
rice (4.0.4)
ripcord (2.0.0)
@@ -407,6 +420,8 @@ GEM
unf_ext
unf_ext (0.0.8.2)
useragent (0.16.11)
warden (1.2.9)
rack (>= 2.0.9)
web-console (4.2.0)
actionview (>= 6.0.0)
activemodel (>= 6.0.0)
@@ -440,6 +455,7 @@ DEPENDENCIES
curb
daemons
debug (~> 1.10)
devise (~> 4.9)
diffy
discard
disco
@@ -463,6 +479,7 @@ DEPENDENCIES
pry
pry-stack_explorer
puma (~> 5.0)
pundit (~> 2.4)
rack-cors
rack-mini-profiler (~> 3.3)
rails (~> 7.2)

23
app/controllers/application_controller.rb
View File

@@ -1,5 +1,7 @@
class ApplicationController < ActionController::Base
before_action :validate_api_token
include Pundit::Authorization
before_action :authenticate_user_or_validate_api_token
before_action do
if Rails.env.development? || Rails.env.staging?
Rack::MiniProfiler.authorize_request
@@ -15,12 +17,25 @@ class ApplicationController < ActionController::Base
"9b3cf444-5913-4efb-9935-bf26501232ff" => "syfaro",
}
def validate_api_token
protected
def authenticate_user_or_validate_api_token
api_token = request.params[:api_token]
user = API_TOKENS[api_token]
if user.nil?
api_user_name = API_TOKENS[api_token]
if api_user_name.nil?
return if VpnOnlyRouteConstraint.new.matches?(request)
render status: 403, json: { error: "not authenticated" }
end
end
# Pundit authorization error handling
rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
private
def user_not_authorized
flash[:alert] = "You are not authorized to perform this action."
redirect_back(fallback_location: root_path)
end
end

9
app/controllers/domain/fa/users_controller.rb
View File

@@ -1,14 +1,19 @@
class Domain::Fa::UsersController < ApplicationController
before_action :set_user, only: %i[show]
skip_before_action :validate_api_token, only: %i[show]
skip_before_action :authenticate_user_or_validate_api_token, only: %i[show]
# GET /domain/fa/users or /domain/fa/users.json
def index
@users = Domain::Fa::User.includes({ avatar: [:file] }).page(params[:page])
authorize Domain::Fa::User
@users =
policy_scope(Domain::Fa::User).includes({ avatar: [:file] }).page(
params[:page],
)
end
# GET /domain/fa/users/1 or /domain/fa/users/1.json
def show
authorize @user
end
private

2
app/controllers/pages_controller.rb
View File

@@ -1,5 +1,5 @@
class PagesController < ApplicationController
skip_before_action :validate_api_token, only: [:root]
skip_before_action :authenticate_user_or_validate_api_token, only: [:root]
def root
render :root

16
app/models/user.rb Normal file
View File

@@ -0,0 +1,16 @@
class User < ReduxApplicationRecord
# Include default devise modules. Others available are:
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
devise :database_authenticatable,
:registerable,
:recoverable,
:rememberable,
:validatable
enum role: {
user: "user",
admin: "admin",
moderator: "moderator",
},
_default: "user"
end

53
app/policies/application_policy.rb Normal file
View File

@@ -0,0 +1,53 @@
# frozen_string_literal: true
class ApplicationPolicy
attr_reader :user, :record
def initialize(user, record)
@user = user
@record = record
end
def index?
false
end
def show?
false
end
def create?
false
end
def new?
create?
end
def update?
false
end
def edit?
update?
end
def destroy?
false
end
class Scope
def initialize(user, scope)
@user = user
@scope = scope
end
def resolve
raise NoMethodError, "You must define #resolve in #{self.class}"
end
private
attr_reader :user, :scope
end
end

24
app/policies/domain/fa/user_policy.rb Normal file
View File

@@ -0,0 +1,24 @@
class Domain::Fa::UserPolicy < ApplicationPolicy
def index?
true # Anyone can view the index
end
def show?
true # Anyone can view user profiles
end
# Only admins and moderators can access these actions
def scan_user?
user&.admin? || user&.moderator?
end
def enqueue_objects?
user&.admin? || user&.moderator?
end
class Scope < Scope
def resolve
scope.all
end
end
end

16
app/views/devise/confirmations/new.html.erb Normal file
View File

@@ -0,0 +1,16 @@
<h2>Resend confirmation instructions</h2>
<%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email", value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %>
</div>
<div class="actions">
<%= f.submit "Resend confirmation instructions" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

5
app/views/devise/mailer/confirmation_instructions.html.erb Normal file
View File

@@ -0,0 +1,5 @@
<p>Welcome <%= @email %>!</p>
<p>You can confirm your account email through the link below:</p>
<p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>

7
app/views/devise/mailer/email_changed.html.erb Normal file
View File

@@ -0,0 +1,7 @@
<p>Hello <%= @email %>!</p>
<% if @resource.try(:unconfirmed_email?) %>
<p>We're contacting you to notify you that your email is being changed to <%= @resource.unconfirmed_email %>.</p>
<% else %>
<p>We're contacting you to notify you that your email has been changed to <%= @resource.email %>.</p>
<% end %>

3
app/views/devise/mailer/password_change.html.erb Normal file
View File

@@ -0,0 +1,3 @@
<p>Hello <%= @resource.email %>!</p>
<p>We're contacting you to notify you that your password has been changed.</p>

8
app/views/devise/mailer/reset_password_instructions.html.erb Normal file
View File

@@ -0,0 +1,8 @@
<p>Hello <%= @resource.email %>!</p>
<p>Someone has requested a link to change your password. You can do this through the link below.</p>
<p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
<p>If you didn't request this, please ignore this email.</p>
<p>Your password won't change until you access the link above and create a new one.</p>

7
app/views/devise/mailer/unlock_instructions.html.erb Normal file
View File

@@ -0,0 +1,7 @@
<p>Hello <%= @resource.email %>!</p>
<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
<p>Click the link below to unlock your account:</p>
<p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>

25
app/views/devise/passwords/edit.html.erb Normal file
View File

@@ -0,0 +1,25 @@
<h2>Change your password</h2>
<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<%= f.hidden_field :reset_password_token %>
<div class="field">
<%= f.label :password, "New password" %><br />
<% if @minimum_password_length %>
<em>(<%= @minimum_password_length %> characters minimum)</em><br />
<% end %>
<%= f.password_field :password, autofocus: true, autocomplete: "new-password" %>
</div>
<div class="field">
<%= f.label :password_confirmation, "Confirm new password" %><br />
<%= f.password_field :password_confirmation, autocomplete: "new-password" %>
</div>
<div class="actions">
<%= f.submit "Change my password" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

34
app/views/devise/passwords/new.html.erb Normal file
View File

@@ -0,0 +1,34 @@
<div class="mx-auto mt-8 max-w-md rounded-lg bg-white p-6 shadow-md">
<h2 class="mb-6 text-2xl font-bold text-slate-900">Forgot your password?</h2>
<%= form_for(
resource,
as: resource_name,
url: password_path(resource_name),
html: {
method: :post,
class: "space-y-4",
},
) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email, class: "block text-sm font-medium text-slate-700" %>
<%= f.email_field :email,
autofocus: true,
autocomplete: "email",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="actions">
<%= f.submit "Send reset password instructions",
class:
"w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-slate-600 hover:bg-slate-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-slate-500" %>
</div>
<% end %>
<div class="mt-6 text-center text-sm">
<%= render "devise/shared/links" %>
</div>
</div>

91
app/views/devise/registrations/edit.html.erb Normal file
View File

@@ -0,0 +1,91 @@
<div class="mx-auto mt-8 max-w-md rounded-lg bg-white p-6 shadow-md">
<h2 class="mb-6 text-2xl font-bold text-slate-900">Edit Profile</h2>
<%= form_for(
resource,
as: resource_name,
url: registration_path(resource_name),
html: {
method: :put,
class: "space-y-4",
},
) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email, class: "block text-sm font-medium text-slate-700" %>
<%= f.email_field :email,
autofocus: true,
autocomplete: "email",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
<div class="text-sm text-slate-500">
Currently waiting confirmation for: <%= resource.unconfirmed_email %>
</div>
<% end %>
<div class="field">
<%= f.label :password, class: "block text-sm font-medium text-slate-700" %>
<div class="mb-1 text-xs text-slate-500">
(leave blank if you don't want to change it)
</div>
<%= f.password_field :password,
autocomplete: "new-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
<% if @minimum_password_length %>
<div class="mt-1 text-xs text-slate-500">
<%= @minimum_password_length %> characters minimum
</div>
<% end %>
</div>
<div class="field">
<%= f.label :password_confirmation,
class: "block text-sm font-medium text-slate-700" %>
<%= f.password_field :password_confirmation,
autocomplete: "new-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="field">
<%= f.label :current_password, class: "block text-sm font-medium text-slate-700" %>
<div class="mb-1 text-xs text-slate-500">
(we need your current password to confirm your changes)
</div>
<%= f.password_field :current_password,
autocomplete: "current-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="actions">
<%= f.submit "Update",
class:
"w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-slate-600 hover:bg-slate-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-slate-500" %>
</div>
<% end %>
<div class="mt-8 border-t border-slate-200 pt-6">
<h3 class="mb-4 text-lg font-medium text-slate-900">Cancel my account</h3>
<div class="mb-4 text-sm text-slate-500">Unhappy?</div>
<%= button_to "Cancel my account",
registration_path(resource_name),
data: {
confirm: "Are you sure?",
turbo_confirm: "Are you sure?",
},
method: :delete,
class:
"w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-red-600 hover:bg-red-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500" %>
</div>
<div class="mt-6 text-center text-sm">
<%= link_to "Back", :back, class: "text-slate-600 hover:text-slate-900" %>
</div>
</div>

55
app/views/devise/registrations/new.html.erb Normal file
View File

@@ -0,0 +1,55 @@
<div class="mx-auto mt-8 max-w-md rounded-lg bg-white p-6 shadow-md">
<h2 class="mb-6 text-2xl font-bold text-slate-900">Sign Up</h2>
<%= form_for(
resource,
as: resource_name,
url: registration_path(resource_name),
html: {
class: "space-y-4",
},
) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email, class: "block text-sm font-medium text-slate-700" %>
<%= f.email_field :email,
autofocus: true,
autocomplete: "email",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="field">
<%= f.label :password, class: "block text-sm font-medium text-slate-700" %>
<% if @minimum_password_length %>
<span class="text-xs text-slate-500"
>(<%= @minimum_password_length %> characters minimum)</span
>
<% end %>
<%= f.password_field :password,
autocomplete: "new-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="field">
<%= f.label :password_confirmation,
class: "block text-sm font-medium text-slate-700" %>
<%= f.password_field :password_confirmation,
autocomplete: "new-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="actions">
<%= f.submit "Sign up",
class:
"w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-slate-600 hover:bg-slate-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-slate-500" %>
</div>
<% end %>
<div class="mt-6 text-center text-sm">
<%= render "devise/shared/links" %>
</div>
</div>

48
app/views/devise/sessions/new.html.erb Normal file
View File

@@ -0,0 +1,48 @@
<div class="mx-auto mt-8 max-w-md rounded-lg bg-white p-6 shadow-md">
<h2 class="mb-6 text-2xl font-bold text-slate-900">Sign In</h2>
<%= form_for(
resource,
as: resource_name,
url: session_path(resource_name),
html: {
class: "space-y-4",
},
) do |f| %>
<div class="field">
<%= f.label :email, class: "block text-sm font-medium text-slate-700" %>
<%= f.email_field :email,
autofocus: true,
autocomplete: "email",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<div class="field">
<%= f.label :password, class: "block text-sm font-medium text-slate-700" %>
<%= f.password_field :password,
autocomplete: "current-password",
class:
"mt-1 block w-full rounded-md border-slate-300 shadow-sm focus:border-slate-500 focus:ring-slate-500" %>
</div>
<% if devise_mapping.rememberable? %>
<div class="field flex items-center">
<%= f.check_box :remember_me,
class:
"h-4 w-4 rounded border-slate-300 text-slate-600 focus:ring-slate-500" %>
<%= f.label :remember_me, class: "ml-2 block text-sm text-slate-700" %>
</div>
<% end %>
<div class="actions">
<%= f.submit "Sign in",
class:
"w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-slate-600 hover:bg-slate-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-slate-500" %>
</div>
<% end %>
<div class="mt-6 text-center text-sm">
<%= render "devise/shared/links" %>
</div>
</div>

37
app/views/devise/shared/_error_messages.html.erb Normal file
View File

@@ -0,0 +1,37 @@
<% if resource.errors.any? %>
<div class="mb-6 border-l-4 border-red-400 bg-red-50 p-4" role="alert">
<div class="flex">
<div class="flex-shrink-0">
<svg
class="h-5 w-5 text-red-400"
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 20 20"
fill="currentColor"
aria-hidden="true"
>
<path
fill-rule="evenodd"
d="M10 18a8 8 0 100-16 8 8 0 000 16zM8.707 7.293a1 1 0 00-1.414 1.414L8.586 10l-1.293 1.293a1 1 0 101.414 1.414L10 11.414l1.293 1.293a1 1 0 001.414-1.414L11.414 10l1.293-1.293a1 1 0 00-1.414-1.414L10 8.586 8.707 7.293z"
clip-rule="evenodd"
/>
</svg>
</div>
<div class="ml-3">
<h3 class="text-sm font-medium text-red-800">
<%= I18n.t(
"errors.messages.not_saved",
count: resource.errors.count,
resource: resource.class.model_name.human.downcase,
) %>
</h3>
<div class="mt-2 text-sm text-red-700">
<ul class="list-disc space-y-1 pl-5">
<% resource.errors.full_messages.each do |message| %>
<li><%= message %></li>
<% end %>
</ul>
</div>
</div>
</div>
</div>
<% end %>

40
app/views/devise/shared/_links.html.erb Normal file
View File

@@ -0,0 +1,40 @@
<div class="space-y-2">
<%- if controller_name != "sessions" %>
<%= link_to "Sign in",
new_session_path(resource_name),
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<%- if devise_mapping.registerable? && controller_name != "registrations" %>
<%= link_to "Sign up",
new_registration_path(resource_name),
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<%- if devise_mapping.recoverable? && controller_name != "passwords" &&
controller_name != "registrations" %>
<%= link_to "Forgot your password?",
new_password_path(resource_name),
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<%- if devise_mapping.confirmable? && controller_name != "confirmations" %>
<%= link_to "Didn't receive confirmation instructions?",
new_confirmation_path(resource_name),
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<%- if devise_mapping.lockable? &&
resource_class.unlock_strategy_enabled?(:email) &&
controller_name != "unlocks" %>
<%= link_to "Didn't receive unlock instructions?",
new_unlock_path(resource_name),
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<%- if devise_mapping.omniauthable? %>
<%- resource_class.omniauth_providers.each do |provider| %>
<%= button_to "Sign in with #{OmniAuth::Utils.camelize(provider)}",
omniauth_authorize_path(resource_name, provider),
data: {
turbo: false,
},
class: "text-slate-600 hover:text-slate-900" %><br />
<% end %>
<% end %>
</div>

16
app/views/devise/unlocks/new.html.erb Normal file
View File

@@ -0,0 +1,16 @@
<h2>Resend unlock instructions</h2>
<%= form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f| %>
<%= render "devise/shared/error_messages", resource: resource %>
<div class="field">
<%= f.label :email %><br />
<%= f.email_field :email, autofocus: true, autocomplete: "email" %>
</div>
<div class="actions">
<%= f.submit "Resend unlock instructions" %>
</div>
<% end %>
<%= render "devise/shared/links" %>

25
app/views/layouts/application.html.erb
View File

@@ -26,12 +26,35 @@
<%= link_to "ReFurrer", root_path %>
</h1>
<div class="flex-grow"></div>
<h2 class="text-1xl sm:text-2xl italic font-bold text-slate-500">
<nav class="flex items-center space-x-4">
<% if user_signed_in? %>
<span class="text-slate-600">
<%= current_user.email %>
<% if current_user.admin? %>
<span class="bg-red-100 text-red-800 text-xs font-medium px-2 py-0.5 rounded">Admin</span>
<% elsif current_user.moderator? %>
<span class="bg-blue-100 text-blue-800 text-xs font-medium px-2 py-0.5 rounded">Mod</span>
<% end %>
</span>
<%= link_to "Edit Profile", edit_user_registration_path, class: "text-slate-600 hover:text-slate-900" %>
<%= button_to "Sign Out", destroy_user_session_path, method: :delete, class: "text-slate-600 hover:text-slate-900" %>
<% else %>
<%= link_to "Sign In", new_user_session_path, class: "text-slate-600 hover:text-slate-900" %>
<%= link_to "Sign Up", new_user_registration_path, class: "text-slate-600 hover:text-slate-900" %>
<% end %>
</nav>
<h2 class="text-1xl sm:text-2xl italic font-bold text-slate-500 ml-4">
Furry Swiss Army Knife
</h2>
</div>
</header>
<main class="flex flex-col grow bg-slate-200">
<% if notice %>
<p class="notice bg-green-100 border border-green-400 text-green-700 px-4 py-3 rounded relative" role="alert"><%= notice %></p>
<% end %>
<% if alert %>
<p class="alert bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative" role="alert"><%= alert %></p>
<% end %>
<%= yield %>
</main>
</body>

5
config/environments/development.rb
View File

@@ -26,7 +26,7 @@ Rails.application.configure do
config.cache_store = :memory_store
config.public_file_server.headers = {
"Cache-Control" => "public, max-age=#{2.days.to_i}"
"Cache-Control" => "public, max-age=#{2.days.to_i}",
}
else
config.action_controller.perform_caching = false
@@ -42,6 +42,9 @@ Rails.application.configure do
config.action_mailer.perform_caching = false
# Devise mailer configuration
config.action_mailer.default_url_options = { host: "localhost", port: 3000 }
# Print deprecation notices to the Rails logger.
config.active_support.deprecation = :log

313
config/initializers/devise.rb Normal file
View File

@@ -0,0 +1,313 @@
# frozen_string_literal: true
# Assuming you have not yet modified this file, each configuration option below
# is set to its default value. Note that some are commented out while others
# are not: uncommented lines are intended to protect your configuration from
# breaking changes in upgrades (i.e., in the event that future versions of
# Devise change the default values for those options).
#
# Use this hook to configure devise mailer, warden hooks and so forth.
# Many of these configuration options can be set straight in your model.
Devise.setup do |config|
# The secret key used by Devise. Devise uses this key to generate
# random tokens. Changing this key will render invalid all existing
# confirmation, reset password and unlock tokens in the database.
# Devise will use the `secret_key_base` as its `secret_key`
# by default. You can change it below and use your own secret key.
# config.secret_key = '08443e1f27377f38e2d78d94609cb1eb0c7bcd44a5751c996b83f5c56e384372ee5c7d756c54ed78164098599fb3200fa2f53914524d92a43132f842e2a816b4'
# ==> Controller configuration
# Configure the parent class to the devise controllers.
# config.parent_controller = 'DeviseController'
# ==> Mailer Configuration
# Configure the e-mail address which will be shown in Devise::Mailer,
# note that it will be overwritten if you use your own mailer class
# with default "from" parameter.
config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
# Configure the class responsible to send e-mails.
# config.mailer = 'Devise::Mailer'
# Configure the parent class responsible to send e-mails.
# config.parent_mailer = 'ActionMailer::Base'
# ==> ORM configuration
# Load and configure the ORM. Supports :active_record (default) and
# :mongoid (bson_ext recommended) by default. Other ORMs may be
# available as additional gems.
require 'devise/orm/active_record'
# ==> Configuration for any authentication mechanism
# Configure which keys are used when authenticating a user. The default is
# just :email. You can configure it to use [:username, :subdomain], so for
# authenticating a user, both parameters are required. Remember that those
# parameters are used only when authenticating and not when retrieving from
# session. If you need permissions, you should implement that in a before filter.
# You can also supply a hash where the value is a boolean determining whether
# or not authentication should be aborted when the value is not present.
# config.authentication_keys = [:email]
# Configure parameters from the request object used for authentication. Each entry
# given should be a request method and it will automatically be passed to the
# find_for_authentication method and considered in your model lookup. For instance,
# if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
# The same considerations mentioned for authentication_keys also apply to request_keys.
# config.request_keys = []
# Configure which authentication keys should be case-insensitive.
# These keys will be downcased upon creating or modifying a user and when used
# to authenticate or find a user. Default is :email.
config.case_insensitive_keys = [:email]
# Configure which authentication keys should have whitespace stripped.
# These keys will have whitespace before and after removed upon creating or
# modifying a user and when used to authenticate or find a user. Default is :email.
config.strip_whitespace_keys = [:email]
# Tell if authentication through request.params is enabled. True by default.
# It can be set to an array that will enable params authentication only for the
# given strategies, for example, `config.params_authenticatable = [:database]` will
# enable it only for database (email + password) authentication.
# config.params_authenticatable = true
# Tell if authentication through HTTP Auth is enabled. False by default.
# It can be set to an array that will enable http authentication only for the
# given strategies, for example, `config.http_authenticatable = [:database]` will
# enable it only for database authentication.
# For API-only applications to support authentication "out-of-the-box", you will likely want to
# enable this with :database unless you are using a custom strategy.
# The supported strategies are:
# :database = Support basic authentication with authentication key + password
# config.http_authenticatable = false
# If 401 status code should be returned for AJAX requests. True by default.
# config.http_authenticatable_on_xhr = true
# The realm used in Http Basic Authentication. 'Application' by default.
# config.http_authentication_realm = 'Application'
# It will change confirmation, password recovery and other workflows
# to behave the same regardless if the e-mail provided was right or wrong.
# Does not affect registerable.
# config.paranoid = true
# By default Devise will store the user in session. You can skip storage for
# particular strategies by setting this option.
# Notice that if you are skipping storage for all authentication paths, you
# may want to disable generating routes to Devise's sessions controller by
# passing skip: :sessions to `devise_for` in your config/routes.rb
config.skip_session_storage = [:http_auth]
# By default, Devise cleans up the CSRF token on authentication to
# avoid CSRF token fixation attacks. This means that, when using AJAX
# requests for sign in and sign up, you need to get a new CSRF token
# from the server. You can disable this option at your own risk.
# config.clean_up_csrf_token_on_authentication = true
# When false, Devise will not attempt to reload routes on eager load.
# This can reduce the time taken to boot the app but if your application
# requires the Devise mappings to be loaded during boot time the application
# won't boot properly.
# config.reload_routes = true
# ==> Configuration for :database_authenticatable
# For bcrypt, this is the cost for hashing the password and defaults to 12. If
# using other algorithms, it sets how many times you want the password to be hashed.
# The number of stretches used for generating the hashed password are stored
# with the hashed password. This allows you to change the stretches without
# invalidating existing passwords.
#
# Limiting the stretches to just one in testing will increase the performance of
# your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
# a value less than 10 in other environments. Note that, for bcrypt (the default
# algorithm), the cost increases exponentially with the number of stretches (e.g.
# a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
config.stretches = Rails.env.test? ? 1 : 12
# Set up a pepper to generate the hashed password.
# config.pepper = '2c6c46b4c830dd12d337ecc465ee8db6ab2060ebf7790d0d01859c7459bf64b76e252d6694d57c10cfd1dd85d9701bf16de6d00d47e3bda877a809619d82c0d7'
# Send a notification to the original email when the user's email is changed.
# config.send_email_changed_notification = false
# Send a notification email when the user's password is changed.
# config.send_password_change_notification = false
# ==> Configuration for :confirmable
# A period that the user is allowed to access the website even without
# confirming their account. For instance, if set to 2.days, the user will be
# able to access the website for two days without confirming their account,
# access will be blocked just in the third day.
# You can also set it to nil, which will allow the user to access the website
# without confirming their account.
# Default is 0.days, meaning the user cannot access the website without
# confirming their account.
# config.allow_unconfirmed_access_for = 2.days
# A period that the user is allowed to confirm their account before their
# token becomes invalid. For example, if set to 3.days, the user can confirm
# their account within 3 days after the mail was sent, but on the fourth day
# their account can't be confirmed with the token any more.
# Default is nil, meaning there is no restriction on how long a user can take
# before confirming their account.
# config.confirm_within = 3.days
# If true, requires any email changes to be confirmed (exactly the same way as
# initial account confirmation) to be applied. Requires additional unconfirmed_email
# db field (see migrations). Until confirmed, new email is stored in
# unconfirmed_email column, and copied to email column on successful confirmation.
config.reconfirmable = true
# Defines which key will be used when confirming an account
# config.confirmation_keys = [:email]
# ==> Configuration for :rememberable
# The time the user will be remembered without asking for credentials again.
# config.remember_for = 2.weeks
# Invalidates all the remember me tokens when the user signs out.
config.expire_all_remember_me_on_sign_out = true
# If true, extends the user's remember period when remembered via cookie.
# config.extend_remember_period = false
# Options to be passed to the created cookie. For instance, you can set
# secure: true in order to force SSL only cookies.
# config.rememberable_options = {}
# ==> Configuration for :validatable
# Range for password length.
config.password_length = 6..128
# Email regex used to validate email formats. It simply asserts that
# one (and only one) @ exists in the given string. This is mainly
# to give user feedback and not to assert the e-mail validity.
config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
# ==> Configuration for :timeoutable
# The time you want to timeout the user session without activity. After this
# time the user will be asked for credentials again. Default is 30 minutes.
# config.timeout_in = 30.minutes
# ==> Configuration for :lockable
# Defines which strategy will be used to lock an account.
# :failed_attempts = Locks an account after a number of failed attempts to sign in.
# :none = No lock strategy. You should handle locking by yourself.
# config.lock_strategy = :failed_attempts
# Defines which key will be used when locking and unlocking an account
# config.unlock_keys = [:email]
# Defines which strategy will be used to unlock an account.
# :email = Sends an unlock link to the user email
# :time = Re-enables login after a certain amount of time (see :unlock_in below)
# :both = Enables both strategies
# :none = No unlock strategy. You should handle unlocking by yourself.
# config.unlock_strategy = :both
# Number of authentication tries before locking an account if lock_strategy
# is failed attempts.
# config.maximum_attempts = 20
# Time interval to unlock the account if :time is enabled as unlock_strategy.
# config.unlock_in = 1.hour
# Warn on the last attempt before the account is locked.
# config.last_attempt_warning = true
# ==> Configuration for :recoverable
#
# Defines which key will be used when recovering the password for an account
# config.reset_password_keys = [:email]
# Time interval you can reset your password with a reset password key.
# Don't put a too small interval or your users won't have the time to
# change their passwords.
config.reset_password_within = 6.hours
# When set to false, does not sign a user in automatically after their password is
# reset. Defaults to true, so a user is signed in automatically after a reset.
# config.sign_in_after_reset_password = true
# ==> Configuration for :encryptable
# Allow you to use another hashing or encryption algorithm besides bcrypt (default).
# You can use :sha1, :sha512 or algorithms from others authentication tools as
# :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
# for default behavior) and :restful_authentication_sha1 (then you should set
# stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
#
# Require the `devise-encryptable` gem when using anything other than bcrypt
# config.encryptor = :sha512
# ==> Scopes configuration
# Turn scoped views on. Before rendering "sessions/new", it will first check for
# "users/sessions/new". It's turned off by default because it's slower if you
# are using only default views.
# config.scoped_views = false
# Configure the default scope given to Warden. By default it's the first
# devise role declared in your routes (usually :user).
# config.default_scope = :user
# Set this configuration to false if you want /users/sign_out to sign out
# only the current scope. By default, Devise signs out all scopes.
# config.sign_out_all_scopes = true
# ==> Navigation configuration
# Lists the formats that should be treated as navigational. Formats like
# :html should redirect to the sign in page when the user does not have
# access, but formats like :xml or :json, should return 401.
#
# If you have any extra navigational formats, like :iphone or :mobile, you
# should add them to the navigational formats lists.
#
# The "*/*" below is required to match Internet Explorer requests.
# config.navigational_formats = ['*/*', :html, :turbo_stream]
# The default HTTP method used to sign out a resource. Default is :delete.
config.sign_out_via = :delete
# ==> OmniAuth
# Add a new OmniAuth provider. Check the wiki for more information on setting
# up on your models and hooks.
# config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
# ==> Warden configuration
# If you want to use other strategies, that are not supported by Devise, or
# change the failure app, you can configure them inside the config.warden block.
#
# config.warden do |manager|
# manager.intercept_401 = false
# manager.default_strategies(scope: :user).unshift :some_external_strategy
# end
# ==> Mountable engine configurations
# When using Devise inside an engine, let's call it `MyEngine`, and this engine
# is mountable, there are some extra configurations to be taken into account.
# The following options are available, assuming the engine is mounted as:
#
# mount MyEngine, at: '/my_engine'
#
# The router that invoked `devise_for`, in the example above, would be:
# config.router_name = :my_engine
#
# When using OmniAuth, Devise cannot automatically set OmniAuth path,
# so you need to do it manually. For the users scope, it would be:
# config.omniauth_path_prefix = '/my_engine/users/auth'
# ==> Hotwire/Turbo configuration
# When using Devise with Hotwire/Turbo, the http status for error responses
# and some redirects must match the following. The default in Devise for existing
# apps is `200 OK` and `302 Found` respectively, but new apps are generated with
# these new defaults that match Hotwire/Turbo behavior.
# Note: These might become the new default in future versions of Devise.
config.responder.error_status = :unprocessable_entity
config.responder.redirect_status = :see_other
# ==> Configuration for :registerable
# When set to false, does not sign a user in automatically after their password is
# changed. Defaults to true, so a user is signed in automatically after changing a password.
# config.sign_in_after_change_password = true
end

65
config/locales/devise.en.yml Normal file
View File

@@ -0,0 +1,65 @@
# Additional translations at https://github.com/heartcombo/devise/wiki/I18n
en:
devise:
confirmations:
confirmed: "Your email address has been successfully confirmed."
send_instructions: "You will receive an email with instructions for how to confirm your email address in a few minutes."
send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
failure:
already_authenticated: "You are already signed in."
inactive: "Your account is not activated yet."
invalid: "Invalid %{authentication_keys} or password."
locked: "Your account is locked."
last_attempt: "You have one more attempt before your account is locked."
not_found_in_database: "Invalid %{authentication_keys} or password."
timeout: "Your session expired. Please sign in again to continue."
unauthenticated: "You need to sign in or sign up before continuing."
unconfirmed: "You have to confirm your email address before continuing."
mailer:
confirmation_instructions:
subject: "Confirmation instructions"
reset_password_instructions:
subject: "Reset password instructions"
unlock_instructions:
subject: "Unlock instructions"
email_changed:
subject: "Email Changed"
password_change:
subject: "Password Changed"
omniauth_callbacks:
failure: "Could not authenticate you from %{kind} because \"%{reason}\"."
success: "Successfully authenticated from %{kind} account."
passwords:
no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided."
send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes."
send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
updated: "Your password has been changed successfully. You are now signed in."
updated_not_active: "Your password has been changed successfully."
registrations:
destroyed: "Bye! Your account has been successfully cancelled. We hope to see you again soon."
signed_up: "Welcome! You have signed up successfully."
signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated."
signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked."
signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please follow the link to activate your account."
update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirmation link to confirm your new email address."
updated: "Your account has been updated successfully."
updated_but_not_signed_in: "Your account has been updated successfully, but since your password was changed, you need to sign in again."
sessions:
signed_in: "Signed in successfully."
signed_out: "Signed out successfully."
already_signed_out: "Signed out successfully."
unlocks:
send_instructions: "You will receive an email with instructions for how to unlock your account in a few minutes."
send_paranoid_instructions: "If your account exists, you will receive an email with instructions for how to unlock it in a few minutes."
unlocked: "Your account has been unlocked successfully. Please sign in to continue."
errors:
messages:
already_confirmed: "was already confirmed, please try signing in"
confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one"
expired: "has expired, please request a new one"
not_found: "not found"
not_locked: "was not locked"
not_saved:
one: "1 error prohibited this %{resource} from being saved:"
other: "%{count} errors prohibited this %{resource} from being saved:"

5
config/routes.rb
View File

@@ -1,7 +1,10 @@
Rails.application.routes.draw do
root to: "pages#root"
mount ActionCable.server => "/cable"
# Authentication routes
devise_for :users
root to: "pages#root"
# Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
namespace :api do
namespace :fa do

45
db/migrate/20241227185335_devise_create_users.rb Normal file
View File

@@ -0,0 +1,45 @@
# frozen_string_literal: true
class DeviseCreateUsers < ActiveRecord::Migration[7.2]
def change
create_table :users do |t|
## Database authenticatable
t.string :email, null: false, default: ""
t.string :encrypted_password, null: false, default: ""
## Recoverable
t.string :reset_password_token
t.datetime :reset_password_sent_at
## Rememberable
t.datetime :remember_created_at
# Trackable
t.integer :sign_in_count, default: 0, null: false
t.datetime :current_sign_in_at
t.datetime :last_sign_in_at
t.string :current_sign_in_ip
t.string :last_sign_in_ip
## Confirmable
# t.string :confirmation_token
# t.datetime :confirmed_at
# t.datetime :confirmation_sent_at
# t.string :unconfirmed_email # Only if using reconfirmable
## Lockable
# t.integer :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
# t.string :unlock_token # Only if unlock strategy is :email or :both
# t.datetime :locked_at
t.string :role
t.timestamps null: false
end
add_index :users, :email, unique: true
add_index :users, :reset_password_token, unique: true
# add_index :users, :confirmation_token, unique: true
# add_index :users, :unlock_token, unique: true
end
end

20
db/schema.rb generated
View File

@@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema[7.2].define(version: 2024_12_25_183955) do
ActiveRecord::Schema[7.2].define(version: 2024_12_27_185335) do
# These are extensions that must be enabled in order to support this database
enable_extension "hstore"
enable_extension "intarray"
@@ -2054,6 +2054,24 @@ ActiveRecord::Schema[7.2].define(version: 2024_12_25_183955) do
t.index ["database", "captured_at"], name: "index_pghero_space_stats_on_database_and_captured_at"
end
create_table "users", force: :cascade do |t|
t.string "email", default: "", null: false
t.string "encrypted_password", default: "", null: false
t.string "reset_password_token"
t.datetime "reset_password_sent_at"
t.datetime "remember_created_at"
t.integer "sign_in_count", default: 0, null: false
t.datetime "current_sign_in_at"
t.datetime "last_sign_in_at"
t.string "current_sign_in_ip"
t.string "last_sign_in_ip"
t.string "role"
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["email"], name: "index_users_on_email", unique: true
t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
end
create_table "versions", force: :cascade do |t|
t.string "item_type", null: false
t.bigint "item_id", null: false

11
test/fixtures/users.yml vendored Normal file
View File

@@ -0,0 +1,11 @@
# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
# This model initially had no columns defined. If you add columns to the
# model remove the "{}" from the fixture names and add the columns immediately
# below each fixture, per the syntax in the comments below
#
one: {}
# column: value
#
two: {}
# column: value

7
test/models/user_test.rb Normal file
View File

@@ -0,0 +1,7 @@
require "test_helper"
class UserTest < ActiveSupport::TestCase
# test "the truth" do
# assert true
# end
end