Documentation
¶
Overview ¶
Package user provides an example of a core business API. Right now these calls are just wrapping the data/data layer. But at some point you will want auditing or something that isn't specific to the data/store layer.
Index ¶
- Constants
- Variables
- type Core
- func (c *Core) Authenticate(ctx context.Context, email mail.Address, password string) (User, error)
- func (c *Core) Count(ctx context.Context, filter QueryFilter) (int, error)
- func (c *Core) Create(ctx context.Context, nu NewUser) (User, error)
- func (c *Core) Delete(ctx context.Context, usr User) error
- func (c *Core) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, ...) ([]User, error)
- func (c *Core) QueryByEmail(ctx context.Context, email mail.Address) (User, error)
- func (c *Core) QueryByID(ctx context.Context, userID uuid.UUID) (User, error)
- func (c *Core) QueryByIDs(ctx context.Context, userIDs []uuid.UUID) ([]User, error)
- func (c *Core) Update(ctx context.Context, usr User, uu UpdateUser) (User, error)
- type NewUser
- type QueryFilter
- func (qf *QueryFilter) Validate() error
- func (qf *QueryFilter) WithEmail(email mail.Address)
- func (qf *QueryFilter) WithEndCreatedDate(endDate time.Time)
- func (qf *QueryFilter) WithName(name string)
- func (qf *QueryFilter) WithStartCreatedDate(startDate time.Time)
- func (qf *QueryFilter) WithUserID(userID uuid.UUID)
- type Role
- type Store
- type UpdateUser
- type User
Constants ¶
const ( OrderByID = "userid" OrderByName = "name" OrderByEmail = "email" OrderByRoles = "roles" OrderByEnabled = "enabled" )
Set of fields that the results can be ordered by. These are the names that should be used by the application layer.
Variables ¶
var ( RoleAdmin = Role{"ADMIN"} RoleUser = Role{"USER"} )
var ( ErrNotFound = errors.New("user not found") ErrUniqueEmail = errors.New("email is not unique") ErrAuthenticationFailure = errors.New("authentication failed") )
Set of error variables for CRUD operations.
DefaultOrderBy repesents the default way we sort.
Functions ¶
This section is empty.
Types ¶
type Core ¶
type Core struct {
// contains filtered or unexported fields
}
Core manages the set of APIs for user access.
func (*Core) Authenticate ¶
Authenticate finds a user by their email and verifies their password. On success it returns a Claims User representing the user. The claims can be used to generate a token fort future authentication.
func (*Core) Query ¶
func (c *Core) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]User, error)
Query retrieves a list of existing users from the database.
func (*Core) QueryByEmail ¶
QueryByEmail gets the specified user from the database by email.
func (*Core) QueryByIDs ¶
QueryByIDs gets the specified users from the database.
type NewUser ¶
type NewUser struct {
Name string
Email mail.Address
Roles []Role
Department string
Password string
PasswordConfirm string
}
NewUser contains information needed to create a new user.
type QueryFilter ¶
type QueryFilter struct {
ID *uuid.UUID `validate:"omitempty"`
Name *string `validate:"omitempty,min=3"`
Email *mail.Address `validate:"omitempty"`
StartCreatedDate *time.Time `validate:"omitempty"`
EndCreatedDate *time.Time `validate:"omitempty"`
}
QueryFilter holds the available fields a query can be filtered on.
func (*QueryFilter) Validate ¶
func (qf *QueryFilter) Validate() error
Validate checks the data in the model is considered clean.
func (*QueryFilter) WithEmail ¶
func (qf *QueryFilter) WithEmail(email mail.Address)
WithEmail sets the Email field of the QueryFilter value.
func (*QueryFilter) WithEndCreatedDate ¶
func (qf *QueryFilter) WithEndCreatedDate(endDate time.Time)
WithEndCreatedDate sets the EndCreatedDate field of the QueryFilter value.
func (*QueryFilter) WithName ¶
func (qf *QueryFilter) WithName(name string)
WithName sets the Name field of the QueryFilter value.
func (*QueryFilter) WithStartCreatedDate ¶
func (qf *QueryFilter) WithStartCreatedDate(startDate time.Time)
WithStartCreatedDate sets the StartCreatedDate field of the QueryFilter value.
func (*QueryFilter) WithUserID ¶
func (qf *QueryFilter) WithUserID(userID uuid.UUID)
WithUserID sets the ID field of the QueryFilter value.
type Role ¶
type Role struct {
// contains filtered or unexported fields
}
Role represents a role in the system.
func MustParseRole ¶
MustParseRole parses the string value and returns a role if one exists. If an error occurs the function panics.
func (Role) MarshalText ¶
MarshalText implements the marshal interface for JSON conversions.
func (*Role) UnmarshalText ¶
UnmarshalText implements the unmarshal interface for JSON conversions.
type Store ¶
type Store interface {
Create(ctx context.Context, usr User) error
Update(ctx context.Context, usr User) error
Delete(ctx context.Context, usr User) error
Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]User, error)
Count(ctx context.Context, filter QueryFilter) (int, error)
QueryByID(ctx context.Context, userID uuid.UUID) (User, error)
QueryByIDs(ctx context.Context, userIDs []uuid.UUID) ([]User, error)
QueryByEmail(ctx context.Context, email mail.Address) (User, error)
}
Store inteface declares the behavior this package needs to persist and retrieve data.
Source Files
Directories