db

Documentation

Index

• Constants
• Variables
• func GenerateShortURL(url string) string
• func IsValidEmail(email string) bool
• func RandomString(len int) (string, error)
• type DataStore
• type ShortURLClick
• type ShortURLInfo
• type UserInfo

Constants

const (
	// URLLength is the length of the shortened URL.
	URLLength = 6
	// MaxGuestURLs is the maximum number of URLs a guest can shorten.
	MaxGuestURLs = 2
)

Variables

var (
	// ErrorBadRequest is returned for user-facing errors.
	ErrorBadRequest = errors.New("bad request")
)

Functions

func GenerateShortURL

func GenerateShortURL(url string) string

GenerateShortURL generates a short URL from a given URL.

func IsValidEmail

func IsValidEmail(email string) bool

IsValidEmail checks if the given email is valid.

func RandomString

func RandomString(len int) (string, error)

RandomString generates and returns a random string of x2 the specified length.

Types

type DataStore

type DataStore interface {
	// UsernameExists checks if a username exists in the database.
	UsernameExists(username string) (bool, error)
	// CreateUser adds a new user to the database. The username must be unique
	// and email must be unique. The password is hashed before being stored.
	CreateUser(username, email string, password []byte) error
	// RetrieveUserInfo fetches information about a user using the email.
	RetrieveUserInfo(email string) (*UserInfo, error)
	// LoginUser logs a user in and returns a nil error if the user exists and the
	// password is correct.
	LoginUser(email string, password []byte) (*UserInfo, error)
	// CreateNewShortURL adds a new URL to the database and returns the
	// shortened URL. userID will can be any unique identifier for a guest user
	// but it is an email for non-guest users.
	CreateNewShortURL(userID, longURL, customShortURL string, isGuest bool) (*ShortURLInfo, error)
	// UpdateShortURL updates the information for the specified short URL. This
	// method is used for click update and link editing.
	UpdateShortURL(shortURL string, newLongURL string, click *ShortURLClick) error
	// RetrieveURLInfo fetches information about a short URL using the shortened
	// URL.
	RetrieveURLInfo(short string) (*ShortURLInfo, error)
	// RetrieveUserURLs fetches all the shorted URLs for the specified user.
	RetrieveUserURLs(email string) ([]*ShortURLInfo, error)
	// RetrieveShortURLClicks returns a list of complete click information for a
	// short URL.
	RetrieveShortURLClicks(shortURL string) ([]*ShortURLClick, error)
	// ToggleShortLinkStatus enables/disables a short link.
	ToggleShortLinkStatus(shortURL string, disable bool) error
	// Close ends the connection to the database.
	Close() error
}

DataStore is the interface that wraps the basic database operations.

type ShortURLClick

type ShortURLClick struct {
	IP         string `json:"ip" bson:"ip"`
	Browser    string `json:"browser" bson:"browser"`
	Device     string `json:"device" bson:"device"`
	DeviceType string `json:"deviceType" bson:"device_type"`
	Timestamp  int64  `json:"timestamp" bson:"timestamp"`
}

ShortURLClick is information about a click on a short URL.

type ShortURLInfo

type ShortURLInfo struct {
	OwnerID     string `json:"ownerID" bson:"owner_id"`
	ShortURL    string `json:"shortUrl" bson:"short_url"`
	OriginalURL string `json:"originalUrl" bson:"original_url"`
	Timestamp   int64  `json:"timestamp" bson:"timestamp"`
	Clicks      int32  `json:"clicks" bson:"clicks"`
	Disabled    bool   `json:"disabled" bson:"disabled"`
}

ShortURLInfo represents a short URL in the database.

type UserInfo

type UserInfo struct {
	Username   string `json:"username" bson:"username"`
	Email      string `json:"email" bson:"email"`
	Timestamp  int64  `json:"timestamp" bson:"timestamp"`
	TotalLinks int    `json:"totalLinks" bson:"total_links"`
}

UserInfo represents a user in the database.