tracking

Documentation

Overview

Package tracking manages a ticket tracker server.

Index

• type Pagination
• type SortBy
• type TS
  • func New(ticketServerStorage storage.TicketServerStorage, ...) (*TS, error)
  • func (ts *TS) ProjectConfigByTeamID(teamID string) (model.ProjectConfig, error)
  • func (ts *TS) ServerConf(serverID string) (model.TrackerConfig, error)
• type TTBuilder
  • func (ttb *TTBuilder) GenerateTicketTrackerClient(ticketServer TicketServer, teamID string, logger echo.Logger) (TicketTracker, error)
• type TicketServer
• type TicketTracker
• type TicketTrackerBuilder

Types

type Pagination

type Pagination struct {
	Limit  int `json:"limit"`
	Offset int `json:"offset"`
	Total  int `json:"total"`
}

Pagination holds database pagination information.

type SortBy

type SortBy struct {
	Field string
	Order string
}

SortBy holds information for the query sorting criteria.

type TS

type TS struct {
	Logger echo.Logger
	// contains filtered or unexported fields
}

TS represents a service that manages the access to a ticket tracker server.

func New

func New(ticketServerStorage storage.TicketServerStorage, secretsService secrets.Secrets, logger echo.Logger) (*TS, error)

New creates a new instance to red the configuration from a toml file.

func (*TS) ProjectConfigByTeamID

func (ts *TS) ProjectConfigByTeamID(teamID string) (model.ProjectConfig, error)

ProjectConfigByTeamID retrieves all the needed configuration to access a ticket tracker project for a specific team.

func (*TS) ServerConf

func (ts *TS) ServerConf(serverID string) (model.TrackerConfig, error)

ServerConf retrieves all the needed configuration to access a ticket tracker server.

type TTBuilder

type TTBuilder struct {
}

TTBuilder represents a builder of clients to access ticket trackers.

func (*TTBuilder) GenerateTicketTrackerClient

func (ttb *TTBuilder) GenerateTicketTrackerClient(ticketServer TicketServer, teamID string, logger echo.Logger) (TicketTracker, error)

GenerateTicketTrackerClient generates a ticket tracker client.

type TicketServer

type TicketServer interface {
	ServerConf(serverID string) (model.TrackerConfig, error)
	ProjectConfigByTeamID(teamID string) (model.ProjectConfig, error)
}

TicketServer manages the access to a ticket tracker server.

type TicketTracker

type TicketTracker interface {
	GetTicket(id string) (model.Ticket, error)
	CreateTicket(ticket model.Ticket) (model.Ticket, error)
}

TicketTracker defines the interface for high level querying data from ticket tracker.

type TicketTrackerBuilder

type TicketTrackerBuilder interface {
	GenerateTicketTrackerClient(ticketServer TicketServer, teamID string, logger echo.Logger) (TicketTracker, error)
}

TicketTrackerBuilder builds clients to access ticket trackers.