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.question
21 
22 import java.time.ZonedDateTime
23 import cats.data.NonEmptyList
24 import eu.timepit.refined.api.Refined
25 import eu.timepit.refined.collection._
26 import io.circe.{Codec, Decoder, Encoder}
27 import io.circe.refined._
28 import io.swagger.annotations.{ApiModel, ApiModelProperty}
29 import org.make.core.CirceFormatters
30 import org.make.core.question.QuestionId
31 import io.circe.generic.semiauto.{deriveCodec, deriveDecoder, deriveEncoder}
32 import org.make.core.operation.indexed.IndexedOperationOfQuestion
33 import org.make.core.operation.{OperationId, OperationOfQuestion, QuestionTheme}
34 import org.make.core.profile.Gender
35 import org.make.core.reference.{Country, Language}
36 import org.make.core.user.UserId
37 
38 import scala.annotation.meta.field
39 
40 @ApiModel
41 final case class SimpleQuestionResponse(
42   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
43   questionId: QuestionId,
44   slug: String,
45   @(ApiModelProperty @field)(dataType = "org.make.api.question.SimpleQuestionWordingResponse")
46   wording: SimpleQuestionWordingResponse,
47   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
48   countries: NonEmptyList[Country],
49   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
50   preferredLanguage: Option[Language],
51   returnedLanguage: Language,
52   startDate: ZonedDateTime,
53   endDate: ZonedDateTime
54 )
55 
56 object SimpleQuestionResponse extends CirceFormatters {
57 
58   implicit val codec: Codec[SimpleQuestionResponse] = deriveCodec
59 }
60 
61 final case class SimpleQuestionWordingResponse(title: String, question: String Refined NonEmpty)
62 
63 object SimpleQuestionWordingResponse extends CirceFormatters {
64 
65   implicit val codec: Codec[SimpleQuestionWordingResponse] = deriveCodec
66 }
67 
68 final case class QuestionPersonalityResponseWithTotal(total: Int, results: Seq[QuestionPersonalityResponse])
69 
70 object QuestionPersonalityResponseWithTotal {
71 
72   implicit val codec: Codec[QuestionPersonalityResponseWithTotal] = deriveCodec
73 }
74 
75 final case class QuestionPersonalityResponse(
76   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true) userId: UserId,
77   firstName: Option[String],
78   lastName: Option[String],
79   politicalParty: Option[String],
80   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png") avatarUrl: Option[String],
81   @(ApiModelProperty @field)(dataType = "string", allowableValues = Gender.swaggerAllowableValues) gender: Option[
82     String
83   ]
84 )
85 
86 object QuestionPersonalityResponse {
87   implicit val decoder: Decoder[QuestionPersonalityResponse] = deriveDecoder[QuestionPersonalityResponse]
88   implicit val encoder: Encoder[QuestionPersonalityResponse] = deriveEncoder[QuestionPersonalityResponse]
89 }
90 
91 final case class QuestionListResponse(results: Seq[QuestionOfOperationResponse], total: Long)
92 
93 object QuestionListResponse {
94   implicit val codec: Codec[QuestionListResponse] = deriveCodec[QuestionListResponse]
95 }
96 
97 final case class SearchQuestionsResponse(total: Long, results: Seq[SearchQuestionResponse])
98 
99 object SearchQuestionsResponse {
100   implicit val codec: Codec[SearchQuestionsResponse] = deriveCodec
101 }
102 
103 final case class SearchQuestionResponse(
104   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
105   questionId: QuestionId,
106   preferredLanguage: Option[Language],
107   returnedLanguage: Language,
108   question: String Refined NonEmpty,
109   slug: String,
110   questionShortTitle: Option[String Refined NonEmpty],
111   startDate: ZonedDateTime,
112   endDate: ZonedDateTime,
113   @(ApiModelProperty @field)(
114     dataType = "string",
115     required = true,
116     allowableValues = OperationOfQuestion.Status.swaggerAllowableValues
117   )
118   status: OperationOfQuestion.Status,
119   theme: QuestionTheme,
120   description: Option[String],
121   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/consultation-image.png")
122   consultationImage: Option[String],
123   @(ApiModelProperty @field)(dataType = "string", example = "consultation image alternative")
124   consultationImageAlt: Option[String Refined MaxSize[130]],
125   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/description-image.png")
126   descriptionImage: Option[String],
127   @(ApiModelProperty @field)(dataType = "string", example = "description image alternative")
128   descriptionImageAlt: Option[String Refined MaxSize[130]],
129   @(ApiModelProperty @field)(dataType = "list[string]", required = true)
130   countries: NonEmptyList[Country],
131   @(ApiModelProperty @field)(dataType = "string", example = "fr", required = true)
132   languages: NonEmptyList[Language],
133   defaultLanguage: Language,
134   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
135   operationId: OperationId,
136   operationTitle: String,
137   operationKind: String,
138   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/about")
139   aboutUrl: Option[String],
140   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/results")
141   resultsLink: Option[String],
142   proposalsCount: Int,
143   participantsCount: Int,
144   votesCount: Int,
145   actions: Option[String],
146   featured: Boolean,
147   @(ApiModelProperty @field)(dataType = "double") top20ConsensusThreshold: Option[Double]
148 )
149 
150 object SearchQuestionResponse extends CirceFormatters {
151   implicit val codec: Codec[SearchQuestionResponse] = deriveCodec
152 
153   def apply(
154     indexedOperationOfQuestion: IndexedOperationOfQuestion,
155     preferredLanguage: Option[Language]
156   ): SearchQuestionResponse = {
157     val returnedLanguage = preferredLanguage.fold(indexedOperationOfQuestion.defaultLanguage)(
158       lang =>
159         indexedOperationOfQuestion.languages
160           .find(language => language.value == lang.value)
161           .getOrElse(indexedOperationOfQuestion.defaultLanguage)
162     )
163     SearchQuestionResponse(
164       questionId = indexedOperationOfQuestion.questionId,
165       preferredLanguage = preferredLanguage,
166       returnedLanguage = returnedLanguage,
167       question = indexedOperationOfQuestion.questions.getTranslationUnsafe(returnedLanguage),
168       slug = indexedOperationOfQuestion.slug,
169       questionShortTitle = indexedOperationOfQuestion.questionShortTitles.flatMap(_.getTranslation(returnedLanguage)),
170       startDate = indexedOperationOfQuestion.startDate,
171       endDate = indexedOperationOfQuestion.endDate,
172       status = indexedOperationOfQuestion.status,
173       theme = indexedOperationOfQuestion.theme,
174       description = indexedOperationOfQuestion.descriptions.flatMap(_.getTranslation(returnedLanguage)),
175       consultationImage = indexedOperationOfQuestion.consultationImages.flatMap(_.getTranslation(returnedLanguage)),
176       consultationImageAlt =
177         indexedOperationOfQuestion.consultationImageAlts.flatMap(_.getTranslation(returnedLanguage)),
178       descriptionImage = indexedOperationOfQuestion.descriptionImages.flatMap(_.getTranslation(returnedLanguage)),
179       descriptionImageAlt = indexedOperationOfQuestion.descriptionImageAlts.flatMap(_.getTranslation(returnedLanguage)),
180       countries = indexedOperationOfQuestion.countries,
181       languages = indexedOperationOfQuestion.languages,
182       defaultLanguage = indexedOperationOfQuestion.defaultLanguage,
183       operationId = indexedOperationOfQuestion.operationId,
184       operationTitle = indexedOperationOfQuestion.operationTitles.getTranslationUnsafe(returnedLanguage),
185       operationKind = indexedOperationOfQuestion.operationKind,
186       aboutUrl = indexedOperationOfQuestion.aboutUrls.flatMap(_.getTranslation(returnedLanguage)),
187       resultsLink = indexedOperationOfQuestion.resultsLink,
188       proposalsCount = indexedOperationOfQuestion.proposalsCount,
189       participantsCount = indexedOperationOfQuestion.participantsCount,
190       votesCount = indexedOperationOfQuestion.votesCount,
191       actions = indexedOperationOfQuestion.actions,
192       featured = indexedOperationOfQuestion.featured,
193       top20ConsensusThreshold = indexedOperationOfQuestion.top20ConsensusThreshold
194     )
195   }
196 }