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.organisation
21 
22 import io.circe.{Decoder, Encoder}
23 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
24 import io.swagger.annotations.ApiModelProperty
25 import org.make.core.CirceFormatters
26 import org.make.core.question.QuestionId
27 import org.make.core.reference.Country
28 import org.make.core.user.indexed.{IndexedOrganisation, OrganisationSearchResult, ProposalsAndVotesCountsByQuestion}
29 import org.make.core.user.UserId
30 
31 import scala.annotation.meta.field
32 
33 final case class OrganisationSearchResponse(
34   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
35   organisationId: UserId,
36   organisationName: Option[String],
37   slug: Option[String],
38   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/avatar.png")
39   avatarUrl: Option[String],
40   description: Option[String],
41   publicProfile: Boolean,
42   @(ApiModelProperty @field)(dataType = "int", example = "42", required = true)
43   proposalsCount: Int,
44   @(ApiModelProperty @field)(dataType = "int", example = "42", required = true)
45   votesCount: Int,
46   @(ApiModelProperty @field)(dataType = "string", example = "FR", required = true)
47   country: Country,
48   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/website")
49   website: Option[String],
50   @(ApiModelProperty @field)(dataType = "Map[string,org.make.api.organisation.ProposalsAndVotesCountsResponse]")
51   countsByQuestion: Map[QuestionId, ProposalsAndVotesCountsResponse]
52 )
53 
54 object OrganisationSearchResponse extends CirceFormatters {
55   implicit val encoder: Encoder[OrganisationSearchResponse] = deriveEncoder[OrganisationSearchResponse]
56   implicit val decoder: Decoder[OrganisationSearchResponse] = deriveDecoder[OrganisationSearchResponse]
57 
58   def fromIndexedOrganisation(organisation: IndexedOrganisation): OrganisationSearchResponse = {
59     OrganisationSearchResponse(
60       organisationId = organisation.organisationId,
61       organisationName = organisation.organisationName,
62       slug = organisation.slug,
63       avatarUrl = organisation.avatarUrl,
64       description = organisation.description,
65       publicProfile = organisation.publicProfile,
66       proposalsCount = organisation.proposalsCount,
67       votesCount = organisation.votesCount,
68       country = organisation.country,
69       website = organisation.website,
70       countsByQuestion = organisation.countsByQuestion.map(ProposalsAndVotesCountsResponse.fromCounts).toMap
71     )
72   }
73 }
74 
75 final case class OrganisationsSearchResultResponse(total: Long, results: Seq[OrganisationSearchResponse])
76 
77 object OrganisationsSearchResultResponse {
78   implicit val encoder: Encoder[OrganisationsSearchResultResponse] = deriveEncoder[OrganisationsSearchResultResponse]
79   implicit val decoder: Decoder[OrganisationsSearchResultResponse] = deriveDecoder[OrganisationsSearchResultResponse]
80 
81   def empty: OrganisationsSearchResultResponse = OrganisationsSearchResultResponse(0, Seq.empty)
82 
83   def fromOrganisationSearchResult(results: OrganisationSearchResult): OrganisationsSearchResultResponse =
84     OrganisationsSearchResultResponse(
85       total = results.total,
86       results = results.results.map(OrganisationSearchResponse.fromIndexedOrganisation)
87     )
88 }
89 
90 final case class ProposalsAndVotesCountsResponse(proposalsCount: Int, votesCount: Int)
91 
92 object ProposalsAndVotesCountsResponse {
93   implicit val encoder: Encoder[ProposalsAndVotesCountsResponse] = deriveEncoder[ProposalsAndVotesCountsResponse]
94   implicit val decoder: Decoder[ProposalsAndVotesCountsResponse] = deriveDecoder[ProposalsAndVotesCountsResponse]
95 
96   def fromCounts(counts: ProposalsAndVotesCountsByQuestion): (QuestionId, ProposalsAndVotesCountsResponse) =
97     counts.questionId -> ProposalsAndVotesCountsResponse(counts.proposalsCount, counts.votesCount)
98 }