[JOH-27] User endpoints and Admin middleware

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,13 @@
+## Change made
+
+- [ ]  New features
+- [ ]  Bug fixes
+- [ ]  Breaking changes
+## Describe what you have done
+- 
+### New Features
+- 
+### Fix
+- 
+### Others
+- 

config/auth/config.example.yaml

@@ -4,7 +4,7 @@ app:
   secret: <secret>
 
 database:
-  host: localhost
+  host: local-db
   port: 5432
   name: johnjud_db
   username: root

src/app/dto/pet.dto.go

@@ -55,7 +55,7 @@ type ChangeViewPetRequest struct {
 }
 
 type ChangeViewPetResponse struct {
-	Success bool `json:"success" validate:"required"`
+	Success bool `json:"success"`
 }
 
 type UpdatePetRequest struct {
@@ -81,5 +81,5 @@ type DeleteRequest struct {
 	Id string `json:"id" validate:"required"`
 }
 type DeleteResponse struct {
-	Success bool `json:"success" validate:"required"`
+	Success bool `json:"success"`
 }

src/app/dto/user.dto.go

@@ -1,14 +1,19 @@
 package dto
 
-type UserDto struct {
+type User struct {
+	Id        string `json:"id"`
+	Email     string `json:"email"`
+	Firstname string `json:"firstname"`
+	Lastname  string `json:"lastname"`
+}
+
+type UpdateUserRequest struct {
 	Email     string `json:"email" validate:"required,email"`
 	Password  string `json:"password" validate:"required,gte=6,lte=30"`
 	Firstname string `json:"firstname" validate:"required"`
 	Lastname  string `json:"lastname" validate:"required"`
 }
 
-type UpdateUserDto struct {
-	Password  string `json:"password" validate:"required,gte=6,lte=30"`
-	Firstname string `json:"firstname" validate:"required"`
-	Lastname  string `json:"lastname" validate:"required"`
+type DeleteUserResponse struct {
+	Success bool `json:"success" validate:"required"`
 }

src/app/handler/user/user.handler.go

@@ -1,11 +1,15 @@
 package user
 
 import (
+	"net/http"
+	"strings"
+
+	"github.com/isd-sgcu/johnjud-gateway/src/app/constant"
 	"github.com/isd-sgcu/johnjud-gateway/src/app/dto"
 	"github.com/isd-sgcu/johnjud-gateway/src/app/router"
 	"github.com/isd-sgcu/johnjud-gateway/src/app/validator"
+	userconst "github.com/isd-sgcu/johnjud-gateway/src/constant/user"
 	"github.com/isd-sgcu/johnjud-gateway/src/pkg/service/user"
-	"net/http"
 )
 
 type Handler struct {
@@ -17,12 +21,24 @@ func NewHandler(service user.Service, validate validator.IDtoValidator) *Handler
 	return &Handler{service, validate}
 }
 
-func (h *Handler) FindOne(c *router.FiberCtx) {
+// FindOne is a function that returns a user by id from database
+// @Summary finds one user
+// @Description Returns the data of user if successful
+// @Param id path string true "user id"
+// @Tags user
+// @Accept json
+// @Produce json
+// @Success 200 {object} dto.User
+// @Failure 400 {object} dto.ResponseBadRequestErr "Invalid request body"
+// @Failure 500 {object} dto.ResponseInternalErr "Internal service error"
+// @Failure 503 {object} dto.ResponseServiceDownErr "Service is down"
+// @Router /v1/users/{id} [get]
+func (h *Handler) FindOne(c router.IContext) {
 	id, err := c.ID()
 	if err != nil {
-		c.JSON(http.StatusInternalServerError, dto.ResponseErr{
-			StatusCode: http.StatusInternalServerError,
-			Message:    "Invalid ID",
+		c.JSON(http.StatusBadRequest, &dto.ResponseErr{
+			StatusCode: http.StatusBadRequest,
+			Message:    err.Error(),
 			Data:       nil,
 		})
 		return
@@ -34,27 +50,102 @@ func (h *Handler) FindOne(c *router.FiberCtx) {
 		return
 	}
 
-	c.JSON(http.StatusCreated, user)
+	c.JSON(http.StatusOK, &dto.ResponseSuccess{
+		StatusCode: http.StatusOK,
+		Message:    userconst.FindOneUserSuccessMessage,
+		Data:       user,
+	})
 	return
 }
 
-func (h *Handler) Update(c *router.FiberCtx) {
+// Update is a function that updates user in database
+// @Summary updates user
+// @Description Returns the data of user if successfully
+// @Param update body dto.UpdateUserRequest true "update user dto"
+// @Tags auth
+// @Accept json
+// @Produce json
+// @Success 201 {object} dto.User
+// @Failure 400 {object} dto.ResponseBadRequestErr "Invalid request body"
+// @Failure 500 {object} dto.ResponseInternalErr "Internal service error"
+// @Failure 503 {object} dto.ResponseServiceDownErr "Service is down"
+// @Router /v1/users [put]
+func (h *Handler) Update(c router.IContext) {
 	usrId := c.UserID()
 
-	usrDto := dto.UpdateUserDto{}
+	request := &dto.UpdateUserRequest{}
 
-	err := c.Bind(&usrDto)
+	err := c.Bind(request)
 	if err != nil {
-		c.JSON(http.StatusBadRequest, err)
+		c.JSON(http.StatusBadRequest, &dto.ResponseErr{
+			StatusCode: http.StatusBadRequest,
+			Message:    constant.BindingRequestErrorMessage + err.Error(),
+			Data:       nil,
+		})
+		return
+	}
+
+	if err := h.validate.Validate(request); err != nil {
+		var errorMessage []string
+		for _, reqErr := range err {
+			errorMessage = append(errorMessage, reqErr.Message)
+		}
+		c.JSON(http.StatusBadRequest, &dto.ResponseErr{
+			StatusCode: http.StatusBadRequest,
+			Message:    constant.InvalidRequestBodyMessage + strings.Join(errorMessage, ", "),
+			Data:       nil,
+		})
+		return
+	}
+
+	user, errRes := h.service.Update(usrId, request)
+	if errRes != nil {
+		c.JSON(errRes.StatusCode, errRes)
+		return
+	}
+
+	c.JSON(http.StatusOK, &dto.ResponseSuccess{
+		StatusCode: http.StatusOK,
+		Message:    userconst.UpdateUserSuccessMessage,
+		Data:       user,
+	})
+	return
+}
+
+// Delete is a function that deletes user in database
+// @Summary deletes user
+// @Description Returns successful status if user is successfully deleted
+// @Param id path string true "user id"
+// @Tags user
+// @Accept json
+// @Produce json
+// @Success 201 {object} bool
+// @Success 201 {object} dto.DeleteUserResponse
+// @Failure 400 {object} dto.ResponseBadRequestErr "Invalid request body"
+// @Failure 500 {object} dto.ResponseInternalErr "Internal service error"
+// @Failure 503 {object} dto.ResponseServiceDownErr "Service is down"
+// @Router /v1/users/{id} [delete]
+func (h *Handler) Delete(c router.IContext) {
+	id, err := c.ID()
+	if err != nil {
+		c.JSON(http.StatusBadRequest, &dto.ResponseErr{
+			StatusCode: http.StatusBadRequest,
+			Message:    err.Error(),
+			Data:       nil,
+		})
 		return
 	}
 
-	user, errRes := h.service.Update(usrId, &usrDto)
+	res, errRes := h.service.Delete(id)
 	if errRes != nil {
 		c.JSON(errRes.StatusCode, errRes)
 		return
 	}
 
-	c.JSON(http.StatusOK, user)
+	c.JSON(http.StatusOK, &dto.ResponseSuccess{
+		StatusCode: http.StatusOK,
+		Message:    userconst.DeleteUserSuccessMessage,
+		Data:       res,
+	})
 	return
 }