1 import { isAbsolute, join } from 'path'
2 import * as request from 'supertest'
3 import { makePostBodyRequest, makeUploadRequest, makePutBodyRequest } from '../'
5 import { UserRole } from '../../../../shared/index'
6 import { NSFWPolicyType } from '../../../../shared/models/videos/nsfw-policy.type'
14 role: UserRole = UserRole.USER,
17 const path = '/api/v1/users'
22 email: username + '@example.com',
28 .set('Accept', 'application/json')
29 .set('Authorization', 'Bearer ' + accessToken)
31 .expect(specialStatus)
34 function registerUser (url: string, username: string, password: string, specialStatus = 204) {
35 const path = '/api/v1/users/register'
39 email: username + '@example.com'
44 .set('Accept', 'application/json')
46 .expect(specialStatus)
49 function getMyUserInformation (url: string, accessToken: string, specialStatus = 200) {
50 const path = '/api/v1/users/me'
54 .set('Accept', 'application/json')
55 .set('Authorization', 'Bearer ' + accessToken)
56 .expect(specialStatus)
57 .expect('Content-Type', /json/)
60 function getMyUserVideoQuotaUsed (url: string, accessToken: string, specialStatus = 200) {
61 const path = '/api/v1/users/me/video-quota-used'
65 .set('Accept', 'application/json')
66 .set('Authorization', 'Bearer ' + accessToken)
67 .expect(specialStatus)
68 .expect('Content-Type', /json/)
71 function getUserInformation (url: string, accessToken: string, userId: number) {
72 const path = '/api/v1/users/' + userId
76 .set('Accept', 'application/json')
77 .set('Authorization', 'Bearer ' + accessToken)
79 .expect('Content-Type', /json/)
82 function getMyUserVideoRating (url: string, accessToken: string, videoId: number | string, specialStatus = 200) {
83 const path = '/api/v1/users/me/videos/' + videoId + '/rating'
87 .set('Accept', 'application/json')
88 .set('Authorization', 'Bearer ' + accessToken)
89 .expect(specialStatus)
90 .expect('Content-Type', /json/)
93 function getUsersList (url: string, accessToken: string) {
94 const path = '/api/v1/users'
98 .set('Accept', 'application/json')
99 .set('Authorization', 'Bearer ' + accessToken)
101 .expect('Content-Type', /json/)
104 function getUsersListPaginationAndSort (url: string, accessToken: string, start: number, count: number, sort: string) {
105 const path = '/api/v1/users'
112 .set('Accept', 'application/json')
113 .set('Authorization', 'Bearer ' + accessToken)
115 .expect('Content-Type', /json/)
118 function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) {
119 const path = '/api/v1/users'
122 .delete(path + '/' + userId)
123 .set('Accept', 'application/json')
124 .set('Authorization', 'Bearer ' + accessToken)
125 .expect(expectedStatus)
128 function updateMyUser (options: {
131 newPassword?: string,
132 nsfwPolicy?: NSFWPolicyType,
134 autoPlayVideo?: boolean
135 displayName?: string,
138 const path = '/api/v1/users/me'
141 if (options.newPassword !== undefined && options.newPassword !== null) toSend['password'] = options.newPassword
142 if (options.nsfwPolicy !== undefined && options.nsfwPolicy !== null) toSend['nsfwPolicy'] = options.nsfwPolicy
143 if (options.autoPlayVideo !== undefined && options.autoPlayVideo !== null) toSend['autoPlayVideo'] = options.autoPlayVideo
144 if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
145 if (options.description !== undefined && options.description !== null) toSend['description'] = options.description
146 if (options.displayName !== undefined && options.displayName !== null) toSend['displayName'] = options.displayName
148 return makePutBodyRequest({
151 token: options.accessToken,
153 statusCodeExpected: 204
157 function updateMyAvatar (options: {
162 const path = '/api/v1/users/me/avatar/pick'
164 if (isAbsolute(options.fixture)) {
165 filePath = options.fixture
167 filePath = join(__dirname, '..', '..', 'fixtures', options.fixture)
170 return makeUploadRequest({
173 token: options.accessToken,
175 attaches: { avatarfile: filePath },
176 statusCodeExpected: 200
180 function updateUser (options: {
188 const path = '/api/v1/users/' + options.userId
191 if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
192 if (options.videoQuota !== undefined && options.videoQuota !== null) toSend['videoQuota'] = options.videoQuota
193 if (options.role !== undefined && options.role !== null) toSend['role'] = options.role
195 return makePutBodyRequest({
198 token: options.accessToken,
200 statusCodeExpected: 204
204 function askResetPassword (url: string, email: string) {
205 const path = '/api/v1/users/ask-reset-password'
207 return makePostBodyRequest({
211 statusCodeExpected: 204
215 function resetPassword (url: string, userId: number, verificationString: string, password: string, statusCodeExpected = 204) {
216 const path = '/api/v1/users/' + userId + '/reset-password'
218 return makePostBodyRequest({
221 fields: { password, verificationString },
226 // ---------------------------------------------------------------------------
231 getMyUserInformation,
232 getMyUserVideoRating,
233 getMyUserVideoQuotaUsed,
235 getUsersListPaginationAndSort,