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.operation
21 
22 import java.net.URI
23 import io.circe.{Decoder, Encoder}
24 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
25 import io.circe.refined._
26 import eu.timepit.refined.api.Refined
27 import io.swagger.annotations.{ApiModel, ApiModelProperty}
28 import org.make.core.Validation._
29 import org.make.core.operation.{OperationAuthentication, OperationKind, ResultsLink}
30 
31 import scala.annotation.meta.field
32 import scala.util.Try
33 
34 @ApiModel
35 final case class AdminCreateOperationRequest(
36   slug: String Refined Slug,
37   @(ApiModelProperty @field)(
38     dataType = "string",
39     allowableValues = OperationKind.swaggerAllowableValues,
40     required = true
41   )
42   operationKind: OperationKind,
43   operationAuthentication: Option[OperationAuthentication]
44 )
45 
46 object AdminCreateOperationRequest {
47   implicit val decoder: Decoder[AdminCreateOperationRequest] = deriveDecoder
48 }
49 @ApiModel
50 final case class AdminUpdateOperationRequest(
51   slug: String Refined Slug,
52   @(ApiModelProperty @field)(
53     dataType = "string",
54     allowableValues = OperationKind.swaggerAllowableValues,
55     required = true
56   )
57   operationKind: OperationKind,
58   operationAuthentication: Option[OperationAuthentication]
59 )
60 
61 object AdminUpdateOperationRequest {
62   implicit val decoder: Decoder[AdminUpdateOperationRequest] = deriveDecoder
63 }
64 
65 final case class ResultsLinkRequest(
66   @(ApiModelProperty @field)(
67     dataType = "string",
68     required = true,
69     allowableValues = ResultsLink.Internal.swaggerAllowableValues
70   ) kind: ResultsLinkKind,
71   @(ApiModelProperty @field)(dataType = "string", required = true, example = "results") value: String
72 ) {
73 
74   @ApiModelProperty(hidden = true)
75   val resultsLink: Option[ResultsLink] = ResultsLink.parse(value)
76 
77 }
78 
79 object ResultsLinkRequest {
80   // FIXME: provide a generic implementation with shapeless of discriminated ADTs
81   private val baseDecoder: Decoder[ResultsLinkRequest] = deriveDecoder
82   implicit val decoder: Decoder[ResultsLinkRequest] = baseDecoder.emap {
83     case t @ ResultsLinkRequest(ResultsLinkKind.External, value) =>
84       if (Try(new URI(value)).isSuccess)
85         Right(t)
86       else
87         Left(s"Invalid URI: '${value}'")
88 
89     case t @ ResultsLinkRequest(ResultsLinkKind.Internal, value) =>
90       if (ResultsLink.Internal.withValueOpt(value).nonEmpty)
91         Right(t)
92       else
93         Left(s"Invalid internal link: '${value}'")
94   }
95 
96   implicit val encoder: Encoder[ResultsLinkRequest] = deriveEncoder
97 }