feat: adding httsuite basics

Author: rluders

.idea/.gitignore

@@ -1,2 +1,86 @@
 # httpsuite
- A Go library to simplify request parsing, validation, and response handling in microservices, making code cleaner and more maintainable.
+
+**httpsuite** is a Go library designed to simplify the handling of HTTP requests, validations, and responses 
+in microservices. By providing a clear structure and modular approach, it helps developers write 
+cleaner, more maintainable code with reduced boilerplate.
+
+## Features
+
+- **Request Parsing**: Streamline the parsing of incoming HTTP requests, including URL parameters.
+- **Validation:** Centralize validation logic for easy reuse and consistency.
+- **Response Handling:** Standardize responses across your microservices for a unified client experience.
+- **Modular Design:** Each component (Request, Validation, Response) can be used independently, 
+enhancing testability and flexibility.
+
+> **Note:** Currently it only supports Chi.
+
+## Installation
+
+To install **httpsuite**, run:
+
+```
+go get github.com/rluders/httpsuite
+```
+
+## Usage
+
+### Request Parsing with URL Parameters
+
+Easily parse incoming requests and set URL parameters:
+
+```go
+package main
+
+import (
+	"github.com/go-chi/chi/v5"
+	"github.com/go-chi/chi/v5/middleware"
+	"github.com/rluders/httpsuite"
+	"log"
+	"net/http"
+)
+
+type SampleRequest struct {
+	Name string `json:"name" validate:"required,min=3"`
+	Age  int    `json:"age" validate:"required,min=1"`
+}
+
+func (r *SampleRequest) SetParam(fieldName, value string) error {
+	switch fieldName {
+	case "name":
+		r.Name = value
+	}
+	return nil
+}
+
+func main() {
+	r := chi.NewRouter()
+	r.Use(middleware.Logger)
+	r.Use(middleware.Recoverer)
+
+	r.Post("/submit/{name}", func(w http.ResponseWriter, r *http.Request) {
+		// Step 1: Parse the request and validate it
+		req, err := httpsuite.ParseRequest[*SampleRequest](w, r, "name")
+		if err != nil {
+			log.Printf("Error parsing or validating request: %v", err)
+			return
+		}
+
+		// Step 2: Send a success response
+		httpsuite.SendResponse(w, "Request received successfully", http.StatusOK, &req)
+	})
+
+	log.Println("Starting server on :8080")
+	http.ListenAndServe(":8080", r)
+}
+```
+
+Check out the [example folder for a complete project](./examples) demonstrating how to integrate **httpsuite** into 
+your Go microservices.
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues, submit pull requests, and help improve **httpsuite**.
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.

.idea/httpsuite.iml

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"github.com/go-chi/chi/v5"
+	"github.com/go-chi/chi/v5/middleware"
+	"github.com/rluders/httpsuite"
+	"log"
+	"net/http"
+)
+
+type SampleRequest struct {
+	Name string `json:"name" validate:"required,min=3"`
+	Age  int    `json:"age" validate:"required,min=1"`
+}
+
+func (r *SampleRequest) SetParam(fieldName, value string) error {
+	switch fieldName {
+	case "name":
+		r.Name = value
+	}
+	return nil
+}
+
+func main() {
+	r := chi.NewRouter()
+	r.Use(middleware.Logger)
+	r.Use(middleware.Recoverer)
+
+	r.Post("/submit/{name}", func(w http.ResponseWriter, r *http.Request) {
+		// Step 1: Parse the request and validate it
+		req, err := httpsuite.ParseRequest[*SampleRequest](w, r, "name")
+		if err != nil {
+			log.Printf("Error parsing or validating request: %v", err)
+			return
+		}
+
+		// Step 2: Send a success response
+		httpsuite.SendResponse(w, "Request received successfully", http.StatusOK, &req)
+	})
+
+	log.Println("Starting server on :8080")
+	http.ListenAndServe(":8080", r)
+}

.idea/modules.xml

@@ -0,0 +1,23 @@
+module github.com/rluders/httpsuite
+
+go 1.23.1
+
+require (
+	github.com/go-chi/chi/v5 v5.1.0
+	github.com/go-playground/validator/v10 v10.22.1
+	github.com/stretchr/testify v1.9.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/crypto v0.19.0 // indirect
+	golang.org/x/net v0.21.0 // indirect
+	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

.idea/vcs.xml

@@ -0,0 +1,32 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0=
+github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk=
+github.com/go-chi/chi/v5 v5.1.0 h1:acVI1TYaD+hhedDJ3r54HyA6sExp3HfXq7QWEEY/xMw=
+github.com/go-chi/chi/v5 v5.1.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
+github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
+github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
+github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
+github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
+github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
+github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
+github.com/go-playground/validator/v10 v10.22.1 h1:40JcKH+bBNGFczGuoBYgX4I6m/i27HYW8P9FDk5PbgA=
+github.com/go-playground/validator/v10 v10.22.1/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM=
+github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
+github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/crypto v0.19.0 h1:ENy+Az/9Y1vSrlrvBSyna3PITt4tiZLf7sgCjZBX7Wo=
+golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
+golang.org/x/net v0.21.0 h1:AQyQV4dYCvJ7vGmJyKki9+PBdyvhkSd8EIx/qb0AYv4=
+golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
+golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y=
+golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

README.md

@@ -0,0 +1,68 @@
+package httpsuite
+
+import (
+	"encoding/json"
+	"errors"
+	"github.com/go-chi/chi/v5"
+	"net/http"
+	"reflect"
+)
+
+// RequestParamSetter defines the interface used to set the parameters to the HTTP request object by the request parser.
+// Implementing this interface allows custom handling of URL parameters.
+type RequestParamSetter interface {
+	// SetParam assigns a value to a specified field in the request struct.
+	// The fieldName parameter is the name of the field, and value is the value to set.
+	SetParam(fieldName, value string) error
+}
+
+// ParseRequest parses the incoming HTTP request into a specified struct type, handling JSON decoding and URL parameters.
+// It validates the parsed request and returns it along with any potential errors.
+// The pathParams variadic argument allows specifying URL parameters to be extracted.
+// If an error occurs during parsing, validation, or parameter setting, it responds with an appropriate HTTP status.
+func ParseRequest[T RequestParamSetter](w http.ResponseWriter, r *http.Request, pathParams ...string) (T, error) {
+	var request T
+	var empty T
+
+	defer func() {
+		_ = r.Body.Close()
+	}()
+
+	if r.Body != http.NoBody {
+		if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
+			SendResponse[any](w, "Invalid JSON format", http.StatusBadRequest, nil)
+			return empty, err
+		}
+	}
+
+	// If body wasn't parsed request may be nil and cause problems ahead
+	if isRequestNil(request) {
+		request = reflect.New(reflect.TypeOf(request).Elem()).Interface().(T)
+	}
+
+	// Parse URL parameters
+	for _, key := range pathParams {
+		value := chi.URLParam(r, key)
+		if value == "" {
+			SendResponse[any](w, "Parameter "+key+" not found in request", http.StatusBadRequest, nil)
+			return empty, errors.New("missing parameter: " + key)
+		}
+
+		if err := request.SetParam(key, value); err != nil {
+			SendResponse[any](w, "Failed to set field "+key, http.StatusInternalServerError, nil)
+			return empty, err
+		}
+	}
+
+	// Validate the combined request struct
+	if validationErr := IsRequestValid(request); validationErr != nil {
+		SendResponse[ValidationErrors](w, "Validation error", http.StatusBadRequest, validationErr)
+		return empty, errors.New("validation error")
+	}
+
+	return request, nil
+}
+
+func isRequestNil(i interface{}) bool {
+	return i == nil || (reflect.ValueOf(i).Kind() == reflect.Ptr && reflect.ValueOf(i).IsNil())
+}