users

Documentation

Index

• Variables
• type Config
• type Service
  • func NewService(db *sql.DB, cfg *Config) *Service
  • func (s *Service) Create(ctx context.Context, username string, password []byte) (*User, error)
  • func (s *Service) GetByID(ctx context.Context, id string) (*User, error)
  • func (s *Service) GetByUsername(ctx context.Context, username string) (*User, error)
• type User
  • func (u *User) ValidatePassword(password []byte) error

Variables

var (
	ErrNotFound      = fmt.Errorf("user does not exist")
	ErrAlreadyExists = fmt.Errorf("user already exists")
)

Known errors.

var (
	ErrInvalidPassword = fmt.Errorf("invalid password")
	ErrUsernameEmpty   = fmt.Errorf("username is empty")
	ErrPasswordEmpty   = fmt.Errorf("password is empty")
)

Known errors.

Types

type Config

type Config struct {
	BCryptCost int `yaml:"bcrypt_cost"`
}

Config contains users configuration.

type Service

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

Service allows to manage users resource.

func NewService

func NewService(db *sql.DB, cfg *Config) *Service

NewService returns new users service.

func (*Service) Create

func (s *Service) Create(ctx context.Context, username string, password []byte) (*User, error)

Create creates a new user with the given password.

func (*Service) GetByID

func (s *Service) GetByID(ctx context.Context, id string) (*User, error)

GetByID returns a user by id.

func (*Service) GetByUsername

func (s *Service) GetByUsername(ctx context.Context, username string) (*User, error)

GetByUsername returns a user by id.

type User

type User struct {
	ID       string    `json:"id"`
	Username string    `json:"username"`
	Hash     []byte    `json:"-"`
	Created  time.Time `json:"-"`
}

User is the user model.

func (*User) ValidatePassword

func (u *User) ValidatePassword(password []byte) error

ValidatePassword returns nil if a given password is valid.