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 ValidatePlainPassword(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 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

Constants

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

Variables

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

var AnonymousUser = &User{}

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

var ErrInvalidRuntime = fmt.Errorf("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 ValidatePlainPassword

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

func ValidateTokenPlainText

func ValidateTokenPlainText(v *validator.Validator, tokenPlainText string)

func ValidateUser

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

Types

type Filters

type Filters struct {
	Page         int
	PageSize     int
	Sort         string
	SortSafelist []string // holds the supported sort values.
}

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      MovieModel
	Users       UserModel
	Tokens      TokenModel
	Permissions PermissionModel
}

Models wraps the MovieMode and other models.

func NewModels

func NewModels(db *sql.DB) Models

type Movie

type Movie struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"-"`
	Title     string    `json:"title"`
	Year      int32     `json:"year,omitempty"`
	Runtime   Runtime   `json:"runtime,omitempty"`
	Genres    []string  `json:"genres,omitempty"`
	Version   int32     `json:"version"` // The version number starts at 1 and will be incremented each time the movie information is updated
}

type MovieModel

type MovieModel struct {
	DB *sql.DB
}

MovieModel provides access to the movie data store.

func (MovieModel) Delete

func (m MovieModel) Delete(id int64) error

Delete deletes a specific record from the Movie table.

func (MovieModel) Get

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

Get fetches a specific record from the Movie table.

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

Insert creates a new record in the Movie table.

func (MovieModel) Update

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

Update updates a specific record from the Movie table.

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)

type Permissions

type Permissions []string

func (Permissions) Include

func (p Permissions) Include(code string) bool

Include checks whether the Permissions slice contains a specific permission code.

type Runtime

type Runtime int32

Runtime represents the runtime of a movie in minutes.

func (Runtime) MarshalJSON

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

func (*Runtime) UnmarshalJSON

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

UnmarshalJSON unmarshals the JSON value into the Runtime type. We need pointer here in order to modify the receiver

type Token

type Token struct {
	Plaintext string `json:"token"`
	Hash      []byte `json:"-"`

	Expiry time.Time `json:"expiry"`
	Scope  string    `json:"-"`
	// contains filtered or unexported fields
}

Token holds the data for an individual token. This includes the plaintext and hashed versions of the token, associated user ID, expiry time and scope.

type TokenModel

type TokenModel struct {
	DB *sql.DB
}

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)

New 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:"password"`
	Activated bool      `json:"activated"`
	Version   int       `json:"-"` // The version number starts at 1 and will be incremented each time the movie information is updated
}

func (*User) IsAnonymous

func (u *User) IsAnonymous() bool

IsAnonymous checks if a User instance is the AnonymousUser: an inactivated user with no ID, name, email or password

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

Update user