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.history
21 
22 import java.time.ZonedDateTime
23 
24 import enumeratum.values.{StringEnum, StringEnumEntry}
25 import org.make.core.SprayJsonFormatters._
26 import org.make.core.proposal.{ProposalId, QualificationKey, VoteKey}
27 import spray.json.DefaultJsonProtocol._
28 import spray.json.{DefaultJsonProtocol, RootJsonFormat}
29 
30 object HistoryActions {
31 
32   sealed abstract class VoteTrust(val value: String) extends StringEnumEntry with Product with Serializable {
33     def isTrusted: Boolean
34     def isInSequence: Boolean
35     def isInSegment: Boolean
36   }
37 
38   object VoteTrust extends StringEnum[VoteTrust] {
39 
40     case object Trusted extends VoteTrust("trusted") {
41       override val isTrusted: Boolean = true
42       override val isInSequence: Boolean = false
43       override val isInSegment: Boolean = false
44     }
45 
46     case object Troll extends VoteTrust("troll") {
47       override val isTrusted: Boolean = false
48       override val isInSequence: Boolean = false
49       override val isInSegment: Boolean = false
50     }
51 
52     case object Sequence extends VoteTrust("sequence") {
53       override val isTrusted: Boolean = true
54       override val isInSequence: Boolean = true
55       override val isInSegment: Boolean = false
56     }
57 
58     case object Segment extends VoteTrust("segment") {
59       override val isTrusted: Boolean = true
60       override val isInSequence: Boolean = true
61       override val isInSegment: Boolean = true
62     }
63 
64     override val values: IndexedSeq[VoteTrust] = findValues
65 
66   }
67 
68   final case class VoteAndQualifications(
69     voteKey: VoteKey,
70     qualificationKeys: Map[QualificationKey, VoteTrust],
71     date: ZonedDateTime,
72     trust: VoteTrust
73   )
74 
75   object VoteAndQualifications {
76     implicit val formatter: RootJsonFormat[VoteAndQualifications] =
77       DefaultJsonProtocol.jsonFormat4(VoteAndQualifications.apply)
78   }
79 
80   sealed trait VoteRelatedAction extends Product with Serializable {
81     def proposalId: ProposalId
82     def date: ZonedDateTime
83     def trust: VoteTrust
84   }
85 
86   sealed trait GenericVoteAction extends VoteRelatedAction {
87     def key: VoteKey
88   }
89 
90   sealed trait GenericQualificationAction extends VoteRelatedAction {
91     def key: QualificationKey
92   }
93 
94   final case class VoteAction(proposalId: ProposalId, date: ZonedDateTime, key: VoteKey, trust: VoteTrust)
95       extends GenericVoteAction
96   final case class UnvoteAction(proposalId: ProposalId, date: ZonedDateTime, key: VoteKey, trust: VoteTrust)
97       extends GenericVoteAction
98   final case class QualificationAction(
99     proposalId: ProposalId,
100     date: ZonedDateTime,
101     key: QualificationKey,
102     trust: VoteTrust
103   ) extends GenericQualificationAction
104   final case class UnqualificationAction(
105     proposalId: ProposalId,
106     date: ZonedDateTime,
107     key: QualificationKey,
108     trust: VoteTrust
109   ) extends GenericQualificationAction
110 
111 }