1 import * as request from 'supertest'
2 import { makePostBodyRequest, makePutBodyRequest, updateAvatarRequest } from '../'
4 import { UserRole } from '../../../../shared/index'
5 import { NSFWPolicyType } from '../../../../shared/models/videos/nsfw-policy.type'
13 role: UserRole = UserRole.USER,
16 const path = '/api/v1/users'
21 email: username + '@example.com',
27 .set('Accept', 'application/json')
28 .set('Authorization', 'Bearer ' + accessToken)
30 .expect(specialStatus)
33 function registerUser (url: string, username: string, password: string, specialStatus = 204) {
34 const path = '/api/v1/users/register'
38 email: username + '@example.com'
43 .set('Accept', 'application/json')
45 .expect(specialStatus)
48 function getMyUserInformation (url: string, accessToken: string, specialStatus = 200) {
49 const path = '/api/v1/users/me'
53 .set('Accept', 'application/json')
54 .set('Authorization', 'Bearer ' + accessToken)
55 .expect(specialStatus)
56 .expect('Content-Type', /json/)
59 function getMyUserVideoQuotaUsed (url: string, accessToken: string, specialStatus = 200) {
60 const path = '/api/v1/users/me/video-quota-used'
64 .set('Accept', 'application/json')
65 .set('Authorization', 'Bearer ' + accessToken)
66 .expect(specialStatus)
67 .expect('Content-Type', /json/)
70 function getUserInformation (url: string, accessToken: string, userId: number) {
71 const path = '/api/v1/users/' + userId
75 .set('Accept', 'application/json')
76 .set('Authorization', 'Bearer ' + accessToken)
78 .expect('Content-Type', /json/)
81 function getMyUserVideoRating (url: string, accessToken: string, videoId: number | string, specialStatus = 200) {
82 const path = '/api/v1/users/me/videos/' + videoId + '/rating'
86 .set('Accept', 'application/json')
87 .set('Authorization', 'Bearer ' + accessToken)
88 .expect(specialStatus)
89 .expect('Content-Type', /json/)
92 function getUsersList (url: string, accessToken: string) {
93 const path = '/api/v1/users'
97 .set('Accept', 'application/json')
98 .set('Authorization', 'Bearer ' + accessToken)
100 .expect('Content-Type', /json/)
103 function getUsersListPaginationAndSort (url: string, accessToken: string, start: number, count: number, sort: string) {
104 const path = '/api/v1/users'
111 .set('Accept', 'application/json')
112 .set('Authorization', 'Bearer ' + accessToken)
114 .expect('Content-Type', /json/)
117 function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) {
118 const path = '/api/v1/users'
121 .delete(path + '/' + userId)
122 .set('Accept', 'application/json')
123 .set('Authorization', 'Bearer ' + accessToken)
124 .expect(expectedStatus)
127 function updateMyUser (options: {
130 newPassword?: string,
131 nsfwPolicy?: NSFWPolicyType,
133 autoPlayVideo?: boolean
134 displayName?: string,
137 const path = '/api/v1/users/me'
140 if (options.newPassword !== undefined && options.newPassword !== null) toSend['password'] = options.newPassword
141 if (options.nsfwPolicy !== undefined && options.nsfwPolicy !== null) toSend['nsfwPolicy'] = options.nsfwPolicy
142 if (options.autoPlayVideo !== undefined && options.autoPlayVideo !== null) toSend['autoPlayVideo'] = options.autoPlayVideo
143 if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
144 if (options.description !== undefined && options.description !== null) toSend['description'] = options.description
145 if (options.displayName !== undefined && options.displayName !== null) toSend['displayName'] = options.displayName
147 return makePutBodyRequest({
150 token: options.accessToken,
152 statusCodeExpected: 204
156 function updateMyAvatar (options: {
161 const path = '/api/v1/users/me/avatar/pick'
163 return updateAvatarRequest(Object.assign(options, { path }))
166 function updateUser (options: {
174 const path = '/api/v1/users/' + options.userId
177 if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
178 if (options.videoQuota !== undefined && options.videoQuota !== null) toSend['videoQuota'] = options.videoQuota
179 if (options.role !== undefined && options.role !== null) toSend['role'] = options.role
181 return makePutBodyRequest({
184 token: options.accessToken,
186 statusCodeExpected: 204
190 function askResetPassword (url: string, email: string) {
191 const path = '/api/v1/users/ask-reset-password'
193 return makePostBodyRequest({
197 statusCodeExpected: 204
201 function resetPassword (url: string, userId: number, verificationString: string, password: string, statusCodeExpected = 204) {
202 const path = '/api/v1/users/' + userId + '/reset-password'
204 return makePostBodyRequest({
207 fields: { password, verificationString },
212 // ---------------------------------------------------------------------------
217 getMyUserInformation,
218 getMyUserVideoRating,
219 getMyUserVideoQuotaUsed,
221 getUsersListPaginationAndSort,