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.user.indexed
21 
22 import cats.implicits._
23 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
24 import io.circe.{Decoder, Encoder}
25 import org.make.core.question.QuestionId
26 import org.make.core.reference.{Country, Language}
27 import org.make.core.user.{User, UserId}
28 import org.make.core.{BusinessConfig, CirceFormatters, SlugHelper}
29 
30 object OrganisationElasticsearchFieldNames {
31   val organisationId: String = "organisationId"
32   val organisationName: String = "organisationName"
33   val organisationNameKeyword: String = "organisationName.keyword"
34   val organisationNameGeneral: String = "organisationName.general"
35   val slug: String = "slug"
36   val avatarUrl: String = "avatarUrl"
37   val description: String = "description"
38   val canBeFollowed: String = "canBeFollowed"
39   val proposalsCount: String = "proposalsCount"
40   val votesCount: String = "votesCount"
41   val language: String = "language"
42   val country: String = "country"
43   val countsByQuestion: String = "countsByQuestion"
44   val countsByQuestionQuestionId: String = "countsByQuestion.questionId"
45 
46   def organisationNameLanguageSubfield(language: Language, stemmed: Boolean = false): Option[String] = {
47     BusinessConfig.supportedCountries
48       .find(_.supportedLanguages.contains(language))
49       .as(
50         if (stemmed)
51           s"organisationName.$language-stemmed"
52         else
53           s"organisationName.$language"
54       )
55   }
56 }
57 
58 final case class IndexedOrganisation(
59   organisationId: UserId,
60   organisationName: Option[String],
61   slug: Option[String],
62   avatarUrl: Option[String],
63   description: Option[String],
64   publicProfile: Boolean,
65   proposalsCount: Int,
66   votesCount: Int,
67   country: Country,
68   website: Option[String],
69   countsByQuestion: Seq[ProposalsAndVotesCountsByQuestion]
70 )
71 
72 object IndexedOrganisation extends CirceFormatters {
73   implicit val encoder: Encoder[IndexedOrganisation] = deriveEncoder[IndexedOrganisation]
74   implicit val decoder: Decoder[IndexedOrganisation] = deriveDecoder[IndexedOrganisation]
75 
76   def createFromOrganisation(
77     organisation: User,
78     countsByQuestion: Seq[ProposalsAndVotesCountsByQuestion] = Seq.empty
79   ): IndexedOrganisation = {
80     IndexedOrganisation(
81       organisationId = organisation.userId,
82       organisationName = organisation.organisationName,
83       slug = organisation.organisationName.map(SlugHelper.apply),
84       avatarUrl = organisation.profile.flatMap(_.avatarUrl),
85       description = organisation.profile.flatMap(_.description),
86       publicProfile = organisation.publicProfile,
87       proposalsCount = countsByQuestion.map(_.proposalsCount).sum,
88       votesCount = countsByQuestion.map(_.votesCount).sum,
89       country = organisation.country,
90       website = organisation.profile.flatMap(_.website),
91       countsByQuestion = countsByQuestion
92     )
93   }
94 }
95 
96 final case class OrganisationSearchResult(total: Long, results: Seq[IndexedOrganisation])
97 
98 object OrganisationSearchResult {
99   implicit val encoder: Encoder[OrganisationSearchResult] = deriveEncoder[OrganisationSearchResult]
100   implicit val decoder: Decoder[OrganisationSearchResult] = deriveDecoder[OrganisationSearchResult]
101 
102   def empty: OrganisationSearchResult = OrganisationSearchResult(0, Seq.empty)
103 }
104 
105 final case class ProposalsAndVotesCountsByQuestion(questionId: QuestionId, proposalsCount: Int, votesCount: Int)
106 
107 object ProposalsAndVotesCountsByQuestion {
108   implicit val encoder: Encoder[ProposalsAndVotesCountsByQuestion] = deriveEncoder[ProposalsAndVotesCountsByQuestion]
109   implicit val decoder: Decoder[ProposalsAndVotesCountsByQuestion] = deriveDecoder[ProposalsAndVotesCountsByQuestion]
110 }