models

Documentation

Index

• Constants
• type Gallery
  • func (g *Gallery) ImagesSplitN(n int) [][]Image
• type GalleryDB
• type GalleryService
  • func NewGalleryService(db *gorm.DB) GalleryService
• type Image
  • func (i *Image) Path() string
  • func (i *Image) RelativePath() string
• type ImageService
  • func NewImageService() ImageService
• type Services
  • func NewServices(connectionInfo string) (*Services, error)
  • func (s *Services) AutoMigrate() error
  • func (s *Services) Close() error
  • func (s *Services) DestructiveReset() error
• type User
• type UserDB
• type UserService
  • func NewUserService(db *gorm.DB) UserService

Constants

const (
	// ErrNotFound is return when a resource cannot be found
	// in a database.
	ErrNotFound modelError = "models: resource not found"

	// ErrPasswordIncorrect is returned when an invalid password
	// is used when attempting to authenticate a user.
	ErrPasswordIncorrect modelError = "models: incorrect password provided"

	// ErrEmailRequired is return when an empty email
	// is passed mainly during registration.
	ErrEmailRequired modelError = "models: email address is required"

	// ErrEmailInvalid is returned when the email format
	// passed in does not match emailRegex.
	ErrEmailInvalid modelError = "models: email address is not valid"

	// ErrEmailTaken is returned when an update or create
	// is attempted with an email address that is already in use.
	ErrEmailTaken modelError = "models: email address is already taken"

	// ErrPasswordTooShort is returned when an update or create is
	// attempted with a user password that is less than 8 characters
	ErrPasswordTooShort modelError = "models: password must be at least 8 characters long"

	// ErrPasswordRequired is returned when a create is attempted
	// without a user password provided
	ErrPasswordRequired modelError = "models: password is required"

	ErrTitleRequired modelError = "models: title is required"

	// ErrRememberTooShort is returned when a remember token is not at least
	// 32 bytes
	ErrRememberTooShort privateError = "models: remember token must be at least 32 bytes"

	// ErrPasswordRequired is returned when a create or update is attempted
	// without a valid user remember token hash
	ErrRememberRequired privateError = "models: remember token is required"

	ErrUserIDRequired privateError = "models: user ID is required"

	// ErrInvalidID is returned when an invalid ID is provided
	// to a method like Delete.
	ErrInvalidID privateError = "models: ID provided was invalid"
)

Types

type Gallery

type Gallery struct {
	gorm.Model
	UserID uint    `gorm:"not null;index"`
	Title  string  `gorm:"not null"`
	Images []Image `gorm:"-"`
}

Gallery is our image container resources that visitors view.

func (*Gallery) ImagesSplitN

func (g *Gallery) ImagesSplitN(n int) [][]Image

type GalleryDB

type GalleryDB interface {
	Create(gallery *Gallery) error
	ByID(id uint) (*Gallery, error)
	ByUserID(userID uint) ([]Gallery, error)
	Update(gallery *Gallery) error
	Delete(id uint) error
}

type GalleryService

type GalleryService interface {
	GalleryDB
}

func NewGalleryService

func NewGalleryService(db *gorm.DB) GalleryService

type Image

type Image struct {
	GalleryID uint
	Filename  string
}

Image is NOT stored in the database

func (*Image) Path

func (i *Image) Path() string

func (*Image) RelativePath

func (i *Image) RelativePath() string

type ImageService

type ImageService interface {
	Create(galleryID uint, filename string, r io.ReadCloser) error
	ByGalleryID(galleryID uint) ([]Image, error)
	Delete(image *Image) error
}

func NewImageService

func NewImageService() ImageService

type Services

type Services struct {
	Gallery GalleryService
	User    UserService
	Image   ImageService
	// contains filtered or unexported fields
}

func NewServices

func NewServices(connectionInfo string) (*Services, error)

func (*Services) AutoMigrate

func (s *Services) AutoMigrate() error

AutoMigrate will attempt to automatically migrate the all tables.

func (*Services) Close

func (s *Services) Close() error

Closes the database connection.

func (*Services) DestructiveReset

func (s *Services) DestructiveReset() error

DestructiveReset drops the all table and rebuilds them.

type User

type User struct {
	gorm.Model
	Name         string
	Email        string `gorm:"not null;unique_index"`
	Password     string `gorm:"-"`
	PasswordHash string `gorm:"not null"`
	Remember     string `gorm:"-"`
	RememberHash string `gorm:"not null;unique_index"`
}

User represent the user model stored in our database. This is used for user accounts, storing both an email address and a password so users can log in and gain access to their content.

type UserDB

type UserDB interface {
	// Methods for querying for single users
	ByID(id uint) (*User, error)
	ByEmail(email string) (*User, error)
	ByRemember(token string) (*User, error)

	// Methods for altering users
	Create(user *User) error
	Update(user *User) error
	Delete(id uint) error
}

UserDB is used to interact with the users database.

For pretty much all single user queries: If the user is found, we will return a nil error If the user is not found, we will return ErrNotFound If there is another error, we will return an error with more information about what went wrong. This may not be an error generated by the models package.

For single user queries, any error but ErrNotFound should probably result in a 500 error.

type UserService

type UserService interface {
	// Authenticate will verify the provided email address and
	// password are correct. If they are correct, the user
	// corresponding to that email will be returned. Otherwise
	// you will receive either:
	// ErrNotFound, ErrPasswordIncorrect, or another error if
	// something goes wrong.
	Authenticate(email, password string) (*User, error)
	UserDB
}

UserService is a set of methods used to manipulate and work with the user model.

func NewUserService

func NewUserService(db *gorm.DB) UserService