Compare commits

...

85 Commits
0.1.1 ... 1.2.0

Author SHA1 Message Date
ecc17e50b9 update dependencies 2022-06-21 23:54:25 +06:00
ffafee3f43 start 1.2.0 2022-06-21 23:53:38 +06:00
b99bb9ee64 Merge pull request #30 from InsanusMokrassar/1.1.2
1.1.2
2022-06-20 20:59:53 +06:00
0dff596926 update dependencies and optimize imports 2022-06-20 20:58:38 +06:00
e0a19bb5e5 start 1.1.2 + add opportunity to load object plugins 2022-06-20 20:52:42 +06:00
5ec1c8c55f Merge pull request #29 from InsanusMokrassar/1.1.1
1.1.1
2022-06-11 19:20:33 +06:00
37fd9f39d3 fixes in logging 2022-06-11 19:19:19 +06:00
f9f56f6afb update dependencies and add logging 2022-06-11 19:15:09 +06:00
343c26a7f1 start 1.1.1 2022-06-08 17:14:50 +06:00
1b5361eb28 change version in properties 2022-06-08 17:13:46 +06:00
511ec904e9 start 1.1.0 and update tgbotapi 2022-06-08 17:13:46 +06:00
a3f59087e0 updates in dependencies and update bot setup logic 2022-06-08 17:13:46 +06:00
492c04e25f start 1.0.1 2022-06-08 17:13:46 +06:00
6b017c129f remove redundant config test and update build workflow 2022-06-08 17:13:46 +06:00
93829d3e0d add logging inside of plagubot 2022-06-08 17:13:46 +06:00
a5e7ac180d fill changelog 2022-06-08 17:13:46 +06:00
77ba1d686c complete 1.0.0 2022-06-08 17:13:46 +06:00
dec27b1c34 temporal progress 2022-06-08 17:13:46 +06:00
11c5a38b72 start migration 2022-06-08 17:13:46 +06:00
9521217765 start 1.0.0 2022-06-08 17:13:46 +06:00
4df6eafe6a Update CHANGELOG.md 2022-02-02 13:37:33 +06:00
3876262a7b Update gradle.properties 2022-02-02 13:36:59 +06:00
b10a00ca0d Update README.md 2022-01-06 12:46:23 +06:00
e6765b6c25 Merge pull request #24 from InsanusMokrassar/0.5.0
0.5.0
2022-01-04 17:41:05 +06:00
2fde3206e7 update changelog 2022-01-02 12:42:41 +06:00
4113fb2cc1 update dependencies 2022-01-02 12:41:15 +06:00
79ddfaf9bd start 0.5.0 2022-01-02 12:34:12 +06:00
8ae85ecc6e Merge pull request #23 from InsanusMokrassar/0.4.1
0.4.1
2021-11-12 17:38:41 +06:00
9d25b4b071 0.4.1 2021-11-12 17:38:18 +06:00
6d00bb6242 Merge pull request #22 from InsanusMokrassar/0.4.0
0.4.0
2021-11-12 15:33:37 +06:00
d7638d620f 0.4.0 2021-11-12 14:05:42 +06:00
8885047409 start 0.4.0 2021-11-12 13:38:19 +06:00
f09f13c13d Merge pull request #21 from InsanusMokrassar/0.3.2
0.3.2
2021-09-22 20:34:34 +06:00
8853af9a26 Update CHANGELOG.md 2021-09-22 20:34:03 +06:00
ab98b59633 Update dependencies 2021-09-22 20:30:52 +06:00
d88cf0c911 Update gradle.properties 2021-09-22 20:29:28 +06:00
5145b22dd5 Merge pull request #20 from InsanusMokrassar/0.3.1
0.3.1
2021-07-02 11:19:27 +06:00
90dd06db6d update dependencies 2021-07-01 22:44:01 +06:00
4e9b8349eb start 0.3.1 2021-07-01 22:38:54 +06:00
466e531faf Merge pull request #19 from InsanusMokrassar/0.3.0
0.3.0
2021-06-07 19:38:43 +06:00
8bf42e6fca Update CHANGELOG.md 2021-06-07 19:35:46 +06:00
a42bb91121 Update gradle.properties 2021-06-07 19:35:29 +06:00
fae2dca3d3 update changelog 2021-06-05 16:16:40 +06:00
a0d1bd2d54 update mircoutils and exposed 2021-06-05 15:25:17 +06:00
14e6c0c67d update versions 2021-06-04 12:12:58 +06:00
5a116d512a migration onto 0.3.0 2021-06-04 12:09:06 +06:00
3ba965f162 PluginsHolder, new Config deserialization and PlaguBot as correctly serializable/deserializable 2021-05-09 12:37:28 +06:00
aa8dc1af57 start 0.2.2 2021-05-08 21:35:53 +06:00
e83af6ba9f Merge pull request #17 from InsanusMokrassar/0.2.1
0.2.1
2021-05-06 03:01:26 +06:00
83c5c30555 update dependencies 2021-05-05 19:45:49 +06:00
2740ba690b start 0.2.1 2021-05-05 19:43:06 +06:00
9c681e25d2 Merge pull request #16 from InsanusMokrassar/0.2.0
0.2.0
2021-04-30 01:44:46 +06:00
d799845bea Update CHANGELOG.md 2021-04-30 01:44:24 +06:00
1f45b80b54 Update gradle.properties 2021-04-30 01:42:22 +06:00
9dabad898a Merge pull request #15 from InsanusMokrassar/0.1.9
0.1.9
2021-04-25 10:55:56 +06:00
3a718f8652 Update gradle.properties 2021-04-25 09:45:47 +06:00
6f70c9eab3 Update CHANGELOG.md 2021-04-25 09:41:36 +06:00
ca98c74952 start 0.1.9 2021-04-25 09:35:35 +06:00
4fd6922864 Merge pull request #14 from InsanusMokrassar/0.1.8
0.1.8
2021-04-05 21:27:52 +06:00
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
26 changed files with 502 additions and 213 deletions

View File

@@ -8,9 +8,9 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Set up JDK 1.8
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 1.8
java-version: 11
- name: Build with Gradle
run: ./gradlew build

2
.gitignore vendored
View File

@@ -10,5 +10,7 @@ build/
out/
local.properties
local.*
local.*/
config.json
secret.gradle

View File

@@ -1,11 +0,0 @@
language: java
install: true
os: linux
dist: trusty
jdk: oraclejdk8
jobs:
include:
- stage: build
script: ./gradlew build -s

View File

@@ -1,6 +1,178 @@
# Changelog
## 0.1.1
## 1.2.0
* `Versions`
* `tgbotapi`: `2.1.0`
## 1.1.2
* `Versions`
* `tgbotapi`: `2.0.3`
* `microutils`: `0.11.3`
* `kslog`: `0.3.1`
* `Plugin`:
* Now it is possible to use `object`s of plugins instead of classes
## 1.1.1
* `Versions`
* `coroutines`: `1.6.2`
* `tgbotapi`: `2.0.2`
* `microutils`: `0.11.0`
* `ktor`: `2.0.2`
* `uuid`: `0.4.1`
## 1.1.0
* `Versions`
* `tgbotapi`: `2.0.0`
* `microutils`: `0.10.5`
* `Plugin`:
* All plugins will be loaded in parallel
## 1.0.0
* `Versions`
* `kotlin`: `1.6.21`
* `coroutines`: `1.6.1`
* `serialization`: `1.3.3`
* `exposed`: `0.38.2`
* `tgbotapi`: `1.1.0`
* `microutils`: `0.10.4`
* `Common`:
* ___ALL THE SDI/KLASSINDEX FUNCTIONALITY HAS BEEN REMOVED___
* `Plugin`:
* Now plugins must have empty constructor
* Now plugins may provide realization of two methods: `setupDI` and `setupBotPlugin`
* `PlaguBot`:
* `Config` now is simple serializable `data class`
* `PlaguBot` now is more simple as a plugin
## 0.5.1
* `Versions`
* `tgbotapi`: `0.38.4`
* `microutils`: `0.9.5`
## 0.5.0
* `Versions`
* `kotlin`: `1.6.10`
* `coroutines`: `1.6.0`
* `serialization`: `1.3.2`
* `exposed`: `0.37.2`
* `tgbotapi`: `0.38.0`
* `microutils`: `0.9.0`
## 0.4.1
Temporal update for compatibility with java 1.8
## 0.3.2
* `Versions`
* `kotlin`: `1.5.20` -> `1.5.31`
* `coroutines`: `1.5.0` -> `1.5.2`
* `serialization`: `1.2.1` -> `1.2.2`
* `exposed`: `0.32.1` -> `0.34.2`
* `tgbotapi`: `0.35.1` -> `0.35.9`
* `microutils`: `0.5.15` -> `0.5.28`
## 0.3.1
* `Versions`
* `kotlin`: `1.5.10` -> `1.5.20`
* `tgbotapi`: `0.35.0` -> `0.35.1`
* `microutils`: `0.5.7` -> `0.5.15`
## 0.3.0
* `Versions`
* `kotlin`: `1.4.32` -> `1.5.10`
* `coroutines`: `1.4.3` -> `1.5.0`
* `serialization`: `1.1.0` -> `1.2.1`
* `exposed`: `0.31.1` -> `0.32.1`
* `sdi`: `0.4.1` -> `0.5.0`
* `tgbotapi`: `0.34.1` -> `0.35.0`
* `microutils`: `0.4.36` -> `0.5.7`
* `Bot`
* Add plugin `PluginsHolder`
* Rewrite mechanism of `Config` working
* `PlaguBot` now is correctly serializable/deserializable
## 0.2.1
* `Versions`
* `tgbotapi`: `0.33.4` -> `0.34.0`
* `sqlite`: `3.30.1` -> `3.34.0`
## 0.2.0
* `Versions`
* `tgbotapi`: `0.33.4` -> `0.34.0`
* `exposed`: `0.30.2` -> `0.31.1`
## 0.1.9
* `Versions`
* `tgbotapi`: `0.33.3` -> `0.33.4`
* `microutils`: `0.4.33` -> `0.4.36`
* `exposed`: `0.30.1` -> `0.30.2`
## 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`

View File

@@ -11,8 +11,8 @@ You can create your bot using
| Template: | [![Use template](badges/use_template.svg)](https://github.com/InsanusMokrassar/PlaguBotPluginTemplate/generate) |
|-----------|-----------------------------------------------------------------------------------------------------------------|
| Bot version: | [![Download](https://api.bintray.com/packages/insanusmokrassar/PlaguBot/plagubot.bot/images/download.svg)](https://bintray.com/insanusmokrassar/PlaguBot/plagubot.bot/_latestVersion) |
| Plugin version: | [![Download](https://api.bintray.com/packages/insanusmokrassar/PlaguBot/plagubot.plugin/images/download.svg)](https://bintray.com/insanusmokrassar/PlaguBot/plagubot.plugin/_latestVersion) |
| Bot version: | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/plagubot.bot/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/plagubot.bot) |
| Plugin version: | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/plagubot.plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/plagubot.plugin) |
That is a set of libraries for plagubots. Look at the
[PlaguBot Plugin template](https://insanusmokrassar.github.io/PlaguBotPluginTemplate/) to find how to create your bot.

View File

@@ -1,7 +1,6 @@
plugins {
id 'org.jetbrains.kotlin.jvm'
id "org.jetbrains.kotlin.plugin.serialization"
id "org.jetbrains.kotlin.kapt"
id 'application'
}
@@ -11,19 +10,18 @@ project.version="$version"
apply from: "publish.gradle"
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
api "org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlin_coroutines_version"
api "org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlin_serialisation_runtime_version"
api "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
api "org.jetbrains.exposed:exposed-jdbc:$kotlin_exposed_version"
implementation libs.kt.stdlib
api libs.kt.coroutines
api libs.kt.serialization
api libs.jb.exposed.jdbc
api "dev.inmo:tgbotapi:$tgbotapi_version"
api "dev.inmo:sdi:$sdi_version"
api "dev.inmo:micro_utils.repos.exposed:$microutils_version"
api libs.tgbotapi
api libs.microutils.repos.exposed
api libs.kslog
api "com.github.matfax.klassindex:library:$klassindex_version"
kapt "com.github.matfax.klassindex:processor:$klassindex_version"
api "org.xerial:sqlite-jdbc:$sqlite_version"
api libs.sqlite
testImplementation libs.kt.test.junit
api project(":plagubot.plugin")
}
@@ -32,10 +30,8 @@ application {
mainClassName = 'dev.inmo.plagubot.AppKt'
}
kapt {
arguments {
arg("com.github.matfax.klassindex.IndexSubclasses", "dev.inmo.plagubot.Plugin")
arg("com.github.matfax.klassindex.IndexAnnotated", "dev.inmo.sdi.SDIIncluded")
}
java {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}

View File

@@ -1 +0,0 @@
{"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,6 +1,4 @@
apply plugin: 'maven-publish'
apply plugin: 'signing'
task javadocJar(type: Jar) {
from javadoc
@@ -50,17 +48,8 @@ publishing {
}
}
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')
}
}
repositories {
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
maven {
name = "sonatype"
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
@@ -69,14 +58,24 @@ publishing {
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
}
}
}
}
}
}
}
signing {
useGpgCmd()
sign publishing.publications
if (project.hasProperty("signing.gnupg.keyName")) {
apply plugin: 'signing'
signing {
useGpgCmd()
sign publishing.publications
}
task signAll {
tasks.withType(Sign).forEach {
dependsOn(it)
}
}
}

1
bot/publish.kpsb Normal file
View File

@@ -0,0 +1 @@
{"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","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}

View File

@@ -1,50 +1,25 @@
package dev.inmo.plagubot
import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
import dev.inmo.plagubot.config.*
import dev.inmo.plagubot.config.configSerialFormat
import dev.inmo.tgbotapi.bot.Ktor.telegramBot
import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.longPolling
import dev.inmo.tgbotapi.types.botCommandsLimit
import kotlinx.coroutines.*
import dev.inmo.kslog.common.KSLog
import dev.inmo.kslog.common.i
import dev.inmo.plagubot.config.Config
import dev.inmo.plagubot.config.defaultJsonFormat
import kotlinx.serialization.InternalSerializationApi
import kotlinx.serialization.json.jsonObject
import java.io.File
suspend inline fun initPlaguBot(
config: Config,
scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
) {
val bot = telegramBot(config.botToken)
val paramsMap = config.params ?.toMap() ?: emptyMap()
val database = config.params ?.database ?: config.database.database
bot.buildBehaviour(scope) {
val commands = config.plugins.flatMap {
it.apply { invoke(database, paramsMap) }
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)
}
safelyWithoutExceptions { setMyCommands(commands) }
}
}
/**
* This method by default expects one argument in [args] field: path to config
*/
@InternalSerializationApi
suspend fun main(args: Array<String>) {
KSLog.default = KSLog("PlaguBot")
val (configPath) = args
val file = File(configPath)
val config = configSerialFormat.decodeFromString(Config.serializer(), file.readText())
KSLog.i("Start read config from ${file.absolutePath}")
val json = defaultJsonFormat.parseToJsonElement(file.readText()).jsonObject
val config = defaultJsonFormat.decodeFromJsonElement(Config.serializer(), json)
KSLog.i("Config has been read")
val scope = CoroutineScope(Dispatchers.Default)
initPlaguBot(config, scope)
scope.coroutineContext.job.join()
PlaguBot(json, config).start().join()
}

View File

@@ -1,16 +1,37 @@
package dev.inmo.plagubot
import dev.inmo.kslog.common.*
import dev.inmo.tgbotapi.extensions.api.bot.getMe
import dev.inmo.tgbotapi.extensions.api.send.reply
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onCommand
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonObject
import org.jetbrains.exposed.sql.Database
import org.koin.core.Koin
import org.koin.core.module.Module
@Serializable
@SerialName("Hello")
data class HelloPlugin(
val parameter: String
) : Plugin {
override suspend fun BehaviourContext.invoke(database: Database) {
println(parameter)
object HelloPlugin : Plugin {
@Serializable
data class HelloPluginConfig(
val print: String
)
override fun Module.setupDI(database: Database, params: JsonObject) {
single {
get<Json>().decodeFromJsonElement(HelloPluginConfig.serializer(), params["helloPlugin"] ?: return@single null)
}
}
override suspend fun BehaviourContext.setupBotPlugin(koin: Koin) {
logger.d { koin.get<HelloPluginConfig>().print }
logger.dS { getMe().toString() }
onCommand("hello_world") {
reply(it, "Hello :)")
}
}
}

View File

@@ -0,0 +1,108 @@
package dev.inmo.plagubot
import dev.inmo.kslog.common.*
import dev.inmo.micro_utils.common.Warning
import dev.inmo.micro_utils.coroutines.runCatchingSafely
import dev.inmo.plagubot.config.Config
import dev.inmo.plagubot.config.defaultJsonFormat
import dev.inmo.tgbotapi.bot.ktor.telegramBot
import dev.inmo.tgbotapi.extensions.api.webhook.deleteWebhook
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.startGettingOfUpdatesByLongPolling
import kotlinx.coroutines.*
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import kotlinx.serialization.json.JsonObject
import org.jetbrains.exposed.sql.Database
import org.koin.core.Koin
import org.koin.core.KoinApplication
import org.koin.core.context.GlobalContext
import org.koin.core.module.Module
import org.koin.core.scope.Scope
import org.koin.dsl.module
val Scope.plagubot: PlaguBot
get() = get()
val Koin.plagubot: PlaguBot
get() = get()
@OptIn(Warning::class)
@Serializable
data class PlaguBot(
private val json: JsonObject,
private val config: Config
) : Plugin {
@Transient
private val bot = telegramBot(config.botToken)
override fun Module.setupDI(database: Database, params: JsonObject) {
single { config }
single { config.plugins }
single { config.databaseConfig }
single { config.databaseConfig.database }
single { defaultJsonFormat }
single { this@PlaguBot }
includes(
config.plugins.mapNotNull {
runCatching {
module {
with(it) {
setupDI(database, params)
}
}
}.onFailure { e ->
logger.w("Unable to load DI part of $it", e)
}.getOrNull()
}
)
}
override suspend fun BehaviourContext.setupBotPlugin(koin: Koin) {
config.plugins.map { plugin ->
launch {
runCatchingSafely {
logger.i("Start loading of $plugin")
with(plugin) {
setupBotPlugin(koin)
}
}.onFailure { e ->
logger.w("Unable to load bot part of $plugin", e)
}.onSuccess {
logger.i("Complete loading of $plugin")
}
}
}.joinAll()
}
/**
* This method will create an [Job] which will be the main [Job] of ran instance
*/
suspend fun start(
scope: CoroutineScope = CoroutineScope(Dispatchers.IO)
): Job {
logger.i("Start initialization")
val koinApp = KoinApplication.init()
koinApp.modules(
module {
setupDI(config.databaseConfig.database, json)
}
)
logger.i("Modules loaded")
GlobalContext.startKoin(koinApp)
logger.i("Koin started")
lateinit var behaviourContext: BehaviourContext
bot.buildBehaviour(scope = scope) {
logger.i("Start setup of bot part")
behaviourContext = this
setupBotPlugin(koinApp.koin)
deleteWebhook()
}
logger.i("Behaviour builder has been setup")
return bot.startGettingOfUpdatesByLongPolling(scope = behaviourContext, updatesFilter = behaviourContext).also {
logger.i("Long polling has been started")
}
}
}

View File

@@ -1,44 +1,15 @@
package dev.inmo.plagubot.config
import com.github.matfax.klassindex.KlassIndex
import dev.inmo.micro_utils.common.Warning
import dev.inmo.plagubot.Plugin
import dev.inmo.sdi.Module
import kotlinx.serialization.*
import kotlinx.serialization.json.Json
import kotlinx.serialization.modules.*
import kotlin.reflect.KClass
@InternalSerializationApi
internal inline fun <T : Plugin> KClass<T>.includeIn(builder: PolymorphicModuleBuilder<Plugin>) = builder.subclass(this, serializer())
@InternalSerializationApi
internal val configSerialFormat: StringFormat
get() = Json {
ignoreUnknownKeys = true
serializersModule = SerializersModule {
polymorphic(Plugin::class) {
KlassIndex.getSubclasses(Plugin::class).flatMap { kclass ->
kclass.includeIn(this)
kclass.annotations.mapNotNull { it as? SerialName }.map {
it.value to kclass.serializer()
} + listOfNotNull(
kclass.simpleName ?.let {
it to kclass.serializer()
}
)
}.toMap().let {
default { requiredType ->
it[requiredType]
}
}
}
}
}
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Warning("This API is internal and can be changed without notifications of mentions of changes")
@Serializable
data class Config(
val plugins: List<Plugin>,
val database: DatabaseConfig = DatabaseConfig(),
val botToken: String,
val params: Module? = null
val plugins: List<Plugin>,
@SerialName("database")
val databaseConfig: DatabaseConfig = DatabaseConfig(),
)

View File

@@ -1,19 +1,17 @@
package dev.inmo.plagubot.config
import dev.inmo.sdi.SDIIncluded
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import org.jetbrains.exposed.sql.Database
import org.jetbrains.exposed.sql.transactions.transactionManager
import org.koin.core.scope.Scope
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
inline val Scope.database: Database?
get() = getOrNull<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,7 @@
package dev.inmo.plagubot.config
import kotlinx.serialization.json.Json
val defaultJsonFormat = Json {
ignoreUnknownKeys = true
}

View File

@@ -1,20 +1,19 @@
buildscript {
repositories {
jcenter()
mavenCentral()
maven { url "https://plugins.gradle.org/m2/" }
}
dependencies {
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
classpath "com.github.breadmoirai:github-release:$github_release_plugin_version"
classpath libs.buildscript.kt.gradle
classpath libs.buildscript.kt.serialization
classpath libs.buildscript.gh.release
}
}
allprojects {
repositories {
mavenCentral()
jcenter()
mavenLocal()
maven { url 'https://jitpack.io' }
}

View File

@@ -4,19 +4,5 @@ org.gradle.parallel=true
kotlin.js.generate.externals=true
kotlin.incremental=true
kotlin_version=1.4.30
kotlin_coroutines_version=1.4.2
kotlin_serialisation_runtime_version=1.1.0-RC
kotlin_exposed_version=0.29.1
sdi_version=0.4.0-rc2
tgbotapi_version=0.32.6
microutils_version=0.4.25
klassindex_version=4.1.0-rc.1
sqlite_version=3.30.1
github_release_plugin_version=2.2.12
group=dev.inmo
version=0.1.1
version=1.2.0

51
gradle/libs.versions.toml Normal file
View File

@@ -0,0 +1,51 @@
[versions]
kt = "1.6.21"
kt-serialization = "1.3.3"
kt-coroutines = "1.6.2"
microutils = "0.11.3"
tgbotapi = "2.1.0"
kslog = "0.3.1"
jb-exposed = "0.38.2"
jb-dokka = "1.6.21"
sqlite = "3.36.0.3"
klock = "2.7.0"
uuid = "0.4.1"
ktor = "2.0.2"
gh-release = "2.4.1"
android-gradle = "7.0.4"
dexcount = "3.1.0"
koin = "3.2.0"
[libraries]
kt-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kt" }
kt-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kt-coroutines" }
kt-serialization = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kt-serialization" }
tgbotapi = { module = "dev.inmo:tgbotapi", version.ref = "tgbotapi" }
microutils-repos-exposed = { module = "dev.inmo:micro_utils.repos.exposed", version.ref = "microutils" }
kslog = { module = "dev.inmo:kslog", version.ref = "kslog" }
koin = { module = "io.insert-koin:koin-core", version.ref = "koin" }
jb-exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "jb-exposed" }
sqlite = { module = "org.xerial:sqlite-jdbc", version.ref = "sqlite" }
kt-test-junit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version.ref = "kt" }
buildscript-kt-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kt" }
buildscript-kt-serialization = { module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kt" }
buildscript-jb-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "jb-dokka" }
buildscript-gh-release = { module = "com.github.breadmoirai:github-release", version.ref = "gh-release" }

View File

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

View File

@@ -9,9 +9,16 @@ project.version="$version"
apply from: "publish.gradle"
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
api "org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlin_serialisation_runtime_version"
implementation libs.kt.stdlib
api libs.kt.serialization
api "dev.inmo:tgbotapi:$tgbotapi_version"
api "dev.inmo:micro_utils.repos.exposed:$microutils_version"
api libs.tgbotapi
api libs.microutils.repos.exposed
api libs.koin
}
java {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}

View File

@@ -1 +0,0 @@
{"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,6 +1,4 @@
apply plugin: 'maven-publish'
apply plugin: 'signing'
task javadocJar(type: Jar) {
from javadoc
@@ -50,17 +48,8 @@ publishing {
}
}
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')
}
}
repositories {
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
maven {
name = "sonatype"
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
@@ -69,14 +58,24 @@ publishing {
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
}
}
}
}
}
}
}
signing {
useGpgCmd()
sign publishing.publications
if (project.hasProperty("signing.gnupg.keyName")) {
apply plugin: 'signing'
signing {
useGpgCmd()
sign publishing.publications
}
task signAll {
tasks.withType(Sign).forEach {
dependsOn(it)
}
}
}

1
plugin/publish.kpsb Normal file
View File

@@ -0,0 +1 @@
{"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","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}

View File

@@ -1,45 +1,29 @@
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 kotlinx.serialization.json.JsonObject
import org.jetbrains.exposed.sql.Database
import org.koin.core.Koin
import org.koin.core.module.Module
/**
* **ANY REALIZATION OF [Plugin] MUST HAVE CONSTRUCTOR WITH ABSENCE OF INCOMING PARAMETERS**
*
* Use this interface for your bot. It is possible to use [kotlinx.serialization.SerialName] annotations on your plugins
* 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
*
* @see BotCommand
* This method will be called when this plugin should configure di module based on the incoming params
*/
suspend fun getCommands(): List<BotCommand> = emptyList()
@Deprecated("Override other method with receiver BehaviourContext")
suspend operator fun invoke(
bot: TelegramBot,
fun Module.setupDI(
database: Database,
updatesFilter: FlowsUpdatesFilter,
scope: CoroutineScope
params: JsonObject
) {}
suspend fun BehaviourContext.setupBotPlugin(
koin: Koin
) {}
/**
* 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,25 @@
package dev.inmo.plagubot
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializer
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
@Serializer(Plugin::class)
class PluginSerializer : KSerializer<Plugin> {
override val descriptor: SerialDescriptor
get() = String.serializer().descriptor
override fun deserialize(decoder: Decoder): Plugin {
val kclass = Class.forName(decoder.decodeString()).kotlin
return (kclass.objectInstance ?: kclass.constructors.first { it.parameters.isEmpty() }.call()) as Plugin
}
override fun serialize(encoder: Encoder, value: Plugin) {
encoder.encodeString(
value::class.java.canonicalName
)
}
}

View File

@@ -8,9 +8,9 @@
},
"botToken": "1234567890:ABCDEFGHIJKLMNOP_qrstuvwxyz12345678",
"plugins": [
{
"type": "Hello",
"parameter": "Example"
}
]
}
"dev.inmo.plagubot.HelloPlugin"
],
"helloPlugin": {
"print": "Hello World"
}
}