entities

Documentation

Index

• Constants
• Variables
• func NewError(status int, code openapi.GocomErrorCode, instance string, err error) error
• type AmountInCents
  • func NewAmountInCents(amountInCents int) AmountInCents
  • func NewAmountInCentsFromString(amount string) (AmountInCents, error)
  • func (a AmountInCents) Int() int
  • func (a AmountInCents) String() string
• type Category
  • func (c *Category) Clean()
  • func (c *Category) Validate() error
• type Content
  • func (c *Content) Validate() error
• type ContentType
  • func (contentType ContentType) IsValid() bool
  • func (contentType ContentType) String() string
• type Event
  • func (e *Event) Clean()
  • func (e *Event) Validate() error
• type GoComError
  • func (e *GoComError) Error() string
• type ID
  • func NewID() ID
  • func NewIDFromBytes(b []byte) (ID, error)
  • func NewIDFromString(s string) (ID, error)
  • func NewNilID() ID
  • func (id ID) Bytes() []byte
  • func (id ID) IsNil() bool
  • func (id ID) String() string
• 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) Clean()
  • func (m *Manufacturer) Validate() error
• type Product
  • func (p *Product) Clean()
  • func (p *Product) Validate() error
• type ProductStatus
  • func (status ProductStatus) String() string
• type ResolvedProduct

Constants

const ContentTypeHTML = "HTML"

const ContentTypeSimple = "SIMPLE"

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, code openapi.GocomErrorCode, instance string, err error) error

NewError returns a new GoComError

Types

type AmountInCents

type AmountInCents struct {
	// contains filtered or unexported fields
}

func NewAmountInCents

func NewAmountInCents(amountInCents int) AmountInCents

func NewAmountInCentsFromString

func NewAmountInCentsFromString(amount string) (AmountInCents, error)

NewAmountInCentsFromString converts a decimal string into an AmountInCents, without using float conversions

func (AmountInCents) Int

func (a AmountInCents) Int() int

func (AmountInCents) String

func (a AmountInCents) String() string

FormatPrice formats a price in cents into a decimal string, without using float conversions.

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) Clean

func (c *Category) Clean()

func (*Category) Validate

func (c *Category) Validate() error

Validate cleans and validates the category data

type Content

type Content struct {
	Name        string
	ContentType ContentType
	Body        string
}

Content data

func (*Content) Validate

func (c *Content) Validate() error

Validate validates the content data

type ContentType

type ContentType string

func (ContentType) IsValid

func (contentType ContentType) IsValid() bool

func (ContentType) String

func (contentType ContentType) String() string

type Event

type Event struct {
	ID          ID
	Name        string
	Description string
	EventType   string
	Start       time.Time
	End         time.Time
	WholeDay    bool
}

Event data

func (*Event) Clean

func (e *Event) Clean()

func (*Event) Validate

func (e *Event) Validate() error

Validate cleans and validates the event data

type GoComError

type GoComError struct {
	// HTTP status code
	Status int `json:"status"`

	// Original error
	Err error `json:"-"`

	// Error code
	Code string `json:"code"`

	// Human-readable description of the error
	Message string `json:"message"`

	// Optional - On which object to error occurred
	Instance string `json:"instance"`
}

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 struct {
	// contains filtered or unexported fields
}

ID contains an entity ID, which is a valid UUID. ID type is created to make it library agnostic and to add useful helpers like IsNil.

func NewID

func NewID() ID

NewID create a new entity ID

func NewIDFromBytes

func NewIDFromBytes(b []byte) (ID, error)

NewIDFromString convert a bytes slice to an entity ID

func NewIDFromString

func NewIDFromString(s string) (ID, error)

NewIDFromString convert a string to an entity ID

func NewNilID

func NewNilID() ID

NewNilID create a new entity ID with value Nil

func (ID) Bytes

func (id ID) Bytes() []byte

Bytes converts the ID to a byte slice. Returns an empty slice in case the ID is Nil.

func (ID) IsNil

func (id ID) IsNil() bool

func (ID) String

func (id ID) String() string

String converts the ID to a string. Returns an empty string in case the ID is Nil.

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) Clean

func (m *Manufacturer) Clean()

func (*Manufacturer) Validate

func (m *Manufacturer) Validate() error

Validate cleans and 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 AmountInCents

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

Product data

func (*Product) Clean

func (p *Product) Clean()

func (*Product) Validate

func (p *Product) Validate() error

Validate cleans and 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.