models

Documentation

Index

• Variables
• func DeleteToken(ctx context.Context, tokenID uuid.UUID, dbtx db.DBTX) error
• func UpdateUserPassword(ctx context.Context, data UpdateUserPasswordPayload, ...) error
• type MakeUserAdminPayload
• type MetaInformation
• type NewTokenPayload
• type NewUserPayload
• type Resource
• type Scope
• type Token
  • func GetToken(ctx context.Context, token string, dbtx db.DBTX) (Token, error)
  • func NewToken(ctx context.Context, data NewTokenPayload, dbtx db.DBTX) (Token, error)
  • func (te Token) IsValid() bool
• type UpdateUserPasswordPayload
• type UpdateUserPayload
• type UserEntity
  • func GetUser(ctx context.Context, id uuid.UUID, dbtx db.DBTX) (UserEntity, error)
  • func GetUserByEmail(ctx context.Context, email string, dbtx db.DBTX) (UserEntity, error)
  • func MakeUserAdmin(ctx context.Context, data MakeUserAdminPayload, dbtx db.DBTX) (UserEntity, error)
  • func NewUser(ctx context.Context, data NewUserPayload, dbtx db.DBTX, ...) (UserEntity, error)
  • func UpdateUser(ctx context.Context, data UpdateUserPayload, dbtx db.DBTX) (UserEntity, error)
  • func (ue UserEntity) IsVerified() bool

Variables

var (
	ErrDomainValidation = errors.New("the provided payload failed validations")
	ErrMustBeAdmin      = errors.New(
		"this action requires the actor to be an admin",
	)
)

Functions

func DeleteToken

func DeleteToken(
	ctx context.Context,
	tokenID uuid.UUID,
	dbtx db.DBTX,
) error

func UpdateUserPassword

func UpdateUserPassword(
	ctx context.Context,
	data UpdateUserPasswordPayload,
	q func(
		ctx context.Context,
		userID uuid.UUID,
		newPassword string,
		updatedAt time.Time,
	) error,
) error

Types

type MakeUserAdminPayload

type MakeUserAdminPayload struct {
	UserID    uuid.UUID `validate:"required,uuid"`
	UpdatedAt time.Time `validate:"required"`
	ActorID   uuid.UUID `validate:"required,uuid"`
}

type MetaInformation

type MetaInformation struct {
	Resource   Resource  `validate:"required"`
	ResourceID uuid.UUID `validate:"required,uuid"`
	Scope      Scope     `validate:"required"`
}

type NewTokenPayload

type NewTokenPayload struct {
	Expiration time.Time       `validate:"required"`
	Meta       MetaInformation `validate:"required"`
}

type NewUserPayload

type NewUserPayload struct {
	Email           string `validate:"required,email"`
	Password        string `validate:"required,gte=6"`
	ConfirmPassword string `validate:"required,gte=6"`
}

type Resource

type Resource string

var (
	ResourceUser       Resource = "users"
	ResourceSubscriber Resource = "subscribers"
)

type Scope

type Scope string

var (
	ScopeEmailVerification Scope = "email_verification"
	ScopeUnsubscribe       Scope = "unsubscribe"
	ScopeResetPassword     Scope = "password_reset"
)

type Token

type Token struct {
	ID         uuid.UUID
	CreatedAt  time.Time
	Expiration time.Time
	Hash       string
	Plain      string
	Meta       MetaInformation
}

func GetToken

func GetToken(
	ctx context.Context,
	token string,
	dbtx db.DBTX,
) (Token, error)

func NewToken

func NewToken(
	ctx context.Context,
	data NewTokenPayload,
	dbtx db.DBTX,
) (Token, error)

func (Token) IsValid

func (te Token) IsValid() bool

type UpdateUserPasswordPayload

type UpdateUserPasswordPayload struct {
	ID        uuid.UUID `validate:"required,uuid"`
	UpdatedAt time.Time `validate:"required"`
	Password  string    `validate:"required"`
}

type UpdateUserPayload

type UpdateUserPayload struct {
	ID             uuid.UUID `validate:"required,uuid"`
	UpdatedAt      time.Time `validate:"required"`
	Name           string    `validate:"required,gte=2,lte=25"`
	Email          string    `validate:"required,email"`
	EmailUpdatedAt time.Time
}

type UserEntity

type UserEntity struct {
	ID              uuid.UUID
	CreatedAt       time.Time
	UpdatedAt       time.Time
	Email           string
	EmailVerifiedAt time.Time
	IsAdmin         bool
}

func GetUser

func GetUser(
	ctx context.Context,
	id uuid.UUID,
	dbtx db.DBTX,
) (UserEntity, error)

func GetUserByEmail

func GetUserByEmail(
	ctx context.Context,
	email string,
	dbtx db.DBTX,
) (UserEntity, error)

func MakeUserAdmin

func MakeUserAdmin(
	ctx context.Context,
	data MakeUserAdminPayload,
	dbtx db.DBTX,
) (UserEntity, error)

func NewUser

func NewUser(
	ctx context.Context,
	data NewUserPayload,
	dbtx db.DBTX,
	hash func(password string) (string, error),
) (UserEntity, error)

func UpdateUser

func UpdateUser(
	ctx context.Context,
	data UpdateUserPayload,
	dbtx db.DBTX,
) (UserEntity, error)

func (UserEntity) IsVerified

func (ue UserEntity) IsVerified() bool