web

Documentation

Index

• Variables
• type Country
• type InitialState
  • func NewInitialState(cnf *config.Config, client *model.Client, user *model.User, ...) *InitialState
• type Profile
  • func NewProfile(user *model.User, usergroups []*models.UserUserGroupPrivateResponse, ...) *Profile
• type Service
  • func NewService(cnf *config.Config, oauthService oauth.ServiceInterface, ...) *Service
  • func (s *Service) Close()
  • func (s *Service) GetConfig() *config.Config
  • func (s *Service) GetOauthService() oauth.ServiceInterface
  • func (s *Service) GetRoutes() []routes.Route
  • func (s *Service) GetSessionService() session.ServiceInterface
  • func (s *Service) RegisterRoutes(router *mux.Router, prefix string)
• type ServiceInterface

Variables

var (
	// ErrSessionServiceNotPresent ...
	ErrSessionServiceNotPresent = errors.New("Session service not present in the request context")
	// ErrClientNotPresent ...
	ErrClientNotPresent = errors.New("Client not present in the request context")
)

var (
	ErrPasswordMismatch = errors.New("Password confirmation mismatch")
	ErrInvalidPassword  = errors.New("Invalid password")
)

var (
	// ErrEmailInvalid
	ErrEmailInvalid = errors.New("Not a valid email")
)

var ErrIncorrectResponseType = errors.New("Response type not one of token or code")

ErrIncorrectResponseType a form value for response_type was not set to token or code

var (
	ErrTokenMissing = errors.New("Email confirmation token is missing")
)

Types

type Country

type Country struct {
	Name string `json:"name"`
	Code string `json:"code"`
}

type InitialState

type InitialState struct {
	ApplicationName string                `json:"applicationName"`
	ClientID        string                `json:"clientID"`
	UserGroup       string                `json:"usergroup"`
	Token           string                `json:"token"`
	Clients         []config.ClientConfig `json:"clients"`
	Profile         *Profile              `json:"profile"`
	CSRFToken       string                `json:"csrfToken"`
	CountryList     []Country             `json:"countries"`
}

func NewInitialState

func NewInitialState(
	cnf *config.Config,
	client *model.Client,
	user *model.User,
	userSession *session.UserSession,
	isUserAccountComplete bool,
	usergroups []*models.UserUserGroupPrivateResponse,
	csrfToken string,
	countryList []Country,
) *InitialState

type Profile

type Profile struct {
	ID          string `json:"id"`
	Role        string `json:"role"`
	DisplayName string `json:"displayName"`
	Email       string `json:"email"`
	// FullName               string                                 `json:"fullName"`
	// FirstName              string                                 `json:"firstName"`
	// LastName               string                                 `json:"lastName"`
	Country                string                                 `json:"country"`
	NewsletterNotification bool                                   `json:"newsletterNotification"`
	EmailConfirmed         bool                                   `json:"emailConfirmed"`
	Member                 bool                                   `json:"member"`
	Complete               bool                                   `json:"complete"`
	Usergroups             []*models.UserUserGroupPrivateResponse `json:"usergroups"`
}

Profile user public profile

func NewProfile

func NewProfile(
	user *model.User,
	usergroups []*models.UserUserGroupPrivateResponse,
	isUserAccountComplete bool,
	role string,
) *Profile

NewProfile

type Service

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

Service struct keeps variables for reuse

func NewService

func NewService(cnf *config.Config, oauthService oauth.ServiceInterface, sessionService session.ServiceInterface) *Service

NewService returns a new Service instance

func (*Service) Close

func (s *Service) Close()

Close stops any running services

func (*Service) GetConfig

func (s *Service) GetConfig() *config.Config

GetConfig returns config.Config instance

func (*Service) GetOauthService

func (s *Service) GetOauthService() oauth.ServiceInterface

GetOauthService returns oauth.Service instance

func (*Service) GetRoutes

func (s *Service) GetRoutes() []routes.Route

GetRoutes returns []routes.Route slice for the health service

func (*Service) GetSessionService

func (s *Service) GetSessionService() session.ServiceInterface

GetSessionService returns session.Service instance

func (*Service) RegisterRoutes

func (s *Service) RegisterRoutes(router *mux.Router, prefix string)

RegisterRoutes registers route handlers for the health service

type ServiceInterface

type ServiceInterface interface {
	// Exported methods
	GetConfig() *config.Config
	GetOauthService() oauth.ServiceInterface
	GetSessionService() session.ServiceInterface
	GetRoutes() []routes.Route
	RegisterRoutes(router *mux.Router, prefix string)
	Close()
	// contains filtered or unexported methods
}

ServiceInterface defines exported methods