models

Documentation

Index

• func GroupName(g string) uuid.UUID
• func GroupSuperAdmin() uuid.UUID
• func GroupTitle(g uuid.UUID) string
• type GroupMembership
  • func (gm *GroupMembership) BeforeAppendModel(_ context.Context, query bun.Query) error
• type User
  • func (u *User) BeforeAppendModel(_ context.Context, query bun.Query) error
  • func (u *User) CheckPasswordHash(password string) bool
  • func (u *User) InGroup(g ...uuid.UUID) bool
  • func (u *User) SetPassword(password string) error

Functions

func GroupName

func GroupName(g string) uuid.UUID

GroupName return a uuid for the group name

func GroupSuperAdmin

func GroupSuperAdmin() uuid.UUID

GroupSuperAdmin returns the uuid for the Super Admin

func GroupTitle

func GroupTitle(g uuid.UUID) string

GroupTitle return a pretty text name for the group

Types

type GroupMembership

type GroupMembership struct {
	ID        string    `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"`
	CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`
	UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`
	UserID    string    `validate:"required,ulid" bun:"type:CHAR(26),unique:groupmembership,notnull,nullzero"`
	User      *User     `validate:"-" bun:"rel:belongs-to,join:user_id=id"`
	GroupID   uuid.UUID `validate:"required" bun:",unique:groupmembership,notnull,nullzero"`
}

GroupMembership represents a user's membership in a group

func (*GroupMembership) BeforeAppendModel

func (gm *GroupMembership) BeforeAppendModel(_ context.Context, query bun.Query) error

BeforeAppendModel runs before a bun append operation

type User

type User struct {
	ID                string             `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"`
	CreatedAt         time.Time          `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`
	UpdatedAt         time.Time          `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"`
	Email             string             `validate:"-" bun:",nullzero,notnull,unique"`
	EncryptedPassword string             `validate:"-" bun:""`
	SignInCount       int                `validate:"min=0" bun:",notnull,default:0"`
	Groups            []*GroupMembership `validate:"-" bun:"rel:has-many,join:id=user_id"`
	Disabled          bool               `validate:"-" bun:",notnull,default:false"`
}

User represents a human user.

func (*User) BeforeAppendModel

func (u *User) BeforeAppendModel(_ context.Context, query bun.Query) error

BeforeAppendModel runs before a bun append operation

func (*User) CheckPasswordHash

func (u *User) CheckPasswordHash(password string) bool

CheckPasswordHash is used to validate that a given password matches the stored hash

func (*User) InGroup

func (u *User) InGroup(g ...uuid.UUID) bool

InGroup returns true if user is member of group

func (*User) SetPassword

func (u *User) SetPassword(password string) error

SetPassword updates the user object's password hash