feat: add shelve management functionality

This commit is contained in:
Tran Anh Tuan
2026-05-08 18:17:07 +07:00
parent 8562d39071
commit 9f27436d5d
14 changed files with 2682 additions and 1074 deletions

View File

@@ -0,0 +1,46 @@
package mapper
import (
"wm-backend/internal/models"
db "wm-backend/sqlc_gen"
"github.com/jackc/pgx/v5/pgtype"
)
func ToDomainShelve(r db.Shelf) *models.Shelve {
return &models.Shelve{
ID: r.ID,
CabinetID: r.CabinetID,
Name: r.Name,
LevelIndex: r.LevelIndex,
Description: r.Description.String,
CreatedAt: r.CreatedAt,
UpdatedAt: r.UpdatedAt,
}
}
func ToModelShelve(r *models.Shelve) *db.CreateShelveParams {
return &db.CreateShelveParams{
CabinetID: r.CabinetID,
Name: r.Name,
LevelIndex: r.LevelIndex,
Description: pgtype.Text{
String: r.Description,
Valid: r.Description != "",
},
CreatedAt: r.CreatedAt,
}
}
func ToUpdateModelShelve(r *models.Shelve) *db.UpdateShelveParams {
return &db.UpdateShelveParams{
Name: r.Name,
LevelIndex: r.LevelIndex,
Description: pgtype.Text{
String: r.Description,
Valid: r.Description != "",
},
UpdatedAt: r.UpdatedAt,
ID: r.ID,
}
}

View File

@@ -0,0 +1,14 @@
package requests
type CreateShelveRequest struct {
CabinetID int64 `json:"cabinetId" binding:"required"`
Name string `json:"name" binding:"required"`
LevelIndex int32 `json:"levelIndex" binding:"required"`
Description string `json:"description"`
}
type UpdateShelveRequest struct {
Name string `json:"name"`
LevelIndex int32 `json:"levelIndex"`
Description string `json:"description"`
}

View File

@@ -0,0 +1,13 @@
package responses
type CreateShelveResponse struct {
ID int64 `json:"id"`
}
type UpdateShelveResponse struct {
ID int64 `json:"id"`
CabinetID int64 `json:"cabinetId"`
Name string `json:"name"`
LevelIndex int32 `json:"levelIndex"`
Description string `json:"description"`
}

View File

@@ -0,0 +1,13 @@
package models
import "time"
type Shelve struct {
ID int64 `json:"id"`
CabinetID int64 `json:"cabinetId"`
Name string `json:"name"`
LevelIndex int32 `json:"levelIndex"`
Description string `json:"description"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"`
}

View File

@@ -0,0 +1,55 @@
package repositories
import (
"context"
"wm-backend/internal/mapper"
"wm-backend/internal/models"
db "wm-backend/sqlc_gen"
"github.com/rs/zerolog/log"
)
func CreateShelve(ctx context.Context, queries *db.Queries, body models.Shelve) (models.Shelve, error) {
result, err := queries.CreateShelve(ctx, *mapper.ToModelShelve(&body))
if err != nil {
return models.Shelve{}, err
}
return *mapper.ToDomainShelve(result), nil
}
func GetShelveByID(ctx context.Context, queries *db.Queries, id int64) (models.Shelve, error) {
result, err := queries.GetShelveByID(ctx, id)
if err != nil {
return models.Shelve{}, err
}
return *mapper.ToDomainShelve(result), nil
}
func ListShelves(ctx context.Context, queries *db.Queries) ([]models.Shelve, error) {
results, err := queries.ListShelves(ctx)
if err != nil {
return nil, err
}
var items []models.Shelve
for _, r := range results {
items = append(items, *mapper.ToDomainShelve(r))
}
return items, nil
}
func UpdateShelve(ctx context.Context, queries *db.Queries, body models.Shelve) (models.Shelve, error) {
result, err := queries.UpdateShelve(ctx, *mapper.ToUpdateModelShelve(&body))
if err != nil {
return models.Shelve{}, err
}
return *mapper.ToDomainShelve(result), nil
}
func DeleteShelve(ctx context.Context, queries *db.Queries, id int64) (int64, error) {
rowsAffected, err := queries.DeleteShelve(ctx, id)
log.Info().Int64("id", id).Int64("rowsAffected", rowsAffected).Msg("Deleted shelve")
if err != nil {
return rowsAffected, err
}
return rowsAffected, nil
}

View File

@@ -55,6 +55,15 @@ func NewRouter() *gin.Engine {
cabinet.PUT("/:id", utils.AsyncHandler(services.CabinetUpdate))
cabinet.DELETE("/:id", utils.AsyncHandler(services.CabinetDelete))
}
shelve := v1.Group(constants.API_GROUP_SHELF)
{
shelve.GET("", utils.AsyncHandler(services.ShelveList))
shelve.GET("/:id", utils.AsyncHandler(services.ShelveGetByID))
shelve.POST("", utils.AsyncHandler(services.ShelveCreate))
shelve.PUT("/:id", utils.AsyncHandler(services.ShelveUpdate))
shelve.DELETE("/:id", utils.AsyncHandler(services.ShelveDelete))
}
}
r.GET(constants.API_PATH_PING, services.PingHandler)

View File

@@ -0,0 +1,192 @@
package services
import (
"net/http"
"strconv"
"time"
"wm-backend/global"
"wm-backend/internal/models"
"wm-backend/internal/models/requests"
"wm-backend/internal/models/responses"
"wm-backend/internal/repositories"
"wm-backend/pkg/helper"
"wm-backend/response"
"github.com/gin-gonic/gin"
"github.com/rs/zerolog/log"
)
// ShelveCreate creates a new shelve.
// It validates the request body and creates the shelve in the database.
//
// @Summary Create a new shelve
// @Description Create a new shelve with the provided details
// @Tags shelve
// @Accept json
// @Produce json
// @Param body body requests.CreateShelveRequest true "Shelve request body"
// @Success 201 {object} response.SuccessResponse{data=responses.CreateShelveResponse}
// @Failure 400 {object} response.ErrorResponse
// @Failure 500 {object} response.ErrorResponse
// @Router /v1/shelves [post]
func ShelveCreate(c *gin.Context) error {
requestBody := requests.CreateShelveRequest{}
if helper.IsShouldBindJSON(c, &requestBody) {
return nil
}
shelveModel := &models.Shelve{
CabinetID: requestBody.CabinetID,
Name: requestBody.Name,
LevelIndex: requestBody.LevelIndex,
Description: requestBody.Description,
CreatedAt: time.Now(),
}
shelve, err := repositories.CreateShelve(c.Request.Context(), global.Queries, *shelveModel)
if err != nil {
log.Error().Err(err).Msg("Failed to create shelve")
response.InternalServerError(c, http.StatusInternalServerError, "Failed to create shelve")
return nil
}
response.Created(c, "Shelve created successfully", &responses.CreateShelveResponse{
ID: shelve.ID,
})
return nil
}
// ShelveGetByID retrieves a single shelve by its ID.
//
// @Summary Get shelve by ID
// @Description Retrieve a single shelve using its unique identifier
// @Tags shelve
// @Accept json
// @Produce json
// @Param id path int true "Shelve ID"
// @Success 200 {object} response.SuccessResponse{data=models.Shelve}
// @Failure 400 {object} response.ErrorResponse
// @Failure 404 {object} response.ErrorResponse
// @Failure 500 {object} response.ErrorResponse
// @Router /v1/shelves/{id} [get]
func ShelveGetByID(c *gin.Context) error {
id, err := strconv.ParseInt(c.Param("id"), 10, 64)
if err != nil {
response.BadRequestError(c, http.StatusBadRequest, "Invalid ID")
return nil
}
shelve, err := repositories.GetShelveByID(c.Request.Context(), global.Queries, id)
if err != nil {
log.Error().Err(err).Msgf("Failed to get shelve by ID: %d", id)
response.NotFoundError(c, http.StatusNotFound, "Shelve not found")
return nil
}
response.Ok(c, "Success", shelve)
return nil
}
// ShelveList retrieves all shelves.
//
// @Summary List all shelves
// @Description Retrieve a list of all shelves ordered by creation date
// @Tags shelve
// @Accept json
// @Produce json
// @Success 200 {object} response.SuccessResponse{data=[]models.Shelve}
// @Failure 500 {object} response.ErrorResponse
// @Router /v1/shelves [get]
func ShelveList(c *gin.Context) error {
shelves, err := repositories.ListShelves(c.Request.Context(), global.Queries)
if err != nil {
response.InternalServerError(c, http.StatusInternalServerError, "Failed to list shelves")
return nil
}
response.Ok(c, "Success", shelves)
return nil
}
// ShelveUpdate updates an existing shelve by its ID.
// It validates the request body, fetches the existing record,
// merges non-empty fields from the request, and updates the shelve in the database.
//
// @Summary Update shelve
// @Description Update an existing shelve by its ID. Only non-empty fields will be updated.
// @Tags shelve
// @Accept json
// @Produce json
// @Param id path int true "Shelve ID"
// @Param body body requests.UpdateShelveRequest true "Shelve request body"
// @Success 200 {object} response.SuccessResponse{data=responses.UpdateShelveResponse}
// @Failure 400 {object} response.ErrorResponse
// @Failure 404 {object} response.ErrorResponse
// @Failure 500 {object} response.ErrorResponse
// @Router /v1/shelves/{id} [put]
func ShelveUpdate(c *gin.Context) error {
id, err := strconv.ParseInt(c.Param("id"), 10, 64)
if err != nil {
response.BadRequestError(c, http.StatusBadRequest, "Invalid ID")
return nil
}
requestBody := requests.UpdateShelveRequest{}
if helper.IsShouldBindJSON(c, &requestBody) {
return nil
}
existing, err := repositories.GetShelveByID(c.Request.Context(), global.Queries, id)
if err != nil {
response.NotFoundError(c, http.StatusNotFound, "Shelve not found")
return nil
}
if requestBody.Name != "" {
existing.Name = requestBody.Name
}
if requestBody.LevelIndex != 0 {
existing.LevelIndex = requestBody.LevelIndex
}
if requestBody.Description != "" {
existing.Description = requestBody.Description
}
existing.UpdatedAt = time.Now()
shelve, err := repositories.UpdateShelve(c.Request.Context(), global.Queries, existing)
if err != nil {
log.Error().Err(err).Msgf("Failed to update shelve with ID: %d", id)
response.InternalServerError(c, http.StatusInternalServerError, "Failed to update shelve")
return nil
}
response.Ok(c, "Shelve updated successfully", &responses.UpdateShelveResponse{
ID: shelve.ID,
CabinetID: shelve.CabinetID,
Name: shelve.Name,
LevelIndex: shelve.LevelIndex,
Description: shelve.Description,
})
return nil
}
// ShelveDelete deletes a shelve by its ID.
//
// @Summary Delete shelve
// @Description Delete a shelve by its unique identifier
// @Tags shelve
// @Accept json
// @Produce json
// @Param id path int true "Shelve ID"
// @Success 200 {object} response.SuccessResponse
// @Failure 400 {object} response.ErrorResponse
// @Failure 500 {object} response.ErrorResponse
// @Router /v1/shelves/{id} [delete]
func ShelveDelete(c *gin.Context) error {
id, err := strconv.ParseInt(c.Param("id"), 10, 64)
if err != nil {
response.BadRequestError(c, http.StatusBadRequest, "Invalid ID")
return nil
}
rowsAffected, err := repositories.DeleteShelve(c.Request.Context(), global.Queries, id)
if err != nil {
log.Error().Err(err).Msgf("Failed to delete shelve with ID: %d", id)
response.InternalServerError(c, http.StatusInternalServerError, "Failed to delete shelve")
return nil
}
if rowsAffected == 0 {
response.NotFoundError(c, http.StatusNotFound, "Shelve not found")
return nil
}
response.Ok(c, "Delete Success", nil)
return nil
}