api

type Application ¶

type Application struct {
	ApplicationName string
	ApplicationHome string
	PrivatePort     int
	PublicPort      int
	CustomTaskTypes []entity.TaskConstructor
	CustomTargets   []entity.TargetConstructor
	LogLevel        LogLevel
	Hub             Hub
	PublicHandler   *requesthandler.RequestHandler
	PrivateHandler  *requesthandler.RequestHandler
	Logger          *zerolog.Logger
}

func NewApplication(applicationName string, opts ...Option) *Application

func (a *Application) Start() error

func (a *Application) Stop() error

type Hub ¶

type Hub interface {
	HandleRequest(r *http.Request) (entity.ServiceResponse, error)
	SetLogger(l *zerolog.Logger)
	GetLogger() *zerolog.Logger
	GetServices() map[string]*entity.Service
}

type LogLevel ¶

type LogLevel int

const (
	// Define log levels as constants
	DebugLevel LogLevel = iota
	InfoLevel
	WarnLevel
	ErrorLevel
	FatalLevel
	PanicLevel
)

func (l LogLevel) ToZeroLogLevel() zerolog.Level

type Option ¶

type Option func(*Application)

func WithApplicationHome(home string) Option

func WithCustomTargets(targets ...entity.TargetConstructor) Option

func WithCustomTasks(targets ...entity.TaskConstructor) Option

func WithLogLevel(level LogLevel) Option

func WithPrivatePort(port int) Option

func WithPublicPort(port int) Option

type RegisteredTargets ¶

type RegisteredTargets map[string]TargetConstructor

RegisteredTargets allows us to register targets at start-up

type ServiceRequest ¶

type ServiceRequest entity.ServiceRequest

type ServiceResponse ¶

type ServiceResponse entity.ServiceResponse

type Target ¶

type Target interface {
	Apply(ctx context.Context, request ServiceRequest) (ServiceResponse, error)
}

We duplicate the Target interface from the entity package to allow for the evolution of the API without breaking changes.

type TargetAdapter ¶

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

TargetAdapter wraps an api.Target and implements entity.Target

func NewTargetAdapter(target Target) *TargetAdapter

func (a *TargetAdapter) Apply(ctx context.Context, request entity.ServiceRequest) (entity.ServiceResponse, error)

type TargetConstructor ¶

type TargetConstructor interface {
	New(config map[string]any) (Target, error)
}

TargetConstructor takes a config object and returns a configured Target instance.

type TargetConstructorFunc ¶

type TargetConstructorFunc func(config map[string]any) (Target, error)

TaskConstructorFunc is a function type that implements TaskConstructor

func TargetConstructorFromFunction(
	fn func(map[string]interface{}) (Target, error),
) TargetConstructorFunc

func (f TargetConstructorFunc) New(config map[string]any) (Target, error)

type Task ¶

type Task interface {
	Name() string
	Apply(ctx context.Context, request ServiceRequest) error
}

We duplicate the Task interface from the entity package to allow for the evolution of the API without breaking changes.

type TaskAdapter ¶

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

TaskAdapter wraps an api.Task and implements entity.Task

func NewTaskAdapter(task Task) *TaskAdapter

func (a *TaskAdapter) Apply(ctx context.Context, request entity.ServiceRequest) error

func (a *TaskAdapter) Name() string

type TaskConstructor ¶

type TaskConstructor interface {
	New(config map[string]any) (Task, error)
}

type TaskConstructorFunc ¶

type TaskConstructorFunc func(config map[string]any) (Task, error)

TaskConstructorFunc is a function type that implements TaskConstructor

func TaskConstructorFromFunction(
	fn func(map[string]interface{}) (Task, error),
) TaskConstructorFunc

func (f TaskConstructorFunc) New(config map[string]any) (Task, error)