From 80807d1066dd26742585696bb5a1958e50a85b26 Mon Sep 17 00:00:00 2001 From: Mathis Joffre Date: Thu, 25 Aug 2022 12:51:25 +0200 Subject: [PATCH] Refactoring package Signed-off-by: Mathis Joffre --- .../fiber/middleware.go => fiber_middleware.go | 16 ++++++++-------- .../gin/middleware.go => gin_middleware.go | 16 ++++++++-------- .../http/middleware.go => http_middleware.go | 2 +- ...middleware_test.go => http_middleware_test.go | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) rename middleware/fiber/middleware.go => fiber_middleware.go (82%) rename middleware/gin/middleware.go => gin_middleware.go (79%) rename middleware/http/middleware.go => http_middleware.go (98%) rename middleware/http/middleware_test.go => http_middleware_test.go (99%) diff --git a/middleware/fiber/middleware.go b/fiber_middleware.go similarity index 82% rename from middleware/fiber/middleware.go rename to fiber_middleware.go index 2873045..a97d490 100644 --- a/middleware/fiber/middleware.go +++ b/fiber_middleware.go @@ -1,4 +1,4 @@ -package fibermiddleware +package opamiddleware import ( "errors" @@ -10,17 +10,17 @@ import ( ) // InputCreationMethod is the method that is used to create the input for the policy. -type InputCreationMethod func(c *fiber.Ctx) (map[string]interface{}, error) +type FiberInputCreationMethod func(c *fiber.Ctx) (map[string]interface{}, error) -type Middleware struct { +type FiberMiddleware struct { // Config is the configuration for the middleware. Config *config.Config // InputCreationMethod is a function that returns the value to be sent to the OPA server. - InputCreationMethod InputCreationMethod `json:"binding_method,omitempty"` + InputCreationMethod FiberInputCreationMethod `json:"binding_method,omitempty"` } // NewFiberMiddleware is the constructor for the opa fiber middleware. -func NewFiberMiddleware(cfg *config.Config, input InputCreationMethod) (*Middleware, error) { +func NewFiberMiddleware(cfg *config.Config, input FiberInputCreationMethod) (*FiberMiddleware, error) { err := cfg.Validate() if err != nil { return nil, err @@ -30,14 +30,14 @@ func NewFiberMiddleware(cfg *config.Config, input InputCreationMethod) (*Middlew return nil, errors.New("[opa-middleware-fiber] InputCreationMethod must be provided") } } - return &Middleware{ + return &FiberMiddleware{ Config: cfg, InputCreationMethod: input, }, nil } // Use returns the handler for the middleware that is used by fiber to evaluate the request against the policy. -func (g *Middleware) Use() func(c *fiber.Ctx) error { +func (g *FiberMiddleware) Use() func(c *fiber.Ctx) error { return func(c *fiber.Ctx) error { if g.Config.Debug { g.Config.Logger.Printf("[opa-middleware-fiber] Request: %s", c.Request().URI()) @@ -65,7 +65,7 @@ func (g *Middleware) Use() func(c *fiber.Ctx) error { } } -func (g *Middleware) query(c *fiber.Ctx) (bool, error) { +func (g *FiberMiddleware) query(c *fiber.Ctx) (bool, error) { bind, err := g.InputCreationMethod(c) if err != nil { return !g.Config.ExceptedResult, err diff --git a/middleware/gin/middleware.go b/gin_middleware.go similarity index 79% rename from middleware/gin/middleware.go rename to gin_middleware.go index 02a196d..793a14c 100644 --- a/middleware/gin/middleware.go +++ b/gin_middleware.go @@ -1,4 +1,4 @@ -package ginmiddleware +package opamiddleware import ( "errors" @@ -8,16 +8,16 @@ import ( "net/http" ) -type InputCreationMethod func(c *gin.Context) (map[string]interface{}, error) +type GinInputCreationMethod func(c *gin.Context) (map[string]interface{}, error) -type Middleware struct { +type GinMiddleware struct { Config *config.Config // BindingMethod is a function that returns the value to be sent to the OPA server. - InputCreationMethod InputCreationMethod `json:"binding_method,omitempty"` + InputCreationMethod GinInputCreationMethod `json:"binding_method,omitempty"` } // NewGinMiddleware is the constructor for the opa gin middleware. -func NewGinMiddleware(cfg *config.Config, input InputCreationMethod) (*Middleware, error) { +func NewGinMiddleware(cfg *config.Config, input GinInputCreationMethod) (*GinMiddleware, error) { err := cfg.Validate() if err != nil { return nil, err @@ -34,14 +34,14 @@ func NewGinMiddleware(cfg *config.Config, input InputCreationMethod) (*Middlewar return bind, nil } } - return &Middleware{ + return &GinMiddleware{ Config: cfg, InputCreationMethod: input, }, nil } // Use returns the handler for the middleware that is used by gin to evaluate the request against the policy. -func (g *Middleware) Use() func(c *gin.Context) { +func (g *GinMiddleware) Use() func(c *gin.Context) { return func(c *gin.Context) { if g.Config.Debug { g.Config.Logger.Printf("[opa-middleware-gin] Request: %s", c.Request.URL.String()) @@ -64,7 +64,7 @@ func (g *Middleware) Use() func(c *gin.Context) { } } -func (g *Middleware) query(c *gin.Context) (bool, error) { +func (g *GinMiddleware) query(c *gin.Context) (bool, error) { bind, err := g.InputCreationMethod(c) if err != nil { return !g.Config.ExceptedResult, err diff --git a/middleware/http/middleware.go b/http_middleware.go similarity index 98% rename from middleware/http/middleware.go rename to http_middleware.go index 1b293dd..83d8722 100644 --- a/middleware/http/middleware.go +++ b/http_middleware.go @@ -1,4 +1,4 @@ -package httpmiddleware +package opamiddleware import ( "github.com/Joffref/opa-middleware/config" diff --git a/middleware/http/middleware_test.go b/http_middleware_test.go similarity index 99% rename from middleware/http/middleware_test.go rename to http_middleware_test.go index 41cf3e3..88b441e 100644 --- a/middleware/http/middleware_test.go +++ b/http_middleware_test.go @@ -1,4 +1,4 @@ -package httpmiddleware +package opamiddleware import ( "github.com/Joffref/opa-middleware/config"