1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.user
21 
22 import enumeratum.values.{StringCirceEnum, StringEnum, StringEnumEntry}
23 import eu.timepit.refined.api.Refined
24 import eu.timepit.refined.boolean.{And, Or}
25 import eu.timepit.refined.collection.{Empty, MaxSize, NonEmpty}
26 import eu.timepit.refined.string.Url
27 import io.circe.generic.semiauto.{deriveCodec, deriveDecoder}
28 import io.circe.{Codec, Decoder, Encoder}
29 import io.circe.refined._
30 import io.swagger.annotations.ApiModelProperty
31 import org.make.api.technical.RequestHelper
32 import org.make.api.user.validation.UserProfileRequestValidation
33 import org.make.core.CirceFormatters
34 import org.make.core.Validation._
35 import org.make.core.profile.{Gender, Profile, SocioProfessionalCategory}
36 import org.make.core.proposal.ProposalId
37 import org.make.core.question.QuestionId
38 import org.make.core.reference.{Country, Language}
39 
40 import scala.annotation.meta.field
41 
42 final case class ProfileRequest(
43   @(ApiModelProperty @field)(dataType = "date", example = "1970-01-01") dateOfBirth: Option[BirthDate],
44   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png")
45   avatarUrl: Option[String Refined (Url And MaxSize[2048] And ValidHtml)],
46   profession: Option[String Refined ValidHtml],
47   phoneNumber: Option[String Refined ValidHtml],
48   @(ApiModelProperty @field)(dataType = "string")
49   description: Option[String Refined (MaxSize[450] And ValidHtml)],
50   @(ApiModelProperty @field)(dataType = "string", allowableValues = Gender.swaggerAllowableValues) gender: Option[
51     Gender
52   ],
53   genderName: Option[String Refined ValidHtml],
54   @(ApiModelProperty @field)(dataType = "string", example = "12345")
55   postalCode: Option[String Refined ValidHtml],
56   locale: Option[String Refined ValidHtml],
57   optInNewsletter: Boolean = true,
58   @(ApiModelProperty @field)(dataType = "string", allowableValues = SocioProfessionalCategory.swaggerAllowableValues)
59   socioProfessionalCategory: Option[SocioProfessionalCategory] = None,
60   @(ApiModelProperty @field)(dataType = "boolean") optInPartner: Option[Boolean] = None,
61   politicalParty: Option[String Refined ValidHtml],
62   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
63   website: Option[String Refined (Url And ValidHtml)]
64 ) {
65 
66   def mergeProfile(maybeProfile: Option[Profile]): Option[Profile] = maybeProfile match {
67     case None => toProfile
68     case Some(profile) =>
69       Some(
70         profile.copy(
71           dateOfBirth = dateOfBirth.map(_.birthDate).orElse(profile.dateOfBirth),
72           avatarUrl = RequestHelper.updateValue(profile.avatarUrl, avatarUrl.map(_.value)),
73           profession = RequestHelper.updateValue(profile.profession, profession.map(_.value)),
74           phoneNumber = RequestHelper.updateValue(profile.phoneNumber, phoneNumber.map(_.value)),
75           description = RequestHelper.updateValue(profile.description, description.map(_.value)),
76           gender = gender.orElse(profile.gender),
77           genderName = RequestHelper.updateValue(profile.genderName, genderName.map(_.value)),
78           postalCode = RequestHelper.updateValue(profile.postalCode, postalCode.map(_.value)),
79           locale = RequestHelper.updateValue(profile.locale, locale.map(_.value)),
80           optInNewsletter = optInNewsletter,
81           socioProfessionalCategory = socioProfessionalCategory.orElse(profile.socioProfessionalCategory),
82           optInPartner = optInPartner.orElse(profile.optInPartner),
83           politicalParty = RequestHelper.updateValue(profile.politicalParty, politicalParty.map(_.value)),
84           website = RequestHelper.updateValue(profile.website, website.map(_.value))
85         )
86       )
87   }
88 
89   def toProfile: Option[Profile] = Profile.parseProfile(
90     dateOfBirth = dateOfBirth.map(_.birthDate),
91     avatarUrl = avatarUrl.map(_.value),
92     profession = profession.map(_.value),
93     phoneNumber = phoneNumber.map(_.value),
94     description = description.map(_.value),
95     gender = gender,
96     genderName = genderName.map(_.value),
97     postalCode = postalCode.map(_.value),
98     locale = locale.map(_.value),
99     optInNewsletter = optInNewsletter,
100     socioProfessionalCategory = socioProfessionalCategory,
101     optInPartner = optInPartner,
102     politicalParty = politicalParty.map(_.value),
103     website = website.map(_.value)
104   )
105 }
106 
107 object ProfileRequest extends CirceFormatters {
108   implicit val codec: Codec[ProfileRequest] = deriveCodec[ProfileRequest]
109 
110   def validateProfileRequest(profileRequest: ProfileRequest): Unit = ()
111 }
112 
113 final case class RegisterUserRequest(
114   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
115   email: Email,
116   @(ApiModelProperty @field)(dataType = "string", example = "p4ssw0rd", required = true)
117   password: Password,
118   @(ApiModelProperty @field)(dataType = "date", example = "1970-01-01") dateOfBirth: BirthDate,
119   firstName: Option[Name],
120   lastName: Option[Name],
121   profession: Option[String Refined ValidHtml],
122   @(ApiModelProperty @field)(dataType = "string", example = "12345")
123   postalCode: Option[PostalCode],
124   @(ApiModelProperty @field)(dataType = "string", example = "FR") country: Country,
125   @(ApiModelProperty @field)(dataType = "string", example = "fr") language: Option[Language],
126   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
127   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language],
128   @(ApiModelProperty @field)(dataType = "boolean") optIn: Option[Boolean],
129   @(ApiModelProperty @field)(dataType = "string", allowableValues = Gender.swaggerAllowableValues) gender: Option[
130     Gender
131   ],
132   @(ApiModelProperty @field)(dataType = "string", allowableValues = SocioProfessionalCategory.swaggerAllowableValues)
133   socioProfessionalCategory: Option[SocioProfessionalCategory],
134   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
135   questionId: Option[QuestionId],
136   @(ApiModelProperty @field)(dataType = "boolean") optInPartner: Option[Boolean],
137   politicalParty: Option[String],
138   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
139   website: Option[String Refined Url],
140   @(ApiModelProperty @field)(dataType = "boolean") legalMinorConsent: Option[Boolean],
141   @(ApiModelProperty @field)(dataType = "boolean") legalAdvisorApproval: Option[Boolean],
142   @(ApiModelProperty @field)(dataType = "boolean") approvePrivacyPolicy: Option[Boolean]
143 ) extends UserProfileRequestValidation {
144   validate(
145     validateField(
146       "approvePrivacyPolicy",
147       "invalid_value",
148       approvePrivacyPolicy.exists(identity),
149       "Privacy policy must be approved."
150     )
151   )
152 }
153 
154 object RegisterUserRequest extends CirceFormatters {
155   @SuppressWarnings(Array("org.wartremover.warts.Option2Iterable"))
156   implicit val decoder: Decoder[RegisterUserRequest] = deriveDecoder[RegisterUserRequest]
157 }
158 
159 final case class UserProfileRequest(
160   firstName: Name,
161   lastName: Option[Name],
162   dateOfBirth: BirthDate,
163   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/logo.jpg")
164   avatarUrl: Option[String Refined Url],
165   profession: Option[String Refined ValidHtml],
166   description: Option[String Refined (ValidHtml And MaxSize[450])],
167   @(ApiModelProperty @field)(dataType = "string", example = "12345") postalCode: Option[PostalCode],
168   optInNewsletter: Boolean,
169   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
170   website: Option[String Refined Url],
171   @(ApiModelProperty @field)(dataType = "boolean") legalMinorConsent: Option[Boolean],
172   @(ApiModelProperty @field)(dataType = "boolean") legalAdvisorApproval: Option[Boolean],
173   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
174   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language]
175 ) extends UserProfileRequestValidation
176 
177 object UserProfileRequest extends CirceFormatters {
178   implicit val codec: Codec[UserProfileRequest] = deriveCodec[UserProfileRequest]
179 }
180 
181 final case class UpdateUserRequest(
182   @(ApiModelProperty @field)(dataType = "date", example = "1970-01-01") dateOfBirth: Option[BirthDate],
183   firstName: Option[Name],
184   lastName: Option[String],
185   organisationName: Option[Name],
186   profession: Option[String],
187   @(ApiModelProperty @field)(dataType = "string", example = "12345") postalCode: Option[PostalCode],
188   phoneNumber: Option[String Refined ValidHtml], // TODO: use google libphonenumber?
189   description: Option[String Refined (ValidHtml And MaxSize[450])],
190   @(ApiModelProperty @field)(dataType = "boolean") optInNewsletter: Option[Boolean],
191   @(ApiModelProperty @field)(dataType = "string", allowableValues = Gender.swaggerAllowableValues) gender: Option[
192     Gender
193   ],
194   genderName: Option[String],
195   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
196   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language],
197   socioProfessionalCategory: Option[SocioProfessionalCategory],
198   politicalParty: Option[String],
199   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
200   website: Option[String Refined Or[Url, Empty]]
201 )
202 
203 object UpdateUserRequest extends CirceFormatters {
204   implicit val decoder: Decoder[UpdateUserRequest] = deriveDecoder[UpdateUserRequest]
205 }
206 
207 sealed abstract class SocialProvider(val value: String) extends StringEnumEntry
208 
209 object SocialProvider extends StringEnum[SocialProvider] with StringCirceEnum[SocialProvider] {
210   case object GooglePeople extends SocialProvider("google_people")
211   case object Facebook extends SocialProvider("facebook")
212   case object OpenIDConnect extends SocialProvider("oidc")
213 
214   override val values: IndexedSeq[SocialProvider] = findValues
215   final val swaggerAllowableValues = "google_people,facebook,oidc"
216 
217   implicit val decoder: Decoder[SocialProvider] =
218     Decoder.decodeString.emap { t =>
219       valuesToEntriesMap.get(t).toRight(s"invalid social provider: $t")
220     }
221   implicit val encoder: Encoder[SocialProvider] =
222     Encoder.encodeString.contramap(_.value)
223 }
224 
225 final case class SocialLoginRequest(
226   @(ApiModelProperty @field)(
227     dataType = "string",
228     allowableValues = SocialProvider.swaggerAllowableValues,
229     required = true
230   )
231   provider: SocialProvider,
232   token: String,
233   @(ApiModelProperty @field)(dataType = "string", example = "FR") country: Country,
234   @(ApiModelProperty @field)(dataType = "string", example = "fr") language: Option[Language],
235   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
236   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language],
237   @(ApiModelProperty @field)(dataType = "boolean", example = "true") approvePrivacyPolicy: Option[Boolean],
238   @(ApiModelProperty @field)(dataType = "boolean", example = "true") optIn: Option[Boolean],
239   @(ApiModelProperty @field)(dataType = "string", example = "11111111-1111-1111-1111-111111111111") questionId: Option[
240     QuestionId
241   ],
242   @(ApiModelProperty @field)(dataType = "string", example = "https://make.org/callback") redirectUri: Option[String]
243 ) {
244   validate(
245     validateField(
246       "approvePrivacyPolicy",
247       key = "invalid_value",
248       condition = approvePrivacyPolicy.forall(identity),
249       message = "Privacy policy must be approved."
250     )
251   )
252 }
253 
254 object SocialLoginRequest {
255   implicit val decoder: Decoder[SocialLoginRequest] = deriveDecoder[SocialLoginRequest]
256 }
257 
258 final case class ResetPasswordRequest(
259   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
260   email: Email
261 )
262 
263 object ResetPasswordRequest {
264   implicit val decoder: Decoder[ResetPasswordRequest] = deriveDecoder[ResetPasswordRequest]
265 }
266 
267 final case class ResetPassword(resetToken: String Refined NonEmpty, password: Password)
268 
269 object ResetPassword {
270   implicit val decoder: Decoder[ResetPassword] = deriveDecoder[ResetPassword]
271 }
272 
273 final case class ChangePasswordRequest(actualPassword: Option[String], newPassword: Password)
274 
275 object ChangePasswordRequest {
276   implicit val decoder: Decoder[ChangePasswordRequest] = deriveDecoder[ChangePasswordRequest]
277 }
278 
279 final case class DeleteUserRequest(password: Option[String])
280 
281 object DeleteUserRequest {
282   implicit val decoder: Decoder[DeleteUserRequest] = deriveDecoder[DeleteUserRequest]
283 }
284 
285 final case class SubscribeToNewsLetter(
286   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
287   email: Email
288 )
289 
290 object SubscribeToNewsLetter {
291   implicit val decoder: Decoder[SubscribeToNewsLetter] = deriveDecoder[SubscribeToNewsLetter]
292 }
293 
294 final case class ResendValidationEmailRequest(
295   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
296   email: String
297 )
298 
299 object ResendValidationEmailRequest {
300   implicit val decoder: Decoder[ResendValidationEmailRequest] = deriveDecoder[ResendValidationEmailRequest]
301 }
302 
303 final case class SendProposerEmailRequest(
304   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
305   proposalId: ProposalId,
306   @(ApiModelProperty @field)(dataType = "string", example = "hyd bud?", required = true)
307   text: String,
308   @(ApiModelProperty @field)(dataType = "boolean", example = "false", required = true)
309   dryRun: Boolean
310 )
311 
312 object SendProposerEmailRequest {
313   implicit val decoder: Codec[SendProposerEmailRequest] = deriveCodec
314 }
315 
316 final case class PrivacyPolicyRequest(
317   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
318   email: String,
319   password: String
320 )
321 
322 object PrivacyPolicyRequest {
323   implicit val codec: Codec[PrivacyPolicyRequest] = deriveCodec
324 }
325 
326 final case class SocialPrivacyPolicyRequest(
327   @(ApiModelProperty @field)(
328     dataType = "string",
329     allowableValues = SocialProvider.swaggerAllowableValues,
330     required = true
331   )
332   provider: SocialProvider,
333   token: String,
334   questionId: Option[QuestionId],
335   redirectUri: Option[String]
336 )
337 
338 object SocialPrivacyPolicyRequest {
339   implicit val decoder: Decoder[SocialPrivacyPolicyRequest] = deriveDecoder[SocialPrivacyPolicyRequest]
340 }
341 
342 final case class SocialInfosRequest(
343   @(ApiModelProperty @field)(
344     dataType = "string",
345     allowableValues = SocialProvider.swaggerAllowableValues,
346     required = true
347   )
348   provider: SocialProvider,
349   token: String
350 )
351 
352 object SocialInfosRequest {
353   implicit val decoder: Decoder[SocialInfosRequest] = deriveDecoder[SocialInfosRequest]
354 }
355 
356 final case class CheckRegistrationRequest(
357   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
358   email: Email,
359   password: Password
360 )
361 
362 object CheckRegistrationRequest {
363   implicit val codec: Codec[CheckRegistrationRequest] = deriveCodec
364 }