This repository has been archived by the owner on Jun 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
140 lines (109 loc) · 5.39 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
*******************************************************************************
* Microservices simple task *
*******************************************************************************
UsersStorageService - is used for storing users.
PermissionsService - is used for storing the permissions list and relations
between permissions and users.
ManagementService - is used for managing (add/edit/delete) users and permissions
and for assigning permissions to users. Should have very simple graphic user
interface.
///////////////////////////////////////////////////////////////////////////////
/ UsersStorageService
///////////////////////////////////////////////////////////////////////////////
Business logic ----------------------------------------------------------------
-------------------------------------------------------------------------------
User
-- Id
-- FirstName
-- LastName
-- Email
-- Password (should be encrypted)
UserRepository
-- GetAllUsers()
-- AddOrReplaceUser(userId, newOrUpdatedUser)
-- DeleteUser()
Public API --------------------------------------------------------------------
-------------------------------------------------------------------------------
GET http://localhost:5000/users/list - returns all users from the DB.
POST http://localhost:5000/users/update/{userId}
+ request body {newOrUpdatedUser} - updates the user
if exists or add new user otherwise.
DELETE http://localhost:5000/users/delete/{userId} - deletes the user by id.
///////////////////////////////////////////////////////////////////////////////
/ PermissionsService
///////////////////////////////////////////////////////////////////////////////
Business logic ----------------------------------------------------------------
-------------------------------------------------------------------------------
Permission
-- Id
-- Name
UserPermissions
-- UserId
-- PermissionIds - the list of user's permission IDs.
PermissionUsers
-- PermissionId
-- UserIds - the list of the user IDs which have the permission.
PermissionRepository
-- GetAllPermissions()
-- GetUserPermissions(userId)
-- AddOrReplacePermission(permissionId, newOrUpdatedPermission)
-- DeletePermission(permissionId)
-- AssignPermission(permissionId, userId)
-- UnassignPermission(permissionId, userId)
Public API --------------------------------------------------------------------
-------------------------------------------------------------------------------
GET http://localhost:5001/permissions/list
- returns all permissions from the DB.
GET http://localhost:5001/permissions/list/{userId}
- returns the permissions for the user.
POST http://localhost:5001/permissions/update/{permissionId}
+ request body {newOrUpdatedPermission} - updates the permission
if exists or add new user otherwise.
POST http://localhost:5001/permissions/assign/{permissionId}/{userId}
- assigns the permission to the user.
POST http://localhost:5001/permissions/unassign/{permissionId}/{userId}
- unassigns the permission out of the user.
DELETE http://localhost:5001/permissions/delete/{permissionId}
- deletes the permission by id.
///////////////////////////////////////////////////////////////////////////////
/ ManagementService
///////////////////////////////////////////////////////////////////////////////
Users table:
- possibility to add a new user ("inline" or "popup" add mode)
- possibility to edit the user ("inline" or "popup" edit mode,
"Permissions" column is not editable)
- possibility to delete the user
Permissions table:
- possibility to add a new permission ("inline" or "popup" add mode)
- possibility to edit the permission ("inline" or "popup" edit mode)
- possibility to delete the permission
Assign/Unassign Permissions table:
- here must be possible to add/delete
- the permissions the result must be shown in the "Users" table
("Permissions" column)
-------------------------------------------------------------------------------
TODO list:
- Indexes
- Common library for common code
- Refresh changes in the tables without refresh page
- Unit tests
- Replace the HTTP interaction protocol between ManagementService
and PermissionsService or ManagementService and Users StorageService by MQTT.
-------------------------------------------------------------------------------
MIT License
Copyright (c) 2019 Alexey Bur'yanov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.