echo: add new content type negotiatorecho/v0.10.0

4 files changed, 284 insertions, 10 deletions

diff --git a/echo/controller/content_type_negotiator_v2.go b/echo/controller/content_type_negotiator_v2.go
new file mode 100644
index 0000000..63d7fd3
--- /dev/null
+++ b/echo/controller/content_type_negotiator_v2.go
@@ -0,0 +1,196 @@
+package controller
+
+import (
+        "errors"
+        "net/http"
+
+        "github.com/labstack/echo/v4"
+
+        glecho "code.crute.us/mcrute/golib/echo"
+        glhttp "code.crute.us/mcrute/golib/net/http"
+)
+
+const (
+        ContextMediaTypeParameters = "__golib_echo_negotiator_media_type_params"
+        DefaultContentType         = "*/*"
+)
+
+type ContentTypeHandlerMap map[string]ErrorHandler
+
+type ErrorHandler interface {
+        HandleError(echo.Context, int, error) error
+}
+
+type GetableHandler interface{ HandleGet(echo.Context) error }
+type HeadableHandler interface{ HandleHead(echo.Context) error }
+type PostableHandler interface{ HandlePost(echo.Context) error }
+type PutableHandler interface{ HandlePut(echo.Context) error }
+type PatchableHandler interface{ HandlePatch(echo.Context) error }
+type DeleteableHandler interface{ HandleDelete(echo.Context) error }
+type ConnectableHandler interface{ HandleConnect(echo.Context) error }
+type OptionableHandler interface{ HandleOptions(echo.Context) error }
+type TraceableHandler interface{ HandleTrace(echo.Context) error }
+
+type ContentTypeNegotiatingHandlerV2 struct {
+        handlers      map[string]map[string]echo.HandlerFunc // Content-Type -> HTTP Method -> Handler
+        errorHandlers map[string]ErrorHandler
+        mediaTypes    glhttp.AcceptableTypes
+}
+
+func NewContentTypeNegotiatingHandlerV2() *ContentTypeNegotiatingHandlerV2 {
+        return &ContentTypeNegotiatingHandlerV2{
+                handlers:      map[string]map[string]echo.HandlerFunc{},
+                mediaTypes:    glhttp.AcceptableTypes{},
+                errorHandlers: map[string]ErrorHandler{},
+        }
+}
+
+func buildMethodMap(hnd ErrorHandler) map[string]echo.HandlerFunc {
+        methods := map[string]echo.HandlerFunc{}
+
+        if h, ok := hnd.(GetableHandler); ok {
+                methods[http.MethodGet] = h.HandleGet
+        }
+
+        if h, ok := hnd.(HeadableHandler); ok {
+                methods[http.MethodHead] = h.HandleHead
+        }
+
+        if h, ok := hnd.(PostableHandler); ok {
+                methods[http.MethodPost] = h.HandlePost
+        }
+
+        if h, ok := hnd.(PutableHandler); ok {
+                methods[http.MethodPut] = h.HandlePut
+        }
+
+        if h, ok := hnd.(PatchableHandler); ok {
+                methods[http.MethodPatch] = h.HandlePatch
+        }
+
+        if h, ok := hnd.(DeleteableHandler); ok {
+                methods[http.MethodDelete] = h.HandleDelete
+        }
+
+        if h, ok := hnd.(ConnectableHandler); ok {
+                methods[http.MethodConnect] = h.HandleConnect
+        }
+
+        if h, ok := hnd.(OptionableHandler); ok {
+                methods[http.MethodOptions] = h.HandleOptions
+        }
+
+        if h, ok := hnd.(TraceableHandler); ok {
+                methods[http.MethodTrace] = h.HandleTrace
+        }
+
+        return methods
+}
+
+// RegisterHandler registers a handler for a content type and method. It
+// will return an error if registration fails.
+func (h *ContentTypeNegotiatingHandlerV2) RegisterHandler(ct string, hnd ErrorHandler) error {
+        mt, err := glhttp.ParseMediaType(ct)
+        if err != nil {
+                return err
+        }
+
+        h.mediaTypes = append(h.mediaTypes, mt)
+        h.mediaTypes.Sorted()
+
+        h.handlers[mt.String()] = buildMethodMap(hnd)
+        h.errorHandlers[mt.String()] = hnd
+        return nil
+}
+
+func (h *ContentTypeNegotiatingHandlerV2) Default(hnd ErrorHandler) *ContentTypeNegotiatingHandlerV2 {
+        return h.Handles(DefaultContentType, hnd)
+}
+
+// Handles is a fluent builder that panics on error
+func (h *ContentTypeNegotiatingHandlerV2) Handles(ct string, hnd ErrorHandler) *ContentTypeNegotiatingHandlerV2 {
+        if err := h.RegisterHandler(ct, hnd); err != nil {
+                panic(err)
+        }
+        return h
+}
+
+func (h *ContentTypeNegotiatingHandlerV2) HandlesAll(hnds ContentTypeHandlerMap) *ContentTypeNegotiatingHandlerV2 {
+        for ct, hnd := range hnds {
+                h.Handles(ct, hnd)
+        }
+        return h
+}
+
+func (h *ContentTypeNegotiatingHandlerV2) handleDefaultError(c echo.Context, code int, status string) error {
+        if hnd, ok := h.errorHandlers[DefaultContentType]; ok {
+                return hnd.HandleError(c, code, errors.New(status))
+        }
+
+        return c.JSON(code, map[string]any{
+                "error": map[string]any{
+                        "code":    code,
+                        "message": status,
+                },
+        })
+}
+
+func (h *ContentTypeNegotiatingHandlerV2) Handle(c echo.Context) error {
+        accept, err := glhttp.ParseAccept(c.Request().Header.Values("Accept"))
+        if err != nil {
+                return err
+        }
+
+        match, matcher := h.mediaTypes.FindMatch(accept)
+        if match == nil {
+                code := http.StatusNotAcceptable
+                return h.handleDefaultError(c, code, http.StatusText(code))
+        }
+
+        c.Set(ContextMediaTypeParameters, matcher.Parameters)
+
+        ctHandlers := h.handlers[match.String()]
+        handler, ok := ctHandlers[c.Request().Method]
+        if !ok {
+                code := http.StatusMethodNotAllowed
+                return h.errorHandlers[match.String()].HandleError(c, code, errors.New(http.StatusText(code)))
+        }
+
+        c.Response().Header().Set("Content-Type", match.String())
+
+        return handler(c)
+}
+
+func (h *ContentTypeNegotiatingHandlerV2) Connect(path string, r glecho.URLRouter, mw ...echo.MiddlewareFunc) *ContentTypeNegotiatingHandlerV2 {
+        allMethods := map[string]*int{}
+        for _, v := range h.handlers {
+                for k, _ := range v {
+                        allMethods[k] = nil
+                }
+        }
+
+        for k, _ := range allMethods {
+                switch k {
+                case http.MethodGet:
+                        r.GET(path, h.Handle, mw...)
+                case http.MethodHead:
+                        r.HEAD(path, h.Handle, mw...)
+                case http.MethodPost:
+                        r.POST(path, h.Handle, mw...)
+                case http.MethodPut:
+                        r.PUT(path, h.Handle, mw...)
+                case http.MethodPatch:
+                        r.PATCH(path, h.Handle, mw...)
+                case http.MethodDelete:
+                        r.DELETE(path, h.Handle, mw...)
+                case http.MethodConnect:
+                        r.Add(http.MethodConnect, path, h.Handle, mw...)
+                case http.MethodOptions:
+                        r.OPTIONS(path, h.Handle, mw...)
+                case http.MethodTrace:
+                        r.Add(http.MethodTrace, path, h.Handle, mw...)
+                }
+        }
+
+        return h
+}
diff --git a/echo/controller/content_type_negotiator_v2_test.go b/echo/controller/content_type_negotiator_v2_test.go
new file mode 100644
index 0000000..689003a
--- /dev/null
+++ b/echo/controller/content_type_negotiator_v2_test.go
@@ -0,0 +1,72 @@
+package controller
+
+import (
+        "fmt"
+        "io"
+        "net/http"
+        "net/http/httptest"
+        "testing"
+
+        "github.com/labstack/echo/v4"
+        "github.com/stretchr/testify/assert"
+)
+
+// TODO
+// Not Acceptable Error
+// Bad Request Error
+// Other error
+// Error with default handler
+// Error without default handler
+
+// Check context params
+// No handler for method
+// Check content-type return header
+// Handler runs
+
+type GetOnlyHandler struct{}
+
+func (h *GetOnlyHandler) HandleError(c echo.Context, code int, err error) error {
+        return c.String(code, fmt.Sprintf("%s -- default", err))
+}
+
+func (h *GetOnlyHandler) HandleGet(c echo.Context) error {
+        return c.String(http.StatusOK, "GET OK -- default")
+}
+
+type GetPostHandler struct{ Name string }
+
+func (h *GetPostHandler) HandleError(c echo.Context, code int, err error) error {
+        return c.String(code, fmt.Sprintf("%s %s", h.Name, err))
+}
+
+func (h *GetPostHandler) HandleGet(c echo.Context) error {
+        return c.String(http.StatusOK, fmt.Sprintf("%s GET OK", h.Name))
+}
+
+func (h *GetPostHandler) HandlePost(c echo.Context) error {
+        return c.String(http.StatusOK, fmt.Sprintf("%s POST OK", h.Name))
+}
+
+func TestHandlerSuccess(t *testing.T) {
+        hnd := NewContentTypeNegotiatingHandlerV2().
+                HandlesAll(ContentTypeHandlerMap{
+                        "*/*":        &GetOnlyHandler{},
+                        "text/xml":   &GetPostHandler{"xml"},
+                        "text/*":     &GetPostHandler{"html"},
+                        "text/plain": &GetPostHandler{"plain"},
+                })
+
+        e := echo.New()
+        req := httptest.NewRequest(http.MethodPost, "/", nil)
+        req.Header.Set("Accept", "text/*,*/*;q=0.8")
+        //"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8")
+        rec := httptest.NewRecorder()
+        c := e.NewContext(req, rec)
+
+        assert.NoError(t, hnd.Handle(c))
+
+        res := rec.Result()
+        o, _ := io.ReadAll(res.Body)
+        fmt.Printf("%s\n", o)
+        assert.False(t, true)
+}
diff --git a/echo/go.mod b/echo/go.mod
index 39501c2..fcedf30 100644
--- a/echo/go.mod
+++ b/echo/go.mod
@@ -2,16 +2,18 @@ module code.crute.us/mcrute/golib/echo
 
 go 1.18
 
+replace code.crute.us/mcrute/golib => ../
+
 require (
         code.crute.us/mcrute/golib v0.4.2
         code.crute.us/mcrute/golib/clients/netbox v0.1.0
         code.crute.us/mcrute/golib/secrets v0.1.0
         code.crute.us/mcrute/golib/vault v0.2.4
-        github.com/elnormous/contenttype v1.0.0
+        github.com/elnormous/contenttype v1.0.3
         github.com/labstack/echo/v4 v4.6.1
         github.com/labstack/gommon v0.3.1
         github.com/prometheus/client_golang v1.11.0
-        github.com/stretchr/testify v1.7.0
+        github.com/stretchr/testify v1.8.1
         gopkg.in/square/go-jose.v2 v2.5.1
 )
 
@@ -72,5 +74,5 @@ require (
         google.golang.org/genproto v0.0.0-20200825200019-8632dd797987 // indirect
         google.golang.org/grpc v1.41.0 // indirect
         google.golang.org/protobuf v1.26.0 // indirect
-        gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+        gopkg.in/yaml.v3 v3.0.1 // indirect
 )
diff --git a/echo/go.sum b/echo/go.sum
index 0c48b3b..fe3ba40 100644
--- a/echo/go.sum
+++ b/echo/go.sum
@@ -30,8 +30,6 @@ cloud.google.com/go/storage v1.5.0/go.mod h1:tpKbwo567HUNpVclU5sGELwQWBDZ8gh0Zeo
 cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohlUTyfDhBk=
 cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
 cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
-code.crute.us/mcrute/golib v0.4.2 h1:WeZyBMRFOiIkdNhsXx3kMgRGDUdUshzHS/J4OIPThlY=
-code.crute.us/mcrute/golib v0.4.2/go.mod h1:dukLPhs1H8dxtkhXtpJZYo/bMzefLRbdRj9Tj67wdaQ=
 code.crute.us/mcrute/golib/clients/netbox v0.1.0 h1:7ae676WtINm2oSLoUw1ERIZ2ndLD5gi7cvv2iZZd1XI=
 code.crute.us/mcrute/golib/clients/netbox v0.1.0/go.mod h1:csRsnmAwenAz8Pbo7CcQTWzn6uaXadELIdB81JxsacY=
 code.crute.us/mcrute/golib/secrets v0.1.0 h1:22W0rLhE5jvIQlsUDQt1soGBEoBn4rl4a883f1yBybI=
@@ -76,8 +74,8 @@ github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ3
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 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/elnormous/contenttype v1.0.0 h1:cTLou7K7uQMsPEmRiTJosAznsPcYuoBmXMrFAf86t2A=
-github.com/elnormous/contenttype v1.0.0/go.mod h1:ngVcyGGU8pnn4QJ5sL4StrNgc/wmXZXy5IQSBuHOFPg=
+github.com/elnormous/contenttype v1.0.3 h1:5DrD4LGO3ohab+jPplwE/LlY9JqmkYdssz4Zu7xl8Cs=
+github.com/elnormous/contenttype v1.0.3/go.mod h1:ngVcyGGU8pnn4QJ5sL4StrNgc/wmXZXy5IQSBuHOFPg=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
@@ -334,14 +332,19 @@ github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPx
 github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
 github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
-github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/tv42/httpunix v0.0.0-20150427012821-b75d8614f926/go.mod h1:9ESjWnEqriFuLhtthL60Sar/7RFoluCcXsuvEwTV5KM=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
@@ -653,8 +656,9 @@ gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=