dictionaryapi.dev API

Author: madhead

english/dictionaryapi-dev/README.adoc

@@ -0,0 +1,3 @@
+= English / dictionaryapi.dev
+
+https://dictionaryapi.dev[dictionaryapi.dev] client.

english/dictionaryapi-dev/build.gradle.kts

@@ -0,0 +1,31 @@
+plugins {
+    kotlin("jvm")
+    kotlin("plugin.serialization")
+}
+
+dependencies {
+    implementation(platform(libs.ktor.bom))
+
+    implementation(libs.ktor.client.apache)
+    implementation(libs.ktor.client.content.negotiation)
+    implementation(libs.ktor.serialization.kotlinx.json)
+    implementation(libs.log4j.api)
+
+    testImplementation(libs.junit.jupiter.api)
+    testImplementation(libs.junit.jupiter.params)
+    testImplementation(libs.mockk)
+    testRuntimeOnly(libs.junit.jupiter.engine)
+    testRuntimeOnly(libs.log4j.core)
+}
+
+tasks {
+    val integrationTest by registering(Test::class) {
+        group = LifecycleBasePlugin.VERIFICATION_GROUP
+        description = "Runs the integration tests."
+        shouldRunAfter("test")
+        outputs.upToDateWhen { false }
+        useJUnitPlatform {
+            includeTags("it")
+        }
+    }
+}

english/dictionaryapi-dev/src/main/kotlin/by/jprof/telegram/bot/english/dictionaryapi_dev/DictionaryAPIDotDevClient.kt

@@ -0,0 +1,5 @@
+package by.jprof.telegram.bot.english.dictionaryapi_dev
+
+interface DictionaryAPIDotDevClient {
+    suspend fun define(term: String): Collection<Word>
+}

english/dictionaryapi-dev/src/main/kotlin/by/jprof/telegram/bot/english/dictionaryapi_dev/KtorDictionaryAPIDotDevClient.kt

@@ -0,0 +1,35 @@
+package by.jprof.telegram.bot.english.dictionaryapi_dev
+
+import io.ktor.client.HttpClient
+import io.ktor.client.call.body
+import io.ktor.client.engine.apache.Apache
+import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
+import io.ktor.client.request.get
+import io.ktor.client.request.url
+import io.ktor.http.encodeURLPathPart
+import io.ktor.serialization.kotlinx.json.json
+import java.io.Closeable
+import kotlinx.serialization.json.Json
+
+class KtorDictionaryAPIDotDevClient(
+    private val baseUrl: String = "https://api.dictionaryapi.dev/api/v2"
+) : DictionaryAPIDotDevClient, Closeable {
+    private val client = HttpClient(Apache) {
+        install(ContentNegotiation) {
+            json(
+                Json {
+                    ignoreUnknownKeys = true
+                }
+            )
+        }
+    }
+
+    override suspend fun define(term: String): Collection<Word> =
+        client.get {
+            url("$baseUrl/entries/en/${term.encodeURLPathPart()}")
+        }.body()
+
+    override fun close() {
+        client.close()
+    }
+}

english/dictionaryapi-dev/src/main/kotlin/by/jprof/telegram/bot/english/dictionaryapi_dev/Word.kt

@@ -0,0 +1,42 @@
+package by.jprof.telegram.bot.english.dictionaryapi_dev
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class Word(
+    val word: String,
+    val phonetics: Collection<Phonetic>? = null,
+    val meanings: Collection<Meaning>? = null,
+    val license: License? = null,
+    val sourceUrls: Collection<String>? = null,
+)
+
+@Serializable
+data class Phonetic(
+    val text: String? = null,
+    val audio: String? = null,
+    val sourceUrl: String? = null,
+    val license: License? = null,
+)
+
+@Serializable
+data class Meaning(
+    val partOfSpeech: String,
+    val definitions: Collection<Definition>,
+    val synonyms: Collection<String>? = null,
+    val antonyms: Collection<String>? = null,
+)
+
+@Serializable
+data class Definition(
+    val definition: String,
+    val example: String? = null,
+    val synonyms: Collection<String>? = null,
+    val antonyms: Collection<String>? = null,
+)
+
+@Serializable
+data class License(
+    val name: String,
+    val url: String,
+)

english/dictionaryapi-dev/src/test/kotlin/by/jprof/telegram/bot/english/dictionaryapi_dev/KtorKtorDictionaryAPIDotDevClientIntegrationTest.kt

@@ -0,0 +1,26 @@
+package by.jprof.telegram.bot.english.dictionaryapi_dev
+
+import kotlinx.coroutines.runBlocking
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.BeforeAll
+import org.junit.jupiter.api.Tag
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+
+@Tag("it")
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+internal class KtorKtorDictionaryAPIDotDevClientIntegrationTest {
+    private lateinit var sut: KtorDictionaryAPIDotDevClient
+
+    @BeforeAll
+    internal fun setup() {
+        sut = KtorDictionaryAPIDotDevClient()
+    }
+
+    @Test
+    fun define() = runBlocking {
+        val definitions = sut.define("motherfucker")
+
+        assertTrue(definitions.isNotEmpty())
+    }
+}

settings.gradle.kts

@@ -38,6 +38,7 @@ include(":english")
 include(":english:language-rooms")
 include(":english:language-rooms:dynamodb")
 include(":english:urban-dictionary")
+include(":english:dictionaryapi-dev")
 include(":english:urban-word-of-the-day")
 include(":english:urban-word-of-the-day:dynamodb")
 include(":english:urban-word-of-the-day-formatter")