vproduct

Documentation

Overview

Package vproduct provides an example of a core business API that is based on a view.

Index

• Constants
• Variables
• type Core
  • func NewCore(storer Storer) *Core
  • func (c *Core) Count(ctx context.Context, filter QueryFilter) (int, error)
  • func (c *Core) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, ...) ([]Product, error)
• type Product
• type QueryFilter
  • func (qf *QueryFilter) Validate() error
  • func (qf *QueryFilter) WithCost(cost float64)
  • func (qf *QueryFilter) WithID(productID uuid.UUID)
  • func (qf *QueryFilter) WithName(name string)
  • func (qf *QueryFilter) WithQuantity(quantity int)
  • func (qf *QueryFilter) WithUserName(userName string)
• type Storer

Constants

const (
	OrderByProductID = "product_id"
	OrderByUserID    = "user_id"
	OrderByName      = "name"
	OrderByCost      = "cost"
	OrderByQuantity  = "quantity"
	OrderByUserName  = "user_name"
)

Set of fields that the results can be ordered by.

Variables

var DefaultOrderBy = order.NewBy(OrderByProductID, order.ASC)

DefaultOrderBy represents the default way we sort.

Types

type Core

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

Core manages the set of APIs for user access.

func NewCore

func NewCore(storer Storer) *Core

NewCore constructs a usersummary core API for use.

func (*Core) Count

func (c *Core) Count(ctx context.Context, filter QueryFilter) (int, error)

Count returns the total number of products.

func (*Core) Query

func (c *Core) Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]Product, error)

Query retrieves a list of existing products.

type Product

type Product struct {
	ID          uuid.UUID
	UserID      uuid.UUID
	Name        string
	Cost        float64
	Quantity    int
	DateCreated time.Time
	DateUpdated time.Time
	UserName    string
}

Product represents an individual product with extended information.

type QueryFilter

type QueryFilter struct {
	ID       *uuid.UUID
	Name     *string `validate:"omitempty,min=3"`
	Cost     *float64
	Quantity *int
	UserName *string
}

QueryFilter holds the available fields a query can be filtered on. We are using pointer semantics because the With API mutates the value.

func (*QueryFilter) Validate

func (qf *QueryFilter) Validate() error

Validate can perform a check of the data against the validate tags.

func (*QueryFilter) WithCost

func (qf *QueryFilter) WithCost(cost float64)

WithCost sets the Cost field of the QueryFilter value.

func (*QueryFilter) WithID

func (qf *QueryFilter) WithID(productID uuid.UUID)

WithID sets the ID field of the QueryFilter value.

func (*QueryFilter) WithName

func (qf *QueryFilter) WithName(name string)

WithName sets the Name field of the QueryFilter value.

func (*QueryFilter) WithQuantity

func (qf *QueryFilter) WithQuantity(quantity int)

WithQuantity sets the Quantity field of the QueryFilter value.

func (*QueryFilter) WithUserName

func (qf *QueryFilter) WithUserName(userName string)

WithUserName sets the UserName field of the QueryFilter value.

type Storer

type Storer interface {
	Query(ctx context.Context, filter QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]Product, error)
	Count(ctx context.Context, filter QueryFilter) (int, error)
}

Storer interface declares the behavior this package needs to perists and retrieve data.