diff options
Diffstat (limited to 'shared/utils/users/users.ts')
-rw-r--r-- | shared/utils/users/users.ts | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/shared/utils/users/users.ts b/shared/utils/users/users.ts new file mode 100644 index 000000000..554e42c01 --- /dev/null +++ b/shared/utils/users/users.ts | |||
@@ -0,0 +1,298 @@ | |||
1 | import * as request from 'supertest' | ||
2 | import { makePostBodyRequest, makePutBodyRequest, updateAvatarRequest } from '../requests/requests' | ||
3 | |||
4 | import { UserRole } from '../../index' | ||
5 | import { NSFWPolicyType } from '../../models/videos/nsfw-policy.type' | ||
6 | |||
7 | function createUser ( | ||
8 | url: string, | ||
9 | accessToken: string, | ||
10 | username: string, | ||
11 | password: string, | ||
12 | videoQuota = 1000000, | ||
13 | videoQuotaDaily = -1, | ||
14 | role: UserRole = UserRole.USER, | ||
15 | specialStatus = 200 | ||
16 | ) { | ||
17 | const path = '/api/v1/users' | ||
18 | const body = { | ||
19 | username, | ||
20 | password, | ||
21 | role, | ||
22 | email: username + '@example.com', | ||
23 | videoQuota, | ||
24 | videoQuotaDaily | ||
25 | } | ||
26 | |||
27 | return request(url) | ||
28 | .post(path) | ||
29 | .set('Accept', 'application/json') | ||
30 | .set('Authorization', 'Bearer ' + accessToken) | ||
31 | .send(body) | ||
32 | .expect(specialStatus) | ||
33 | } | ||
34 | |||
35 | function registerUser (url: string, username: string, password: string, specialStatus = 204) { | ||
36 | const path = '/api/v1/users/register' | ||
37 | const body = { | ||
38 | username, | ||
39 | password, | ||
40 | email: username + '@example.com' | ||
41 | } | ||
42 | |||
43 | return request(url) | ||
44 | .post(path) | ||
45 | .set('Accept', 'application/json') | ||
46 | .send(body) | ||
47 | .expect(specialStatus) | ||
48 | } | ||
49 | |||
50 | function getMyUserInformation (url: string, accessToken: string, specialStatus = 200) { | ||
51 | const path = '/api/v1/users/me' | ||
52 | |||
53 | return request(url) | ||
54 | .get(path) | ||
55 | .set('Accept', 'application/json') | ||
56 | .set('Authorization', 'Bearer ' + accessToken) | ||
57 | .expect(specialStatus) | ||
58 | .expect('Content-Type', /json/) | ||
59 | } | ||
60 | |||
61 | function deleteMe (url: string, accessToken: string, specialStatus = 204) { | ||
62 | const path = '/api/v1/users/me' | ||
63 | |||
64 | return request(url) | ||
65 | .delete(path) | ||
66 | .set('Accept', 'application/json') | ||
67 | .set('Authorization', 'Bearer ' + accessToken) | ||
68 | .expect(specialStatus) | ||
69 | } | ||
70 | |||
71 | function getMyUserVideoQuotaUsed (url: string, accessToken: string, specialStatus = 200) { | ||
72 | const path = '/api/v1/users/me/video-quota-used' | ||
73 | |||
74 | return request(url) | ||
75 | .get(path) | ||
76 | .set('Accept', 'application/json') | ||
77 | .set('Authorization', 'Bearer ' + accessToken) | ||
78 | .expect(specialStatus) | ||
79 | .expect('Content-Type', /json/) | ||
80 | } | ||
81 | |||
82 | function getUserInformation (url: string, accessToken: string, userId: number) { | ||
83 | const path = '/api/v1/users/' + userId | ||
84 | |||
85 | return request(url) | ||
86 | .get(path) | ||
87 | .set('Accept', 'application/json') | ||
88 | .set('Authorization', 'Bearer ' + accessToken) | ||
89 | .expect(200) | ||
90 | .expect('Content-Type', /json/) | ||
91 | } | ||
92 | |||
93 | function getMyUserVideoRating (url: string, accessToken: string, videoId: number | string, specialStatus = 200) { | ||
94 | const path = '/api/v1/users/me/videos/' + videoId + '/rating' | ||
95 | |||
96 | return request(url) | ||
97 | .get(path) | ||
98 | .set('Accept', 'application/json') | ||
99 | .set('Authorization', 'Bearer ' + accessToken) | ||
100 | .expect(specialStatus) | ||
101 | .expect('Content-Type', /json/) | ||
102 | } | ||
103 | |||
104 | function getUsersList (url: string, accessToken: string) { | ||
105 | const path = '/api/v1/users' | ||
106 | |||
107 | return request(url) | ||
108 | .get(path) | ||
109 | .set('Accept', 'application/json') | ||
110 | .set('Authorization', 'Bearer ' + accessToken) | ||
111 | .expect(200) | ||
112 | .expect('Content-Type', /json/) | ||
113 | } | ||
114 | |||
115 | function getUsersListPaginationAndSort (url: string, accessToken: string, start: number, count: number, sort: string, search?: string) { | ||
116 | const path = '/api/v1/users' | ||
117 | |||
118 | return request(url) | ||
119 | .get(path) | ||
120 | .query({ start }) | ||
121 | .query({ count }) | ||
122 | .query({ sort }) | ||
123 | .query({ search }) | ||
124 | .set('Accept', 'application/json') | ||
125 | .set('Authorization', 'Bearer ' + accessToken) | ||
126 | .expect(200) | ||
127 | .expect('Content-Type', /json/) | ||
128 | } | ||
129 | |||
130 | function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) { | ||
131 | const path = '/api/v1/users' | ||
132 | |||
133 | return request(url) | ||
134 | .delete(path + '/' + userId) | ||
135 | .set('Accept', 'application/json') | ||
136 | .set('Authorization', 'Bearer ' + accessToken) | ||
137 | .expect(expectedStatus) | ||
138 | } | ||
139 | |||
140 | function blockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204, reason?: string) { | ||
141 | const path = '/api/v1/users' | ||
142 | let body: any | ||
143 | if (reason) body = { reason } | ||
144 | |||
145 | return request(url) | ||
146 | .post(path + '/' + userId + '/block') | ||
147 | .send(body) | ||
148 | .set('Accept', 'application/json') | ||
149 | .set('Authorization', 'Bearer ' + accessToken) | ||
150 | .expect(expectedStatus) | ||
151 | } | ||
152 | |||
153 | function unblockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) { | ||
154 | const path = '/api/v1/users' | ||
155 | |||
156 | return request(url) | ||
157 | .post(path + '/' + userId + '/unblock') | ||
158 | .set('Accept', 'application/json') | ||
159 | .set('Authorization', 'Bearer ' + accessToken) | ||
160 | .expect(expectedStatus) | ||
161 | } | ||
162 | |||
163 | function updateMyUser (options: { | ||
164 | url: string | ||
165 | accessToken: string, | ||
166 | currentPassword?: string, | ||
167 | newPassword?: string, | ||
168 | nsfwPolicy?: NSFWPolicyType, | ||
169 | email?: string, | ||
170 | autoPlayVideo?: boolean | ||
171 | displayName?: string, | ||
172 | description?: string | ||
173 | }) { | ||
174 | const path = '/api/v1/users/me' | ||
175 | |||
176 | const toSend = {} | ||
177 | if (options.currentPassword !== undefined && options.currentPassword !== null) toSend['currentPassword'] = options.currentPassword | ||
178 | if (options.newPassword !== undefined && options.newPassword !== null) toSend['password'] = options.newPassword | ||
179 | if (options.nsfwPolicy !== undefined && options.nsfwPolicy !== null) toSend['nsfwPolicy'] = options.nsfwPolicy | ||
180 | if (options.autoPlayVideo !== undefined && options.autoPlayVideo !== null) toSend['autoPlayVideo'] = options.autoPlayVideo | ||
181 | if (options.email !== undefined && options.email !== null) toSend['email'] = options.email | ||
182 | if (options.description !== undefined && options.description !== null) toSend['description'] = options.description | ||
183 | if (options.displayName !== undefined && options.displayName !== null) toSend['displayName'] = options.displayName | ||
184 | |||
185 | return makePutBodyRequest({ | ||
186 | url: options.url, | ||
187 | path, | ||
188 | token: options.accessToken, | ||
189 | fields: toSend, | ||
190 | statusCodeExpected: 204 | ||
191 | }) | ||
192 | } | ||
193 | |||
194 | function updateMyAvatar (options: { | ||
195 | url: string, | ||
196 | accessToken: string, | ||
197 | fixture: string | ||
198 | }) { | ||
199 | const path = '/api/v1/users/me/avatar/pick' | ||
200 | |||
201 | return updateAvatarRequest(Object.assign(options, { path })) | ||
202 | } | ||
203 | |||
204 | function updateUser (options: { | ||
205 | url: string | ||
206 | userId: number, | ||
207 | accessToken: string, | ||
208 | email?: string, | ||
209 | emailVerified?: boolean, | ||
210 | videoQuota?: number, | ||
211 | videoQuotaDaily?: number, | ||
212 | role?: UserRole | ||
213 | }) { | ||
214 | const path = '/api/v1/users/' + options.userId | ||
215 | |||
216 | const toSend = {} | ||
217 | if (options.email !== undefined && options.email !== null) toSend['email'] = options.email | ||
218 | if (options.emailVerified !== undefined && options.emailVerified !== null) toSend['emailVerified'] = options.emailVerified | ||
219 | if (options.videoQuota !== undefined && options.videoQuota !== null) toSend['videoQuota'] = options.videoQuota | ||
220 | if (options.videoQuotaDaily !== undefined && options.videoQuotaDaily !== null) toSend['videoQuotaDaily'] = options.videoQuotaDaily | ||
221 | if (options.role !== undefined && options.role !== null) toSend['role'] = options.role | ||
222 | |||
223 | return makePutBodyRequest({ | ||
224 | url: options.url, | ||
225 | path, | ||
226 | token: options.accessToken, | ||
227 | fields: toSend, | ||
228 | statusCodeExpected: 204 | ||
229 | }) | ||
230 | } | ||
231 | |||
232 | function askResetPassword (url: string, email: string) { | ||
233 | const path = '/api/v1/users/ask-reset-password' | ||
234 | |||
235 | return makePostBodyRequest({ | ||
236 | url, | ||
237 | path, | ||
238 | fields: { email }, | ||
239 | statusCodeExpected: 204 | ||
240 | }) | ||
241 | } | ||
242 | |||
243 | function resetPassword (url: string, userId: number, verificationString: string, password: string, statusCodeExpected = 204) { | ||
244 | const path = '/api/v1/users/' + userId + '/reset-password' | ||
245 | |||
246 | return makePostBodyRequest({ | ||
247 | url, | ||
248 | path, | ||
249 | fields: { password, verificationString }, | ||
250 | statusCodeExpected | ||
251 | }) | ||
252 | } | ||
253 | |||
254 | function askSendVerifyEmail (url: string, email: string) { | ||
255 | const path = '/api/v1/users/ask-send-verify-email' | ||
256 | |||
257 | return makePostBodyRequest({ | ||
258 | url, | ||
259 | path, | ||
260 | fields: { email }, | ||
261 | statusCodeExpected: 204 | ||
262 | }) | ||
263 | } | ||
264 | |||
265 | function verifyEmail (url: string, userId: number, verificationString: string, statusCodeExpected = 204) { | ||
266 | const path = '/api/v1/users/' + userId + '/verify-email' | ||
267 | |||
268 | return makePostBodyRequest({ | ||
269 | url, | ||
270 | path, | ||
271 | fields: { verificationString }, | ||
272 | statusCodeExpected | ||
273 | }) | ||
274 | } | ||
275 | |||
276 | // --------------------------------------------------------------------------- | ||
277 | |||
278 | export { | ||
279 | createUser, | ||
280 | registerUser, | ||
281 | getMyUserInformation, | ||
282 | getMyUserVideoRating, | ||
283 | deleteMe, | ||
284 | getMyUserVideoQuotaUsed, | ||
285 | getUsersList, | ||
286 | getUsersListPaginationAndSort, | ||
287 | removeUser, | ||
288 | updateUser, | ||
289 | updateMyUser, | ||
290 | getUserInformation, | ||
291 | blockUser, | ||
292 | unblockUser, | ||
293 | askResetPassword, | ||
294 | resetPassword, | ||
295 | updateMyAvatar, | ||
296 | askSendVerifyEmail, | ||
297 | verifyEmail | ||
298 | } | ||