entities

Documentation

Index

• Constants
• Variables
• func NewError(status int, err error) error
• type Category
  • func (c *Category) Validate() error
• type GoComError
  • func (e *GoComError) Error() string
• type ID
  • func NewID() ID
  • func StringToID(s string) (ID, error)
• type Image
  • func (img *Image) SetURLsFromConfigs(service imageproxy.Service, configs map[string]imageproxy.ImageConfig) error
  • func (img *Image) Validate() error
• type Manufacturer
  • func (m *Manufacturer) Validate() error
• type Product
  • func (c *Product) Validate() error
• type ProductStatus
  • func (status ProductStatus) String() string
• type ResolvedProduct

Constants

const ProductStatusArchived = "ARCHIVED"

const ProductStatusAvailable = "AVAILABLE"

Variables

var ErrInvalidEntity = errors.New("invalid entity")

ErrInvalidEntity indicates the provided entity is invalid

var ErrInvalidID = errors.New("invalid id")

ErrInvalidID indicates the provided id is malformed

var ErrNotFound = errors.New("not found")

ErrNotFound indicates the requested entity is not found

Functions

func NewError

func NewError(status int, err error) error

NewError returns a new GoComError

Types

type Category

type Category struct {
	ID          ID
	Name        string
	Description string

	// ID of the parent.
	// uuid.Nil means it's a root category
	ParentID ID

	// Order (priority) of the category.
	// 1 = highest, inf = lowest
	Order int

	ProductIDs []ID

	Image *Image
}

Category data

func (*Category) Validate

func (c *Category) Validate() error

Validate validates the category data

type GoComError

type GoComError struct {
	// HTTP status code
	Status int

	// Original error
	Err error
}

GoComError allows to bundle a status with the original error. This allows to fine-grained response codes at the API level.

func (*GoComError) Error

func (e *GoComError) Error() string

type ID

type ID = uuid.UUID

ID entity ID

func NewID

func NewID() ID

NewID create a new entity ID

func StringToID

func StringToID(s string) (ID, error)

StringToID convert a string to an entity ID

type Image

type Image struct {
	ID        ID
	Extension string // File extension
	URLs      map[string]string
	Order     int
}

func (*Image) SetURLsFromConfigs

func (img *Image) SetURLsFromConfigs(service imageproxy.Service, configs map[string]imageproxy.ImageConfig) error

SetURLsFromConfigs generates and sets an URL from the provided config

func (*Image) Validate

func (img *Image) Validate() error

Validate validates the product data

type Manufacturer

type Manufacturer struct {
	ID         ID
	Name       string
	WebsiteURL string
	Image      *Image
}

Manufacturer data

func (*Manufacturer) Validate

func (m *Manufacturer) Validate() error

Validate validates the manufacturer data

type Product

type Product struct {
	ID               ID
	CreatedAt        time.Time
	UpdatedAt        time.Time
	Name             string
	DescriptionShort string
	DescriptionLong  string

	// Price of a single product in cents (1/100)
	Price int

	CategoryIDs    []ID
	ManufacturerID ID
	Status         ProductStatus
	StockCount     int
	Images         []*Image
}

Product data

func (*Product) Validate

func (c *Product) Validate() error

Validate validates the product data

type ProductStatus

type ProductStatus string

func (ProductStatus) String

func (status ProductStatus) String() string

type ResolvedProduct

type ResolvedProduct struct {
	Product
	Manufacturer *Manufacturer
	Categories   []*Category
}

ResolvedProduct is a product for which related entities are included. This way all information is immediately at hand.