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.core.profile
21 
22 import java.time.LocalDate
23 import enumeratum.values.{StringCirceEnum, StringEnum, StringEnumEntry}
24 import io.circe.generic.semiauto._
25 import io.circe.{Decoder, Encoder}
26 import org.make.core.question.QuestionId
27 import org.make.core.CirceFormatters
28 import org.make.core.operation.OperationId
29 import org.make.core.reference.{Country, Language}
30 import org.make.core.technical.enumeratum.EnumKeys.StringEnumKeys
31 import org.make.core.user.OidcInfo
32 
33 sealed abstract class Gender(val value: String) extends StringEnumEntry
34 
35 object Gender extends StringEnum[Gender] with StringCirceEnum[Gender] with StringEnumKeys[Gender] {
36 
37   case object Male extends Gender("M")
38   case object Female extends Gender("F")
39   case object Other extends Gender("O")
40 
41   override val values: IndexedSeq[Gender] = findValues
42   final val swaggerAllowableValues = "M,F,O"
43 
44   implicit val decoder: Decoder[Gender] = Decoder.decodeString.emap { t =>
45     valuesToEntriesMap.get(t).toRight(s"gender should be on of this specified values: ${values.mkString(",")}")
46   }
47   implicit val encoder: Encoder[Gender] = Encoder.encodeString.contramap(_.value)
48 }
49 
50 sealed abstract class SocioProfessionalCategory(val value: String) extends StringEnumEntry
51 
52 object SocioProfessionalCategory
53     extends StringEnum[SocioProfessionalCategory]
54     with StringCirceEnum[SocioProfessionalCategory]
55     with StringEnumKeys[SocioProfessionalCategory] {
56 
57   case object Farmers extends SocioProfessionalCategory("FARM")
58 
59   case object ArtisansMerchantsCompanyDirector extends SocioProfessionalCategory("AMCD")
60 
61   case object ManagersAndHigherIntellectualOccupations extends SocioProfessionalCategory("MHIO")
62 
63   case object IntermediateProfessions extends SocioProfessionalCategory("INPR")
64 
65   case object Employee extends SocioProfessionalCategory("EMPL")
66 
67   case object Workers extends SocioProfessionalCategory("WORK")
68 
69   case object HighSchoolStudent extends SocioProfessionalCategory("HSTU")
70 
71   case object Student extends SocioProfessionalCategory("STUD")
72 
73   case object Apprentice extends SocioProfessionalCategory("APRE")
74 
75   case object Other extends SocioProfessionalCategory("O")
76 
77   override val values: IndexedSeq[SocioProfessionalCategory] = findValues
78   final val swaggerAllowableValues = "FARM,AMCD,MHIO,INPR,EMPL,WORK,HSTU,STUD,APRE,O"
79 
80   implicit val decoder: Decoder[SocioProfessionalCategory] = Decoder.decodeString.emap { t =>
81     valuesToEntriesMap
82       .get(t)
83       .toRight(s"CSP should be on of this specified values: ${values.mkString(",")}")
84   }
85   implicit val encoder: Encoder[SocioProfessionalCategory] = Encoder.encodeString.contramap(_.value)
86 }
87 
88 final case class Profile(
89   dateOfBirth: Option[LocalDate],
90   avatarUrl: Option[String],
91   profession: Option[String],
92   phoneNumber: Option[String],
93   description: Option[String],
94   twitterId: Option[String],
95   facebookId: Option[String],
96   googleId: Option[String],
97   oidcInfos: Option[Map[OperationId, OidcInfo]] = None,
98   gender: Option[Gender],
99   genderName: Option[String],
100   postalCode: Option[String],
101   karmaLevel: Option[Int],
102   locale: Option[String],
103   crmCountry: Country,
104   crmLanguage: Language,
105   optInNewsletter: Boolean = true,
106   socioProfessionalCategory: Option[SocioProfessionalCategory] = None,
107   registerQuestionId: Option[QuestionId] = None,
108   optInPartner: Option[Boolean] = None,
109   politicalParty: Option[String],
110   website: Option[String],
111   legalMinorConsent: Option[Boolean],
112   legalAdvisorApproval: Option[Boolean]
113 )
114 
115 object Profile extends CirceFormatters {
116 
117   implicit val encoder: Encoder[Profile] = deriveEncoder[Profile]
118   implicit val decoder: Decoder[Profile] = deriveDecoder[Profile]
119 
120   def parseProfile(
121     dateOfBirth: Option[LocalDate] = None,
122     avatarUrl: Option[String] = None,
123     profession: Option[String] = None,
124     phoneNumber: Option[String] = None,
125     description: Option[String] = None,
126     twitterId: Option[String] = None,
127     facebookId: Option[String] = None,
128     googleId: Option[String] = None,
129     oidcInfos: Option[Map[OperationId, OidcInfo]] = None,
130     gender: Option[Gender] = None,
131     genderName: Option[String] = None,
132     postalCode: Option[String] = None,
133     karmaLevel: Option[Int] = None,
134     locale: Option[String] = None,
135     crmCountry: Country = Country("FR"),
136     crmLanguage: Language = Language("fr"),
137     optInNewsletter: Boolean = true,
138     socioProfessionalCategory: Option[SocioProfessionalCategory] = None,
139     registerQuestionId: Option[QuestionId] = None,
140     optInPartner: Option[Boolean] = None,
141     politicalParty: Option[String] = None,
142     website: Option[String] = None,
143     legalMinorConsent: Option[Boolean] = None,
144     legalAdvisorApproval: Option[Boolean] = None
145   ): Some[Profile] = {
146 
147     val profile = Profile(
148       dateOfBirth = dateOfBirth,
149       avatarUrl = avatarUrl,
150       profession = profession,
151       phoneNumber = phoneNumber,
152       description = description,
153       twitterId = twitterId,
154       facebookId = facebookId,
155       googleId = googleId,
156       oidcInfos = oidcInfos,
157       gender = gender,
158       genderName = genderName,
159       postalCode = postalCode,
160       karmaLevel = karmaLevel,
161       locale = locale,
162       crmCountry = crmCountry,
163       crmLanguage = crmLanguage,
164       optInNewsletter = optInNewsletter,
165       socioProfessionalCategory = socioProfessionalCategory,
166       registerQuestionId = registerQuestionId,
167       optInPartner = optInPartner,
168       politicalParty = politicalParty,
169       website = website,
170       legalMinorConsent = legalMinorConsent,
171       legalAdvisorApproval = legalAdvisorApproval
172     )
173     Some(profile)
174   }
175 }