Skip to content

Feature/6210 - Endpoint API remember_me option #6263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
compwron merged 6 commits into from
Mar 20, 2025
Merged

Feature/6210 - Endpoint API remember_me option #6263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fbe8b1f
Permit remember_me params and pass to blueprint
JustinTan-1 Mar 17, 2025
35d0783
Add remember_me param to api controller
JustinTan-1 Mar 17, 2025
8c0e87b
Update return_new_refresh_token with remember_me
JustinTan-1 Mar 17, 2025
cbb6ce6
Tests for refreshtoken remember_me
JustinTan-1 Mar 17, 2025
b50066f
Style fixes
JustinTan-1 Mar 18, 2025
c028074
Lint
JustinTan-1 Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions app/blueprints/api/v1/session_blueprint.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,12 @@ class Api::V1::SessionBlueprint < Blueprinter::Base
token.return_new_api_token![:api_token]
end

field :refresh_token do |user|
field :refresh_token do |user, options|
token = user.api_credential
token.return_new_refresh_token![:refresh_token]
if options[:remember_me]
token.return_new_refresh_token!(true)[:refresh_token]
else
token.return_new_refresh_token!(false)[:refresh_token]
end
end
end
4 changes: 2 additions & 2 deletions app/controllers/api/v1/users/sessions_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ class Api::V1::Users::SessionsController < Api::V1::BaseController
def create
load_resource
if @user
render json: Api::V1::SessionBlueprint.render(@user), status: 201
render json: Api::V1::SessionBlueprint.render(@user, remember_me: user_params[:remember_me]), status: 201
else
render json: {message: "Incorrect email or password."}, status: 401
end
Expand All @@ -27,7 +27,7 @@ def destroy
private

def user_params
params.permit(:email, :password)
params.permit(:email, :password, :remember_me)
end

def load_resource
Expand Down
7 changes: 6 additions & 1 deletion app/models/api_credential.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,13 @@ def return_new_api_token!
{api_token: new_token}
end

def return_new_refresh_token!
def return_new_refresh_token!(remember_me)
new_token = generate_refresh_token
if remember_me
update_column(:refresh_token_expires_at, 1.year.from_now)
else
update_column(:refresh_token_expires_at, 30.days.from_now)
end
update_column(:refresh_token_digest, refresh_token_digest)
{refresh_token: new_token}
end
Expand Down
28 changes: 23 additions & 5 deletions spec/models/api_credential_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

describe "#authenticate_refresh_token" do
it "returns true for a valid refresh_token" do
refresh_token = api_credential.return_new_refresh_token![:refresh_token]
refresh_token = api_credential.return_new_refresh_token!(false)[:refresh_token]
expect(api_credential.authenticate_refresh_token(refresh_token)).to be true
end

Expand All @@ -47,13 +47,13 @@
describe "#return_new_refresh_token!" do
it "updates the refresh_token digest" do
old_digest = api_credential.refresh_token_digest
api_credential.return_new_refresh_token![:refresh_token]
api_credential.return_new_refresh_token!(false)[:refresh_token]
api_credential.reload
expect(api_credential.refresh_token_digest).not_to eq(old_digest)
end

it "sets a new refresh_token" do
new_token = api_credential.return_new_refresh_token![:refresh_token]
new_token = api_credential.return_new_refresh_token!(false)[:refresh_token]

expect(new_token).not_to be_nil
end
Expand Down Expand Up @@ -95,7 +95,7 @@
describe "#generate_refresh_token" do
it "creates a secure hashed refresh_token" do
api_credential.refresh_token_digest
refresh_token = api_credential.return_new_refresh_token![:refresh_token]
refresh_token = api_credential.return_new_refresh_token!(false)[:refresh_token]

expect(api_credential.refresh_token_digest).to eq(Digest::SHA256.hexdigest(refresh_token))
end
Expand All @@ -112,10 +112,28 @@

describe "#revoke_refresh_token" do
it "sets refresh token to nil" do
api_credential.return_new_refresh_token![:refresh_token]
api_credential.return_new_refresh_token!(false)[:refresh_token]
api_credential.revoke_refresh_token

expect(api_credential.refresh_token_digest).to be_nil
end
end

describe "#generate_refresh_token_with_rememberme" do
Copy link
Copy Markdown
Collaborator

@xihai01 xihai01 Mar 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "remember_me"

Copy link
Copy Markdown
Collaborator

@xihai01 xihai01 Mar 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a _

it "updates token to be valid for 1 year" do
api_credential.refresh_token_digest
api_credential.return_new_refresh_token!(true)[:refresh_token]

expect(api_credential.refresh_token_expires_at).to be_within(1.minutes).of(1.year.from_now)
end
end

describe "#generate_refresh_token_without_rememberme" do
it "updates token to be valid for 30 days" do
api_credential.refresh_token_digest
api_credential.return_new_refresh_token!(false)[:refresh_token]

expect(api_credential.refresh_token_expires_at).to be_within(1.minutes).of(30.days.from_now)
end
end
end