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 io.circe.Encoder
23 import io.circe.generic.semiauto.deriveEncoder
24 import org.make.api.demographics.DemographicsCardForSequence
25 import org.make.api.proposal.ProposalResponse
26 import org.make.core.proposal._
27 import org.make.core.question.Question
28 import org.make.core.user._
29 import org.make.core.RequestContext
30 import org.make.core.reference.Language
31 import org.make.core.demographics.DemographicsCardId
32 import org.make.core.proposal.indexed.IndexedProposal
33 import org.make.core.sequence.SequenceConfiguration
34 import org.make.core.session.SessionId
35 
36 import scala.concurrent.Future
37 
38 trait SequenceServiceComponent {
39   def sequenceService: SequenceService
40 }
41 
42 trait SequenceService {
43   def startNewSequence[T: SequenceBehaviourProvider](
44     behaviourParam: T,
45     maybeUserId: Option[UserId],
46     includedProposalsIds: Seq[ProposalId],
47     requestContext: RequestContext,
48     cardId: Option[DemographicsCardId],
49     token: Option[String],
50     configurationOverride: Option[SequenceConfiguration] = None,
51     preferredLanguage: Option[Language],
52     question: Question
53   ): Future[SequenceResult]
54 
55   def simpleSequence(
56     includedProposalsIds: Seq[ProposalId],
57     behaviour: SequenceBehaviour,
58     proposalsToExclude: Seq[ProposalId],
59     sessionId: Option[SessionId]
60   ): Future[Seq[IndexedProposal]]
61 }
62 
63 final case class SequenceResult(
64   proposals: Seq[ProposalResponse],
65   demographics: Seq[DemographicsCardForSequence],
66   sessionBindingMode: Boolean
67 )
68 
69 object SequenceResult {
70   implicit val encoder: Encoder[SequenceResult] = deriveEncoder
71 
72   val empty: SequenceResult =
73     SequenceResult(proposals = Seq.empty, demographics = Seq.empty, sessionBindingMode = false)
74 }