models

Documentation

Index

• Variables
• func CreateUser(d mongo.Database, u *User) (err error)
• func IsErrNameCharsNotAllowed(err error) bool
• func IsErrNamePatternNotAllowed(err error) bool
• func IsErrNameReserved(err error) bool
• func IsErrUserAlreadyExist(err error) bool
• func IsUsableUsername(name string) error
• type ErrNameCharsNotAllowed
  • func (err ErrNameCharsNotAllowed) Error() string
• type ErrNamePatternNotAllowed
  • func (err ErrNamePatternNotAllowed) Error() string
• type ErrNameReserved
  • func (err ErrNameReserved) Error() string
• type ErrUserAlreadyExist
  • func (err ErrUserAlreadyExist) Error() string
• type User
  • func (u *User) APIFormat() *api.User
  • func (u *User) FullName() string
  • func (u *User) HashPassword(passwd string)
  • func (u *User) SetLastLogin()
  • func (u *User) ValidatePassword(passwd string) bool
• type UserList
  • func GetUsers(d *mongo.Database) (UserList, error)

Variables

var (
	ErrNameEmpty = errors.New("Name is empty")
)

var (
	ErrUserNameIllegal = errors.New("User name contains illegal characters")
)

Functions

func CreateUser

func CreateUser(d mongo.Database, u *User) (err error)

CreateUser creates record of a new user.

func IsErrNameCharsNotAllowed

func IsErrNameCharsNotAllowed(err error) bool

IsErrNameCharsNotAllowed checks if an error is an ErrNameCharsNotAllowed.

func IsErrNamePatternNotAllowed

func IsErrNamePatternNotAllowed(err error) bool

func IsErrNameReserved

func IsErrNameReserved(err error) bool

IsErrNameReserved checks if an error is a ErrNameReserved.

func IsErrUserAlreadyExist

func IsErrUserAlreadyExist(err error) bool

IsErrUserAlreadyExist checks if an error is a ErrUserAlreadyExists.

func IsUsableUsername

func IsUsableUsername(name string) error

Types

type ErrNameCharsNotAllowed

type ErrNameCharsNotAllowed struct {
	Name string
}

func (ErrNameCharsNotAllowed) Error

func (err ErrNameCharsNotAllowed) Error() string

type ErrNamePatternNotAllowed

type ErrNamePatternNotAllowed struct {
	Pattern string
}

func (ErrNamePatternNotAllowed) Error

func (err ErrNamePatternNotAllowed) Error() string

type ErrNameReserved

type ErrNameReserved struct {
	Name string
}

func (ErrNameReserved) Error

func (err ErrNameReserved) Error() string

type ErrUserAlreadyExist

type ErrUserAlreadyExist struct {
	Name string
}

func (ErrUserAlreadyExist) Error

func (err ErrUserAlreadyExist) Error() string

type User

type User struct {
	ID        primitive.ObjectID `bson:"_id"`
	Username  string             `bson:"username"`
	Password  string             `bson:"password"`
	Email     string             `bson:"email"`
	FirstName string             `bson:"firstName"`
	LastName  string             `bson:"lastName"`
	LastLogin time.Time          `bson:"lastLogin"`
}

User represents a user in the database

func (*User) APIFormat

func (u *User) APIFormat() *api.User

func (*User) FullName

func (u *User) FullName() string

FullName returns the full name of the user

func (*User) HashPassword

func (u *User) HashPassword(passwd string)

func (*User) SetLastLogin

func (u *User) SetLastLogin()

func (*User) ValidatePassword

func (u *User) ValidatePassword(passwd string) bool

type UserList

type UserList []*User

func GetUsers

func GetUsers(d *mongo.Database) (UserList, error)