refactor: added interfaces and auto generated mocks

Author: leo-aa88

pkg/api/books.go

@@ -1,7 +1,10 @@
 package api
 
 import (
+	"context"
 	"encoding/json"
+	"golang-rest-api-template/pkg/cache"
+	"golang-rest-api-template/pkg/database"
 	"golang-rest-api-template/pkg/models"
 	"net/http"
 	"strconv"
@@ -10,6 +13,31 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
+type BookRepository interface {
+	Healthcheck(c *gin.Context)
+	FindBooks(c *gin.Context)
+	CreateBook(c *gin.Context)
+	FindBook(c *gin.Context)
+	UpdateBook(c *gin.Context)
+	DeleteBook(c *gin.Context)
+}
+
+// bookRepository holds shared resources like database and Redis client
+type bookRepository struct {
+	DB          database.Database
+	RedisClient cache.Cache
+	Ctx         *context.Context
+}
+
+// NewAppContext creates a new AppContext
+func NewBookRepository(db database.Database, redisClient cache.Cache, ctx *context.Context) *bookRepository {
+	return &bookRepository{
+		DB:          db,
+		RedisClient: redisClient,
+		Ctx:         ctx,
+	}
+}
+
 // @BasePath /api/v1
 
 // Healthcheck godoc
@@ -21,8 +49,8 @@ import (
 // @Produce json
 // @Success 200 {string} ok
 // @Router / [get]
-func Healthcheck(g *gin.Context) {
-	g.JSON(http.StatusOK, "ok")
+func (r *bookRepository) Healthcheck(c *gin.Context) {
+	c.JSON(http.StatusOK, "ok")
 }
 
 // FindBooks godoc
@@ -35,13 +63,7 @@ func Healthcheck(g *gin.Context) {
 // @Param limit query int false "Limit for pagination" default(10)
 // @Success 200 {array} models.Book "Successfully retrieved list of books"
 // @Router /books [get]
-func FindBooks(c *gin.Context) {
-	appCtx, exists := c.MustGet("appCtx").(*AppContext)
-	if !exists {
-		c.JSON(http.StatusInternalServerError, gin.H{"error": "internal server error"})
-		return
-	}
-
+func (r *bookRepository) FindBooks(c *gin.Context) {
 	var books []models.Book
 
 	// Get query params
@@ -65,7 +87,7 @@ func FindBooks(c *gin.Context) {
 	cacheKey := "books_offset_" + offsetQuery + "_limit_" + limitQuery
 
 	// Try fetching the data from Redis first
-	cachedBooks, err := appCtx.RedisClient.Get(*appCtx.Ctx, cacheKey).Result()
+	cachedBooks, err := r.RedisClient.Get(*r.Ctx, cacheKey).Result()
 	if err == nil {
 		err := json.Unmarshal([]byte(cachedBooks), &books)
 		if err != nil {
@@ -77,15 +99,15 @@ func FindBooks(c *gin.Context) {
 	}
 
 	// If cache missed, fetch data from the database
-	appCtx.DB.Offset(offset).Limit(limit).Find(&books)
+	r.DB.Offset(offset).Limit(limit).Find(&books)
 
 	// Serialize books object and store it in Redis
 	serializedBooks, err := json.Marshal(books)
 	if err != nil {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to marshal data"})
 		return
 	}
-	err = appCtx.RedisClient.Set(*appCtx.Ctx, cacheKey, serializedBooks, time.Minute).Err() // Here TTL is set to one hour
+	err = r.RedisClient.Set(*r.Ctx, cacheKey, serializedBooks, time.Minute).Err() // Here TTL is set to one hour
 	if err != nil {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to set cache"})
 		return
@@ -107,8 +129,8 @@ func FindBooks(c *gin.Context) {
 // @Failure 400 {string} string "Bad Request"
 // @Failure 401 {string} string "Unauthorized"
 // @Router /books [post]
-func CreateBook(c *gin.Context) {
-	appCtx, exists := c.MustGet("appCtx").(*AppContext)
+func (r *bookRepository) CreateBook(c *gin.Context) {
+	appCtx, exists := c.MustGet("appCtx").(*bookRepository)
 	if !exists {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "internal server error"})
 		return
@@ -146,15 +168,10 @@ func CreateBook(c *gin.Context) {
 // @Success 200 {object} models.Book "Successfully retrieved book"
 // @Failure 404 {string} string "Book not found"
 // @Router /books/{id} [get]
-func FindBook(c *gin.Context) {
-	appCtx, exists := c.MustGet("appCtx").(*AppContext)
-	if !exists {
-		c.JSON(http.StatusInternalServerError, gin.H{"error": "internal server error"})
-		return
-	}
+func (r *bookRepository) FindBook(c *gin.Context) {
 	var book models.Book
 
-	if err := appCtx.DB.Where("id = ?", c.Param("id")).First(&book).Error; err != nil {
+	if err := r.DB.Where("id = ?", c.Param("id")).First(&book).Error; err != nil {
 		c.JSON(http.StatusNotFound, gin.H{"error": "book not found"})
 		return
 	}
@@ -175,16 +192,11 @@ func FindBook(c *gin.Context) {
 // @Failure 400 {string} string "Bad Request"
 // @Failure 404 {string} string "book not found"
 // @Router /books/{id} [put]
-func UpdateBook(c *gin.Context) {
-	appCtx, exists := c.MustGet("appCtx").(*AppContext)
-	if !exists {
-		c.JSON(http.StatusInternalServerError, gin.H{"error": "internal server error"})
-		return
-	}
+func (r *bookRepository) UpdateBook(c *gin.Context) {
 	var book models.Book
 	var input models.UpdateBook
 
-	if err := appCtx.DB.Where("id = ?", c.Param("id")).First(&book).Error; err != nil {
+	if err := r.DB.Where("id = ?", c.Param("id")).First(&book).Error; err != nil {
 		c.JSON(http.StatusNotFound, gin.H{"error": "book not found"})
 		return
 	}
@@ -194,7 +206,7 @@ func UpdateBook(c *gin.Context) {
 		return
 	}
 
-	appCtx.DB.Model(&book).Updates(models.Book{Title: input.Title, Author: input.Author})
+	r.DB.Model(&book).Updates(models.Book{Title: input.Title, Author: input.Author})
 
 	c.JSON(http.StatusOK, gin.H{"data": book})
 }
@@ -209,8 +221,8 @@ func UpdateBook(c *gin.Context) {
 // @Success 204 {string} string "Successfully deleted book"
 // @Failure 404 {string} string "book not found"
 // @Router /books/{id} [delete]
-func DeleteBook(c *gin.Context) {
-	appCtx, exists := c.MustGet("appCtx").(*AppContext)
+func (r *bookRepository) DeleteBook(c *gin.Context) {
+	appCtx, exists := c.MustGet("appCtx").(*bookRepository)
 	if !exists {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "internal server error"})
 		return