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 java.time.{LocalDate, ZonedDateTime}
23 import io.circe.{Codec, Decoder, Encoder}
24 import io.circe.generic.semiauto.{deriveCodec, deriveDecoder, deriveEncoder}
25 import io.swagger.annotations.ApiModelProperty
26 import org.make.api.technical.auth.TokenResponse
27 import org.make.core.{CirceFormatters, EventId}
28 import org.make.core.profile.{Gender, Profile, SocioProfessionalCategory}
29 import org.make.core.question.QuestionId
30 import org.make.core.reference.{Country, Language}
31 import org.make.core.user.{MailingErrorLog, Role, User, UserId, UserType}
32 
33 import scala.annotation.meta.field
34 
35 final case class UserResponse(
36   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
37   userId: UserId,
38   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
39   email: String,
40   firstName: Option[String],
41   lastName: Option[String],
42   organisationName: Option[String],
43   enabled: Boolean,
44   emailVerified: Boolean,
45   isOrganisation: Boolean,
46   lastConnection: Option[ZonedDateTime],
47   @(ApiModelProperty @field)(dataType = "list[string]", required = true, allowableValues = Role.swaggerAllowableValues)
48   roles: Seq[Role],
49   profile: Option[ProfileResponse],
50   @(ApiModelProperty @field)(dataType = "string", example = "FR", required = true) country: Country,
51   isHardBounce: Boolean,
52   @(ApiModelProperty @field)(dataType = "org.make.api.user.MailingErrorLogResponse")
53   lastMailingError: Option[MailingErrorLogResponse],
54   hasPassword: Boolean,
55   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
56   followedUsers: Seq[UserId] = Seq.empty,
57   @(ApiModelProperty @field)(dataType = "string", allowableValues = UserType.swaggerAllowableValues, required = true)
58   userType: UserType
59 )
60 
61 object UserResponse extends CirceFormatters {
62   implicit val encoder: Encoder[UserResponse] = deriveEncoder[UserResponse]
63   implicit val decoder: Decoder[UserResponse] = deriveDecoder[UserResponse]
64 
65   def apply(user: User): UserResponse = UserResponse(user, Seq.empty)
66 
67   def apply(user: User, followedUsers: Seq[UserId]): UserResponse = UserResponse(
68     userId = user.userId,
69     email = user.email,
70     firstName = user.firstName,
71     lastName = user.lastName,
72     organisationName = user.organisationName,
73     enabled = user.enabled,
74     emailVerified = user.emailVerified,
75     isOrganisation = user.userType == UserType.UserTypeOrganisation,
76     lastConnection = user.lastConnection,
77     roles = user.roles,
78     profile = user.profile.map(ProfileResponse.fromProfile),
79     country = user.country,
80     isHardBounce = user.isHardBounce,
81     lastMailingError = user.lastMailingError.map(MailingErrorLogResponse(_)),
82     hasPassword = user.hashedPassword.isDefined,
83     followedUsers = followedUsers,
84     userType = user.userType
85   )
86 }
87 
88 final case class CurrentUserResponse(
89   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
90   userId: UserId,
91   @(ApiModelProperty @field)(dataType = "string", example = "yopmail+test@make.org", required = true)
92   email: String,
93   displayName: Option[String],
94   @(ApiModelProperty @field)(dataType = "string", required = true, allowableValues = UserType.swaggerAllowableValues)
95   userType: UserType,
96   @(ApiModelProperty @field)(dataType = "list[string]", required = true, allowableValues = Role.swaggerAllowableValues)
97   roles: Seq[Role],
98   hasPassword: Boolean,
99   enabled: Boolean,
100   emailVerified: Boolean,
101   @(ApiModelProperty @field)(dataType = "string", example = "FR", required = true)
102   country: Country,
103   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png")
104   avatarUrl: Option[String],
105   privacyPolicyApprovalDate: Option[ZonedDateTime],
106   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
107   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language],
108   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
109   availableEvents: Seq[EventId]
110 )
111 
112 object CurrentUserResponse {
113   implicit val encoder: Encoder[CurrentUserResponse] = deriveEncoder[CurrentUserResponse]
114   implicit val decoder: Decoder[CurrentUserResponse] = deriveDecoder[CurrentUserResponse]
115 }
116 
117 final case class UserProfileResponse(
118   email: String,
119   firstName: Option[String],
120   lastName: Option[String],
121   dateOfBirth: Option[LocalDate],
122   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png") avatarUrl: Option[String],
123   profession: Option[String],
124   description: Option[String],
125   @(ApiModelProperty @field)(dataType = "string", example = "12345") postalCode: Option[String],
126   optInNewsletter: Boolean,
127   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website") website: Option[String],
128   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Option[Country],
129   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Option[Language]
130 )
131 
132 object UserProfileResponse {
133   implicit val encoder: Encoder[UserProfileResponse] = deriveEncoder[UserProfileResponse]
134   implicit val decoder: Decoder[UserProfileResponse] = deriveDecoder[UserProfileResponse]
135 }
136 
137 final case class MailingErrorLogResponse(error: String, date: ZonedDateTime)
138 
139 object MailingErrorLogResponse extends CirceFormatters {
140   implicit val encoder: Encoder[MailingErrorLogResponse] = deriveEncoder[MailingErrorLogResponse]
141   implicit val decoder: Decoder[MailingErrorLogResponse] = deriveDecoder[MailingErrorLogResponse]
142 
143   def apply(mailingErrorLog: MailingErrorLog): MailingErrorLogResponse =
144     MailingErrorLogResponse(error = mailingErrorLog.error, date = mailingErrorLog.date)
145 }
146 
147 final case class ProfileResponse(
148   dateOfBirth: Option[LocalDate],
149   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png")
150   avatarUrl: Option[String],
151   profession: Option[String],
152   phoneNumber: Option[String],
153   description: Option[String],
154   @(ApiModelProperty @field)(dataType = "string", allowableValues = Gender.swaggerAllowableValues) gender: Option[
155     Gender
156   ],
157   genderName: Option[String],
158   @(ApiModelProperty @field)(dataType = "string", example = "12345")
159   postalCode: Option[String],
160   locale: Option[String],
161   optInNewsletter: Boolean = true,
162   @(ApiModelProperty @field)(dataType = "string", allowableValues = SocioProfessionalCategory.swaggerAllowableValues)
163   socioProfessionalCategory: Option[SocioProfessionalCategory] = None,
164   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
165   registerQuestionId: Option[QuestionId] = None,
166   @(ApiModelProperty @field)(dataType = "boolean") optInPartner: Option[Boolean] = None,
167   politicalParty: Option[String],
168   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
169   website: Option[String],
170   @(ApiModelProperty @field)(dataType = "string", example = "FR") crmCountry: Country,
171   @(ApiModelProperty @field)(dataType = "string", example = "fr") crmLanguage: Language
172 )
173 
174 object ProfileResponse extends CirceFormatters {
175   implicit val encoder: Encoder[ProfileResponse] = deriveEncoder[ProfileResponse]
176   implicit val decoder: Decoder[ProfileResponse] = deriveDecoder[ProfileResponse]
177 
178   def fromProfile(profile: Profile): ProfileResponse = {
179     ProfileResponse(
180       dateOfBirth = profile.dateOfBirth,
181       avatarUrl = profile.avatarUrl,
182       profession = profile.profession,
183       phoneNumber = profile.phoneNumber,
184       description = profile.description,
185       gender = profile.gender,
186       genderName = profile.genderName,
187       postalCode = profile.postalCode,
188       locale = profile.locale,
189       optInNewsletter = profile.optInNewsletter,
190       socioProfessionalCategory = profile.socioProfessionalCategory,
191       registerQuestionId = profile.registerQuestionId,
192       optInPartner = profile.optInPartner,
193       politicalParty = profile.politicalParty,
194       website = profile.website,
195       crmCountry = profile.crmCountry,
196       crmLanguage = profile.crmLanguage
197     )
198   }
199 }
200 
201 final case class SocialLoginResponse(
202   @(ApiModelProperty @field)(name = "token_type", required = true)
203   tokenType: String,
204   @(ApiModelProperty @field)(name = "access_token", required = true)
205   accessToken: String,
206   @(ApiModelProperty @field)(name = "expires_in", required = true)
207   expiresIn: Long,
208   @(ApiModelProperty @field)(name = "refresh_token", required = true)
209   refreshToken: Option[String],
210   @(ApiModelProperty @field)(name = "account_creation", required = true)
211   accountCreation: Boolean,
212   @(ApiModelProperty @field)(name = "refresh_expires_in", dataType = "int")
213   refreshExpiresIn: Option[Long],
214   @(ApiModelProperty @field)(name = "created_at", dataType = "dateTime", required = true)
215   createdAt: String
216 ) {
217 
218   def toTokenResponse: TokenResponse = {
219     TokenResponse(
220       tokenType = tokenType,
221       accessToken = accessToken,
222       expiresIn = expiresIn,
223       refreshToken = refreshToken,
224       refreshExpiresIn = refreshExpiresIn,
225       createdAt = createdAt
226     )
227   }
228 }
229 
230 object SocialLoginResponse {
231 
232   def apply(token: TokenResponse, accountCreation: Boolean): SocialLoginResponse = {
233     SocialLoginResponse(
234       tokenType = token.tokenType,
235       accessToken = token.accessToken,
236       expiresIn = token.expiresIn,
237       refreshToken = token.refreshToken,
238       accountCreation = accountCreation,
239       refreshExpiresIn = token.refreshExpiresIn,
240       createdAt = token.createdAt
241     )
242   }
243 
244   implicit val encoder: Encoder[SocialLoginResponse] =
245     Encoder.forProduct7(
246       "token_type",
247       "access_token",
248       "expires_in",
249       "refresh_token",
250       "account_creation",
251       "refresh_expires_in",
252       "created_at"
253     ) { response =>
254       (
255         response.tokenType,
256         response.accessToken,
257         response.expiresIn,
258         response.refreshToken,
259         response.accountCreation,
260         response.refreshExpiresIn,
261         response.createdAt
262       )
263     }
264 
265 }
266 
267 final case class UserPrivacyPolicyResponse(privacyPolicyApprovalDate: Option[ZonedDateTime])
268 
269 object UserPrivacyPolicyResponse extends CirceFormatters {
270   implicit val codec: Codec[UserPrivacyPolicyResponse] = deriveCodec
271 }