server/tests/utils/users/users.ts

   1 import * as request from 'supertest'
   2 import { makePostBodyRequest, makePutBodyRequest, updateAvatarRequest } from '../'
   3
   4 import { UserRole } from '../../../../shared/index'
   5 import { NSFWPolicyType } from '../../../../shared/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) {
 116   const path = '/api/v1/users'
 117
 118   return request(url)
 119           .get(path)
 120           .query({ start })
 121           .query({ count })
 122           .query({ sort })
 123           .set('Accept', 'application/json')
 124           .set('Authorization', 'Bearer ' + accessToken)
 125           .expect(200)
 126           .expect('Content-Type', /json/)
 127 }
 128
 129 function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) {
 130   const path = '/api/v1/users'
 131
 132   return request(url)
 133           .delete(path + '/' + userId)
 134           .set('Accept', 'application/json')
 135           .set('Authorization', 'Bearer ' + accessToken)
 136           .expect(expectedStatus)
 137 }
 138
 139 function blockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204, reason?: string) {
 140   const path = '/api/v1/users'
 141   let body: any
 142   if (reason) body = { reason }
 143
 144   return request(url)
 145     .post(path + '/' + userId + '/block')
 146     .send(body)
 147     .set('Accept', 'application/json')
 148     .set('Authorization', 'Bearer ' + accessToken)
 149     .expect(expectedStatus)
 150 }
 151
 152 function unblockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) {
 153   const path = '/api/v1/users'
 154
 155   return request(url)
 156     .post(path + '/' + userId + '/unblock')
 157     .set('Accept', 'application/json')
 158     .set('Authorization', 'Bearer ' + accessToken)
 159     .expect(expectedStatus)
 160 }
 161
 162 function updateMyUser (options: {
 163   url: string
 164   accessToken: string,
 165   currentPassword?: string,
 166   newPassword?: string,
 167   nsfwPolicy?: NSFWPolicyType,
 168   email?: string,
 169   autoPlayVideo?: boolean
 170   displayName?: string,
 171   description?: string
 172 }) {
 173   const path = '/api/v1/users/me'
 174
 175   const toSend = {}
 176   if (options.currentPassword !== undefined && options.currentPassword !== null) toSend['currentPassword'] = options.currentPassword
 177   if (options.newPassword !== undefined && options.newPassword !== null) toSend['password'] = options.newPassword
 178   if (options.nsfwPolicy !== undefined && options.nsfwPolicy !== null) toSend['nsfwPolicy'] = options.nsfwPolicy
 179   if (options.autoPlayVideo !== undefined && options.autoPlayVideo !== null) toSend['autoPlayVideo'] = options.autoPlayVideo
 180   if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
 181   if (options.description !== undefined && options.description !== null) toSend['description'] = options.description
 182   if (options.displayName !== undefined && options.displayName !== null) toSend['displayName'] = options.displayName
 183
 184   return makePutBodyRequest({
 185     url: options.url,
 186     path,
 187     token: options.accessToken,
 188     fields: toSend,
 189     statusCodeExpected: 204
 190   })
 191 }
 192
 193 function updateMyAvatar (options: {
 194   url: string,
 195   accessToken: string,
 196   fixture: string
 197 }) {
 198   const path = '/api/v1/users/me/avatar/pick'
 199
 200   return updateAvatarRequest(Object.assign(options, { path }))
 201 }
 202
 203 function updateUser (options: {
 204   url: string
 205   userId: number,
 206   accessToken: string,
 207   email?: string,
 208   videoQuota?: number,
 209   videoQuotaDaily?: number,
 210   role?: UserRole
 211 }) {
 212   const path = '/api/v1/users/' + options.userId
 213
 214   const toSend = {}
 215   if (options.email !== undefined && options.email !== null) toSend['email'] = options.email
 216   if (options.videoQuota !== undefined && options.videoQuota !== null) toSend['videoQuota'] = options.videoQuota
 217   if (options.videoQuotaDaily !== undefined && options.videoQuotaDaily !== null) toSend['videoQuotaDaily'] = options.videoQuotaDaily
 218   if (options.role !== undefined && options.role !== null) toSend['role'] = options.role
 219
 220   return makePutBodyRequest({
 221     url: options.url,
 222     path,
 223     token: options.accessToken,
 224     fields: toSend,
 225     statusCodeExpected: 204
 226   })
 227 }
 228
 229 function askResetPassword (url: string, email: string) {
 230   const path = '/api/v1/users/ask-reset-password'
 231
 232   return makePostBodyRequest({
 233     url,
 234     path,
 235     fields: { email },
 236     statusCodeExpected: 204
 237   })
 238 }
 239
 240 function resetPassword (url: string, userId: number, verificationString: string, password: string, statusCodeExpected = 204) {
 241   const path = '/api/v1/users/' + userId + '/reset-password'
 242
 243   return makePostBodyRequest({
 244     url,
 245     path,
 246     fields: { password, verificationString },
 247     statusCodeExpected
 248   })
 249 }
 250
 251 function askSendVerifyEmail (url: string, email: string) {
 252   const path = '/api/v1/users/ask-send-verify-email'
 253
 254   return makePostBodyRequest({
 255     url,
 256     path,
 257     fields: { email },
 258     statusCodeExpected: 204
 259   })
 260 }
 261
 262 function verifyEmail (url: string, userId: number, verificationString: string, statusCodeExpected = 204) {
 263   const path = '/api/v1/users/' + userId + '/verify-email'
 264
 265   return makePostBodyRequest({
 266     url,
 267     path,
 268     fields: { verificationString },
 269     statusCodeExpected
 270   })
 271 }
 272
 273 // ---------------------------------------------------------------------------
 274
 275 export {
 276   createUser,
 277   registerUser,
 278   getMyUserInformation,
 279   getMyUserVideoRating,
 280   deleteMe,
 281   getMyUserVideoQuotaUsed,
 282   getUsersList,
 283   getUsersListPaginationAndSort,
 284   removeUser,
 285   updateUser,
 286   updateMyUser,
 287   getUserInformation,
 288   blockUser,
 289   unblockUser,
 290   askResetPassword,
 291   resetPassword,
 292   updateMyAvatar,
 293   askSendVerifyEmail,
 294   verifyEmail
 295 }