feat: add allocations

Author: morremeyer

internal/controllers/allocation.go

@@ -0,0 +1,131 @@
+package controllers
+
+import (
+	"errors"
+	"log"
+	"net/http"
+	"strconv"
+
+	"github.com/envelope-zero/backend/internal/models"
+	"github.com/gin-gonic/gin"
+	"gorm.io/gorm"
+)
+
+// RegisterAllocationRoutes registers the routes for allocations with
+// the RouterGroup that is passed
+func RegisterAllocationRoutes(r *gin.RouterGroup) {
+	// Root group
+	{
+		r.OPTIONS("", func(c *gin.Context) {
+			c.Header("allow", "GET, POST")
+		})
+		r.GET("", GetAllocations)
+		r.POST("", CreateAllocation)
+	}
+
+	// Transaction with ID
+	{
+		r.OPTIONS("/:allocationId", func(c *gin.Context) {
+			c.Header("allow", "GET, PATCH, DELETE")
+		})
+		r.GET("/:allocationId", GetAllocation)
+		r.PATCH("/:allocationId", UpdateAllocation)
+		r.DELETE("/:allocationId", DeleteAllocation)
+	}
+}
+
+// CreateAllocation creates a new allocation
+func CreateAllocation(c *gin.Context) {
+	var data models.Allocation
+
+	if err := c.ShouldBindJSON(&data); err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
+		return
+	}
+
+	data.EnvelopeID, _ = strconv.Atoi(c.Param("envelopeId"))
+	result := models.DB.Create(&data)
+
+	if result.Error != nil {
+		log.Println(result.Error)
+
+		errMessage := "There was an error processing your request, please contact your server administrator"
+		if result.Error.Error() == "UNIQUE constraint failed: allocations.month, allocations.year" {
+			errMessage = "You can not create multiple allocations for the same month"
+		}
+
+		c.JSON(http.StatusInternalServerError, gin.H{"error": errMessage})
+		return
+	}
+
+	c.JSON(http.StatusOK, gin.H{"data": data})
+}
+
+// GetAllocations retrieves all allocations
+func GetAllocations(c *gin.Context) {
+	var allocations []models.Allocation
+	models.DB.Where("envelope_id = ?", c.Param("envelopeId")).Find(&allocations)
+
+	c.JSON(http.StatusOK, gin.H{"data": allocations})
+}
+
+// GetAllocation retrieves a allocation by its ID
+func GetAllocation(c *gin.Context) {
+	var allocation models.Allocation
+	err := models.DB.First(&allocation, c.Param("allocationId")).Error
+	// Return the apporpriate error: 404 if not found, 500 on all others
+	if err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Record not found"})
+		} else {
+			c.JSON(http.StatusInternalServerError, gin.H{"error": err})
+		}
+		return
+	}
+
+	c.JSON(http.StatusOK, gin.H{"data": allocation})
+}
+
+// UpdateAllocation updates a allocation, selected by the ID parameter
+func UpdateAllocation(c *gin.Context) {
+	var allocation models.Allocation
+
+	err := models.DB.First(&allocation, c.Param("allocationId")).Error
+	// Return the apporpriate error: 404 if not found, 500 on all others
+	if err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Record not found"})
+		} else {
+			c.JSON(http.StatusInternalServerError, gin.H{"error": err})
+		}
+		return
+	}
+
+	var data models.Allocation
+	err = c.ShouldBindJSON(&data)
+	if err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
+		return
+	}
+
+	models.DB.Model(&allocation).Updates(data)
+	c.JSON(http.StatusOK, gin.H{"data": allocation})
+}
+
+// DeleteAllocation removes a allocation, identified by its ID
+func DeleteAllocation(c *gin.Context) {
+	var allocation models.Allocation
+	err := models.DB.First(&allocation, c.Param("allocationId")).Error
+	if err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Record not found"})
+		} else {
+			c.JSON(http.StatusInternalServerError, gin.H{"error": err})
+		}
+		return
+	}
+
+	models.DB.Delete(&allocation)
+
+	c.JSON(http.StatusOK, gin.H{"data": true})
+}

internal/controllers/envelope.go

@@ -31,6 +31,8 @@ func RegisterEnvelopeRoutes(r *gin.RouterGroup) {
 		r.PATCH("/:envelopeId", UpdateEnvelope)
 		r.DELETE("/:envelopeId", DeleteEnvelope)
 	}
+
+	RegisterAllocationRoutes(r.Group("/:envelopeId/allocations"))
 }
 
 // CreateEnvelope creates a new envelope
@@ -70,7 +72,9 @@ func GetEnvelope(c *gin.Context) {
 		return
 	}
 
-	c.JSON(http.StatusOK, gin.H{"data": envelope})
+	c.JSON(http.StatusOK, gin.H{"data": envelope, "links": map[string]string{
+		"allocations": "/allocations",
+	}})
 }
 
 // UpdateEnvelope updates a envelope, selected by the ID parameter

internal/models/allocation.go

@@ -0,0 +1,15 @@
+package models
+
+import (
+	"github.com/shopspring/decimal"
+)
+
+// Allocation represents the allocation of money to an Envelope for a specific month
+type Allocation struct {
+	Model
+	Month      uint8           `json:"month" gorm:"uniqueIndex:year_month;check:month >= 1 AND month <= 12"`
+	Year       uint            `json:"year" gorm:"uniqueIndex:year_month"`
+	Amount     decimal.Decimal `json:"amount" gorm:"type:DECIMAL(20,8)"`
+	EnvelopeID int             `json:"envelopeId,omitempty"`
+	Envelope   Envelope        `json:"-"`
+}

internal/models/database.go

@@ -40,6 +40,11 @@ func ConnectDatabase() error {
 		return err
 	}
 
+	err = db.AutoMigrate(Allocation{})
+	if err != nil {
+		return err
+	}
+
 	DB = db
 	return nil
 }