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.Decoder
25 import io.circe.generic.semiauto.deriveDecoder
26 import io.swagger.annotations.ApiModelProperty
27 import org.make.core.question.QuestionId
28 import org.make.core.sequence._
29 import org.make.core.technical.RefinedTypes.Ratio
30 
31 import scala.annotation.meta.field
32 
33 final case class SequenceConfigurationRequest(
34   main: ExplorationSequenceConfigurationRequest,
35   controversial: SpecificSequenceConfigurationRequest,
36   popular: SpecificSequenceConfigurationRequest,
37   keyword: SpecificSequenceConfigurationRequest,
38   @(ApiModelProperty @field)(dataType = "int", example = "100", required = true) newProposalsVoteThreshold: Int,
39   @(ApiModelProperty @field)(dataType = "double", example = "0.8")
40   testedProposalsEngagementThreshold: Option[Double],
41   @(ApiModelProperty @field)(dataType = "double", example = "0.0")
42   testedProposalsScoreThreshold: Option[Double],
43   @(ApiModelProperty @field)(dataType = "double", example = "0.0") testedProposalsControversyThreshold: Option[Double],
44   @(ApiModelProperty @field)(dataType = "int", example = "1500") testedProposalsMaxVotesThreshold: Option[Int],
45   @(ApiModelProperty @field)(dataType = "double", example = "0.5", required = true) nonSequenceVotesWeight: Double
46 ) {
47 
48   def toSequenceConfiguration(questionId: QuestionId): SequenceConfiguration = {
49     SequenceConfiguration(
50       questionId = questionId,
51       mainSequence = main.toExplorationConfiguration,
52       controversial = controversial.toSpecificSequenceConfiguration,
53       popular = popular.toSpecificSequenceConfiguration,
54       keyword = keyword.toSpecificSequenceConfiguration,
55       newProposalsVoteThreshold = newProposalsVoteThreshold,
56       testedProposalsEngagementThreshold = testedProposalsEngagementThreshold,
57       testedProposalsScoreThreshold = testedProposalsScoreThreshold,
58       testedProposalsControversyThreshold = testedProposalsControversyThreshold,
59       testedProposalsMaxVotesThreshold = testedProposalsMaxVotesThreshold,
60       nonSequenceVotesWeight = nonSequenceVotesWeight
61     )
62   }
63 }
64 
65 object SequenceConfigurationRequest {
66   implicit val decoder: Decoder[SequenceConfigurationRequest] = deriveDecoder[SequenceConfigurationRequest]
67 }
68 
69 final case class ExplorationSequenceConfigurationRequest(
70   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
71   explorationSequenceConfigurationId: ExplorationSequenceConfigurationId,
72   @(ApiModelProperty @field)(dataType = "int", example = "12", required = true, allowableValues = "range[1, infinity]")
73   sequenceSize: PosInt,
74   @(ApiModelProperty @field)(
75     dataType = "int",
76     example = "1000",
77     required = true,
78     allowableValues = "range[1, infinity]"
79   )
80   maxTestedProposalCount: PosInt,
81   @(ApiModelProperty @field)(dataType = "double", example = "0.5", required = true, allowableValues = "range[0, 1]")
82   newRatio: Ratio,
83   @(ApiModelProperty @field)(dataType = "double", example = "0.1", required = true, allowableValues = "range[0, 1]")
84   controversyRatio: Ratio,
85   @(ApiModelProperty @field)(
86     dataType = "string",
87     allowableValues = ExplorationSortAlgorithm.swaggerAllowableValues,
88     required = true
89   )
90   topSorter: ExplorationSortAlgorithm,
91   @(ApiModelProperty @field)(
92     dataType = "string",
93     allowableValues = ExplorationSortAlgorithm.swaggerAllowableValues,
94     required = true
95   )
96   controversySorter: ExplorationSortAlgorithm,
97   @(ApiModelProperty @field)(dataType = "double", example = "0.2", required = true, allowableValues = "range[0, 1]")
98   keywordsThreshold: Ratio,
99   @(ApiModelProperty @field)(dataType = "int", example = "2", required = true)
100   candidatesPoolSize: Int,
101   @(ApiModelProperty @field)(dataType = "double", example = "0.6", required = true)
102   strongOpinionThreshold: Ratio,
103   @(ApiModelProperty @field)(dataType = "double", example = "0.4", required = true)
104   neutralOpinionThreshold: Ratio,
105   @(ApiModelProperty @field)(dataType = "double", example = "0.15", required = true)
106   weakOpinionThreshold: Ratio
107 ) {
108   def toExplorationConfiguration: ExplorationSequenceConfiguration = ExplorationSequenceConfiguration(
109     explorationSequenceConfigurationId = explorationSequenceConfigurationId,
110     sequenceSize = sequenceSize,
111     maxTestedProposalCount = maxTestedProposalCount,
112     newRatio = newRatio,
113     controversyRatio = controversyRatio,
114     topSorter = topSorter,
115     controversySorter = controversySorter,
116     keywordsThreshold = keywordsThreshold,
117     candidatesPoolSize = candidatesPoolSize,
118     sequenceThresholds = ExplorationSequenceConfiguration
119       .SequenceThresholds(strongOpinionThreshold, neutralOpinionThreshold, weakOpinionThreshold)
120   )
121 }
122 
123 object ExplorationSequenceConfigurationRequest {
124   implicit val decoder: Decoder[ExplorationSequenceConfigurationRequest] = deriveDecoder
125 }
126 
127 final case class SpecificSequenceConfigurationRequest(
128   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
129   specificSequenceConfigurationId: SpecificSequenceConfigurationId,
130   @(ApiModelProperty @field)(dataType = "int", example = "12", required = true, allowableValues = "range[1, infinity]")
131   sequenceSize: PosInt,
132   @(ApiModelProperty @field)(dataType = "double", example = "0.5", required = true, allowableValues = "range[0, 1]")
133   newProposalsRatio: Double,
134   @(ApiModelProperty @field)(
135     dataType = "int",
136     example = "1000",
137     required = true,
138     allowableValues = "range[1, infinity]"
139   )
140   maxTestedProposalCount: PosInt,
141   @(ApiModelProperty @field)(
142     dataType = "string",
143     required = true,
144     allowableValues = SelectionAlgorithmName.swaggerAllowableValues
145   )
146   selectionAlgorithmName: SelectionAlgorithmName
147 ) {
148   def toSpecificSequenceConfiguration: SpecificSequenceConfiguration = {
149     SpecificSequenceConfiguration(
150       specificSequenceConfigurationId = specificSequenceConfigurationId,
151       sequenceSize = sequenceSize,
152       newProposalsRatio = newProposalsRatio,
153       maxTestedProposalCount = maxTestedProposalCount,
154       selectionAlgorithmName = selectionAlgorithmName
155     )
156   }
157 }
158 
159 object SpecificSequenceConfigurationRequest {
160   implicit val decoder: Decoder[SpecificSequenceConfigurationRequest] =
161     deriveDecoder[SpecificSequenceConfigurationRequest]
162 }