push

Documentation

Overview

(Web)Push notifications and subscriptions routes and controllers logic package for the backend.

Index

• Constants
• Variables
• func GetSubscriptionByID(userID string, cache db.Cacher) (*[]models.Device, error)
• func NewPushRouter(pushController *PushController) chi.Router
• func NewSubscriptionRepository(cache db.Cacher) models.SubscriptionRepositoryInterface
• func SendNotificationToDevices(opts *NotificationOpts)
• type NotificationOpts
• type NotificationRequest
• type PushController
  • func NewPushController(subscriptionService models.SubscriptionServiceInterface) *PushController
  • func (c *PushController) Create(w http.ResponseWriter, r *http.Request)
  • func (c *PushController) Delete(w http.ResponseWriter, r *http.Request)
  • func (c *PushController) SendNotification(w http.ResponseWriter, r *http.Request)
  • func (c *PushController) Update(w http.ResponseWriter, r *http.Request)
• type SubscriptionRepository
  • func (r *SubscriptionRepository) Delete(userID string) error
  • func (r *SubscriptionRepository) GetByUserID(userID string) (*[]models.Device, error)
  • func (r *SubscriptionRepository) Save(userID string, subscription *[]models.Device) error
• type SubscriptionService
  • func NewSubscriptionService(postRepository models.PostRepositoryInterface, ...) *SubscriptionService
  • func (s *SubscriptionService) Create(ctx context.Context, device *models.Device) error
  • func (s *SubscriptionService) Delete(ctx context.Context, uuid string) error
  • func (s *SubscriptionService) SendNotification(ctx context.Context, postID string) error
  • func (s *SubscriptionService) Update(ctx context.Context, uuid, tagName string) error
• type SubscriptionUpdateRequest

Constants

const (
	LOGGER_WORKER_NAME string = "pushController"
)

Variables

var (
	ErrSubscriptionNotFound error = errors.New("could not find requested Subscription")
)

Functions

func GetSubscriptionByID

func GetSubscriptionByID(userID string, cache db.Cacher) (*[]models.Device, error)

GetSubscriptionByID is a static function to export to other services.

func NewPushRouter

func NewPushRouter(pushController *PushController) chi.Router

func NewSubscriptionRepository

func NewSubscriptionRepository(cache db.Cacher) models.SubscriptionRepositoryInterface

func SendNotificationToDevices

func SendNotificationToDevices(opts *NotificationOpts)

Types

type NotificationOpts

type NotificationOpts struct {
	Receiver string
	Devices  *[]models.Device
	Body     *[]byte
}

type NotificationRequest

type NotificationRequest struct {
	PostID string `json:"post_id" example:"123456789000"`
}

type PushController

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

func NewPushController

func NewPushController(
	subscriptionService models.SubscriptionServiceInterface,
) *PushController

func (*PushController) Create

func (c *PushController) Create(w http.ResponseWriter, r *http.Request)

Create is the handler function to ensure that a sent device has been subscribed to notifications.

@Summary		Create the notifications subscription
@Description		This function call takes in a device specification and creates a new user subscription to webpush notifications.
@Tags			push
@Accept			json
@Produce		json
@Param			request	body	models.Device	true	"A device to create the notification subscription for."
@Success		201		{object}	common.APIResponse{data=models.Stub}	"The subscription has been created successfully."
@Failure		400		{object}	common.APIResponse{data=models.Stub}	"Invalid data input."
@Failure		401		{object}	common.APIResponse{data=models.Stub}	"User unauthorized.."
@Failure		409		{object}	common.APIResponse{data=models.Stub}	"Conflict: a subscription for such device already exists."
@Failure		429		{object}	common.APIResponse{data=models.Stub}	"Too many requests, try again later."
@Failure		500		{object}	common.APIResponse{data=models.Stub}	"A serious internal server problem occurred."
@Router			/push/subscriptions [post]

func (*PushController) Delete

func (c *PushController) Delete(w http.ResponseWriter, r *http.Request)

Delete is the handler function to ensure a given subscription deleted from the database.

@Summary		Delete a subscription
@Description		This function call takes an UUID as parameter to fetch and purge a device associated with such ID from the subscribed devices list.
@Tags			push
@Produce		json
@Param			uuid	path		string	true	"An UUID of a device to delete."
@Success		200		{object}	common.APIResponse{data=models.Stub}	"Requested device has been purged from the subscribed devices list."
@Failure		400		{object}	common.APIResponse{data=models.Stub}	"Invalid data input."
@Failure		401		{object}	common.APIResponse{data=models.Stub}	"User unauthorized."
@Failure		404		{object}	common.APIResponse{data=models.Stub}	"The requested device to delete not found."
@Failure		429		{object}	common.APIResponse{data=models.Stub}	"Too many requests, try again later."
@Failure		500		{object}	common.APIResponse{data=models.Stub}	"A serious internal problem occurred while processing the delete request."
@Router			/push/subscriptions/{uuid} [delete]

func (*PushController) SendNotification

func (c *PushController) SendNotification(w http.ResponseWriter, r *http.Request)

SendNotification is the handler function for sending new notification(s).

@Summary		Send a notification
@Description		This function call handles the procedure of a new webpush notification creation and firing.
@Tags			push
@Produce		json
@Param			request	body	push.NotificationRequest	true	"An original post which is to fire a notification to its author."
@Success		200		{object}	common.APIResponse{data=models.Stub}	"The notification has been created and sent to the webpush gateway."
@Success		400		{object}	common.APIResponse{data=models.Stub}	"Invalid data input."
@Failure		401		{object}	common.APIResponse{data=models.Stub}	"User unauthorized."
@Failure		404		{object}	common.APIResponse{data=models.Stub}	"The requested device to use not found."
@Failure		429		{object}	common.APIResponse{data=models.Stub}	"Too many requests, try again later."
@Failure		500		{object}	common.APIResponse{data=models.Stub}	"A serious internal problem occurred while preparing the notification for firing."
@Router			/push [post]

func (*PushController) Update

func (c *PushController) Update(w http.ResponseWriter, r *http.Request)

Update is the handler function used to update an existing subscription.

@Summary		Update the notification subscription tag
@Description		This function call handles a request to change an user's (caller's) notifications subscription for a device specified by UUID param.
@Tags			push
@Accept			json
@Produce		json
@Param			uuid	path	string					true	"An UUID of a device to update."
@Param			request	body	push.SubscriptionUpdateRequest		true	"The request's body containing fields to modify."
@Success		200		{object}	common.APIResponse{data=models.Stub}	"The subscription has been updated successfully."
@Failure		400		{object}	common.APIResponse{data=models.Stub}	"Invalid input data."
@Failure		401		{object}	common.APIResponse{data=models.Stub}	"User unauthorized."
@Failure		404		{object}	common.APIResponse{data=models.Stub}	"The requested device to update not found."
@Failure		429		{object}	common.APIResponse{data=models.Stub}	"Too many requests, try again later."
@Failure		500		{object}	common.APIResponse{data=models.Stub}	"A serious internal problem occurred while the update procedure was processing the data."
@Router			/push/subscriptions/{uuid} [patch]

type SubscriptionRepository

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

The implementation of pkg/models.SubscriptionRepositoryInterface.

func (*SubscriptionRepository) Delete

func (r *SubscriptionRepository) Delete(userID string) error

func (*SubscriptionRepository) GetByUserID

func (r *SubscriptionRepository) GetByUserID(userID string) (*[]models.Device, error)

func (*SubscriptionRepository) Save

func (r *SubscriptionRepository) Save(userID string, subscription *[]models.Device) error

type SubscriptionService

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

func NewSubscriptionService

func NewSubscriptionService(
	postRepository models.PostRepositoryInterface,
	subscriptionRepository models.SubscriptionRepositoryInterface,
) *SubscriptionService

func (*SubscriptionService) Create

func (s *SubscriptionService) Create(ctx context.Context, device *models.Device) error

func (*SubscriptionService) Delete

func (s *SubscriptionService) Delete(ctx context.Context, uuid string) error

func (*SubscriptionService) SendNotification

func (s *SubscriptionService) SendNotification(ctx context.Context, postID string) error

func (*SubscriptionService) Update

func (s *SubscriptionService) Update(ctx context.Context, uuid, tagName string) error

type SubscriptionUpdateRequest

type SubscriptionUpdateRequest struct {
	Tags []string `json:"tags" example:"reply,mention"`
}