userbus

Documentation

Index

• Constants
• Variables
• type Business
  • func NewBusiness(log *logger.Logger, storer Storer) *Business
  • func (b *Business) Count(ctx context.Context, filter QueryFilter) (int, error)
  • func (b *Business) Create(ctx context.Context, nu NewUser) (User, error)
  • func (b *Business) Delete(ctx context.Context, usr User) error
  • func (b *Business) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, ...) ([]User, error)
  • func (b *Business) QueryByEmail(ctx context.Context, email mail.Address) (User, error)
  • func (b *Business) QueryByID(ctx context.Context, userID uuid.UUID) (User, error)
  • func (b *Business) Update(ctx context.Context, usr User, uu UpdateUser) (User, error)
• type Name
  • func (n Name) Equal(n2 Name) bool
  • func (n Name) MarshalText() ([]byte, error)
  • func (n Name) String() string
  • func (n *Name) UnmarshalText(data []byte) error
• type NewUser
  • func TestNewUsers(n int, role Role) []NewUser
• type QueryFilter
• type Role
  • func (r Role) Equal(r2 Role) bool
  • func (r Role) MarshalText() ([]byte, error)
  • func (r Role) String() string
  • func (r *Role) UnmarshalText(data []byte) error
• type Storer
• type UpdateUser
• type User
  • func TestSeedUsers(ctx context.Context, n int, role Role, api *Business) ([]User, error)

Constants

const (
	OrderByID      = "user_id"
	OrderByName    = "name"
	OrderByEmail   = "email"
	OrderByRoles   = "roles"
	OrderByEnabled = "enabled"
)

Set of fields that the results can be ordered by.

Variables

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.

var DefaultOrderBy = order.NewBy(OrderByID, order.ASC)

DefaultOrderBy represents the default way we sort.

var Names nameSet

var Roles = roleSet{
	Admin: newRole("ADMIN"),
	User:  newRole("USER"),
}

Roles represents the set of roles that can be used.

Types

type Business

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

Business manages the set of APIs for user access.

func NewBusiness

func NewBusiness(log *logger.Logger, storer Storer) *Business

NewBusiness constructs a user business API for use.

func (*Business) Count

func (b *Business) Count(ctx context.Context, filter QueryFilter) (int, error)

Count returns the total number of users.

func (*Business) Create

func (b *Business) Create(ctx context.Context, nu NewUser) (User, error)

Create adds a new user to the system.

func (*Business) Delete

func (b *Business) Delete(ctx context.Context, usr User) error

Delete removes the specified user.

func (*Business) Query

func (b *Business) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]User, error)

Query retrieves a list of existing users.

func (*Business) QueryByEmail

func (b *Business) QueryByEmail(ctx context.Context, email mail.Address) (User, error)

QueryByEmail finds the user by a specified user email.

func (*Business) QueryByID

func (b *Business) QueryByID(ctx context.Context, userID uuid.UUID) (User, error)

QueryByID finds the user by the specified Ib.

func (*Business) Update

func (b *Business) Update(ctx context.Context, usr User, uu UpdateUser) (User, error)

Update modifies information about a user.

type Name

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

Name represents a name in the system.

func (Name) Equal

func (n Name) Equal(n2 Name) bool

Equal provides support for the go-cmp package and testing.

func (Name) MarshalText

func (n Name) MarshalText() ([]byte, error)

MarshalText implement the marshal interface for JSON conversions.

func (Name) String

func (n Name) String() string

String returns the value of the name.

func (*Name) UnmarshalText

func (n *Name) UnmarshalText(data []byte) error

UnmarshalText implement the unmarshal interface for JSON conversions.

type NewUser

type NewUser struct {
	Name     Name
	Email    mail.Address
	Roles    []Role
	Guild    string
	Password string
}

NewUser contains information needed to create a new user.

func TestNewUsers

func TestNewUsers(n int, role Role) []NewUser

TestNewUsers is a helper method for testing.

type QueryFilter

type QueryFilter struct {
	ID               *uuid.UUID
	Name             *Name
	Email            *mail.Address
	StartCreatedDate *time.Time
	EndCreatedDate   *time.Time
}

QueryFilter holds the available fields a query can be filtered on. We are using pointer semantics because the With API mutates the value.

type Role

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

Role represents a role in the system.

func (Role) Equal

func (r Role) Equal(r2 Role) bool

Equal provides support for the go-cmp package and testing.

func (Role) MarshalText

func (r Role) MarshalText() ([]byte, error)

MarshalText implement the marshal interface for JSON conversions.

func (Role) String

func (r Role) String() string

String returns the name of the role.

func (*Role) UnmarshalText

func (r *Role) UnmarshalText(data []byte) error

UnmarshalText implement the unmarshal interface for JSON conversions.

type Storer

type Storer 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)
	QueryByEmail(ctx context.Context, email mail.Address) (User, error)
}

Storer interface declares the behavior this package needs to perists and retrieve data.

type UpdateUser

type UpdateUser struct {
	Name     *Name
	Email    *mail.Address
	Roles    []Role
	Guild    *string
	Password *string
	Enabled  *bool
}

UpdateUser contains information needed to update a user.

type User

type User struct {
	ID           uuid.UUID
	Name         Name
	Email        mail.Address
	Roles        []Role
	PasswordHash []byte
	Guild        string
	Enabled      bool
	DateCreated  time.Time
	DateUpdated  time.Time
}

User represents information about an individual user.

func TestSeedUsers

func TestSeedUsers(ctx context.Context, n int, role Role, api *Business) ([]User, error)

TestSeedUsers is a helper method for testing.