Merge pull request #1 from Demand-IQ/media-type-support

Media Type support

Author: lucasstine-demandiq

go.mod

@@ -1,21 +1,14 @@
-module github.com/loopfz/gadgeto
+module github.com/demand-iq/gadgeto
 
 require (
 	github.com/gin-gonic/gin v1.6.3
 	github.com/go-gorp/gorp v2.2.0+incompatible
 	github.com/go-playground/validator/v10 v10.2.0
-	github.com/go-sql-driver/mysql v1.5.0 // indirect
-	github.com/golang/protobuf v1.3.5 // indirect
 	github.com/google/uuid v1.1.1
 	github.com/juju/errors v0.0.0-20200330140219-3fe23663418f
-	github.com/juju/testing v0.0.0-20210302031854-2c7ee8570c07 // indirect
-	github.com/lib/pq v1.9.0 // indirect
+	github.com/loopfz/gadgeto v0.11.2
 	github.com/mattn/go-sqlite3 v2.0.3+incompatible
-	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
-	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/pires/go-proxyproto v0.6.0
-	github.com/poy/onpar v1.1.2 // indirect
-	github.com/ziutek/mymysql v1.5.4 // indirect
 )
 
 go 1.13

go.sum

@@ -113,6 +113,8 @@ github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
 github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
 github.com/lib/pq v1.9.0 h1:L8nSXQQzAYByakOFMTwpjRoHsMJklur4Gi59b6VivR8=
 github.com/lib/pq v1.9.0/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+github.com/loopfz/gadgeto v0.11.2 h1:kc7GoNcNgjQOZmA6nwS1jOC6yek9GoyDkxQ2vCwf63g=
+github.com/loopfz/gadgeto v0.11.2/go.mod h1:FFfb8QmTdEo+z9pvzTeTousO2ZoP81WInQg1aG42UOo=
 github.com/lunixbochs/vtclean v0.0.0-20160125035106-4fbf7632a2c6/go.mod h1:pHhQNgMf3btfWnGBVipUOjRYhoOsdGqdm/+2c2E2WMI=
 github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
 github.com/masterzen/azure-sdk-for-go v3.2.0-beta.0.20161014135628-ee4f0065d00c+incompatible/go.mod h1:mf8fjOu33zCqxUjuiU3I8S1lJMyEAlH+0F2+M5xl3hE=

tonic/handler.go

@@ -22,12 +22,12 @@ var (
 // in parameters.
 // The handler may use the following signature:
 //
-//  func(*gin.Context, [input object ptr]) ([output object], error)
+//	func(*gin.Context, [input object ptr]) ([output object], error)
 //
 // Input and output objects are both optional.
 // As such, the minimal accepted signature is:
 //
-//  func(*gin.Context) error
+//	func(*gin.Context) error
 //
 // The wrapping gin-handler will bind the parameters from the query-string,
 // path, body and headers, and handle the errors.
@@ -49,16 +49,17 @@ func Handler(h interface{}, status int, options ...func(*Route)) gin.HandlerFunc
 	// Wrap Gin handler.
 	f := func(c *gin.Context) {
 		_, ok := c.Get(tonicWantRouteInfos)
+		r := &Route{}
+		for _, opt := range options {
+			opt(r)
+		}
 		if ok {
 			r := &Route{}
 			r.defaultStatusCode = status
 			r.handler = hv
 			r.handlerType = ht
 			r.inputType = in
 			r.outputType = out
-			for _, opt := range options {
-				opt(r)
-			}
 			c.Set(tonicRoutesInfos, r)
 			c.Abort()
 			return
@@ -71,8 +72,14 @@ func Handler(h interface{}, status int, options ...func(*Route)) gin.HandlerFunc
 		// binding.
 		if in != nil {
 			input := reflect.New(in)
+			routeBindHook := r.GetBindHook()
+			if routeBindHook == nil {
+				// use the default bindHook if the route
+				// does not have a custom one
+				routeBindHook = bindHook
+			}
 			// Bind the body with the hook.
-			if err := bindHook(c, input.Interface()); err != nil {
+			if err := routeBindHook(c, input.Interface()); err != nil {
 				handleError(c, BindError{message: err.Error(), typ: in})
 				return
 			}
@@ -116,7 +123,11 @@ func Handler(h interface{}, status int, options ...func(*Route)) gin.HandlerFunc
 			handleError(c, err.(error))
 			return
 		}
-		renderHook(c, status, val)
+		routeRenderHook := r.GetRenderHook()
+		if routeRenderHook == nil {
+			routeRenderHook = renderHook
+		}
+		routeRenderHook(c, status, val)
 	}
 	// Register route in tonic-enabled routes map
 	route := &Route{
@@ -154,13 +165,13 @@ func RegisterValidation(tagName string, validationFunc validator.Func) error {
 //
 // eg. to use the names which have been specified for JSON representations of structs, rather than normal Go field names:
 //
-//    validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
-//        name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
-//        if name == "-" {
-//            return ""
-//        }
-//        return name
-//    }
+//	validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
+//	    name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
+//	    if name == "-" {
+//	        return ""
+//	    }
+//	    return name
+//	}
 func RegisterTagNameFunc(registerTagFunc validator.TagNameFunc) {
 	validatorObj.RegisterTagNameFunc(registerTagFunc)
 }

tonic/route.go

@@ -32,6 +32,18 @@ type Route struct {
 	// outputType is the type of the output object.
 	// This can be nil if the handler use none.
 	outputType reflect.Type
+
+	// the bindHook for this route
+	bindHook BindHook
+
+	// the renderHook for this route
+	renderHook RenderHook
+
+	// the request media type for this route
+	requestMediaType string
+
+	// the response media type for this route
+	responseMediaType string
 }
 
 // GetVerb returns the HTTP verb of the route.
@@ -40,6 +52,30 @@ func (r *Route) GetVerb() string { return r.Method }
 // GetPath returns the path of the route.
 func (r *Route) GetPath() string { return r.Path }
 
+// GetRequestMediaType returns the media type of the route.
+func (r *Route) GetRequestMediaType() string { return r.requestMediaType }
+
+// GetResponseMediaType returns the media type of the route.
+func (r *Route) GetResponseMediaType() string { return r.responseMediaType }
+
+// SetRequestMediaType returns the media type of the route.
+func (r *Route) SetRequestMediaType(mt string) { r.requestMediaType = mt }
+
+// SetResponseMediaType returns the media type of the route.
+func (r *Route) SetResponseMediaType(mt string) { r.responseMediaType = mt }
+
+// GetBindHook returns the bind hook of the route.
+func (r *Route) GetBindHook() BindHook { return r.bindHook }
+
+// SetBindHook returns the bind hook of the route.
+func (r *Route) SetBindHook(h BindHook) { r.bindHook = h }
+
+// GetRenderHook returns the bind hook of the route.
+func (r *Route) GetRenderHook() RenderHook { return r.renderHook }
+
+// SetRenderHook returns the bind hook of the route.
+func (r *Route) SetRenderHook(h RenderHook) { r.renderHook = h }
+
 // GetDescription returns the description of the route.
 func (r *Route) GetDescription() string { return r.description }
 

tonic/tonic_test.go

@@ -9,9 +9,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/demand-iq/gadgeto/tonic"
 	"github.com/gin-gonic/gin"
 	"github.com/loopfz/gadgeto/iffy"
-	"github.com/loopfz/gadgeto/tonic"
 )
 
 var r http.Handler
@@ -35,6 +35,18 @@ func TestMain(m *testing.M) {
 	g.GET("/query", tonic.Handler(queryHandler, 200))
 	g.GET("/query-old", tonic.Handler(queryHandlerOld, 200))
 	g.POST("/body", tonic.Handler(bodyHandler, 200))
+	g.POST("/bodyYAML", tonic.Handler(bodyHandler, 200, func(r *tonic.Route) {
+		r.SetBindHook(func(c *gin.Context, i interface{}) error {
+			if err := c.ShouldBindYAML(i); err != nil {
+				return fmt.Errorf("error parsing request body: %s", err.Error())
+			}
+			return nil
+		})
+		r.SetRenderHook(func(c *gin.Context, statusCode int, payload interface{}) {
+			c.YAML(statusCode, payload)
+		})
+		r.SetResponseMediaType("text/yaml")
+	}))
 
 	r = g
 
@@ -130,6 +142,15 @@ func TestBody(t *testing.T) {
 	tester.Run()
 }
 
+func TestBodyYAML(t *testing.T) {
+
+	tester := iffy.NewTester(t, r)
+
+	tester.AddCall("body", "POST", "/bodyYAML", `param: foo`).Checkers(iffy.ExpectStatus(200), expectStringInBody("param: foo"))
+
+	tester.Run()
+}
+
 func errorHandler(c *gin.Context) error {
 	return errors.New("error")
 }
@@ -190,9 +211,9 @@ func queryHandlerOld(c *gin.Context, in *queryInOld) (*queryInOld, error) {
 }
 
 type bodyIn struct {
-	Param                  string `json:"param" validate:"required"`
-	ParamOptional          string `json:"param-optional"`
-	ValidatedParamOptional string `json:"param-optional-validated" validate:"eq=|eq=foo|gt=10"`
+	Param                  string `json:"param" validate:"required" yaml:"param"`
+	ParamOptional          string `json:"param-optional" yaml:"param-optional"`
+	ValidatedParamOptional string `json:"param-optional-validated" validate:"eq=|eq=foo|gt=10" yaml:"param-optional-validated"`
 }
 
 func bodyHandler(c *gin.Context, in *bodyIn) (*bodyIn, error) {