user

Documentation

Index

• type CreateUserOpts
• type LoginInput
• type LoginResult
• type PgRepo
  • func NewPgRepo(pool *pgxpool.Pool) *PgRepo
  • func (r *PgRepo) FindByID(ctx context.Context, id uuid.UUID) (*User, error)
  • func (r *PgRepo) FindByUsername(ctx context.Context, username string) (*User, error)
  • func (r *PgRepo) Save(ctx context.Context, u *User) error
  • func (r *PgRepo) Update(ctx context.Context, u *User) error
  • func (r *PgRepo) VerifyPassword(ctx context.Context, username, password string) error
• type RegisterInput
• type Repo
• type Routes
  • func NewRoutes(repo Repo, jwtSecret string, validator *validate.Validate) *Routes
  • func (r *Routes) FindByID(c *fiber.Ctx) error
  • func (r *Routes) Login(c *fiber.Ctx) error
  • func (r *Routes) Register(c *fiber.Ctx) error
  • func (r *Routes) UpdatePassword(c *fiber.Ctx) error
• type UpdatePasswordInput
• type User
  • func CreateUser(opts CreateUserOpts) (User, error)
  • func (u *User) UpdateBio(bio string)
  • func (u *User) UpdateEmail(email string)
  • func (u *User) UpdatePassword(password string) error

Types

type CreateUserOpts

type CreateUserOpts struct {
	Username string `json:"username"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

type LoginInput

type LoginInput struct {
	Username string `json:"username" validate:"required,min=3,max=24"`
	Password string `json:"password" validate:"required,min=6"`
}

type LoginResult

type LoginResult struct {
	ID       uuid.UUID `json:"id"`
	Token    string    `json:"token"`
	Username string    `json:"username"`
	Exp      int64     `json:"exp"`
}

type PgRepo

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

func NewPgRepo

func NewPgRepo(pool *pgxpool.Pool) *PgRepo

func (*PgRepo) FindByID

func (r *PgRepo) FindByID(ctx context.Context, id uuid.UUID) (*User, error)

func (*PgRepo) FindByUsername

func (r *PgRepo) FindByUsername(ctx context.Context, username string) (*User, error)

func (*PgRepo) Save

func (r *PgRepo) Save(ctx context.Context, u *User) error

func (*PgRepo) Update

func (r *PgRepo) Update(ctx context.Context, u *User) error

func (*PgRepo) VerifyPassword

func (r *PgRepo) VerifyPassword(ctx context.Context, username, password string) error

VerifyPassword returns nil on success TODO: This looks unneccessary or should return user too

type RegisterInput

type RegisterInput struct {
	Username string `json:"username" validate:"required,min=3,max=24"`
	Email    string `json:"email" validate:"required,email"`
	Password string `json:"password" validate:"required,min=6"`
}

type Repo

type Repo interface {
	Save(ctx context.Context, u *User) error
	FindByID(ctx context.Context, id uuid.UUID) (*User, error)
	FindByUsername(ctx context.Context, username string) (*User, error)
	VerifyPassword(ctx context.Context, username, password string) error // IDK
	Update(ctx context.Context, u *User) error
}

type Routes

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

func NewRoutes

func NewRoutes(repo Repo, jwtSecret string, validator *validate.Validate) *Routes

func (*Routes) FindByID

func (r *Routes) FindByID(c *fiber.Ctx) error

FindByID

@ID			User-FindByID
@Summary	Find User By ID
@Tags		users
@Accept		json
@Produce	json
@Param		id	path		string	true	"User ID"
@Success	200	{object}	User
@Failure	400
@Failure	500
@Router		/users/{id} [get]

func (*Routes) Login

func (r *Routes) Login(c *fiber.Ctx) error

Login

@ID			User-Login
@Summary	Login With Credentials
@Tags		users
@Accept		json
@Produce	json
@Param		credentials	body	LoginInput	true	"User Credentials"
@Success	200
@Failure	400
@Failure	500
@Router		/users/login [post]

func (*Routes) Register

func (r *Routes) Register(c *fiber.Ctx) error

Register

@ID			User-Register
@Summary	Register New User
@Tags		users
@Accept		json
@Produce	json
@Param		options	body	RegisterInput	true	"New User Info"
@Success	201
@Failure	400
@Failure	500
@Router		/users/register [post]

func (*Routes) UpdatePassword

func (r *Routes) UpdatePassword(c *fiber.Ctx) error

UpdatePassword

@ID			User-Update-Password
@Summary	Upate Password
@Tags		users
@Security	BearerAuth
@Accept		json
@Produce	json
@Param		credentials	body		UpdatePasswordInput	true	"User Credentials and New Password"
@Success	200			{object}	User
@Failure	400
@Failure	500
@Router		/users/update-password [patch]

type UpdatePasswordInput

type UpdatePasswordInput struct {
	Password    string `json:"password" validate:"required"`
	NewPassword string `json:"new_password" validate:"required,min=6"`
}

type User

type User struct {
	ID             uuid.UUID `json:"id"`
	Username       string    `json:"username"`
	Email          string    `json:"email"`
	HashedPassword []byte    `json:"-"`
	Bio            string    `json:"bio"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

func CreateUser

func CreateUser(opts CreateUserOpts) (User, error)

CreateUser creates brand new user with new ID!

func (*User) UpdateBio

func (u *User) UpdateBio(bio string)

func (*User) UpdateEmail

func (u *User) UpdateEmail(email string)

func (*User) UpdatePassword

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