members

Documentation

Index

• func MemberToActor(c *fiber.Ctx, member *member.Member) ([]byte, error)
• type IMemberController
• type MemberController
  • func NewController(storage member.Storer, db *sqlx.DB, logger *zerolog.Logger, conf *cfg.Config) *MemberController
  • func (mc *MemberController) Ban(c *fiber.Ctx) error
  • func (mc *MemberController) Check(c *fiber.Ctx) error
  • func (mc *MemberController) DeleteMember(c *fiber.Ctx) error
  • func (mc *MemberController) GetFollowers(c *fiber.Ctx) error
  • func (mc *MemberController) GetID(c *fiber.Ctx) error
  • func (mc *MemberController) GetMemberByNickOrEmail(c *fiber.Ctx) error
  • func (mc *MemberController) GetMemberByWebfinger(c *fiber.Ctx) error
  • func (mc *MemberController) Unban(c *fiber.Ctx) error
  • func (mc *MemberController) Update(c *fiber.Ctx) (err error)

Functions

func MemberToActor

func MemberToActor(c *fiber.Ctx, member *member.Member) ([]byte, error)

MemberToActor converts a member to an ActivityPub actor

Types

type IMemberController

type IMemberController interface {
	GetMember(c *fiber.Ctx) error
	UpdateMember(c *fiber.Ctx) error
	DeleteMember(c *fiber.Ctx) error
}

IMemberController is the interface for the member controller It defines the methods that the member controller must implement This is useful for mocking the member controller in unit tests

type MemberController

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

MemberController is the controller for member endpoints

func NewController

func NewController(
	storage member.Storer,
	db *sqlx.DB,
	logger *zerolog.Logger,
	conf *cfg.Config,
) *MemberController

func (*MemberController) Ban

func (mc *MemberController) Ban(c *fiber.Ctx) error

@Summary Ban user @Description issues a ban to a user with the given UUID @Tags members,accounts,administration @Accept json @Produce json @Param uuid path string true "UUID of the member to ban" @Param input body BanInput true "Ban details" @Param X-CSRF-Token header string true "X-CSRF-Token header" @Success 200 {object} h.ResponseHTTP{} @Failure 400 {object} h.ResponseHTTP{} @Failure 400 {object} h.ResponseHTTP{} @Failure 500 {object} h.ResponseHTTP{} @Router /members/{uuid}/ban [post]

func (*MemberController) Check

func (mc *MemberController) Check(c *fiber.Ctx) error

check checks for the existence of a member it requires both nickname and email to be provided

func (*MemberController) DeleteMember

func (mc *MemberController) DeleteMember(c *fiber.Ctx) error

DeleteMember handles the deletion of an user

func (*MemberController) GetFollowers

func (mc *MemberController) GetFollowers(c *fiber.Ctx) error

func (*MemberController) GetID

func (mc *MemberController) GetID(c *fiber.Ctx) error

func (*MemberController) GetMemberByNickOrEmail

func (mc *MemberController) GetMemberByNickOrEmail(c *fiber.Ctx) error

@Summary Get a member (user) by nickname or email @Description Retrieve the information the requester is allowed to see about a member @Tags accounts,interactions,metadata @Param email_or_username path string true "The nickname or email of the member to get" @Accept json application/activity+json @Success 200 {object} h.ResponseHTTP{data=member.Member} @Failure 401 {object} h.ResponseHTTP{} "When certain access prerequisites are not met, e.g. a follower's only-visible metadata is requested" @Failure 404 {object} h.ResponseHTTP{} @Failure 500 {object} h.ResponseHTTP{} @Router /members/{email_or_username}/info [get]

func (*MemberController) GetMemberByWebfinger

func (mc *MemberController) GetMemberByWebfinger(c *fiber.Ctx) error

TODO: add webfinger to database

func (*MemberController) Unban

func (mc *MemberController) Unban(c *fiber.Ctx) error

@Summary Unban user @Description removes a ban from a user with the given UUID @Tags members,accounts,administration @Accept json @Produce json @Param uuid path string true "UUID of the member to unban" @Param X-CSRF-Token header string true "X-CSRF-Token header" @Success 200 {object} h.ResponseHTTP{} @Failure 400 {object} h.ResponseHTTP{} @Failure 401 {object} h.ResponseHTTP{} @Failure 500 {object} h.ResponseHTTP{} @Router /members/{uuid}/ban [delete]

func (*MemberController) Update

func (mc *MemberController) Update(c *fiber.Ctx) (err error)

UpdateMember handles the updating of user information