common

Documentation

Index

• Constants
• Variables
• func CustomErrorHandler(ctx *fiber.Ctx, err error) error
• func GenerateErrorDetails(validationErrors []ValidationError) string
• func NormalizeEmail(email *string) *string
• func ValidateRequestEntity(ctx *fiber.Ctx, request interface{}, errorMessage string) error
• type Base64Key
  • func (k *Base64Key) UnmarshalText(text []byte) error
• type CodeHosting
• type Environment
  • func (e *Environment) IsTest() bool
• type Log
• type ProblemJSONError
  • func Error(status int, title string, detail string) ProblemJSONError
  • func ErrorWithValidationErrors(status int, title string, validationErrors []ValidationError) ProblemJSONError
  • func InternalServerError(title string) ProblemJSONError
  • func (pj ProblemJSONError) Error() string
• type PublisherPatch
• type PublisherPost
• type Response
  • func NewResponse(data any) *Response
• type SoftwarePatch
• type SoftwarePost
• type ValidationError
  • func ValidateStruct(validateStruct interface{}) []ValidationError
• type Webhook

Constants

const (
	SymmetricKeyLen = 32

	EventTypeCreate = "create"
	EventTypeUpdate = "update"
	EventTypeDelete = "delete"
)

Variables

var (
	ErrAuthentication  = errors.New("token authentication failed")
	ErrInvalidDateTime = errors.New("invalid date time format (RFC 3339 needed)")
	ErrKeyLen          = errors.New("PASETO_KEY must be 32 bytes long once base64-decoded")
)

Functions

func CustomErrorHandler

func CustomErrorHandler(ctx *fiber.Ctx, err error) error

func GenerateErrorDetails

func GenerateErrorDetails(validationErrors []ValidationError) string

func NormalizeEmail

func NormalizeEmail(email *string) *string

func ValidateRequestEntity

func ValidateRequestEntity(ctx *fiber.Ctx, request interface{}, errorMessage string) error

Types

type Base64Key

type Base64Key [SymmetricKeyLen]byte

func (*Base64Key) UnmarshalText

func (k *Base64Key) UnmarshalText(text []byte) error

type CodeHosting

type CodeHosting struct {
	URL   string `json:"url" validate:"required,url"`
	Group *bool  `json:"group"`
}

type Environment

type Environment struct {
	MaxRequests        int        `env:"MAX_REQUESTS" envDefault:"0"`
	CurrentEnvironment string     `env:"ENVIRONMENT" envDefault:"production"`
	Database           string     `env:"DATABASE_DSN"`
	PasetoKey          *Base64Key `env:"PASETO_KEY"`
}

var EnvironmentConfig Environment //nolint:gochecknoglobals

func (*Environment) IsTest

func (e *Environment) IsTest() bool

type Log

type Log struct {
	Message string `json:"message" validate:"required,gt=1"`
}

type ProblemJSONError

type ProblemJSONError struct {
	Code             string            `json:"code,omitempty"`
	Title            string            `json:"title"`
	Detail           string            `json:"detail,omitempty"`
	Status           int               `json:"status"`
	ValidationErrors []ValidationError `json:"validationErrors,omitempty"`
}

func Error

func Error(status int, title string, detail string) ProblemJSONError

func ErrorWithValidationErrors

func ErrorWithValidationErrors(
	status int, title string, validationErrors []ValidationError,
) ProblemJSONError

func InternalServerError

func InternalServerError(title string) ProblemJSONError

func (ProblemJSONError) Error

func (pj ProblemJSONError) Error() string

type PublisherPatch

type PublisherPatch struct {
	CodeHosting   *[]CodeHosting `json:"codeHosting" validate:"omitempty,gt=0,dive"`
	Description   *string        `json:"description"`
	Email         *string        `json:"email" validate:"omitempty,email"`
	Active        *bool          `json:"active"`
	AlternativeID *string        `json:"alternativeId" validate:"omitempty,max=255"`
}

type PublisherPost

type PublisherPost struct {
	CodeHosting   []CodeHosting `json:"codeHosting" validate:"required,gt=0,dive"`
	Description   string        `json:"description" validate:"required"`
	Email         *string       `json:"email" validate:"omitempty,email"`
	Active        *bool         `json:"active"`
	AlternativeID *string       `json:"alternativeId" validate:"omitempty,min=1,max=255"`
}

type Response

type Response struct {
	Data any `json:"data,omitempty"`
}

func NewResponse

func NewResponse(data any) *Response

type SoftwarePatch

type SoftwarePatch struct {
	URL           *string   `json:"url" validate:"omitempty,url"`
	Aliases       *[]string `json:"aliases" validate:"omitempty,dive,url"`
	PubliccodeYml *string   `json:"publiccodeYml"`
	Active        *bool     `json:"active"`
}

type SoftwarePost

type SoftwarePost struct {
	URL           string   `json:"url" validate:"required,url"`
	Aliases       []string `json:"aliases" validate:"dive,url"`
	PubliccodeYml string   `json:"publiccodeYml" validate:"required"`
	Active        *bool    `json:"active"`
}

type ValidationError

type ValidationError struct {
	Field string `json:"field"`
	Rule  string `json:"rule"`
	Value string `json:"value"`
}

func ValidateStruct

func ValidateStruct(validateStruct interface{}) []ValidationError

type Webhook

type Webhook struct {
	URL    string `json:"url" validate:"required,url"`
	Secret string `json:"secret"`
}