app

Documentation

Index

• type App
  • func NewApp(log *slog.Logger, controller controllers.Controller, cfg *config.AppConfig) *App
  • func (a *App) Run() (err error)
• type AuthHmac
  • func NewAuthHmacMiddleware(log *slog.Logger, cfg HmacConfig) *AuthHmac
  • func (a *AuthHmac) AuthHmacMiddleware(next http.Handler) http.Handler
• type HealthHandler
  • func NewHealthHandler(log *slog.Logger) *HealthHandler
  • func (h *HealthHandler) Get(w http.ResponseWriter, r *http.Request)
  • func (h *HealthHandler) RegisterRoutes(r Router)
• type HmacConfig
• type Response
  • func NewResponse(status int, message string) *Response
  • func (r *Response) ToJson() []byte
  • func (r *Response) WriteResponse(w http.ResponseWriter)
• type Router
• type SwaggerHandler
  • func NewSwaggerHandler(log *slog.Logger) *SwaggerHandler
  • func (sh *SwaggerHandler) Redirect(w http.ResponseWriter, r *http.Request)
  • func (sh *SwaggerHandler) RegisterRoutes(r Router)
• type WebhookHandler
  • func NewWebhookHandler(log *slog.Logger, controller controllers.Controller) *WebhookHandler
  • func (wh *WebhookHandler) Post(w http.ResponseWriter, r *http.Request)
  • func (wh *WebhookHandler) RegisterRoutes(r Router, hmac *AuthHmac)

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(log *slog.Logger, controller controllers.Controller, cfg *config.AppConfig) *App

func (*App) Run

func (a *App) Run() (err error)

type AuthHmac

type AuthHmac struct {
	// contains filtered or unexported fields
}

func NewAuthHmacMiddleware

func NewAuthHmacMiddleware(log *slog.Logger, cfg HmacConfig) *AuthHmac

func (*AuthHmac) AuthHmacMiddleware

func (a *AuthHmac) AuthHmacMiddleware(next http.Handler) http.Handler

type HealthHandler

type HealthHandler struct {
	// contains filtered or unexported fields
}

func NewHealthHandler

func NewHealthHandler(log *slog.Logger) *HealthHandler

func (*HealthHandler) Get

func (h *HealthHandler) Get(w http.ResponseWriter, r *http.Request)

Get - The app Health

@Summary		This API is there to receive the health of this instance.
@Description	Returns the health of this instance.
@Tags			Health
@Produce		json
@Success		200	{object}	app.Response	"Healthy"
@Failure		500	{object}	app.Response	"Internal Server Error"
@Router			/healthz [get]

func (*HealthHandler) RegisterRoutes

func (h *HealthHandler) RegisterRoutes(r Router)

type HmacConfig

type HmacConfig interface {
	HmacSecret() string
	HmacEnabled() bool
}

type Response

type Response struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

func NewResponse

func NewResponse(status int, message string) *Response

func (*Response) ToJson

func (r *Response) ToJson() []byte

func (*Response) WriteResponse

func (r *Response) WriteResponse(w http.ResponseWriter)

type Router

type Router = chi.Router

type SwaggerHandler

type SwaggerHandler struct {
	// contains filtered or unexported fields
}

func NewSwaggerHandler

func NewSwaggerHandler(log *slog.Logger) *SwaggerHandler

func (*SwaggerHandler) Redirect

func (sh *SwaggerHandler) Redirect(w http.ResponseWriter, r *http.Request)

func (*SwaggerHandler) RegisterRoutes

func (sh *SwaggerHandler) RegisterRoutes(r Router)

type WebhookHandler

type WebhookHandler struct {
	// contains filtered or unexported fields
}

func NewWebhookHandler

func NewWebhookHandler(log *slog.Logger, controller controllers.Controller) *WebhookHandler

func (*WebhookHandler) Post

func (wh *WebhookHandler) Post(w http.ResponseWriter, r *http.Request)

Post - Receives the GitHub webhooks

@Summary		This API is there to receive the GitHub events.
@Description	Once received, this will add them to the event stream for consumers.
@Tags			Webhooks
@Accept			json
@Produce		json
@Success		202	{object} Response	"Successful Response"
@Failure		    401	{object} Response	"Unauthorized"
@Failure		  400	{object} Response		"Bad Request"
@Router			/api/v1/webhook/github [post]

func (*WebhookHandler) RegisterRoutes

func (wh *WebhookHandler) RegisterRoutes(r Router, hmac *AuthHmac)