data

Documentation

Index

• Constants
• Variables
• func ValidateEmail(v *validator.Validator, email string)
• func ValidateFilters(v *validator.Validator, f Filters)
• func ValidateMovie(v *validator.Validator, movie *Movie)
• func ValidatePasswordPlaintext(v *validator.Validator, password string)
• func ValidateTokenPlaintext(v *validator.Validator, tokenPlaintext string)
• func ValidateUser(v *validator.Validator, user *User)
• type Filters
• type Metadata
• type Models
  • func NewModels(db *sql.DB) Models
• type Movie
• type MovieModel
  • func (m MovieModel) Delete(id int64) error
  • func (m MovieModel) Get(id int64) (*Movie, error)
  • func (m MovieModel) GetAll(title string, genres []string, filters Filters) ([]*Movie, Metadata, error)
  • func (m MovieModel) Insert(movie *Movie) error
  • func (m MovieModel) Update(movie *Movie) error
• type Movies
• type PermissionModel
  • func (m PermissionModel) AddForUser(userID int64, codes ...string) error
  • func (m PermissionModel) GetAllForUser(userID int64) (Permissions, error)
• type Permissions
  • func (p Permissions) Include(code string) bool
• type Runtime
  • func (r Runtime) MarshalJSON() ([]byte, error)
  • func (r *Runtime) UnmarshalJSON(jsonValue []byte) error
• type Token
• type TokenModel
  • func (m TokenModel) DeleteAllForUser(scope string, userID int64) error
  • func (m TokenModel) Insert(token *Token) error
  • func (m TokenModel) New(userID int64, ttl time.Duration, scope string) (*Token, error)
• type User
  • func (u *User) IsAnonymous() bool
• type UserModel
  • func (m UserModel) GetByEmail(email string) (*User, error)
  • func (m UserModel) GetForToken(tokenScope, tokenPlaintext string) (*User, error)
  • func (m UserModel) Insert(user *User) error
  • func (m UserModel) Update(user *User) error
• type Users

Constants

const (
	ScopeActivation     = "activation"
	ScopeAuthentication = "authentication"
)

Variables

var (
	ErrRecordNotFound = errors.New("record not found")
	ErrEditConflict   = errors.New("edit conflict")
)

var AnonymousUser = &User{}

To represent a unactivated User

var (
	ErrDuplicateEmail = errors.New("duplicate email")
)

var ErrInvalidRuntimeFormat = errors.New("invalid runtime format")

Functions

func ValidateEmail

func ValidateEmail(v *validator.Validator, email string)

func ValidateFilters

func ValidateFilters(v *validator.Validator, f Filters)

func ValidateMovie

func ValidateMovie(v *validator.Validator, movie *Movie)

func ValidatePasswordPlaintext

func ValidatePasswordPlaintext(v *validator.Validator, password string)

func ValidateTokenPlaintext

func ValidateTokenPlaintext(v *validator.Validator, tokenPlaintext string)

Check that the plaintext token has been provided and is exactly 26 bytes long.

func ValidateUser

func ValidateUser(v *validator.Validator, user *User)

Types

type Filters

type Filters struct {
	Page         int
	PageSize     int
	Sort         string
	SortSafelist []string
}

type Metadata

type Metadata struct {
	CurrentPage  int `json:"current_page,omitempty"`
	PageSize     int `json:"page_size,omitempty"`
	FirstPage    int `json:"first_page,omitempty"`
	LastPage     int `json:"last_page,omitempty"`
	TotalRecords int `json:"total_records,omitempty"`
}

type Models

type Models struct {
	Movies      Movies
	Permissions PermissionModel
	Tokens      TokenModel
	Users       UserModel
}

func NewModels

func NewModels(db *sql.DB) Models

type Movie

type Movie struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at"`
	Title     string    `json:"title"`
	Year      int32     `json:"year,omitempty"`
	Runtime   Runtime   `json:"runtime,omitempty"`
	Genres    []string  `json:"genres,omitempty"`
	Version   int32     `json:"version"`
}

type MovieModel

type MovieModel struct {
	DB *sql.DB
}

func (MovieModel) Delete

func (m MovieModel) Delete(id int64) error

func (MovieModel) Get

func (m MovieModel) Get(id int64) (*Movie, error)

func (MovieModel) GetAll

func (m MovieModel) GetAll(title string, genres []string, filters Filters) ([]*Movie, Metadata, error)

func (MovieModel) Insert

func (m MovieModel) Insert(movie *Movie) error

func (MovieModel) Update

func (m MovieModel) Update(movie *Movie) error

type Movies

type Movies interface {
	Insert(movie *Movie) error
	Get(id int64) (*Movie, error)
	Update(movie *Movie) error
	Delete(id int64) error
	GetAll(title string, genres []string, filters Filters) ([]*Movie, Metadata, error)
}

type PermissionModel

type PermissionModel struct {
	DB *sql.DB
}

func (PermissionModel) AddForUser

func (m PermissionModel) AddForUser(userID int64, codes ...string) error

func (PermissionModel) GetAllForUser

func (m PermissionModel) GetAllForUser(userID int64) (Permissions, error)

The GetAllForUser() method returns all permission codes for a specific user in a Permissions slice.

type Permissions

type Permissions []string

"movies:read" and "movies:write") for a single user.

func (Permissions) Include

func (p Permissions) Include(code string) bool

to check whether the Permissions slice contains a specific permission code.

type Runtime

type Runtime int32

func (Runtime) MarshalJSON

func (r Runtime) MarshalJSON() ([]byte, error)

func (*Runtime) UnmarshalJSON

func (r *Runtime) UnmarshalJSON(jsonValue []byte) error

type Token

type Token struct {
	Plaintext string    `json:"token"`
	Hash      []byte    `json:"-"`
	UserID    int64     `json:"-"`
	Expiry    time.Time `json:"expiry"`
	Scope     string    `json:"-"`
}

only the Plaintext and Expiry field will be included when encoding a Token all other fields will be omitted

type TokenModel

type TokenModel struct {
	DB *sql.DB
}

Define the TokenModel type.

func (TokenModel) DeleteAllForUser

func (m TokenModel) DeleteAllForUser(scope string, userID int64) error

DeleteAllForUser() deletes all tokens for a specific user and scope.

func (TokenModel) Insert

func (m TokenModel) Insert(token *Token) error

Insert() adds the data for a specific token to the tokens table.

func (TokenModel) New

func (m TokenModel) New(userID int64, ttl time.Duration, scope string) (*Token, error)

The New() method is a shortcut which creates a new Token struct and then inserts the data in the tokens table.

type User

type User struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at"`
	Name      string    `json:"name"`
	Email     string    `json:"email"`
	Password  password  `json:"-"`
	Activated bool      `json:"activated"`
	Version   int       `json:"-"`
}

Define a User struct to represent an individual user. Importantly, notice how we are using the json:"-" struct tag to prevent the Password and Version fields appearing in any output when we encode it to JSON. Also notice that the Password field uses the custom password type defined below.

func (*User) IsAnonymous

func (u *User) IsAnonymous() bool

Check if a User instance is the AnonymousUser.

type UserModel

type UserModel struct {
	DB *sql.DB
}

func (UserModel) GetByEmail

func (m UserModel) GetByEmail(email string) (*User, error)

func (UserModel) GetForToken

func (m UserModel) GetForToken(tokenScope, tokenPlaintext string) (*User, error)

func (UserModel) Insert

func (m UserModel) Insert(user *User) error

func (UserModel) Update

func (m UserModel) Update(user *User) error

type Users

type Users interface {
	Insert(user *User) error
	GetByEmail(email string) (*User, error)
	Update(user *User) error
}