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
21 
22 import java.time.ZonedDateTime
23 import enumeratum.values.{StringCirceEnum, StringEnum, StringEnumEntry}
24 import io.circe.generic.semiauto._
25 import io.circe.{Codec, Decoder, Encoder}
26 import io.swagger.annotations.ApiModelProperty
27 import org.make.core.operation.OperationId
28 import org.make.core.question.QuestionId
29 import org.make.core.reference.{Country, Language}
30 import org.make.core.session.{SessionId, VisitorId}
31 import org.make.core.user.UserId
32 import spray.json.DefaultJsonProtocol._
33 import spray.json.{DefaultJsonProtocol, RootJsonFormat}
34 
35 import scala.annotation.meta.field
36 
37 sealed abstract class ApplicationName(val value: String) extends StringEnumEntry
38 
39 object ApplicationName extends StringEnum[ApplicationName] with StringCirceEnum[ApplicationName] {
40 
41   case object Backoffice extends ApplicationName("backoffice")
42 
43   case object AssemblyBackoffice extends ApplicationName("assembly-backoffice")
44 
45   case object BiBatchs extends ApplicationName("bi-batchs")
46 
47   case object Dial extends ApplicationName("dial")
48 
49   case object DialBatchs extends ApplicationName("dial-batchs")
50 
51   case object Infrastructure extends ApplicationName("infra")
52 
53   case object LegacyFrontend extends ApplicationName("legacy-front")
54 
55   case object MainFrontend extends ApplicationName("main-front")
56 
57   case object OldBackoffice extends ApplicationName("bo")
58 
59   case object Widget extends ApplicationName("widget")
60 
61   case object WidgetManager extends ApplicationName("widget-manager")
62 
63   override val values: IndexedSeq[ApplicationName] = findValues
64   final val swaggerAllowableValues =
65     "backoffice,bi-batchs,dial,dial-batchs,infra,legacy-front,main-front,bo,widget,widget-manager"
66 }
67 
68 final case class RequestContextQuestion(
69   question: Option[String] = None,
70   questionSlug: Option[String] = None,
71   questionId: Option[QuestionId] = None
72 )
73 
74 object RequestContextQuestion {
75   val empty: RequestContextQuestion = RequestContextQuestion(None, None, None)
76 
77   implicit val codec: Codec[RequestContextQuestion] = deriveCodec[RequestContextQuestion]
78 
79   implicit val formatter: RootJsonFormat[RequestContextQuestion] = jsonFormat3(RequestContextQuestion.apply)
80 }
81 
82 final case class RequestContextLanguage(
83   language: Option[Language] = None,
84   questionLanguage: Option[Language] = None,
85   proposalLanguage: Option[Language] = None,
86   clientLanguage: Option[Language] = None
87 )
88 
89 object RequestContextLanguage {
90   val empty: RequestContextLanguage = RequestContextLanguage(None, None, None, None)
91 
92   implicit val codec: Codec[RequestContextLanguage] = deriveCodec[RequestContextLanguage]
93 
94   implicit val formatter: RootJsonFormat[RequestContextLanguage] = jsonFormat4(RequestContextLanguage.apply)
95 }
96 
97 final case class RequestContext(
98   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
99   userId: Option[UserId] = None,
100   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
101   requestId: String,
102   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
103   sessionId: SessionId,
104   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
105   visitorId: Option[VisitorId] = None,
106   visitorCreatedAt: Option[ZonedDateTime] = None,
107   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
108   externalId: String,
109   @(ApiModelProperty @field)(dataType = "string", example = "FR")
110   country: Option[Country],
111   @(ApiModelProperty @field)(dataType = "string", example = "FR")
112   detectedCountry: Option[Country] = None,
113   @(ApiModelProperty @field)(dataType = "string", example = "fr")
114   languageContext: RequestContextLanguage = RequestContextLanguage.empty,
115   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
116   operationId: Option[OperationId] = None,
117   source: Option[String],
118   location: Option[String],
119   questionContext: RequestContextQuestion = RequestContextQuestion.empty,
120   hostname: Option[String] = None,
121   @(ApiModelProperty @field)(dataType = "string", example = "0.0.0.x")
122   ipAddress: Option[String] = None,
123   ipAddressHash: Option[String] = None,
124   getParameters: Option[Map[String, String]] = None,
125   userAgent: Option[String] = None,
126   @(ApiModelProperty @field)(dataType = "string", allowableValues = ApplicationName.swaggerAllowableValues)
127   applicationName: Option[ApplicationName] = None,
128   @(ApiModelProperty @field)(dataType = "string", example = "main-front")
129   referrer: Option[String] = None,
130   customData: Map[String, String] = Map.empty
131 )
132 
133 object RequestContext extends CirceFormatters with SprayJsonFormatters {
134   implicit val encoder: Encoder[RequestContext] = deriveEncoder[RequestContext]
135   implicit val decoder: Decoder[RequestContext] = deriveDecoder[RequestContext]
136 
137   val empty: RequestContext =
138     RequestContext(
139       userId = None,
140       requestId = "",
141       sessionId = SessionId(""),
142       visitorId = None,
143       visitorCreatedAt = None,
144       externalId = "",
145       country = None,
146       detectedCountry = None,
147       languageContext = RequestContextLanguage.empty,
148       operationId = None,
149       source = None,
150       location = None,
151       questionContext = RequestContextQuestion.empty,
152       hostname = None,
153       ipAddress = None,
154       ipAddressHash = None,
155       getParameters = None,
156       userAgent = None,
157       applicationName = None,
158       referrer = None,
159       customData = Map.empty
160     )
161 
162   implicit val requestContextFormatter: RootJsonFormat[RequestContext] =
163     DefaultJsonProtocol.jsonFormat21(RequestContext.apply)
164 
165 }