subscription

Documentation

Index

• type Manager
  • func NewManager(db hub.DB) *Manager
  • func (m *Manager) Add(ctx context.Context, s *hub.Subscription) error
  • func (m *Manager) Delete(ctx context.Context, s *hub.Subscription) error
  • func (m *Manager) GetByPackageJSON(ctx context.Context, packageID string) ([]byte, error)
  • func (m *Manager) GetByUserJSON(ctx context.Context) ([]byte, error)
  • func (m *Manager) GetSubscriptors(ctx context.Context, packageID string, eventKind hub.EventKind) ([]*hub.User, error)
• type ManagerMock
  • func (m *ManagerMock) Add(ctx context.Context, s *hub.Subscription) error
  • func (m *ManagerMock) Delete(ctx context.Context, s *hub.Subscription) error
  • func (m *ManagerMock) GetByPackageJSON(ctx context.Context, packageID string) ([]byte, error)
  • func (m *ManagerMock) GetByUserJSON(ctx context.Context) ([]byte, error)
  • func (m *ManagerMock) GetSubscriptors(ctx context.Context, packageID string, eventKind hub.EventKind) ([]*hub.User, error)

Types

type Manager

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

Manager provides an API to manage subscriptions.

func NewManager

func NewManager(db hub.DB) *Manager

NewManager creates a new Manager instance.

func (*Manager) Add

func (m *Manager) Add(ctx context.Context, s *hub.Subscription) error

Add adds the provided subscription to the database.

func (*Manager) Delete

func (m *Manager) Delete(ctx context.Context, s *hub.Subscription) error

Delete removes a subscription from the database.

func (*Manager) GetByPackageJSON

func (m *Manager) GetByPackageJSON(ctx context.Context, packageID string) ([]byte, error)

GetByPackageJSON returns the subscriptions the user has for a given package as json array of objects.

func (*Manager) GetByUserJSON

func (m *Manager) GetByUserJSON(ctx context.Context) ([]byte, error)

GetByUserJSON returns all the subscriptions of the user doing the request as as json array of objects.

func (*Manager) GetSubscriptors

func (m *Manager) GetSubscriptors(
	ctx context.Context,
	packageID string,
	eventKind hub.EventKind,
) ([]*hub.User, error)

GetSubscriptors returns the users subscribed to a package to receive notifications for certain kind of events.

type ManagerMock

type ManagerMock struct {
	mock.Mock
}

ManagerMock is a mock implementation of the SubscriptionManager interface.

func (*ManagerMock) Add

func (m *ManagerMock) Add(ctx context.Context, s *hub.Subscription) error

Add implements the SubscriptionManager interface.

func (*ManagerMock) Delete

func (m *ManagerMock) Delete(ctx context.Context, s *hub.Subscription) error

Delete implements the SubscriptionManager interface.

func (*ManagerMock) GetByPackageJSON

func (m *ManagerMock) GetByPackageJSON(ctx context.Context, packageID string) ([]byte, error)

GetByPackageJSON implements the SubscriptionManager interface.

func (*ManagerMock) GetByUserJSON

func (m *ManagerMock) GetByUserJSON(ctx context.Context) ([]byte, error)

GetByUserJSON implements the SubscriptionManager interface.

func (*ManagerMock) GetSubscriptors

func (m *ManagerMock) GetSubscriptors(
	ctx context.Context,
	packageID string,
	eventKind hub.EventKind,
) ([]*hub.User, error)

GetByUserJSON implements the SubscriptionManager interface.