Compare commits

...

48 Commits
0.0.4 ... 0.1.8

Author SHA1 Message Date
1b700857fa update dependencies 2021-04-05 21:27:16 +06:00
64f35ab233 start 0.1.8 2021-04-05 21:26:46 +06:00
f7207688e4 Merge pull request #13 from InsanusMokrassar/0.1.7
0.1.7
2021-04-03 23:02:17 +06:00
d94df49795 optimize imports 2021-04-03 22:07:43 +06:00
1ffb7a1999 update of versions 2021-04-03 22:05:18 +06:00
8444172e44 PlaguBot class 2021-04-03 22:04:18 +06:00
15109391b1 start 0.1.7 2021-04-03 16:04:18 +06:00
175715d769 Merge pull request #12 from InsanusMokrassar/0.1.6
0.1.6
2021-03-30 15:26:06 +06:00
6fa5ccdbe2 update dependencies 2021-03-30 15:24:31 +06:00
f5b562ac01 start 0.1.6 2021-03-30 15:23:47 +06:00
362f5acccf Merge pull request #11 from InsanusMokrassar/0.1.5
0.1.5
2021-03-12 21:51:25 +06:00
c2208b1efb fix build 2021-03-12 21:49:21 +06:00
1a957f808c 0.1.5 2021-03-12 21:45:23 +06:00
152b6e7660 Merge pull request #10 from InsanusMokrassar/0.1.4
0.1.4
2021-02-22 19:10:50 +06:00
fd19f9e4ba update changelog 2021-02-22 19:09:56 +06:00
58eaa86419 fix of #9 2021-02-22 19:08:49 +06:00
cf6b06b41d start 0.1.4 2021-02-19 19:47:33 +06:00
8f88d4b1a3 Merge pull request #8 from InsanusMokrassar/0.1.3
0.1.3
2021-02-18 00:41:18 +06:00
ceb60e3c6a make plugin more correctly serializable 2021-02-18 00:38:18 +06:00
d3d5e70818 update tgbotapi 2021-02-17 22:47:33 +06:00
9d79132b2f initPlaguBot -> initPlaguBot: Job 2021-02-17 21:11:24 +06:00
22f77f8a0f add opportunity to deserialize plugin :) 2021-02-17 21:03:38 +06:00
f72c467b48 start 0.1.3 2021-02-17 20:53:09 +06:00
e150ee9edd update to work with 0.1.2 2021-02-17 19:12:56 +06:00
9124f01b2a remove travis 2021-02-17 18:40:34 +06:00
1e75c7755a Merge pull request #7 from InsanusMokrassar/0.1.1
0.1.1
2021-02-17 17:46:57 +06:00
03d9986fcf update tgbotapi 2021-02-17 17:34:42 +06:00
46986316c2 start 0.1.1 2021-02-17 17:33:36 +06:00
8fe6fb4bf1 Merge pull request #6 from InsanusMokrassar/0.1.0
0.1.0
2021-02-17 01:22:44 +06:00
2baed760f7 inluding sdi 2021-02-17 01:21:41 +06:00
a2b3fe57ac update publication scripts 2021-02-17 00:31:50 +06:00
6dec930a9d Merge pull request #4 from InsanusMokrassar/0.1.0
0.1.0
2021-02-17 00:06:58 +06:00
01aa098125 update changelog and gradle.properties 2021-02-16 23:42:25 +06:00
fc9d668e31 add build workflow 2021-02-16 23:37:42 +06:00
96f1ff56c0 update gradle wrapper version 2021-02-16 23:35:25 +06:00
f3c3640421 update publishing scripts 2021-02-16 23:34:47 +06:00
158b03a9ca update dependencies 2021-02-16 23:32:19 +06:00
7258275d0e start 0.1.1 2021-02-16 23:29:41 +06:00
595102fede BehaviourContext.invoke 2021-01-10 15:21:31 +06:00
bc5737d435 update dependencies 2021-01-10 15:04:45 +06:00
79f3962c65 start 0.1.0 2021-01-10 15:01:52 +06:00
41dade823b Merge pull request #3 from InsanusMokrassar/0.0.5
0.0.5
2020-12-08 15:03:59 +06:00
c5c64bcd2d update publication scripts 2020-12-08 15:00:54 +06:00
95f7f93c20 update dependencies 2020-12-08 14:50:11 +06:00
49c90d2a0d start 0.0.5 2020-12-08 14:35:38 +06:00
2a54ff38f8 Update .travis.yml 2020-11-17 21:46:19 +06:00
5d221435fe Create .travis.yml 2020-11-17 21:45:42 +06:00
d7d8eb8faf Merge pull request #2 from InsanusMokrassar/0.0.4
0.0.4
2020-11-17 21:40:55 +06:00
20 changed files with 577 additions and 241 deletions

16
.github/workflows/build.yml vendored Normal file
View File

@@ -0,0 +1,16 @@
name: Build
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 1.8
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: Build with Gradle
run: ./gradlew build

View File

@@ -1,5 +1,86 @@
# Changelog
## 0.1.8
* `Versions`
* `tgbotapi`: `0.33.2` -> `0.33.3`
* `microutils`: `0.4.32` -> `0.4.33`
## 0.1.7
* `Versions`
* `exposed`: `0.29.1` -> `0.30.1`
* `tgbotapi`: `0.33.1` -> `0.33.2`
* `microutils`: `0.4.31` -> `0.4.32`
* `PlaguBot`
* New class `PlaguBot` (😊)
* `initPlaguBot` is deprecated
* New shortcut for params - `plagubot`. `PlaguBot` class can be put inside other plagubot
for additional opportunities
## 0.1.6
* `Versions`
* `kotlin`: `1.4.31` -> `1.4.32`
* `tgbotapi`: `0.33.0` -> `0.33.1`
* `microutils`: `0.4.29` -> `0.4.31`
## 0.1.5
* `Versions`
* `kotlin`: `1.4.30` -> `1.4.31`
* `serialization`: `1.1.0-RC` -> `1.1.0`
* `coroutines`: `1.4.2` -> `1.4.3`
* `tgbotapi`: `0.32.8` -> `0.33.0`
* `microutils`: `0.4.26` -> `0.4.29`
## 0.1.4
* `Versions`
* `sdi`: `0.4.0-rc2` -> `0.4.1`
* `tgbotapi`: `0.32.7` -> `0.32.8`
* `microutils`: `0.4.25` -> `0.4.26`
* `Bot`
* Fix of [#9](https://github.com/InsanusMokrassar/PlaguBot/issues/9)
## 0.1.3
* `Versions`
* `tgbotapi`: `0.32.6` -> `0.32.7`
* `Bot`
* `initPlaguBot` now will return `Job`
* `Plugin`
* Plugin serializer
## 0.1.2
* `Versions`
* `tgbotapi`: `0.32.5` -> `0.32.6`
## 0.1.0
* `Versions`
* `kotlin`: `1.4.21` -> `1.4.30`
* `serialization`: `1.0.1` -> `1.1.0-RC`
* `exposed`: `0.28.1` -> `0.29.1`
* `tgbotapi`: `0.30.10` -> `0.32.5`
* `microutils`: `0.4.11` -> `0.4.25`
* `Bot`
* New dependency `sdi`
* Now it is possible to pass `Module` to configuration for providing a global plugins parameters like different
common database or tools
* `Plugin`
* Two new methods `BehaviourContext#invoke`
* Old method `invoke` has been deprecated
## 0.0.5
* `Versions`
* `kotlin`: `1.4.10` -> `1.4.21`
* `kotlin coroutines`: `1.4.1` -> `1.4.2`
* `tgbotapi`: `0.30.7` -> `0.30.10`
* `microutils`: `0.4.1` -> `0.4.11`
## 0.0.4
* `Versions`

View File

@@ -18,12 +18,15 @@ dependencies {
api "org.jetbrains.exposed:exposed-jdbc:$kotlin_exposed_version"
api "dev.inmo:tgbotapi:$tgbotapi_version"
api "dev.inmo:sdi:$sdi_version"
api "dev.inmo:micro_utils.repos.exposed:$microutils_version"
api "com.github.matfax.klassindex:library:$klassindex_version"
kapt "com.github.matfax.klassindex:processor:$klassindex_version"
api "org.xerial:sqlite-jdbc:$sqlite_version"
testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
api project(":plagubot.plugin")
}
@@ -34,6 +37,7 @@ application {
kapt {
arguments {
arg("com.github.matfax.klassindex.IndexSubclasses", "dev.inmo.plagubot.Plugin")
arg("com.github.matfax.klassindex.IndexAnnotated", "dev.inmo.sdi.SDIIncluded")
}
}

View File

@@ -1,54 +0,0 @@
apply plugin: 'maven-publish'
task sourcesJar(type: Jar) {
from sourceSets.main.allSource
classifier = 'sources'
}
task javadocJar(type: Jar) {
from javadoc
classifier = 'javadoc'
}
publishing {
publications {
maven(MavenPublication) {
from components.java
artifact sourcesJar
artifact javadocJar
pom {
resolveStrategy = Closure.DELEGATE_FIRST
description = ""
name = "PlaguBot ${project.name}"
url = "https://github.com/InsanusMokrassar/PlaguBot"
scm {
developerConnection = "scm:git:[fetch=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git[push=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
url = "ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
}
developers {
developer {
id = "InsanusMokrassar"
name = "Aleksei Ovsiannikov"
email = "ovsyannikov.alexey95@gmail.com"
}
}
licenses {
license {
name = "Apache Software License 2.0"
url = "https://github.com/InsanusMokrassar/PlaguBot/LICENSE"
}
}
}
}
}
}

View File

@@ -1 +1 @@
{"bintrayConfig":{"repo":"PlaguBot","packageName":"${project.name}","packageVcs":"https://github.com/InsanusMokrassar/PlaguBot","autoPublish":true,"overridePublish":true},"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot ${project.name}","description":"","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}]},"type":"JVM"}
{"bintrayConfig":{"repo":"PlaguBot","packageName":"${project.name}","packageVcs":"https://github.com/InsanusMokrassar/PlaguBot","autoPublish":true,"overridePublish":true},"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Bot","description":"Base PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","includeGpgSigning":true,"publishToMavenCentral":true,"developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}]},"type":"JVM"}

View File

@@ -1,43 +1,82 @@
apply plugin: 'com.jfrog.bintray'
apply plugin: 'maven-publish'
apply plugin: 'signing'
ext {
projectBintrayDir = "${project.group}/".replace(".", "/") + "${project.name}/${project.version}"
task javadocJar(type: Jar) {
from javadoc
classifier = 'javadoc'
}
task sourcesJar(type: Jar) {
from sourceSets.main.allSource
classifier = 'sources'
}
bintray {
user = project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')
key = project.hasProperty('BINTRAY_KEY') ? project.property('BINTRAY_KEY') : System.getenv('BINTRAY_KEY')
publications = ["maven"]
filesSpec {
into "$projectBintrayDir"
from("build/libs") {
include "**/*.asc"
}
from("build/publications/maven") {
rename 'pom-default.xml(.*)', "${project.name}-${project.version}.pom\$1"
}
}
publish = true
override = true
pkg {
repo = "PlaguBot"
name = "${project.name}"
vcsUrl = "https://github.com/InsanusMokrassar/PlaguBot"
licenses = ["Apache-2.0"]
version {
name = "${project.version}"
released = new Date()
vcsTag = "${project.version}"
gpg {
sign = true
passphrase = project.hasProperty('signing.gnupg.passphrase') ? project.property('signing.gnupg.passphrase') : System.getenv('signing.gnupg.passphrase')
publishing {
publications {
maven(MavenPublication) {
from components.java
artifact javadocJar
artifact sourcesJar
pom {
resolveStrategy = Closure.DELEGATE_FIRST
description = "Base PlaguBot project"
name = "PlaguBot Bot"
url = "https://github.com/InsanusMokrassar/PlaguBot"
scm {
developerConnection = "scm:git:[fetch=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git[push=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
url = "ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
}
developers {
developer {
id = "InsanusMokrassar"
name = "Aleksei Ovsiannikov"
email = "ovsyannikov.alexey95@gmail.com"
}
}
licenses {
license {
name = "Apache Software License 2.0"
url = "https://github.com/InsanusMokrassar/PlaguBot/LICENSE"
}
}
}
repositories {
maven {
name = "bintray"
url = uri("https://api.bintray.com/maven/${project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')}/PlaguBot/${project.name}/;publish=1;override=1")
credentials {
username = project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')
password = project.hasProperty('BINTRAY_KEY') ? project.property('BINTRAY_KEY') : System.getenv('BINTRAY_KEY')
}
}
maven {
name = "sonatype"
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
credentials {
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
}
}
}
}
}
}
apply from: "maven.publish.gradle"
bintrayUpload.dependsOn publishToMavenLocal
signing {
useGpgCmd()
sign publishing.publications
}

View File

@@ -1,40 +1,21 @@
package dev.inmo.plagubot
import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
import dev.inmo.plagubot.config.Config
import dev.inmo.plagubot.config.configSerialFormat
import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
import dev.inmo.tgbotapi.extensions.api.telegramBot
import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.startGettingFlowsUpdatesByLongPolling
import dev.inmo.tgbotapi.types.botCommandsLimit
import dev.inmo.plagubot.config.*
import kotlinx.coroutines.*
import kotlinx.serialization.InternalSerializationApi
import java.io.File
@Deprecated(
"This method is redundant due to new class PlaguBot",
ReplaceWith(
"PlaguBot(config).start(scope)",
"dev.inmo.plagubot.PlaguBot"
)
)
suspend inline fun initPlaguBot(
config: Config,
scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
) {
val bot = telegramBot(config.botToken)
bot.startGettingFlowsUpdatesByLongPolling(scope = scope) {
val commands = config.plugins.flatMap {
it.invoke(bot, config.database.database, this, scope)
it.getCommands()
}.let {
val futureUnavailable = it.drop(botCommandsLimit.last)
if (futureUnavailable.isNotEmpty()) {
println("Next commands are out of range in setting command request and will be unavailable from autocompleting: ${futureUnavailable}")
}
it.take(botCommandsLimit.last)
}
scope.launch {
safelyWithoutExceptions {
bot.setMyCommands(commands)
}
}
}
}
): Job = PlaguBot(config).start(scope)
/**
* This method by default expects one argument in [args] field: path to config
@@ -43,9 +24,7 @@ suspend inline fun initPlaguBot(
suspend fun main(args: Array<String>) {
val (configPath) = args
val file = File(configPath)
val config = configSerialFormat.decodeFromString(Config.serializer(), file.readText())
val config = configJsonFormat.decodeFromString(ConfigSerializer, file.readText())
val scope = CoroutineScope(Dispatchers.Default)
initPlaguBot(config, scope)
scope.coroutineContext.job.join()
PlaguBot(config).start().join()
}

View File

@@ -1,8 +1,6 @@
package dev.inmo.plagubot
import dev.inmo.tgbotapi.bot.TelegramBot
import dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter
import kotlinx.coroutines.CoroutineScope
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import org.jetbrains.exposed.sql.Database
@@ -12,12 +10,7 @@ import org.jetbrains.exposed.sql.Database
data class HelloPlugin(
val parameter: String
) : Plugin {
override suspend fun invoke(
bot: TelegramBot,
database: Database,
updatesFilter: FlowsUpdatesFilter,
scope: CoroutineScope
) {
override suspend fun BehaviourContext.invoke(database: Database) {
println(parameter)
}
}

View File

@@ -0,0 +1,56 @@
package dev.inmo.plagubot
import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
import dev.inmo.plagubot.config.Config
import dev.inmo.plagubot.config.database
import dev.inmo.tgbotapi.bot.Ktor.telegramBot
import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
import dev.inmo.tgbotapi.types.BotCommand
import dev.inmo.tgbotapi.types.botCommandsLimit
import kotlinx.coroutines.*
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import org.jetbrains.exposed.sql.Database
const val DefaultPlaguBotParamsKey = "plagubot"
val Map<String, Any>.plagubot
get() = get(DefaultPlaguBotParamsKey) as? PlaguBot
@Serializable
data class PlaguBot(
private val config: Config
) : Plugin {
@Transient
private val bot = telegramBot(config.botToken)
@Transient
private val paramsMap = config.params ?.toMap() ?: emptyMap()
@Transient
private val database = config.params ?.database ?: config.database.database
override suspend fun getCommands(): List<BotCommand> = config.plugins.flatMap {
it.getCommands()
}
override suspend fun BehaviourContext.invoke(database: Database, params: Map<String, Any>) {
config.plugins.forEach {
it.apply { invoke(database, params) }
}
val commands = getCommands()
val futureUnavailable = commands.drop(botCommandsLimit.last)
if (futureUnavailable.isNotEmpty()) {
println("Next commands are out of range in setting command request and will be unavailable from autocompleting: $futureUnavailable")
}
safelyWithoutExceptions { setMyCommands(commands.take(botCommandsLimit.last)) }
}
/**
* This method will create an [Job] which will be the main [Job] of ran instance
*/
suspend fun start(
scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
): Job = bot.buildBehaviour(scope) {
invoke(database, paramsMap)
}
}

View File

@@ -2,8 +2,13 @@ package dev.inmo.plagubot.config
import com.github.matfax.klassindex.KlassIndex
import dev.inmo.plagubot.Plugin
import dev.inmo.plagubot.PluginSerializer
import dev.inmo.sdi.*
import kotlinx.serialization.*
import kotlinx.serialization.json.Json
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
import kotlinx.serialization.json.*
import kotlinx.serialization.modules.*
import kotlin.reflect.KClass
@@ -11,7 +16,7 @@ import kotlin.reflect.KClass
internal inline fun <T : Plugin> KClass<T>.includeIn(builder: PolymorphicModuleBuilder<Plugin>) = builder.subclass(this, serializer())
@InternalSerializationApi
internal val configSerialFormat: StringFormat
internal val configJsonFormat: Json
get() = Json {
ignoreUnknownKeys = true
serializersModule = SerializersModule {
@@ -36,7 +41,126 @@ internal val configSerialFormat: StringFormat
@Serializable
data class Config(
val plugins: List<Plugin>,
val database: DatabaseConfig,
val botToken: String
val plugins: List<@Contextual Plugin>,
val database: DatabaseConfig = DatabaseConfig(),
val botToken: String,
@Contextual
val params: Module? = null
)
@Serializer(Plugin::class)
private class InternalPluginSerializer(
private val params: Module
) : KSerializer<Plugin> {
override val descriptor: SerialDescriptor = PluginSerializer.descriptor
@InternalSerializationApi
override fun deserialize(decoder: Decoder): Plugin {
val asJson = JsonElement.serializer().deserialize(decoder)
return if (asJson is JsonPrimitive) {
params[asJson.jsonPrimitive.content] as Plugin
} else {
val jsonFormat = ((decoder as? JsonDecoder)?.json ?: configJsonFormat)
jsonFormat.decodeFromJsonElement(PluginSerializer, asJson)
}
}
@InternalSerializationApi
override fun serialize(encoder: Encoder, value: Plugin) {
params.keys.firstOrNull { params[it] === value } ?.also {
encoder.encodeString(it)
} ?: PluginSerializer.serialize(encoder, value)
}
}
private val DefaultModuleSerializer = ModuleSerializer(emptyList()) {
}
@Serializer(Module::class)
private class InternalModuleSerializer(
private val original: JsonElement?,
private val params: Module
) : KSerializer<Module> {
override val descriptor: SerialDescriptor = PluginSerializer.descriptor
@InternalSerializationApi
override fun deserialize(decoder: Decoder): Module {
val asJson = JsonElement.serializer().deserialize(decoder)
return if (asJson == original) {
params
} else {
configJsonFormat.decodeFromJsonElement(DefaultModuleSerializer, asJson)
}
}
@InternalSerializationApi
override fun serialize(encoder: Encoder, value: Module) = DefaultModuleSerializer.serialize(encoder, value)
}
private fun internalPluginSerializerSerializersModule(
internalPluginSerializer: InternalPluginSerializer,
internalModuleSerializer: InternalModuleSerializer?
) = SerializersModule {
contextual(internalPluginSerializer)
contextual(internalModuleSerializer ?: return@SerializersModule)
}
@Serializer(Config::class)
internal object ConfigSerializer : KSerializer<Config> {
private val jsonSerializer = JsonObject.serializer()
private val moduleSerializer = ModuleSerializer()
@InternalSerializationApi
override fun deserialize(decoder: Decoder): Config {
val json = jsonSerializer.deserialize(decoder)
val jsonFormat = (decoder as? JsonDecoder) ?.json ?: configJsonFormat
val paramsRow = json["params"]
val resultJsonFormat = if (paramsRow != null && paramsRow != JsonNull) {
val params = jsonFormat.decodeFromJsonElement(
moduleSerializer,
paramsRow
)
val pluginsSerializer = InternalPluginSerializer(params)
val moduleSerializer = InternalModuleSerializer(paramsRow, params)
Json(jsonFormat) {
serializersModule = decoder.serializersModule.overwriteWith(
internalPluginSerializerSerializersModule(pluginsSerializer, moduleSerializer)
)
}
} else {
jsonFormat
}
return resultJsonFormat.decodeFromJsonElement(
Config.serializer(),
json
)
}
@InternalSerializationApi
override fun serialize(encoder: Encoder, value: Config) {
if (value.params != null) {
val pluginsSerializer = InternalPluginSerializer(value.params)
val jsonFormat = Json(configJsonFormat) {
serializersModule = encoder.serializersModule.overwriteWith(
internalPluginSerializerSerializersModule(pluginsSerializer, null)
)
}
jsonSerializer.serialize(
encoder,
jsonFormat.encodeToJsonElement(
Config.serializer(),
value
) as JsonObject
)
} else {
Config.serializer().serialize(encoder, value)
}
}
}

View File

@@ -1,5 +1,6 @@
package dev.inmo.plagubot.config
import dev.inmo.sdi.SDIIncluded
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import org.jetbrains.exposed.sql.Database
@@ -7,7 +8,12 @@ import org.jetbrains.exposed.sql.transactions.transactionManager
import org.sqlite.JDBC
import java.sql.Connection
const val defaultDatabaseParamsName = "defaultDatabase"
inline val Map<String, Any>.database: Database?
get() = (get(defaultDatabaseParamsName) as? DatabaseConfig) ?.database
@Serializable
@SDIIncluded
data class DatabaseConfig(
val url: String = "jdbc:sqlite:file:test?mode=memory&cache=shared",
val driver: String = JDBC::class.qualifiedName!!,

View File

@@ -0,0 +1,37 @@
package dev.inmo.plagubot.config
import dev.inmo.plagubot.HelloPlugin
import kotlinx.serialization.InternalSerializationApi
import org.junit.Test
import kotlin.test.assertEquals
class ConfigTest {
@InternalSerializationApi
@Test
fun testThatPluginPassedToParamsWillBeCorrectlyUsedInPlugins() {
val rawConfig = """
{
"database": {
},
"botToken": "",
"plugins": [
"helloPlugin"
],
"params": {
"helloPlugin": {"type": "dev.inmo.plagubot.HelloPlugin", "parameter": "Example"}
}
}
""".trimIndent()
val config = configJsonFormat.decodeFromString(ConfigSerializer, rawConfig)
assert(config.plugins.size == 1)
assert(config.plugins.first() is HelloPlugin)
assert((config.plugins.first() as HelloPlugin).parameter == "Example")
val redecoded = configJsonFormat.decodeFromString(ConfigSerializer, configJsonFormat.encodeToString(ConfigSerializer, config))
assertEquals(config.database, redecoded.database)
assertEquals(config.plugins, redecoded.plugins)
assertEquals(config.botToken, redecoded.botToken)
assertEquals(config.params ?.toMap(), redecoded.params ?.toMap())
}
}

View File

@@ -7,15 +7,14 @@ buildscript {
dependencies {
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:$gradle_bintray_plugin_version"
classpath "com.github.breadmoirai:github-release:$github_release_plugin_version"
}
}
allprojects {
repositories {
jcenter()
mavenCentral()
jcenter()
mavenLocal()
maven { url 'https://jitpack.io' }
}

View File

@@ -4,17 +4,19 @@ org.gradle.parallel=true
kotlin.js.generate.externals=true
kotlin.incremental=true
kotlin_version=1.4.10
kotlin_coroutines_version=1.4.1
kotlin_serialisation_runtime_version=1.0.1
kotlin_exposed_version=0.28.1
tgbotapi_version=0.30.7
microutils_version=0.4.1
kotlin_version=1.4.32
kotlin_coroutines_version=1.4.3
kotlin_serialisation_runtime_version=1.1.0
kotlin_exposed_version=0.30.1
sdi_version=0.4.1
tgbotapi_version=0.33.3
microutils_version=0.4.33
klassindex_version=4.1.0-rc.1
sqlite_version=3.30.1
gradle_bintray_plugin_version=1.8.5
github_release_plugin_version=2.2.12
group=dev.inmo
version=0.0.4
version=0.1.8

View File

@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

View File

@@ -1,54 +0,0 @@
apply plugin: 'maven-publish'
task sourcesJar(type: Jar) {
from sourceSets.main.allSource
classifier = 'sources'
}
task javadocJar(type: Jar) {
from javadoc
classifier = 'javadoc'
}
publishing {
publications {
maven(MavenPublication) {
from components.java
artifact sourcesJar
artifact javadocJar
pom {
resolveStrategy = Closure.DELEGATE_FIRST
description = ""
name = "PlaguBot ${project.name}"
url = "https://github.com/InsanusMokrassar/PlaguBot"
scm {
developerConnection = "scm:git:[fetch=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git[push=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
url = "ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
}
developers {
developer {
id = "InsanusMokrassar"
name = "Aleksei Ovsiannikov"
email = "ovsyannikov.alexey95@gmail.com"
}
}
licenses {
license {
name = "Apache Software License 2.0"
url = "https://github.com/InsanusMokrassar/PlaguBot/LICENSE"
}
}
}
}
}
}

View File

@@ -1 +1 @@
{"bintrayConfig":{"repo":"PlaguBot","packageName":"${project.name}","packageVcs":"https://github.com/InsanusMokrassar/PlaguBot","autoPublish":true,"overridePublish":true},"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot ${project.name}","description":"","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}]},"type":"JVM"}
{"bintrayConfig":{"repo":"PlaguBot","packageName":"${project.name}","packageVcs":"https://github.com/InsanusMokrassar/PlaguBot","autoPublish":true,"overridePublish":true},"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Plugin","description":"Base dependency for whole PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","includeGpgSigning":true,"publishToMavenCentral":true,"developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}]},"type":"JVM"}

View File

@@ -1,43 +1,82 @@
apply plugin: 'com.jfrog.bintray'
apply plugin: 'maven-publish'
apply plugin: 'signing'
ext {
projectBintrayDir = "${project.group}/".replace(".", "/") + "${project.name}/${project.version}"
task javadocJar(type: Jar) {
from javadoc
classifier = 'javadoc'
}
task sourcesJar(type: Jar) {
from sourceSets.main.allSource
classifier = 'sources'
}
bintray {
user = project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')
key = project.hasProperty('BINTRAY_KEY') ? project.property('BINTRAY_KEY') : System.getenv('BINTRAY_KEY')
publications = ["maven"]
filesSpec {
into "$projectBintrayDir"
from("build/libs") {
include "**/*.asc"
}
from("build/publications/maven") {
rename 'pom-default.xml(.*)', "${project.name}-${project.version}.pom\$1"
}
}
publish = true
override = true
pkg {
repo = "PlaguBot"
name = "${project.name}"
vcsUrl = "https://github.com/InsanusMokrassar/PlaguBot"
licenses = ["Apache-2.0"]
version {
name = "${project.version}"
released = new Date()
vcsTag = "${project.version}"
gpg {
sign = true
passphrase = project.hasProperty('signing.gnupg.passphrase') ? project.property('signing.gnupg.passphrase') : System.getenv('signing.gnupg.passphrase')
publishing {
publications {
maven(MavenPublication) {
from components.java
artifact javadocJar
artifact sourcesJar
pom {
resolveStrategy = Closure.DELEGATE_FIRST
description = "Base dependency for whole PlaguBot project"
name = "PlaguBot Plugin"
url = "https://github.com/InsanusMokrassar/PlaguBot"
scm {
developerConnection = "scm:git:[fetch=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git[push=]ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
url = "ssh://git@github.com/InsanusMokrassar/PlaguBot.git"
}
developers {
developer {
id = "InsanusMokrassar"
name = "Aleksei Ovsiannikov"
email = "ovsyannikov.alexey95@gmail.com"
}
}
licenses {
license {
name = "Apache Software License 2.0"
url = "https://github.com/InsanusMokrassar/PlaguBot/LICENSE"
}
}
}
repositories {
maven {
name = "bintray"
url = uri("https://api.bintray.com/maven/${project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')}/PlaguBot/${project.name}/;publish=1;override=1")
credentials {
username = project.hasProperty('BINTRAY_USER') ? project.property('BINTRAY_USER') : System.getenv('BINTRAY_USER')
password = project.hasProperty('BINTRAY_KEY') ? project.property('BINTRAY_KEY') : System.getenv('BINTRAY_KEY')
}
}
maven {
name = "sonatype"
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
credentials {
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
}
}
}
}
}
}
apply from: "maven.publish.gradle"
bintrayUpload.dependsOn publishToMavenLocal
signing {
useGpgCmd()
sign publishing.publications
}

View File

@@ -1,9 +1,11 @@
package dev.inmo.plagubot
import dev.inmo.tgbotapi.bot.TelegramBot
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
import dev.inmo.tgbotapi.types.BotCommand
import dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter
import kotlinx.coroutines.CoroutineScope
import kotlinx.serialization.Serializable
import org.jetbrains.exposed.sql.Database
/**
@@ -11,6 +13,7 @@ import org.jetbrains.exposed.sql.Database
* to set up short name for your plugin. Besides, simple name of your class will be used as key for deserialization
* too.
*/
@Serializable(PluginSerializer::class)
interface Plugin {
/**
* In case you want to publish some processed by your plugin commands, you can provide it via this method
@@ -19,13 +22,26 @@ interface Plugin {
*/
suspend fun getCommands(): List<BotCommand> = emptyList()
/**
* This method (usually) will be invoked just one time in the whole application.
*/
@Deprecated("Override other method with receiver BehaviourContext")
suspend operator fun invoke(
bot: TelegramBot,
database: Database,
updatesFilter: FlowsUpdatesFilter,
scope: CoroutineScope
)
) {}
/**
* This method (usually) will be invoked just one time in the whole application.
*/
suspend operator fun BehaviourContext.invoke(
database: Database
) = invoke(bot, database, flowsUpdatesFilter, scope)
/**
* This method (usually) will be invoked just one time in the whole application.
*/
suspend operator fun BehaviourContext.invoke(
database: Database,
params: Map<String, Any>
) = invoke(database)
}

View File

@@ -0,0 +1,53 @@
package dev.inmo.plagubot
import kotlinx.serialization.*
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
import kotlinx.serialization.json.*
private val defaultJson = Json {
ignoreUnknownKeys = true
}
@Serializer(Plugin::class)
object PluginSerializer : KSerializer<Plugin> {
private val polymorphic = PolymorphicSerializer(Plugin::class)
override val descriptor: SerialDescriptor = JsonObject.serializer().descriptor
@InternalSerializationApi
override fun deserialize(decoder: Decoder): Plugin {
val format = (decoder as? JsonDecoder) ?.json ?: defaultJson
val asJson = JsonElement.serializer().deserialize(decoder)
val jsonObject = (asJson as? JsonObject)
val type = (jsonObject ?.get("type") as? JsonPrimitive) ?.contentOrNull
val external = if (type != null) {
try {
Class.forName(type) ?.kotlin ?.serializerOrNull()
} catch (e: Exception) {
null
}
} else {
null
}
return if (jsonObject != null && external != null) {
format.decodeFromJsonElement(
external as KSerializer<Plugin>,
JsonObject(jsonObject.toMutableMap().also { it.remove("type") })
)
} else {
format.decodeFromJsonElement(
polymorphic,
asJson
)
}
}
@InternalSerializationApi
override fun serialize(encoder: Encoder, value: Plugin) {
val serializer = (value::class.serializerOrNull() ?: polymorphic) as KSerializer<Plugin>
serializer.serialize(encoder, value)
}
}