1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2021 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.demographics
21 
22 import org.make.core.Order
23 import org.make.core.demographics.{DemographicsCard, DemographicsCardId, LabelValue, LabelsValue}
24 import org.make.core.question.QuestionId
25 import org.make.core.reference.Language
26 import org.make.core.technical.{Multilingual, Pagination}
27 
28 import cats.data.NonEmptyList
29 import io.circe.Encoder
30 import io.circe.generic.semiauto.deriveEncoder
31 import io.swagger.annotations.ApiModelProperty
32 
33 import scala.annotation.meta.field
34 import scala.concurrent.Future
35 
36 trait DemographicsCardService {
37   def get(id: DemographicsCardId): Future[Option[DemographicsCard]]
38 
39   def list(
40     offset: Option[Pagination.Offset] = None,
41     end: Option[Pagination.End] = None,
42     sort: Option[String] = None,
43     order: Option[Order] = None,
44     languages: Option[List[Language]] = None,
45     dataType: Option[String] = None,
46     questionId: Option[QuestionId] = None
47   ): Future[Seq[DemographicsCard]]
48 
49   def create(
50     name: String,
51     layout: DemographicsCard.Layout,
52     dataType: String,
53     languages: NonEmptyList[Language],
54     titles: Multilingual[String],
55     parameters: NonEmptyList[LabelsValue],
56     questionId: QuestionId
57   ): Future[DemographicsCard]
58 
59   def update(
60     id: DemographicsCardId,
61     name: String,
62     layout: DemographicsCard.Layout,
63     dataType: String,
64     languages: NonEmptyList[Language],
65     titles: Multilingual[String],
66     parameters: NonEmptyList[LabelsValue],
67     questionId: QuestionId
68   ): Future[Option[DemographicsCard]]
69 
70   def delete(id: DemographicsCardId): Future[Unit]
71 
72   def count(
73     languages: Option[List[Language]] = None,
74     dataType: Option[String] = None,
75     questionId: Option[QuestionId] = None
76   ): Future[Int]
77   def generateToken(id: DemographicsCardId, questionId: QuestionId): String
78 
79   def isTokenValid(token: String, id: DemographicsCardId, questionId: QuestionId): Boolean
80 
81   def getOneRandomCardByQuestion(questionId: QuestionId): Future[Option[DemographicsCardResponse]]
82 
83   def getOrPickRandom(
84     maybeId: Option[DemographicsCardId],
85     maybeToken: Option[String],
86     questionId: QuestionId
87   ): Future[Option[DemographicsCardResponse]]
88 }
89 
90 trait DemographicsCardServiceComponent {
91   def demographicsCardService: DemographicsCardService
92 }
93 
94 final case class DemographicsCardForSequence(
95   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
96   id: DemographicsCardId,
97   name: String,
98   @(ApiModelProperty @field)(
99     dataType = "string",
100     allowableValues = DemographicsCard.Layout.swaggerAllowableValues,
101     required = true
102   )
103   layout: DemographicsCard.Layout,
104   title: String,
105   @(ApiModelProperty @field)(dataType = "object", required = true)
106   parameters: NonEmptyList[LabelValue],
107   token: String,
108   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
109   questionId: QuestionId
110 )
111 
112 object DemographicsCardForSequence {
113   implicit val encoder: Encoder[DemographicsCardForSequence] = deriveEncoder
114 
115   def apply(card: DemographicsCardResponse, language: Language): DemographicsCardForSequence =
116     DemographicsCardForSequence(
117       id = card.id,
118       name = card.name,
119       layout = card.layout,
120       title = card.titles.getTranslationUnsafe(language),
121       parameters = card.parameters.map(lv => LabelValue(lv.label.getTranslationUnsafe(language), lv.value)),
122       token = card.token,
123       questionId = card.questionId
124     )
125 }
126 
127 final case class DemographicsCardResponse(
128   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
129   id: DemographicsCardId,
130   name: String,
131   @(ApiModelProperty @field)(
132     dataType = "string",
133     allowableValues = DemographicsCard.Layout.swaggerAllowableValues,
134     required = true
135   )
136   layout: DemographicsCard.Layout,
137   titles: Multilingual[String],
138   @(ApiModelProperty @field)(dataType = "object", required = true)
139   parameters: NonEmptyList[LabelsValue],
140   token: String,
141   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
142   questionId: QuestionId
143 )
144 
145 object DemographicsCardResponse {
146   implicit val encoder: Encoder[DemographicsCardResponse] = deriveEncoder[DemographicsCardResponse]
147 
148   def apply(card: DemographicsCard, token: String): DemographicsCardResponse =
149     DemographicsCardResponse(
150       id = card.id,
151       name = card.name,
152       layout = card.layout,
153       titles = card.titles,
154       parameters = card.parameters,
155       token = token,
156       questionId = card.questionId
157     )
158 }