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.sequence
21 
22 import eu.timepit.refined.types.numeric.PosInt
23 import io.circe.refined._
24 import io.circe.Encoder
25 import io.circe.generic.semiauto.deriveEncoder
26 import io.swagger.annotations.{ApiModel, ApiModelProperty}
27 import org.make.api.demographics.DemographicsCardForSequence
28 import org.make.api.proposal.ProposalResponse
29 import org.make.core.question.QuestionId
30 import org.make.core.sequence.{
31   ExplorationSequenceConfiguration,
32   ExplorationSequenceConfigurationId,
33   ExplorationSortAlgorithm,
34   SelectionAlgorithmName,
35   SequenceConfiguration,
36   SpecificSequenceConfiguration,
37   SpecificSequenceConfigurationId
38 }
39 import org.make.core.technical.RefinedTypes.Ratio
40 
41 import scala.annotation.meta.field
42 
43 final case class ExplorationSequenceConfigurationResponse(
44   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
45   explorationSequenceConfigurationId: ExplorationSequenceConfigurationId,
46   @(ApiModelProperty @field)(dataType = "int", example = "12", allowableValues = "range[1, infinity]", required = true)
47   sequenceSize: PosInt,
48   @(ApiModelProperty @field)(
49     dataType = "int",
50     example = "1000",
51     allowableValues = "range[1, infinity]",
52     required = true
53   )
54   maxTestedProposalCount: PosInt,
55   @(ApiModelProperty @field)(dataType = "double", example = "0.5", allowableValues = "range[0, 1]", required = true)
56   newRatio: Ratio,
57   @(ApiModelProperty @field)(dataType = "double", example = "0.1", allowableValues = "range[0, 1]", required = true)
58   controversyRatio: Ratio,
59   @(ApiModelProperty @field)(
60     dataType = "string",
61     allowableValues = ExplorationSortAlgorithm.swaggerAllowableValues,
62     required = true
63   )
64   topSorter: ExplorationSortAlgorithm,
65   @(ApiModelProperty @field)(
66     dataType = "string",
67     allowableValues = ExplorationSortAlgorithm.swaggerAllowableValues,
68     required = true
69   )
70   controversySorter: ExplorationSortAlgorithm,
71   @(ApiModelProperty @field)(dataType = "double", example = "0.2", allowableValues = "range[0, 1]", required = true)
72   keywordsThreshold: Ratio,
73   @(ApiModelProperty @field)(dataType = "int", example = "2", required = true)
74   candidatesPoolSize: Int,
75   @(ApiModelProperty @field)(dataType = "double", example = "0.6", required = true)
76   strongOpinionThreshold: Ratio,
77   @(ApiModelProperty @field)(dataType = "double", example = "0.4", required = true)
78   neutralOpinionThreshold: Ratio,
79   @(ApiModelProperty @field)(dataType = "double", example = "0.15", required = true)
80   weakOpinionThreshold: Ratio
81 )
82 
83 object ExplorationSequenceConfigurationResponse {
84   implicit val encoder: Encoder[ExplorationSequenceConfigurationResponse] = deriveEncoder
85 
86   def fromExplorationConfiguration(conf: ExplorationSequenceConfiguration): ExplorationSequenceConfigurationResponse =
87     ExplorationSequenceConfigurationResponse(
88       explorationSequenceConfigurationId = conf.explorationSequenceConfigurationId,
89       sequenceSize = conf.sequenceSize,
90       maxTestedProposalCount = conf.maxTestedProposalCount,
91       newRatio = conf.newRatio,
92       controversyRatio = conf.controversyRatio,
93       topSorter = conf.topSorter,
94       controversySorter = conf.controversySorter,
95       keywordsThreshold = conf.keywordsThreshold,
96       candidatesPoolSize = conf.candidatesPoolSize,
97       strongOpinionThreshold = conf.sequenceThresholds.strongOpinion,
98       neutralOpinionThreshold = conf.sequenceThresholds.neutralOpinion,
99       weakOpinionThreshold = conf.sequenceThresholds.weakOpinion
100     )
101 }
102 
103 @ApiModel
104 final case class SequenceConfigurationResponse(
105   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
106   id: QuestionId,
107   main: ExplorationSequenceConfigurationResponse,
108   controversial: SpecificSequenceConfigurationResponse,
109   popular: SpecificSequenceConfigurationResponse,
110   keyword: SpecificSequenceConfigurationResponse,
111   @(ApiModelProperty @field)(dataType = "int", example = "100", allowableValues = "range[0, infinity]", required = true)
112   newProposalsVoteThreshold: Int,
113   @(ApiModelProperty @field)(dataType = "double", example = "0.8")
114   testedProposalsEngagementThreshold: Option[Double],
115   @(ApiModelProperty @field)(dataType = "double", example = "0.0")
116   testedProposalsScoreThreshold: Option[Double],
117   @(ApiModelProperty @field)(dataType = "double", example = "0.0")
118   testedProposalsControversyThreshold: Option[Double],
119   @(ApiModelProperty @field)(dataType = "int", example = "1500")
120   testedProposalsMaxVotesThreshold: Option[Int],
121   @(ApiModelProperty @field)(dataType = "double", example = "0.5", required = true)
122   nonSequenceVotesWeight: Double
123 )
124 
125 object SequenceConfigurationResponse {
126   implicit val encoder: Encoder[SequenceConfigurationResponse] = deriveEncoder[SequenceConfigurationResponse]
127 
128   def fromSequenceConfiguration(configuration: SequenceConfiguration): SequenceConfigurationResponse = {
129     SequenceConfigurationResponse(
130       id = configuration.questionId,
131       main = ExplorationSequenceConfigurationResponse.fromExplorationConfiguration(configuration.mainSequence),
132       controversial =
133         SpecificSequenceConfigurationResponse.fromSpecificSequenceConfiguration(configuration.controversial),
134       popular = SpecificSequenceConfigurationResponse.fromSpecificSequenceConfiguration(configuration.popular),
135       keyword = SpecificSequenceConfigurationResponse.fromSpecificSequenceConfiguration(configuration.keyword),
136       newProposalsVoteThreshold = configuration.newProposalsVoteThreshold,
137       testedProposalsEngagementThreshold = configuration.testedProposalsEngagementThreshold,
138       testedProposalsScoreThreshold = configuration.testedProposalsScoreThreshold,
139       testedProposalsControversyThreshold = configuration.testedProposalsControversyThreshold,
140       testedProposalsMaxVotesThreshold = configuration.testedProposalsMaxVotesThreshold,
141       nonSequenceVotesWeight = configuration.nonSequenceVotesWeight
142     )
143   }
144 }
145 
146 final case class SpecificSequenceConfigurationResponse(
147   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
148   specificSequenceConfigurationId: SpecificSequenceConfigurationId,
149   @(ApiModelProperty @field)(dataType = "int", example = "12", allowableValues = "range[1, infinity]", required = true)
150   sequenceSize: PosInt,
151   @(ApiModelProperty @field)(dataType = "double", example = "0.5", allowableValues = "range[0, 1]", required = true)
152   newProposalsRatio: Double,
153   @(ApiModelProperty @field)(
154     dataType = "int",
155     example = "1000",
156     allowableValues = "range[1, infinity]",
157     required = true
158   )
159   maxTestedProposalCount: PosInt,
160   @(ApiModelProperty @field)(
161     dataType = "string",
162     allowableValues = SelectionAlgorithmName.swaggerAllowableValues,
163     required = true
164   )
165   selectionAlgorithmName: SelectionAlgorithmName
166 )
167 
168 object SpecificSequenceConfigurationResponse {
169   implicit val encoder: Encoder[SpecificSequenceConfigurationResponse] = deriveEncoder
170 
171   def fromSpecificSequenceConfiguration(
172     configuration: SpecificSequenceConfiguration
173   ): SpecificSequenceConfigurationResponse = {
174     SpecificSequenceConfigurationResponse(
175       specificSequenceConfigurationId = configuration.specificSequenceConfigurationId,
176       sequenceSize = configuration.sequenceSize,
177       newProposalsRatio = configuration.newProposalsRatio,
178       maxTestedProposalCount = configuration.maxTestedProposalCount,
179       selectionAlgorithmName = configuration.selectionAlgorithmName
180     )
181   }
182 }
183 
184 final case class KeywordSequenceResult(
185   key: String,
186   label: String,
187   proposals: Seq[ProposalResponse],
188   demographics: Seq[DemographicsCardForSequence]
189 )
190 
191 object KeywordSequenceResult {
192   implicit val encoder: Encoder[KeywordSequenceResult] = deriveEncoder
193 }
194 
195 final case class FirstProposalResponse(
196   proposal: ProposalResponse,
197   @(ApiModelProperty @field)(dataType = "int", allowableValues = "range[1, infinity]", required = true)
198   sequenceSize: PosInt
199 )
200 
201 object FirstProposalResponse {
202   implicit val encoder: Encoder[FirstProposalResponse] = deriveEncoder[FirstProposalResponse]
203 }