db

Documentation

Index

• Variables
• func InitDB(dbPath string)
• type BaseModel
• type Short
  • func GetShortByID(id uint) *Short
  • func (s *Short) Create() error
  • func (s *Short) IncrVisitCount() (uint, error)
  • func (s *Short) IsExpired() bool
  • func (s *Short) IsUsable() bool
• type User
  • func GetUserByID(userID uint) *User
  • func GetUserByUsername(username string) *User
  • func (u *User) IsPasswordMatch(plainPassword string) bool
  • func (u *User) SetPassword(newPlainPassword string)

Variables

var DB *gorm.DB

Functions

func InitDB

func InitDB(dbPath string)

Types

type BaseModel

type BaseModel struct {
	ID        uint           `gorm:"primarykey" json:"id"`
	CreatedAt time.Time      `json:"createdAt"`
	UpdatedAt time.Time      `json:"-"`
	DeletedAt gorm.DeletedAt `gorm:"index" json:"-"`
}

type Short

type Short struct {
	BaseModel
	TargetURL  string     `gorm:"not null" json:"targetUrl"`
	VisitCount uint       `gorm:"default:0;not null" json:"visitCount,omitempty"`
	ExpiresAt  *time.Time `json:"expiresAt,omitempty"`
	MaxUses    *uint      `json:"maxUses,omitempty"`
	OwnerID    *uint      `json:"ownerId,omitempty"`
}

func GetShortByID

func GetShortByID(id uint) *Short

func (*Short) Create

func (s *Short) Create() error

func (*Short) IncrVisitCount

func (s *Short) IncrVisitCount() (uint, error)

Records a new visitor

func (*Short) IsExpired

func (s *Short) IsExpired() bool

Whether the short expiry has elapsed

func (*Short) IsUsable

func (s *Short) IsUsable() bool

Whether the short can be used (a redirect)

type User

type User struct {
	BaseModel
	Username       string  `gorm:"unique;not null"`
	HashedPassword []byte  `gorm:"not null" json:"-"`
	OwnedShorts    []Short `gorm:"foreignkey:OwnerID;references:id" json:"-"`
}

func GetUserByID

func GetUserByID(userID uint) *User

func GetUserByUsername

func GetUserByUsername(username string) *User

func (*User) IsPasswordMatch

func (u *User) IsPasswordMatch(plainPassword string) bool

Check if password matches the hashed stored one

func (*User) SetPassword

func (u *User) SetPassword(newPlainPassword string)

Set a new password (hashing it)