From 6611d600bdaabec25e3fe86201cc5607837a85a0 Mon Sep 17 00:00:00 2001 From: Anthony Cicchetti Date: Mon, 24 Jan 2022 21:59:17 -0500 Subject: [PATCH] `/osrsitem` command added --- VERSION | 2 +- build.gradle.kts | 30 +++++- buildSrc/build.gradle.kts | 14 +++ buildSrc/settings.gradle.kts | 16 +++- buildSrc/src/main/kotlin/Libs.kt | 96 +++++++------------ buildSrc/src/main/kotlin/Versions.kt | 53 ---------- settings.gradle.kts | 20 +++- .../com/anthonycicchetti/slackbot/Main.kt | 34 ++++++- .../slackbot/osrs/ItemMapper.kt | 75 +++++++++++++++ .../slackbot/utility/BlockResponse.kt | 24 +++++ .../slackbot/utility/RespObj.kt | 1 + versions.properties | 14 ++- 12 files changed, 253 insertions(+), 126 deletions(-) delete mode 100644 buildSrc/src/main/kotlin/Versions.kt create mode 100644 src/main/kotlin/com/anthonycicchetti/slackbot/osrs/ItemMapper.kt create mode 100644 src/main/kotlin/com/anthonycicchetti/slackbot/utility/BlockResponse.kt diff --git a/VERSION b/VERSION index 0ea3a94..0d91a54 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.2.0 +0.3.0 diff --git a/build.gradle.kts b/build.gradle.kts index 662bfcd..1e15413 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,8 +1,22 @@ +buildscript { + dependencies { + constraints { + classpath("org.apache.logging.log4j:log4j-core") { + version { + strictly("[2.17, 3[") + prefer("2.17.0") + } + because("CVE-2021-44228, CVE-2021-45046, CVE-2021-45105: Log4j vulnerable to remote code execution and other critical security vulnerabilities") + } + } + } +} + import org.jetbrains.kotlin.gradle.tasks.KotlinCompile plugins { - id("com.github.johnrengelman.shadow") version Versions.com_github_johnrengelman_shadow_gradle_plugin - kotlin("jvm") version Versions.org_jetbrains_kotlin_jvm_gradle_plugin + id("com.github.johnrengelman.shadow") version Libs.com_github_johnrengelman_shadow_gradle_plugin + kotlin("jvm") version Libs.org_jetbrains_kotlin_jvm_gradle_plugin application } @@ -14,6 +28,15 @@ repositories { } dependencies { + constraints { + implementation("org.apache.logging.log4j:log4j-core") { + version { + strictly("[2.17, 3[") + prefer("2.17.0") + } + because("CVE-2021-44228, CVE-2021-45046, CVE-2021-45105: Log4j vulnerable to remote code execution and other critical security vulnerabilities") + } + } implementation(kotlin("stdlib-jdk8")) implementation(Libs.javalin) implementation(Libs.javalin_openapi) @@ -22,6 +45,9 @@ dependencies { implementation(Libs.jackson_module_kotlin) implementation(Libs.swagger_core) implementation(Libs.swagger_ui) + implementation(Libs.slack_api_model_kotlin_extension) + implementation(Libs.fuel) + implementation(Libs.fuel_jackson) testImplementation(Libs.junit_jupiter) } diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index 3bd0cc1..079ef76 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -1,3 +1,17 @@ +buildscript { + dependencies { + constraints { + classpath("org.apache.logging.log4j:log4j-core") { + version { + strictly("[2.17, 3[") + prefer("2.17.0") + } + because("CVE-2021-44228, CVE-2021-45046, CVE-2021-45105: Log4j vulnerable to remote code execution and other critical security vulnerabilities") + } + } + } +} + plugins { `kotlin-dsl` } diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts index 3f3bdb6..b2577a6 100644 --- a/buildSrc/settings.gradle.kts +++ b/buildSrc/settings.gradle.kts @@ -1,6 +1,20 @@ pluginManagement { plugins { - id("de.fayard.refreshVersions") version "0.23.0" + id("de.fayard.refreshVersions") version "0.40.0" + } +} + +buildscript { + dependencies { + constraints { + classpath("org.apache.logging.log4j:log4j-core") { + version { + strictly("[2.17, 3[") + prefer("2.17.0") + } + because("CVE-2021-44228, CVE-2021-45046, CVE-2021-45105: Log4j vulnerable to remote code execution and other critical security vulnerabilities") + } + } } } diff --git a/buildSrc/src/main/kotlin/Libs.kt b/buildSrc/src/main/kotlin/Libs.kt index 844631e..8a5f854 100644 --- a/buildSrc/src/main/kotlin/Libs.kt +++ b/buildSrc/src/main/kotlin/Libs.kt @@ -1,82 +1,52 @@ import kotlin.String /** - * Generated by https://github.com/jmfayard/buildSrcVersions + * Generated by + * $ ./gradlew buildSrcLibs + * Re-run when you add a new dependency to the build * - * Update this file with - * `$ ./gradlew buildSrcVersions` + * Find which updates are available by running + * $ ./gradlew refreshVersions + * And edit the file `versions.properties` + * + * See https://github.com/jmfayard/refreshVersions */ -object Libs { - /** - * https://kotlinlang.org/ - */ - const val kotlin_scripting_compiler_embeddable: String = - "org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable:" + - Versions.org_jetbrains_kotlin +public object Libs { + public const val jackson_databind: String = "com.fasterxml.jackson.core:jackson-databind:_" - /** - * https://kotlinlang.org/ - */ - const val kotlin_stdlib_jdk8: String = "org.jetbrains.kotlin:kotlin-stdlib-jdk8:" + - Versions.org_jetbrains_kotlin + public const val jackson_module_kotlin: String = + "com.fasterxml.jackson.module:jackson-module-kotlin:_" - /** - * https://javalin.io - */ - const val javalin: String = "io.javalin:javalin:" + Versions.io_javalin + public const val com_github_johnrengelman_shadow_gradle_plugin: String = + "com.github.johnrengelman.shadow:com.github.johnrengelman.shadow.gradle.plugin:_" - /** - * https://javalin.io - */ - const val javalin_openapi: String = "io.javalin:javalin-openapi:" + Versions.io_javalin + public const val fuel: String = "com.github.kittinunf.fuel:fuel:_" - const val com_github_johnrengelman_shadow_gradle_plugin: String = - "com.github.johnrengelman.shadow:com.github.johnrengelman.shadow.gradle.plugin:" + - Versions.com_github_johnrengelman_shadow_gradle_plugin + public const val fuel_jackson: String = "com.github.kittinunf.fuel:fuel-jackson:_" - const val de_fayard_buildsrcversions_gradle_plugin: String = - "de.fayard.buildSrcVersions:de.fayard.buildSrcVersions.gradle.plugin:" + - Versions.de_fayard_buildsrcversions_gradle_plugin + public const val slack_api_model_kotlin_extension: String = + "com.slack.api:slack-api-model-kotlin-extension:_" - const val org_jetbrains_kotlin_jvm_gradle_plugin: String = - "org.jetbrains.kotlin.jvm:org.jetbrains.kotlin.jvm.gradle.plugin:" + - Versions.org_jetbrains_kotlin_jvm_gradle_plugin + public const val de_fayard_buildsrclibs_gradle_plugin: String = + "de.fayard.buildSrcLibs:de.fayard.buildSrcLibs.gradle.plugin:_" - /** - * https://github.com/FasterXML/jackson-module-kotlin - */ - const val jackson_module_kotlin: String = - "com.fasterxml.jackson.module:jackson-module-kotlin:" + Versions.jackson_module_kotlin + public const val javalin: String = "io.javalin:javalin:_" - /** - * https://github.com/derveloper/kotlin-openapi3-dsl - */ - const val kotlin_openapi3_dsl: String = "cc.vileda:kotlin-openapi3-dsl:" + - Versions.kotlin_openapi3_dsl + public const val javalin_openapi: String = "io.javalin:javalin-openapi:_" - /** - * http://github.com/FasterXML/jackson - */ - const val jackson_databind: String = "com.fasterxml.jackson.core:jackson-databind:" + - Versions.jackson_databind + public const val swagger_core: String = "io.swagger.core.v3:swagger-core:_" - /** - * https://junit.org/junit5/ - */ - const val junit_jupiter: String = "org.junit.jupiter:junit-jupiter:" + Versions.junit_jupiter + public const val org_jetbrains_kotlin_jvm_gradle_plugin: String = + "org.jetbrains.kotlin.jvm:org.jetbrains.kotlin.jvm.gradle.plugin:_" - /** - * http://www.slf4j.org - */ - const val slf4j_simple: String = "org.slf4j:slf4j-simple:" + Versions.slf4j_simple + public const val kotlin_scripting_compiler_embeddable: String = + "org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable:_" - /** - * https://github.com/swagger-api/swagger-core - */ - const val swagger_core: String = "io.swagger.core.v3:swagger-core:" + Versions.swagger_core + public const val kotlin_stdlib_jdk8: String = "org.jetbrains.kotlin:kotlin-stdlib-jdk8" - /** - * http://webjars.org - */ - const val swagger_ui: String = "org.webjars:swagger-ui:" + Versions.swagger_ui + public const val junit_jupiter: String = "org.junit.jupiter:junit-jupiter:_" + + public const val slf4j_simple: String = "org.slf4j:slf4j-simple:_" + + public const val swagger_ui: String = "org.webjars:swagger-ui:_" } diff --git a/buildSrc/src/main/kotlin/Versions.kt b/buildSrc/src/main/kotlin/Versions.kt deleted file mode 100644 index 0137f3e..0000000 --- a/buildSrc/src/main/kotlin/Versions.kt +++ /dev/null @@ -1,53 +0,0 @@ -import kotlin.String -import org.gradle.plugin.use.PluginDependenciesSpec -import org.gradle.plugin.use.PluginDependencySpec - -/** - * Generated by https://github.com/jmfayard/buildSrcVersions - * - * Find which updates are available by running - * `$ ./gradlew buildSrcVersions` - * This will only update the comments. - * - * YOU are responsible for updating manually the dependency version. - */ -object Versions { - const val org_jetbrains_kotlin: String = "_" // available: "_" - - const val io_javalin: String = "_" // available: "_" - - const val com_github_johnrengelman_shadow_gradle_plugin: String = "_" - - const val de_fayard_buildsrcversions_gradle_plugin: String = "_" - - const val org_jetbrains_kotlin_jvm_gradle_plugin: String = "_" // available: "_" - - const val jackson_module_kotlin: String = "_" // available: "_" - - const val kotlin_openapi3_dsl: String = "_" - - const val jackson_databind: String = "_" // available: "_" - - const val junit_jupiter: String = "_" - - const val slf4j_simple: String = "_" - - const val swagger_core: String = "_" // available: "_" - - const val swagger_ui: String = "_" // available: "_" - - /** - * Current version: "_" - * See issue 19: How to update Gradle itself? - * https://github.com/jmfayard/buildSrcVersions/issues/19 - */ - const val gradleLatestVersion: String = "_" -} - -/** - * See issue #47: how to update buildSrcVersions itself - * https://github.com/jmfayard/buildSrcVersions/issues/47 - */ -val PluginDependenciesSpec.buildSrcVersions: PluginDependencySpec - inline get() = - id("de.fayard.buildSrcVersions").version(Versions.de_fayard_buildsrcversions_gradle_plugin) diff --git a/settings.gradle.kts b/settings.gradle.kts index 3e74c94..04d06c7 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -2,10 +2,28 @@ rootProject.name = "slackmemes" pluginManagement { plugins { - id("de.fayard.refreshVersions") version "0.23.0" + id("de.fayard.refreshVersions") version "0.40.0" } } +buildscript { + dependencies { + constraints { + classpath("org.apache.logging.log4j:log4j-core") { + version { + strictly("[2.17, 3[") + prefer("2.17.0") + } + because("CVE-2021-44228, CVE-2021-45046, CVE-2021-45105: Log4j vulnerable to remote code execution and other critical security vulnerabilities") + } + } + } +} + +refreshVersions { + enableBuildSrcLibs() +} + plugins { id("de.fayard.refreshVersions") } diff --git a/src/main/kotlin/com/anthonycicchetti/slackbot/Main.kt b/src/main/kotlin/com/anthonycicchetti/slackbot/Main.kt index d6ee221..a79e0fd 100644 --- a/src/main/kotlin/com/anthonycicchetti/slackbot/Main.kt +++ b/src/main/kotlin/com/anthonycicchetti/slackbot/Main.kt @@ -1,8 +1,7 @@ package com.anthonycicchetti.slackbot -import com.anthonycicchetti.slackbot.utility.Commands -import com.anthonycicchetti.slackbot.utility.RespObj -import com.anthonycicchetti.slackbot.utility.TextResponse +import com.anthonycicchetti.slackbot.osrs.ItemMapper +import com.anthonycicchetti.slackbot.utility.* import io.javalin.http.Context import io.javalin.Javalin import io.javalin.plugin.openapi.OpenApiOptions @@ -63,6 +62,20 @@ fun main() { logger.info("Claptext: Received request from ${ctx.req.requestURL}") ctx.json(TextResponse(200, ctx.body().toClapText())) }) + + post("/api/v1/osrsitem", documented(document().operation { + it.description = "Accepts an OSRS item name and searches for its prices on the wiki" + it.summary = "POST for OSRS Price" + }.body().json("200")) { ctx -> + logger.info("OSRS Item: Received request for ${ctx.body()}") + val item = ItemMapper.getItemByName(ctx.body()) + if (item == null) { + ctx.json(notFoundItem) + } else { + val itemPrices = ItemMapper.getItemPrice(item) + ctx.json((BlockResponse(200, item.name, itemPrices.high, itemPrices.low))) + } + }) } @@ -99,6 +112,7 @@ private fun String?.processToCommand(): Commands { "/spongemock2" -> Commands.Spongebob "/uppercase" -> Commands.Uppercase "/clapback" -> Commands.Claptext + "/osrsitem" -> Commands.OsrsItem else -> Commands.Error } } @@ -116,6 +130,18 @@ private fun sendResponse(ctx: Context, respObj: RespObj) { Commands.Claptext -> { put("text", respObj.text.toClapText()); put("response_type", "in_channel") } + Commands.OsrsItem -> { + val item = ItemMapper.getItemByName(respObj.text) + val itemPricesBlock: BlockResponse = if (item == null) { + notFoundItem + } else { + val itemPrices = ItemMapper.getItemPrice(item) + BlockResponse(200, item.name, itemPrices.high, itemPrices.low) + } + val logger = LoggerFactory.getLogger("sendResponse") + logger.info("${itemPricesBlock.response}") + put("blocks", itemPricesBlock.response); put("response_type", "in_channel") + } Commands.Error -> { put("text", respObj.text); put("response_type", "ephemeral") } @@ -128,7 +154,7 @@ private fun sendResponse(ctx: Context, respObj: RespObj) { private fun createOpenApiOptions(): OpenApiOptions { val o = { OpenAPI() - .info(Info().version("0.2.0").description("Slackbot Open API documentation")) + .info(Info().version("0.3.0").description("Slackbot Open API documentation")) .addServersItem(Server().url("https://acicchetti.dev/")) } diff --git a/src/main/kotlin/com/anthonycicchetti/slackbot/osrs/ItemMapper.kt b/src/main/kotlin/com/anthonycicchetti/slackbot/osrs/ItemMapper.kt new file mode 100644 index 0000000..4912caa --- /dev/null +++ b/src/main/kotlin/com/anthonycicchetti/slackbot/osrs/ItemMapper.kt @@ -0,0 +1,75 @@ +package com.anthonycicchetti.slackbot.osrs + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties +import com.fasterxml.jackson.databind.ObjectMapper +import com.fasterxml.jackson.module.kotlin.readValue +import com.github.kittinunf.fuel.Fuel +import com.github.kittinunf.result.Result +import org.slf4j.LoggerFactory +import java.nio.charset.Charset + +class ItemMapper { + companion object { + private val logger = LoggerFactory.getLogger("ItemMapper") + private val mapper = ObjectMapper() + fun getItemByName(itemName: String): ApiItem? = + itemList.firstOrNull { item -> item.name.lowercase() == itemName.lowercase() } + + fun getItemPrice(item: ApiItem): Item { + val response = Fuel.get("https://prices.runescape.wiki/api/v1/osrs/latest", listOf("id" to item.id)) + .appendHeader("User-Agent", "private_slackbot - @AnthonyCicc") + .responseString(Charset.defaultCharset()).third + return when (response) { + is Result.Success -> { + val r: Resp = mapper.readValue(response.get()) + r.data.getOrDefault(item.id.toString(), Item()) + } + is Result.Failure -> { + logger.warn("Couldn't find Item with ID ${item.id}") + Item() + } + } + } + + private val itemList: List = run { + val response = Fuel.get("https://prices.runescape.wiki/api/v1/osrs/mapping") + .appendHeader("User-Agent", "private_slackbot - @AnthonyCicc") + .responseString(Charset.defaultCharset()).third + when (response) { + is Result.Success -> { + logger.info("Got item mappings") + mapper.readValue(response.get()) + } + is Result.Failure -> { + logger.info("Could not get item mappings") + emptyList() + } + } + } + } +} + +data class Resp( + val data: Map = emptyMap(), +) + +data class Item ( + val low: Int = 0, + val lowTime: Long = 0L, + val high: Int = 0, + val highTime: Long = 0L, +) + + +@JsonIgnoreProperties(ignoreUnknown = true) +data class ApiItem( + val examine: String = "Empty Examine Text", + val id: Int = 0, + val members: Boolean = false, + val lowalch: Int = 0, + val limit: Int = 0, + val highalch: Int = 0, + val name: String = "Empty Name", + val value: Int = 0, +) { +} \ No newline at end of file diff --git a/src/main/kotlin/com/anthonycicchetti/slackbot/utility/BlockResponse.kt b/src/main/kotlin/com/anthonycicchetti/slackbot/utility/BlockResponse.kt new file mode 100644 index 0000000..90621a6 --- /dev/null +++ b/src/main/kotlin/com/anthonycicchetti/slackbot/utility/BlockResponse.kt @@ -0,0 +1,24 @@ +package com.anthonycicchetti.slackbot.utility + +import com.fasterxml.jackson.annotation.JsonInclude +import com.fasterxml.jackson.databind.ObjectMapper +import com.slack.api.model.kotlin_extension.block.withBlocks + +data class BlockResponse(val status: Int = 200, val itemName: String, val highVal: Int, val lowVal: Int) { + val response: String + init { + val mapper = ObjectMapper() + mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL) + val resp = run { + withBlocks { + section { markdownText("Item Found: ${itemName}") } + divider() + section { markdownText(":chart_with_upwards_trend:: $highVal") } + section { markdownText(":chart_with_downwards_trend:: $lowVal") } + } + } + response = mapper.writeValueAsString(resp) + } +} + +val notFoundItem = BlockResponse(200, "Item Not Found", 0, 0 ) diff --git a/src/main/kotlin/com/anthonycicchetti/slackbot/utility/RespObj.kt b/src/main/kotlin/com/anthonycicchetti/slackbot/utility/RespObj.kt index a71a718..fb0f940 100644 --- a/src/main/kotlin/com/anthonycicchetti/slackbot/utility/RespObj.kt +++ b/src/main/kotlin/com/anthonycicchetti/slackbot/utility/RespObj.kt @@ -12,5 +12,6 @@ sealed class Commands { object Spongebob : Commands() object Uppercase : Commands() object Claptext : Commands() + object OsrsItem : Commands() object Error : Commands() } \ No newline at end of file diff --git a/versions.properties b/versions.properties index 1890d4a..7528b69 100644 --- a/versions.properties +++ b/versions.properties @@ -1,5 +1,5 @@ #### Dependencies and Plugin versions with their available updates. -#### Generated by `./gradlew refreshVersions` version 0.23.0 +#### Generated by `./gradlew refreshVersions` version 0.40.0 #### #### Don't manually edit or split the comments that start with four hashtags (####), #### they will be overwritten by refreshVersions. @@ -9,10 +9,20 @@ plugin.com.github.johnrengelman.shadow=7.1.1 +plugin.org.gradle.kotlin.kotlin-dsl=2.1.7 + +plugin.de.fayard.buildSrcLibs=0.40.0 + version.com.fasterxml.jackson.core..jackson-databind=2.13.0 version.com.fasterxml.jackson.module..jackson-module-kotlin=2.13.0 +version.com.github.kittinunf.fuel..fuel-jackson=2.3.1 + +version.com.github.kittinunf.fuel..fuel=2.3.1 + +version.com.slack.api..slack-api-model-kotlin-extension=1.17.0 + version.io.javalin..javalin=4.1.1 version.io.javalin..javalin-openapi=4.1.1 @@ -21,6 +31,8 @@ version.io.swagger.core.v3..swagger-core=2.1.11 version.junit=5.8.2 +version.junit.jupiter=5.8.2 + version.kotlin=1.6.10 version.org.slf4j..slf4j-simple=1.7.32