users

Documentation

Index

• func CheckHash(password, hash string) bool
• func Samples() error
• func SetDB(database database.Database)
• type User
  • func All() []*User
  • func AuthUser(username, password string) (*User, bool)
  • func Find(id int64) (*User, error)
  • func FindByUsername(username string) (*User, error)
  • func (u *User) BeforeCreate() error
  • func (u *User) Create() error
  • func (u *User) Delete() error
  • func (u *User) Update() error

Functions

func CheckHash

func CheckHash(password, hash string) bool

CheckHash returns true if the password matches with a hashed bcrypt password

func Samples

func Samples() error

func SetDB

func SetDB(database database.Database)

Types

type User

type User struct {
	Id        int64         `gorm:"primary_key;column:id" json:"id"`
	Username  string        `gorm:"type:varchar(100);unique;column:username;" json:"username,omitempty"`
	Password  string        `gorm:"column:password" json:"password,omitempty"`
	Email     string        `gorm:"type:varchar(100);column:email" json:"email,omitempty"`
	ApiKey    string        `gorm:"column:api_key" json:"api_key,omitempty"`
	ApiSecret string        `gorm:"column:api_secret" json:"api_secret,omitempty"`
	Admin     null.NullBool `gorm:"column:administrator" json:"admin,omitempty"`
	CreatedAt time.Time     `gorm:"column:created_at" json:"created_at"`
	UpdatedAt time.Time     `gorm:"column:updated_at" json:"updated_at"`
}

User is the main struct for Users

func All

func All() []*User

func AuthUser

func AuthUser(username, password string) (*User, bool)

AuthUser will return the User and a boolean if authentication was correct. AuthUser accepts username, and password as a string

func Find

func Find(id int64) (*User, error)

func FindByUsername

func FindByUsername(username string) (*User, error)

func (*User) BeforeCreate

func (u *User) BeforeCreate() error

func (*User) Create

func (u *User) Create() error

func (*User) Delete

func (u *User) Delete() error

func (*User) Update

func (u *User) Update() error