Merge pull request #121 from /issues/116

Some API bits

Author: madhead

core/src/main/kotlin/me/madhead/tyzenhaus/core/currencies/ChatCurrenciesService.kt core/src/main/kotlin/me/madhead/tyzenhaus/core/service/GroupCurrenciesService.kt

@@ -1,23 +1,22 @@
-package me.madhead.tyzenhaus.core.currencies
+package me.madhead.tyzenhaus.core.service
 
 import me.madhead.tyzenhaus.repository.BalanceRepository
 
 /**
  * Lists currencies used in transactions of the group.
  */
-class ChatCurrenciesService(
+class GroupCurrenciesService(
     private val balanceRepository: BalanceRepository,
 ) {
     /**
      * Lists currencies used in transactions of the [group].
      */
-    fun groupCurrencies(group: Long): List<String> {
+    fun groupCurrencies(group: Long): List<String>? {
         return balanceRepository
             .get(group)
             ?.balance
             ?.keys
             ?.takeUnless { it.isEmpty() }
             ?.toList()
-            ?: listOf("USD", "EUR", "RUB")
     }
 }

core/src/main/kotlin/me/madhead/tyzenhaus/core/service/GroupMembersService.kt

@@ -0,0 +1,37 @@
+package me.madhead.tyzenhaus.core.service
+
+import dev.inmo.tgbotapi.bot.RequestsExecutor
+import dev.inmo.tgbotapi.types.ChatId
+import dev.inmo.tgbotapi.types.UserId
+import me.madhead.tyzenhaus.core.telegram.updates.expense.getChatMemberSafe
+import me.madhead.tyzenhaus.entity.group.members.GroupMember
+import me.madhead.tyzenhaus.entity.group.members.GroupMembers
+import me.madhead.tyzenhaus.repository.GroupConfigRepository
+
+/**
+ * Lists group members.
+ */
+class GroupMembersService(
+    private val groupConfigRepository: GroupConfigRepository,
+    private val requestsExecutor: RequestsExecutor,
+) {
+    /**
+     * Lists members of the [group].
+     */
+    suspend fun groupMembers(group: Long): GroupMembers? {
+        val groupConfig = groupConfigRepository.get(group) ?: return null
+        val chatMembers = groupConfig.members.map { requestsExecutor.getChatMemberSafe(ChatId(groupConfig.id), UserId(it)) }
+
+        return GroupMembers(
+            id = groupConfig.id,
+            members = chatMembers.map {
+                GroupMember(
+                    id = it.user.id.chatId,
+                    firstName = it.user.firstName,
+                    lastName = it.user.lastName,
+                    username = it.user.username?.usernameWithoutAt,
+                )
+            }
+        )
+    }
+}

core/src/main/kotlin/me/madhead/tyzenhaus/core/telegram/updates/expense/AmountReplyUpdateProcessor.kt

@@ -10,7 +10,7 @@ import dev.inmo.tgbotapi.types.message.content.TextContent
 import dev.inmo.tgbotapi.types.update.MessageUpdate
 import dev.inmo.tgbotapi.types.update.abstracts.Update
 import java.math.BigDecimal
-import me.madhead.tyzenhaus.core.currencies.ChatCurrenciesService
+import me.madhead.tyzenhaus.core.service.GroupCurrenciesService
 import me.madhead.tyzenhaus.core.telegram.updates.UpdateProcessor
 import me.madhead.tyzenhaus.core.telegram.updates.UpdateReaction
 import me.madhead.tyzenhaus.core.telegram.updates.groupId
@@ -29,7 +29,7 @@ import org.apache.logging.log4j.LogManager
 class AmountReplyUpdateProcessor(
     private val requestsExecutor: RequestsExecutor,
     private val dialogStateRepository: DialogStateRepository,
-    private val chatCurrenciesService: ChatCurrenciesService,
+    private val groupCurrenciesService: GroupCurrenciesService,
 ) : UpdateProcessor {
     companion object {
         private val logger = LogManager.getLogger(AmountReplyUpdateProcessor::class.java)!!
@@ -110,8 +110,7 @@ class AmountReplyUpdateProcessor(
                 parseMode = MarkdownV2,
                 replyToMessageId = message.messageId,
                 replyMarkup = dev.inmo.tgbotapi.types.buttons.ReplyKeyboardMarkup(
-                    keyboard = chatCurrenciesService
-                        .groupCurrencies(update.groupId)
+                    keyboard = (groupCurrenciesService.groupCurrencies(update.groupId) ?: listOf("USD", "EUR", "RUB"))
                         .map { listOf(SimpleKeyboardButton(it)) },
                     resizeKeyboard = true,
                     oneTimeKeyboard = true,

core/src/main/kotlin/me/madhead/tyzenhaus/core/telegram/updates/history/HistoryCommandUpdateProcessor.kt

@@ -9,13 +9,19 @@ import dev.inmo.tgbotapi.types.message.content.TextContent
 import dev.inmo.tgbotapi.types.message.textsources.BotCommandTextSource
 import dev.inmo.tgbotapi.types.update.MessageUpdate
 import dev.inmo.tgbotapi.types.update.abstracts.Update
+import java.time.Duration
+import java.time.Instant
+import java.util.UUID
 import me.madhead.tyzenhaus.core.telegram.updates.UpdateProcessor
 import me.madhead.tyzenhaus.core.telegram.updates.UpdateReaction
 import me.madhead.tyzenhaus.core.telegram.updates.groupId
 import me.madhead.tyzenhaus.core.telegram.updates.userId
+import me.madhead.tyzenhaus.entity.api.token.APIToken
+import me.madhead.tyzenhaus.entity.api.token.Scope
 import me.madhead.tyzenhaus.entity.dialog.state.DialogState
 import me.madhead.tyzenhaus.entity.group.config.GroupConfig
 import me.madhead.tyzenhaus.i18.I18N
+import me.madhead.tyzenhaus.repository.APITokenRepository
 import org.apache.logging.log4j.LogManager
 
 /**
@@ -24,6 +30,7 @@ import org.apache.logging.log4j.LogManager
 class HistoryCommandUpdateProcessor(
     private val requestsExecutor: RequestsExecutor,
     private val me: ExtendedBot,
+    private val apiTokenRepository: APITokenRepository,
 ) : UpdateProcessor {
     companion object {
         private val logger = LogManager.getLogger(HistoryCommandUpdateProcessor::class.java)!!
@@ -40,9 +47,18 @@ class HistoryCommandUpdateProcessor(
             {
                 logger.debug("{} asked for history in {}", update.userId, update.groupId)
 
+                val token = APIToken(
+                    token = UUID.randomUUID(),
+                    groupId = update.groupId,
+                    scope = Scope.HISTORY,
+                    validUntil = Instant.now() + @Suppress("MagicNumber") Duration.ofMinutes(30)
+                )
+
+                apiTokenRepository.save(token)
+
                 requestsExecutor.sendMessage(
                     chatId = update.data.chat.id,
-                    text = I18N(groupConfig?.language)["history.response", me.username.usernameWithoutAt, "TOKEN"],
+                    text = I18N(groupConfig?.language)["history.response", me.username.usernameWithoutAt, token.token.toString()],
                     parseMode = MarkdownV2,
                 )
             }

detekt.yml

@@ -40,15 +40,15 @@ comments:
     matchDeclarationsOrder: true
     allowParamOnConstructorProperties: false
   UndocumentedPublicClass:
-    active: false
+    active: true
     excludes:
       - '**/test/**'
     searchInNestedClass: true
     searchInInnerClass: true
     searchInInnerObject: true
     searchInInnerInterface: true
   UndocumentedPublicFunction:
-    active: false
+    active: true
     excludes:
       - '**/test/**'
   UndocumentedPublicProperty:

entity/src/main/kotlin/me/madhead/tyzenhaus/entity/api/token/APIToken.kt

@@ -8,9 +8,11 @@ import java.util.UUID
  *
  * Available scopes:
  * - HISTORY: Allows to read group's transaction history.
+ * - EXPENSE: Allows to create new transactions.
  */
 enum class Scope {
     HISTORY,
+    EXPENSE,
 }
 
 /**

entity/src/main/kotlin/me/madhead/tyzenhaus/entity/group/members/GroupMembers.kt

@@ -0,0 +1,23 @@
+package me.madhead.tyzenhaus.entity.group.members
+
+import kotlinx.serialization.Serializable
+
+/**
+ *  Information about a member of a group.
+ */
+@Serializable
+data class GroupMember(
+    val id: Long,
+    val firstName: String,
+    val lastName: String,
+    val username: String?,
+)
+
+/**
+ * Information about group members.
+ */
+@Serializable
+data class GroupMembers(
+    val id: Long,
+    val members: Collection<GroupMember> = emptySet(),
+)

gradle/libs.versions.toml

@@ -22,6 +22,8 @@ kotlin-bom = { module = "org.jetbrains.kotlin:kotlin-bom", version.ref = "kotlin
 kotlinx-coroutines-bom = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-bom", version.ref = "kotlinx-coroutines" }
 ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor" }
 ktor-server-metrics-micrometer = { module = "io.ktor:ktor-server-metrics-micrometer", version.ref = "ktor" }
+ktor-server-auth = { module = "io.ktor:ktor-server-auth", version.ref = "ktor" }
+ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
 koin-ktor = { module = "io.insert-koin:koin-ktor", version.ref = "koin" }
 kotlinx-serialization-bom = { module = "org.jetbrains.kotlinx:kotlinx-serialization-bom", version.ref = "kotlinx-serialization" }
 kotlinx-serialization-core = { module = "org.jetbrains.kotlinx:kotlinx-serialization-core", version.ref = "kotlinx-serialization" }
@@ -45,4 +47,4 @@ picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
 
 [bundles]
 boms = ["kotlin-bom", "kotlinx-serialization-bom", "kotlinx-coroutines-bom", "log4j-bom", "junit-bom"]
-ktor = ["ktor-server-netty", "ktor-server-metrics-micrometer", "koin-ktor"]
+ktor = ["ktor-server-netty", "ktor-server-metrics-micrometer", "ktor-server-auth", "koin-ktor", "ktor-serialization-kotlinx-json"]

launcher/fly/requests.http

@@ -8,3 +8,16 @@ Content-Type: application/json
 {
   "url": "https://{{ngrok}}/{{telegram_token}}"
 }
+
+### Validate initData
+POST https://{{ngrok}}/app/api/auth/validation
+Authorization: Bearer {{api_token}}
+
+
+### Get group members
+GET https://{{ngrok}}/app/api/group/members
+Authorization: Bearer {{api_token}}
+
+### Get group currencies
+GET https://{{ngrok}}/app/api/group/currencies
+Authorization: Bearer {{api_token}}

launcher/fly/src/main/kotlin/me/madhead/tyzenhaus/launcher/fly/koin/db.kt

@@ -3,6 +3,7 @@ package me.madhead.tyzenhaus.launcher.fly.koin
 import io.ktor.server.config.ApplicationConfig
 import java.net.URI
 import javax.sql.DataSource
+import me.madhead.tyzenhaus.repository.APITokenRepository
 import me.madhead.tyzenhaus.repository.BalanceRepository
 import me.madhead.tyzenhaus.repository.DialogStateRepository
 import me.madhead.tyzenhaus.repository.GroupConfigRepository
@@ -11,6 +12,7 @@ import me.madhead.tyzenhaus.repository.SupergroupRepository
 import me.madhead.tyzenhaus.repository.TransactionRepository
 import org.koin.dsl.module
 import org.postgresql.ds.PGSimpleDataSource
+import me.madhead.tyzenhaus.repository.postgresql.api.token.APITokenRepository as PostgreSQLAPITokenRepository
 import me.madhead.tyzenhaus.repository.postgresql.balance.BalanceRepository as PostgreSQLBalanceRepository
 import me.madhead.tyzenhaus.repository.postgresql.dialog.state.DialogStateRepository as PostgreSQLDialogStateRepository
 import me.madhead.tyzenhaus.repository.postgresql.group.config.GroupConfigRepository as PostgreSQLGroupConfigRepository
@@ -52,4 +54,8 @@ val dbModule = module {
     single<SupergroupRepository> {
         PostgreSQLSupegroupRepository(get())
     }
+
+    single<APITokenRepository> {
+        PostgreSQLAPITokenRepository(get())
+    }
 }

launcher/fly/src/main/kotlin/me/madhead/tyzenhaus/launcher/fly/koin/pipeline.kt

@@ -1,9 +1,6 @@
 package me.madhead.tyzenhaus.launcher.fly.koin
 
-import dev.inmo.tgbotapi.types.ChatId
 import dev.inmo.tgbotapi.types.chat.ExtendedBot
-import io.ktor.server.config.ApplicationConfig
-import me.madhead.tyzenhaus.core.currencies.ChatCurrenciesService
 import me.madhead.tyzenhaus.core.debts.DebtsCalculator
 import me.madhead.tyzenhaus.core.telegram.updates.UpdateProcessingPipeline
 import me.madhead.tyzenhaus.core.telegram.updates.expense.AmountReplyUpdateProcessor
@@ -27,11 +24,6 @@ import me.madhead.tyzenhaus.core.telegram.updates.support.IDCommandUpdateProcess
 import org.koin.dsl.module
 
 val pipelineModule = module {
-    single {
-        ChatCurrenciesService(
-            balanceRepository = get(),
-        )
-    }
     single {
         DebtsCalculator()
     }
@@ -75,7 +67,7 @@ val pipelineModule = module {
         AmountReplyUpdateProcessor(
             requestsExecutor = get(),
             dialogStateRepository = get(),
-            chatCurrenciesService = get(),
+            groupCurrenciesService = get(),
         )
     }
     single {
@@ -143,6 +135,7 @@ val pipelineModule = module {
         HistoryCommandUpdateProcessor(
             requestsExecutor = get(),
             me = get(),
+            apiTokenRepository = get(),
         )
     }
     single {

launcher/fly/src/main/kotlin/me/madhead/tyzenhaus/launcher/fly/koin/services.kt

@@ -0,0 +1,20 @@
+package me.madhead.tyzenhaus.launcher.fly.koin
+
+import me.madhead.tyzenhaus.core.service.GroupCurrenciesService
+import me.madhead.tyzenhaus.core.service.GroupMembersService
+import org.koin.dsl.module
+
+val serviceModule = module {
+    single {
+        GroupCurrenciesService(
+            balanceRepository = get(),
+        )
+    }
+
+    single {
+        GroupMembersService(
+            requestsExecutor = get(),
+            groupConfigRepository = get(),
+        )
+    }
+}

launcher/fly/src/main/kotlin/me/madhead/tyzenhaus/launcher/fly/modules/Tyzenhaus.kt

@@ -1,26 +1,39 @@
 package me.madhead.tyzenhaus.launcher.fly.modules
 
+import io.ktor.serialization.kotlinx.json.json
 import io.ktor.server.application.Application
 import io.ktor.server.application.install
+import io.ktor.server.auth.Authentication
+import io.ktor.server.auth.bearer
 import io.ktor.server.metrics.micrometer.MicrometerMetrics
 import io.ktor.server.plugins.callloging.CallLogging
 import io.ktor.server.plugins.compression.Compression
+import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.server.plugins.defaultheaders.DefaultHeaders
 import io.ktor.server.routing.routing
 import io.micrometer.prometheus.PrometheusMeterRegistry
+import java.time.Instant
+import java.util.UUID
 import me.madhead.tyzenhaus.launcher.fly.koin.configModule
 import me.madhead.tyzenhaus.launcher.fly.koin.dbModule
 import me.madhead.tyzenhaus.launcher.fly.koin.jsonModule
 import me.madhead.tyzenhaus.launcher.fly.koin.metricsModule
 import me.madhead.tyzenhaus.launcher.fly.koin.pipelineModule
+import me.madhead.tyzenhaus.launcher.fly.koin.serviceModule
 import me.madhead.tyzenhaus.launcher.fly.koin.telegramModule
 import me.madhead.tyzenhaus.launcher.fly.routes.metrics
 import me.madhead.tyzenhaus.launcher.fly.routes.miniApp
 import me.madhead.tyzenhaus.launcher.fly.routes.miniAppAPI
 import me.madhead.tyzenhaus.launcher.fly.routes.webhook
+import me.madhead.tyzenhaus.launcher.fly.security.APITokenPrincipal
+import me.madhead.tyzenhaus.repository.APITokenRepository
 import org.koin.ktor.ext.get
+import org.koin.ktor.ext.inject
 import org.koin.ktor.plugin.Koin
 
+/**
+ * Initializes and configures the application.
+ */
 fun Application.tyzenhaus() {
     install(DefaultHeaders)
     install(CallLogging)
@@ -29,18 +42,38 @@ fun Application.tyzenhaus() {
     install(Koin) {
         modules(
             configModule(environment.config),
+            dbModule,
+            serviceModule,
+            pipelineModule,
             metricsModule,
             telegramModule,
             jsonModule,
-            pipelineModule,
-            dbModule,
         )
     }
 
+    install(ContentNegotiation) {
+        json(this@tyzenhaus.get())
+    }
+
     install(MicrometerMetrics) {
         this.registry = this@tyzenhaus.get<PrometheusMeterRegistry>()
     }
 
+    install(Authentication) {
+        bearer("api") {
+            authenticate { credential ->
+                val token = try {
+                    UUID.fromString(credential.token)
+                } catch (_: Exception) {
+                    return@authenticate null
+                }
+                val tokenRepository by inject<APITokenRepository>()
+
+                tokenRepository.get(token)?.takeIf { it.validUntil > Instant.now() }?.let { APITokenPrincipal(it.groupId, it.scope) }
+            }
+        }
+    }
+
     routing {
         webhook()
         metrics()