fix query string for characters

Author: UltimateForm

api/bruno/characters.bru

@@ -6,10 +6,15 @@ meta {
 
 get {
   url: {{BASE_URL}}/characters
-  body: json
+  body: none
   auth: inherit
 }
 
+params:query {
+  ~limit: 10
+  ~skip: 0
+}
+
 body:json {
   {
     "limit": 10,

cmd/api/charactersapi/characters.go

@@ -1,45 +1,31 @@
 package charactersapi
 
 import (
+	"errors"
 	"net/http"
 
 	"github.com/UltimateForm/gopen-api/internal/core"
 	"github.com/UltimateForm/gopen-api/internal/repository/charrep"
 )
 
-type Offset struct {
-	Limit int `json:"limit"`
-	Skip  int `json:"skip"`
-}
-
-func (src Offset) Validate() error {
-	if src.Limit <= 0 {
-		return core.BadRequest("limit must be a positive higher than 0 integer")
-	}
-	if src.Skip < 0 {
-		return core.BadRequest("skip be a positive integer")
-	}
-	return nil
-}
-
 func HandleGetCharacters(res http.ResponseWriter, req *http.Request) {
-	var offset Offset
-	// TODO: use query parameters silly
-	err := core.ParseBody(req, &offset)
-	if err != nil {
-		core.RespondError(res, req, err)
+	query := req.URL.Query()
+	limit, limitErr := core.GetIntQuery(query, "limit", 10)
+	skip, skipErr := core.GetIntQuery(query, "skip", 0)
+	if queryErr := errors.Join(limitErr, skipErr); queryErr != nil {
+		core.RespondError(res, req, core.BadRequest(queryErr.Error()))
 		return
 	}
 	characters, err := charrep.ReadCharacters(req.Context(), charrep.Offset{
-		Limit: offset.Limit,
-		Skip:  offset.Skip,
+		Limit: limit,
+		Skip:  skip,
 	})
 	if err != nil {
 		core.RespondError(res, req, err)
 		return
 	}
 	charactersMapped := make([]Character, len(characters))
-	// NOTE: eh should i be mapping at all, golang type integrity does mean i dont need to worry so much about leakage
+	// NOTE: eh should i be mapping at all? golang type integrity does mean i dont need to worry so much about leakage
 	for i, char := range characters {
 		charactersMapped[i] = Character{
 			Id:          char.Id,
@@ -48,5 +34,12 @@ func HandleGetCharacters(res http.ResponseWriter, req *http.Request) {
 			Debut:       char.Debut,
 		}
 	}
-	core.RespondOk(res, CharacterList{Offset: offset, Characters: charactersMapped})
+	core.RespondOk(
+		res, CharacterList{
+			Offset: Offset{
+				Limit: limit,
+				Skip:  skip,
+			},
+			Characters: charactersMapped,
+		})
 }

cmd/api/charactersapi/types.go

@@ -7,6 +7,11 @@ type Character struct {
 	Debut       int    `json:"debut"`
 }
 
+type Offset struct {
+	Limit int `json:"limit"`
+	Skip  int `json:"skip"`
+}
+
 type CharacterList struct {
 	Offset
 	Characters []Character `json:"characters"`

internal/core/body_parse.go

@@ -2,7 +2,10 @@ package core
 
 import (
 	"encoding/json"
+	"fmt"
 	"net/http"
+	"net/url"
+	"strconv"
 )
 
 type RequestBody interface {
@@ -20,3 +23,23 @@ func ParseBody(req *http.Request, data any) error {
 	}
 	return nil
 }
+
+func GetQuery(query url.Values, key string, def string) (string, bool) {
+	val := query.Get(key)
+	if val == "" {
+		return "", false
+	}
+	return val, true
+}
+
+func GetIntQuery(query url.Values, key string, def int) (int, error) {
+	stringVal, exists := GetQuery(query, key, "")
+	if !exists {
+		return def, nil
+	}
+	numericVal, convErr := strconv.Atoi(stringVal)
+	if convErr != nil {
+		return 0, BadRequest(fmt.Sprintf("expected '%v' numeric query parameter but instead found string '%v'", key, stringVal))
+	}
+	return numericVal, nil
+}

internal/core/body_parse_test.go

@@ -55,11 +55,11 @@ func TestParseBodyWithValidationFail(t *testing.T) {
 	if parseErr == nil {
 		t.Fatalf("Expected parseErr to not be nil but instead it is %v", parseErr)
 	}
-	badRequestErr, isErrorResponse := parseErr.(*ErrorResponse)
+	badRequestErr, isErrorResponse := parseErr.(ErrorResponse)
 	if !isErrorResponse {
 		t.Fatalf("Expected error (%v) to be of type error response but it is not", parseErr)
 	}
-	errorRes := &ErrorResponse{
+	errorRes := ErrorResponse{
 		Code:    400,
 		Message: "text is required",
 	}

internal/core/errors.go

@@ -12,28 +12,28 @@ type ErrorResponse struct {
 	Message string `json:"message"`
 }
 
-func (e *ErrorResponse) Error() string {
+func (e ErrorResponse) Error() string {
 	return e.Message
 }
 
-func BadRequest(msg string) *ErrorResponse {
-	return &ErrorResponse{Code: 400, Message: msg}
+func BadRequest(msg string) ErrorResponse {
+	return ErrorResponse{Code: 400, Message: msg}
 }
 
-func InternalServerError() *ErrorResponse {
-	return &ErrorResponse{Code: 500, Message: "Internal Server Error"}
+func InternalServerError() ErrorResponse {
+	return ErrorResponse{Code: 500, Message: "Internal Server Error"}
 }
 
-func NotFound() *ErrorResponse {
-	return &ErrorResponse{Code: 404, Message: "Resource Not Found"}
+func NotFound() ErrorResponse {
+	return ErrorResponse{Code: 404, Message: "Resource Not Found"}
 }
 
-func Unauthorized() *ErrorResponse {
-	return &ErrorResponse{Code: 401, Message: "Unauthorized"}
+func Unauthorized() ErrorResponse {
+	return ErrorResponse{Code: 401, Message: "Unauthorized"}
 }
 
-func Forbidden() *ErrorResponse {
-	return &ErrorResponse{Code: 403, Message: "Forbidden"}
+func Forbidden() ErrorResponse {
+	return ErrorResponse{Code: 403, Message: "Forbidden"}
 }
 
 func RespondKnownError(res http.ResponseWriter, err ErrorResponse) {
@@ -44,11 +44,11 @@ func RespondKnownError(res http.ResponseWriter, err ErrorResponse) {
 
 func RespondError(res http.ResponseWriter, req *http.Request, err error) {
 	switch bindErr := err.(type) {
-	case *ErrorResponse:
-		RespondKnownError(res, *bindErr)
+	case ErrorResponse:
+		RespondKnownError(res, bindErr)
 	default:
 		log.Printf("Non HTTP error occured: %v", err)
-		RespondKnownError(res, *InternalServerError())
+		RespondKnownError(res, InternalServerError())
 
 	}
 }