Documentation
¶
Index ¶
- type AuthService
- func (u *AuthService) GenerateKey(ctx context.Context, req *authService.Empty) (*authService.GenerateKeyRes, error)
- func (u *AuthService) Login(ctx context.Context, req *authService.LoginReq) (*authService.LoginRes, error)
- func (u *AuthService) Logout(ctx context.Context, req *authService.Empty) (*authService.LogoutRes, error)
- func (u *AuthService) Refresh(ctx context.Context, req *authService.Empty) (*authService.RefreshRes, error)
- func (u *AuthService) Register(ctx context.Context, req *authService.RegisterReq) (*authService.RegisterRes, error)
- func (u *AuthService) UpdatePassword(ctx context.Context, req *authService.UpdatePasswordReq) (*authService.UpdatePasswordRes, error)
- type BlacklistDataService
- type FileDataService
- type GroupDataService
- type GroupService
- func (u *GroupService) Create(ctx context.Context, req *groupsService.CreateReq) (*groupsService.CreateRes, error)
- func (u *GroupService) Delete(ctx context.Context, req *groupsService.DeleteReq) (*groupsService.DeleteRes, error)
- func (u *GroupService) Find(ctx context.Context, req *groupsService.FindReq) (*groupsService.FindRes, error)
- func (u *GroupService) Get(ctx context.Context, req *groupsService.GetReq) (*groupsService.GetRes, error)
- func (u *GroupService) Update(ctx context.Context, req *groupsService.UpdateReq) (*groupsService.UpdateRes, error)
- type TaskDataService
- type TaskService
- func (u *TaskService) Create(ctx context.Context, req *tasksService.CreateReq) (*tasksService.CreateRes, error)
- func (u *TaskService) Delete(ctx context.Context, req *tasksService.DeleteReq) (*tasksService.DeleteRes, error)
- func (u *TaskService) Find(ctx context.Context, req *tasksService.FindReq) (*tasksService.FindRes, error)
- func (u *TaskService) Get(ctx context.Context, req *tasksService.GetReq) (*tasksService.GetRes, error)
- func (u *TaskService) GetGroupTasks(ctx context.Context, req *tasksService.GetGroupTasksReq) (*tasksService.GetGroupTasksRes, error)
- func (u *TaskService) GetUserTasks(ctx context.Context, req *tasksService.GetUserTasksReq) (*tasksService.GetUserTasksRes, error)
- func (u *TaskService) Update(ctx context.Context, req *tasksService.UpdateReq) (*tasksService.UpdateRes, error)
- type TokenService
- func (a *TokenService) AdminTokenVerifyMiddleWare(authToken string) (bool, error)
- func (a *TokenService) BlacklistAuthToken(authToken string) error
- func (a *TokenService) GenerateToken(u *models.User, tType string) (string, error)
- func (a *TokenService) MemberTokenVerifyMiddleWare(authToken string) (bool, error)
- func (a *TokenService) RootAdminTokenVerifyMiddleWare(authToken string) (bool, error)
- type UserDataService
- type UserService
- func (u *UserService) Create(ctx context.Context, req *usersService.CreateReq) (*usersService.CreateRes, error)
- func (u *UserService) Delete(ctx context.Context, req *usersService.DeleteReq) (*usersService.DeleteRes, error)
- func (u *UserService) Find(ctx context.Context, req *usersService.FindReq) (*usersService.FindRes, error)
- func (u *UserService) Get(ctx context.Context, req *usersService.GetReq) (*usersService.GetRes, error)
- func (u *UserService) GetGroupUsers(ctx context.Context, req *usersService.GetGroupUsersReq) (*usersService.GetGroupUsersRes, error)
- func (u *UserService) Update(ctx context.Context, req *usersService.UpdateReq) (*usersService.UpdateRes, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthService ¶
type AuthService struct {
// contains filtered or unexported fields
}
AuthService gRPC Service
func NewAuthService ¶
func NewAuthService(log utilities.Logger, ts *TokenService, u UserDataService, g GroupDataService) *AuthService
NewAuthService constructs a UserService for controller gRPC service User requests
func (*AuthService) GenerateKey ¶
func (u *AuthService) GenerateKey(ctx context.Context, req *authService.Empty) (*authService.GenerateKeyRes, error)
GenerateKey is the handler function that generates 6 month API Key for a given user
func (*AuthService) Login ¶
func (u *AuthService) Login(ctx context.Context, req *authService.LoginReq) (*authService.LoginRes, error)
Login is the handler function that manages the user SignIn process
func (*AuthService) Logout ¶
func (u *AuthService) Logout(ctx context.Context, req *authService.Empty) (*authService.LogoutRes, error)
Logout is the handler function that ends a users session
func (*AuthService) Refresh ¶
func (u *AuthService) Refresh(ctx context.Context, req *authService.Empty) (*authService.RefreshRes, error)
Refresh is the handler function that refreshes a users JWT token
func (*AuthService) Register ¶
func (u *AuthService) Register(ctx context.Context, req *authService.RegisterReq) (*authService.RegisterRes, error)
Register handler function that registers a new user
func (*AuthService) UpdatePassword ¶
func (u *AuthService) UpdatePassword(ctx context.Context, req *authService.UpdatePasswordReq) (*authService.UpdatePasswordRes, error)
UpdatePassword is the handler function that manages the user password update process
type BlacklistDataService ¶
type BlacklistDataService interface { BlacklistAuthToken(authToken string) error CheckTokenBlacklist(authToken string) bool }
BlacklistDataService is an interface to database.BlacklistService
type FileDataService ¶
type FileDataService interface { FileCreate(g *models.File, content []byte) (*models.File, error) FileFind(g *models.File) (*models.File, error) FilesFind(g *models.File) ([]*models.File, error) FileDelete(g *models.File) (*models.File, error) FileDeleteMany(g []*models.File) error FileUpdate(g *models.File, content []byte) (*models.File, error) RetrieveFile(g *models.File) (*bytes.Buffer, error) FilesQuery(ctx context.Context, g *models.File, pagination *utilities.Pagination) (*models.FilesRes, error) }
FileDataService is an interface to database.FileService
type GroupDataService ¶
type GroupDataService interface { GroupCreate(g *models.Group) (*models.Group, error) GroupFind(g *models.Group) (*models.Group, error) GroupsFind(g *models.Group) ([]*models.Group, error) GroupDelete(g *models.Group) (*models.Group, error) GroupDeleteMany(g *models.Group) (*models.Group, error) GroupUpdate(g *models.Group) (*models.Group, error) GroupDocInsert(g *models.Group) (*models.Group, error) GroupsQuery(ctx context.Context, g *models.Group, pagination *utilities.Pagination) (*models.GroupsRes, error) }
GroupDataService is an interface to database.GroupService
type GroupService ¶
type GroupService struct {
// contains filtered or unexported fields
}
GroupService gRPC Service
func NewGroupService ¶
func NewGroupService(log utilities.Logger, ts *TokenService, u UserDataService, g GroupDataService, t TaskDataService, f FileDataService) *GroupService
NewGroupService constructs a GroupService for controller gRPC service Group requests
func (*GroupService) Create ¶
func (u *GroupService) Create(ctx context.Context, req *groupsService.CreateReq) (*groupsService.CreateRes, error)
Create is a New Group
func (*GroupService) Delete ¶
func (u *GroupService) Delete(ctx context.Context, req *groupsService.DeleteReq) (*groupsService.DeleteRes, error)
Delete is the handler function that deletes a group
func (*GroupService) Find ¶
func (u *GroupService) Find(ctx context.Context, req *groupsService.FindReq) (*groupsService.FindRes, error)
Find Groups from an input query
func (*GroupService) Get ¶
func (u *GroupService) Get(ctx context.Context, req *groupsService.GetReq) (*groupsService.GetRes, error)
Get a specific Group
func (*GroupService) Update ¶
func (u *GroupService) Update(ctx context.Context, req *groupsService.UpdateReq) (*groupsService.UpdateRes, error)
Update a Group
type TaskDataService ¶
type TaskDataService interface { TaskCreate(g *models.Task) (*models.Task, error) TaskFind(g *models.Task) (*models.Task, error) TasksFind(g *models.Task) ([]*models.Task, error) TaskDelete(g *models.Task) (*models.Task, error) TaskDeleteMany(g *models.Task) (*models.Task, error) TaskUpdate(g *models.Task) (*models.Task, error) TaskDocInsert(g *models.Task) (*models.Task, error) TasksQuery(ctx context.Context, g *models.Task, pagination *utilities.Pagination) (*models.TasksRes, error) }
TaskDataService is an interface to database.TaskService
type TaskService ¶
type TaskService struct {
// contains filtered or unexported fields
}
TaskService gRPC Service
func NewTaskService ¶
func NewTaskService(log utilities.Logger, ts *TokenService, u UserDataService, g GroupDataService, t TaskDataService, f FileDataService) *TaskService
NewTaskService constructs a TaskService for controller gRPC service Task requests
func (*TaskService) Create ¶
func (u *TaskService) Create(ctx context.Context, req *tasksService.CreateReq) (*tasksService.CreateRes, error)
Create a New Task
func (*TaskService) Delete ¶
func (u *TaskService) Delete(ctx context.Context, req *tasksService.DeleteReq) (*tasksService.DeleteRes, error)
Delete is the handler function that deletes a task
func (*TaskService) Find ¶
func (u *TaskService) Find(ctx context.Context, req *tasksService.FindReq) (*tasksService.FindRes, error)
Find Tasks from an input query
func (*TaskService) Get ¶
func (u *TaskService) Get(ctx context.Context, req *tasksService.GetReq) (*tasksService.GetRes, error)
Get a specific Task
func (*TaskService) GetGroupTasks ¶
func (u *TaskService) GetGroupTasks(ctx context.Context, req *tasksService.GetGroupTasksReq) (*tasksService.GetGroupTasksRes, error)
GetGroupTasks returns the tasks for a given groupId
func (*TaskService) GetUserTasks ¶
func (u *TaskService) GetUserTasks(ctx context.Context, req *tasksService.GetUserTasksReq) (*tasksService.GetUserTasksRes, error)
GetUserTasks returns the tasks for a given userId
func (*TaskService) Update ¶
func (u *TaskService) Update(ctx context.Context, req *tasksService.UpdateReq) (*tasksService.UpdateRes, error)
Update a Task
type TokenService ¶
type TokenService struct {
// contains filtered or unexported fields
}
TokenService is used by the app to manage db auth functionality
func NewTokenService ¶
func NewTokenService(uService UserDataService, gService GroupDataService, bService BlacklistDataService) *TokenService
NewTokenService is an exported function used to initialize a new authService struct
func (*TokenService) AdminTokenVerifyMiddleWare ¶
func (a *TokenService) AdminTokenVerifyMiddleWare(authToken string) (bool, error)
AdminTokenVerifyMiddleWare is used to verify that the requester is a valid admin
func (*TokenService) BlacklistAuthToken ¶
func (a *TokenService) BlacklistAuthToken(authToken string) error
BlacklistAuthToken is used to blacklist an unexpired token
func (*TokenService) GenerateToken ¶
GenerateToken outputs an auth token string for an inputted User
func (*TokenService) MemberTokenVerifyMiddleWare ¶
func (a *TokenService) MemberTokenVerifyMiddleWare(authToken string) (bool, error)
MemberTokenVerifyMiddleWare is used to verify that a requester is authenticated
func (*TokenService) RootAdminTokenVerifyMiddleWare ¶
func (a *TokenService) RootAdminTokenVerifyMiddleWare(authToken string) (bool, error)
RootAdminTokenVerifyMiddleWare is used to verify that the requester is a valid admin
type UserDataService ¶
type UserDataService interface { AuthenticateUser(u *models.User) (*models.User, error) UpdatePassword(u *models.User, CurrentPassword string, newPassword string) (*models.User, error) UserCreate(u *models.User) (*models.User, error) UserDelete(u *models.User) (*models.User, error) UserDeleteMany(u *models.User) (*models.User, error) UsersFind(u *models.User) ([]*models.User, error) UserFind(u *models.User) (*models.User, error) UserUpdate(u *models.User) (*models.User, error) UserDocInsert(u *models.User) (*models.User, error) UsersQuery(ctx context.Context, u *models.User, pagination *utilities.Pagination) (*models.UsersRes, error) }
UserDataService is an interface to database.UserService
type UserService ¶
type UserService struct {
// contains filtered or unexported fields
}
UserService gRPC Service
func NewUserService ¶
func NewUserService(log utilities.Logger, ts *TokenService, u UserDataService, g GroupDataService, t TaskDataService, f FileDataService) *UserService
NewUserService constructs a UserService for controller gRPC service User requests
func (*UserService) Create ¶
func (u *UserService) Create(ctx context.Context, req *usersService.CreateReq) (*usersService.CreateRes, error)
Create is a New User
func (*UserService) Delete ¶
func (u *UserService) Delete(ctx context.Context, req *usersService.DeleteReq) (*usersService.DeleteRes, error)
Delete is the handler function that deletes a user
func (*UserService) Find ¶
func (u *UserService) Find(ctx context.Context, req *usersService.FindReq) (*usersService.FindRes, error)
Find Users from an input query
func (*UserService) Get ¶
func (u *UserService) Get(ctx context.Context, req *usersService.GetReq) (*usersService.GetRes, error)
Get a specific User
func (*UserService) GetGroupUsers ¶
func (u *UserService) GetGroupUsers(ctx context.Context, req *usersService.GetGroupUsersReq) (*usersService.GetGroupUsersRes, error)
GetGroupUsers returns the users for a given groupId
func (*UserService) Update ¶
func (u *UserService) Update(ctx context.Context, req *usersService.UpdateReq) (*usersService.UpdateRes, error)
Update a User