rename signin, signout to sign_in, sign_out

Author: IgorPolyakov

api/openapi.yaml

@@ -12,7 +12,7 @@ servers:
   - url: 'http://localhost:4102'
     description: Local server
 paths:
-  /api/v1/auth/signin:
+  /api/v1/auth/sign_in:
     post:
       tags:
         - Sessions
@@ -60,7 +60,7 @@ paths:
         '500':
           description: Internal Server Error
       parameters: []
-  /api/v1/auth/signout:
+  /api/v1/auth/sign_out:
     post:
       tags:
         - Sessions

html/assets/js/api.js

@@ -26,7 +26,7 @@ window.ctf01d_tp_api.game_create = function(game_data) {
 
 window.ctf01d_tp_api.auth_signin = function(auth_data) {
     return $.ajax({
-        url: '/api/v1/auth/signin',
+        url: '/api/v1/auth/sign_in',
         method: 'POST',
         contentType: 'application/json',
         data: JSON.stringify(auth_data),
@@ -35,7 +35,7 @@ window.ctf01d_tp_api.auth_signin = function(auth_data) {
 
 window.ctf01d_tp_api.auth_signout = function(auth_data) {
     return $.ajax({
-        url: '/api/v1/auth/signout',
+        url: '/api/v1/auth/sign_out',
         method: 'POST',
         contentType: 'application/json',
         data: JSON.stringify(auth_data),

html/assets/js/index.js

@@ -145,7 +145,7 @@ function doSignin() {
         password: password,
     }).fail(function(res) {
         $('#sign_error_info').css({"display": ""});
-        $('#sign_error_info').html('Signin failed. Check username and password.');
+        $('#sign_error_info').html('SignIn failed. Check username and password.');
         console.error(res);
     }).done(function(res) {
         console.log(res);

internal/app/handlers/interface.go

@@ -36,12 +36,12 @@ func (siw *ServerInterfaceWrapper) UpdateGame(w http.ResponseWriter, r *http.Req
 	siw.handlers.UpdateGame(w, r, id)
 }
 
-func (siw *ServerInterfaceWrapper) PostApiV1AuthSignin(w http.ResponseWriter, r *http.Request) {
-	siw.handlers.PostApiV1AuthSignin(w, r)
+func (siw *ServerInterfaceWrapper) PostApiV1AuthSignIn(w http.ResponseWriter, r *http.Request) {
+	siw.handlers.PostApiV1AuthSignIn(w, r)
 }
 
-func (siw *ServerInterfaceWrapper) PostApiV1AuthSignout(w http.ResponseWriter, r *http.Request) {
-	siw.handlers.PostApiV1AuthSignout(w, r)
+func (siw *ServerInterfaceWrapper) PostApiV1AuthSignOut(w http.ResponseWriter, r *http.Request) {
+	siw.handlers.PostApiV1AuthSignOut(w, r)
 }
 
 func (siw *ServerInterfaceWrapper) ValidateSession(w http.ResponseWriter, r *http.Request) {

internal/app/handlers/sessions.go

@@ -7,22 +7,22 @@ import (
 
 	"ctf01d/internal/app/repository"
 	"ctf01d/internal/app/server"
-	"ctf01d/internal/app/utils"
 	api_helpers "ctf01d/internal/app/utils"
+
 	openapi_types "github.com/oapi-codegen/runtime/types"
 )
 
-func (h *Handlers) PostApiV1AuthSignin(w http.ResponseWriter, r *http.Request) {
-	var req server.PostApiV1AuthSigninJSONBody
+func (h *Handlers) PostApiV1AuthSignIn(w http.ResponseWriter, r *http.Request) {
+	var req server.PostApiV1AuthSignInJSONBody
 	if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignin")
+		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignIn")
 		http.Error(w, "Invalid request body", http.StatusBadRequest)
 		return
 	}
 	userRepo := repository.NewUserRepository(h.DB)
 	user, err := userRepo.GetByUserName(r.Context(), *req.UserName)
 	if err != nil || !api_helpers.CheckPasswordHash(*req.Password, user.PasswordHash) {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignin")
+		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignIn")
 		api_helpers.RespondWithJSON(w, http.StatusUnauthorized, map[string]string{"error": "Invalid password or user"})
 		return
 	}
@@ -32,7 +32,7 @@ func (h *Handlers) PostApiV1AuthSignin(w http.ResponseWriter, r *http.Request) {
 
 	sessionId, err := repo.StoreSessionInDB(r.Context(), user.Id)
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignin")
+		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignIn")
 		api_helpers.RespondWithJSON(w, http.StatusInternalServerError, map[string]string{"error": "Failed to store session"})
 		return
 	}
@@ -48,17 +48,17 @@ func (h *Handlers) PostApiV1AuthSignin(w http.ResponseWriter, r *http.Request) {
 	api_helpers.RespondWithJSON(w, http.StatusOK, map[string]string{"data": "User logged in"})
 }
 
-func (h *Handlers) PostApiV1AuthSignout(w http.ResponseWriter, r *http.Request) {
+func (h *Handlers) PostApiV1AuthSignOut(w http.ResponseWriter, r *http.Request) {
 	cookie, err := r.Cookie("session_id")
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignout")
+		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignOut")
 		api_helpers.RespondWithJSON(w, http.StatusUnauthorized, map[string]string{"error": "No session found"})
 		return
 	}
 	repo := repository.NewSessionRepository(h.DB)
 	err = repo.DeleteSessionInDB(r.Context(), cookie.Value)
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignout")
+		slog.Warn(err.Error(), "handler", "PostApiV1AuthSignOut")
 		api_helpers.RespondWithJSON(w, http.StatusInternalServerError, map[string]string{"error": "Failed to delete session"})
 		return
 	}
@@ -74,7 +74,7 @@ func (h *Handlers) PostApiV1AuthSignout(w http.ResponseWriter, r *http.Request)
 func (h *Handlers) ValidateSession(w http.ResponseWriter, r *http.Request) {
 	cookie, err := r.Cookie("session_id")
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSession")
+		slog.Warn(err.Error(), "handler", "ValidateSession")
 		api_helpers.RespondWithJSON(w, http.StatusUnauthorized, map[string]string{"error": "No session found"})
 		return
 	}
@@ -83,7 +83,7 @@ func (h *Handlers) ValidateSession(w http.ResponseWriter, r *http.Request) {
 	var userId openapi_types.UUID
 	userId, err = repo.GetSessionFromDB(r.Context(), cookie.Value)
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSession")
+		slog.Warn(err.Error(), "handler", "ValidateSession")
 		api_helpers.RespondWithJSON(w, http.StatusUnauthorized, map[string]string{"error": "No user or session found"})
 		return
 	}
@@ -92,13 +92,13 @@ func (h *Handlers) ValidateSession(w http.ResponseWriter, r *http.Request) {
 	userRepo := repository.NewUserRepository(h.DB)
 	user, err := userRepo.GetById(r.Context(), userId)
 	if err != nil {
-		slog.Warn(err.Error(), "handler", "PostApiV1AuthSession")
+		slog.Warn(err.Error(), "handler", "ValidateSession")
 		api_helpers.RespondWithJSON(w, http.StatusInternalServerError, map[string]string{"error": "Could not find user by user id"})
 		return
 	}
 	var res = make(map[string]string)
 	res["name"] = user.DisplayName
-	res["role"] = helpers.ConvertUserRequestRoleToString(user.Role)
+	res["role"] = api_helpers.ConvertUserRequestRoleToString(user.Role)
 
 	api_helpers.RespondWithJSON(w, http.StatusOK, res)
 }