subscription

Documentation

Overview

Package subscription provides a core business API.

Index

• Variables
• type Core
  • func NewCore(log *zerolog.Logger, storer Storer) *Core
  • func (c *Core) Create(ns NewSubscription) (Subscription, error)
  • func (c *Core) Delete(sub Subscription) error
  • func (c *Core) Query(pageNumber int, rowsPerPage int) ([]Subscription, error)
  • func (c *Core) QueryByID(id uuid.UUID) (Subscription, error)
• type NewSubscription
• type Storer
• type Subscription

Variables

var (
	ErrNotFound        = errors.New("subscription not found")
	ErrUniqueViolation = errors.New("subscription already exists")
)

Set of error variables for CRUD operations.

Types

type Core

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

Core manages the set of APIs for subscription access.

func NewCore

func NewCore(log *zerolog.Logger, storer Storer) *Core

NewCore constructs a subscription core API for use.

func (*Core) Create

func (c *Core) Create(ns NewSubscription) (Subscription, error)

Create adds a new subscription to the system.

func (*Core) Delete

func (c *Core) Delete(sub Subscription) error

Delete removes the specified subscription.

func (*Core) Query

func (c *Core) Query(pageNumber int, rowsPerPage int) ([]Subscription, error)

Query retrieves a list of existing subscriptions.

func (*Core) QueryByID

func (c *Core) QueryByID(id uuid.UUID) (Subscription, error)

QueryByID finds the subscription by the specified ID.

type NewSubscription

type NewSubscription struct {
	TopicID uuid.UUID
	UserID  uuid.UUID
}

NewSubscription contains information needed to create a new subscription.

type Storer

type Storer interface {
	WithinTran(fn func(s Storer) error) error
	Create(sub Subscription) error
	Delete(sub Subscription) error
	Query(pageNumber int, rowsPerPage int) ([]Subscription, error)
	QueryByID(id uuid.UUID) (Subscription, error)
}

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

type Subscription

type Subscription struct {
	ID        uuid.UUID
	TopicID   uuid.UUID
	UserID    uuid.UUID
	CreatedAt time.Time
}

Subscription represents information about an individual subscription.