use CompletableFuture for java api instead of just Future (#136)

Author: sargunv

src/commonMain/kotlin/co/pokeapi/pokekotlin/PokeApi.kt

@@ -3,65 +3,16 @@ package co.pokeapi.pokekotlin
 import co.pokeapi.pokekotlin.internal.ResultConverter
 import co.pokeapi.pokekotlin.internal.createPokeApiKtorfitBuilder
 import co.pokeapi.pokekotlin.internal.getDefaultEngine
-import co.pokeapi.pokekotlin.model.Ability
-import co.pokeapi.pokekotlin.model.ApiResourceList
-import co.pokeapi.pokekotlin.model.Berry
-import co.pokeapi.pokekotlin.model.BerryFirmness
-import co.pokeapi.pokekotlin.model.BerryFlavor
-import co.pokeapi.pokekotlin.model.Characteristic
-import co.pokeapi.pokekotlin.model.ContestEffect
-import co.pokeapi.pokekotlin.model.ContestType
-import co.pokeapi.pokekotlin.model.EggGroup
-import co.pokeapi.pokekotlin.model.EncounterCondition
-import co.pokeapi.pokekotlin.model.EncounterConditionValue
-import co.pokeapi.pokekotlin.model.EncounterMethod
-import co.pokeapi.pokekotlin.model.EvolutionChain
-import co.pokeapi.pokekotlin.model.EvolutionTrigger
-import co.pokeapi.pokekotlin.model.Gender
-import co.pokeapi.pokekotlin.model.Generation
-import co.pokeapi.pokekotlin.model.GrowthRate
-import co.pokeapi.pokekotlin.model.Item
-import co.pokeapi.pokekotlin.model.ItemAttribute
-import co.pokeapi.pokekotlin.model.ItemCategory
-import co.pokeapi.pokekotlin.model.ItemFlingEffect
-import co.pokeapi.pokekotlin.model.ItemPocket
-import co.pokeapi.pokekotlin.model.Language
-import co.pokeapi.pokekotlin.model.Location
-import co.pokeapi.pokekotlin.model.LocationArea
-import co.pokeapi.pokekotlin.model.LocationAreaEncounter
-import co.pokeapi.pokekotlin.model.Machine
-import co.pokeapi.pokekotlin.model.Move
-import co.pokeapi.pokekotlin.model.MoveAilment
-import co.pokeapi.pokekotlin.model.MoveBattleStyle
-import co.pokeapi.pokekotlin.model.MoveCategory
-import co.pokeapi.pokekotlin.model.MoveDamageClass
-import co.pokeapi.pokekotlin.model.MoveLearnMethod
-import co.pokeapi.pokekotlin.model.MoveTarget
-import co.pokeapi.pokekotlin.model.NamedApiResourceList
-import co.pokeapi.pokekotlin.model.Nature
-import co.pokeapi.pokekotlin.model.PalParkArea
-import co.pokeapi.pokekotlin.model.PokeathlonStat
-import co.pokeapi.pokekotlin.model.Pokedex
-import co.pokeapi.pokekotlin.model.Pokemon
-import co.pokeapi.pokekotlin.model.PokemonColor
-import co.pokeapi.pokekotlin.model.PokemonForm
-import co.pokeapi.pokekotlin.model.PokemonHabitat
-import co.pokeapi.pokekotlin.model.PokemonShape
-import co.pokeapi.pokekotlin.model.PokemonSpecies
-import co.pokeapi.pokekotlin.model.Region
-import co.pokeapi.pokekotlin.model.Stat
-import co.pokeapi.pokekotlin.model.SuperContestEffect
-import co.pokeapi.pokekotlin.model.Type
-import co.pokeapi.pokekotlin.model.Version
-import co.pokeapi.pokekotlin.model.VersionGroup
+import co.pokeapi.pokekotlin.model.*
 import de.jensklingenberg.ktorfit.http.GET
 import de.jensklingenberg.ktorfit.http.Path
 import de.jensklingenberg.ktorfit.http.Query
-import io.ktor.client.HttpClientConfig
-import io.ktor.client.engine.HttpClientEngine
-import io.ktor.client.plugins.cache.storage.CacheStorage
-import kotlin.Result
+import io.ktor.client.*
+import io.ktor.client.engine.*
+import io.ktor.client.plugins.cache.storage.*
+import kotlin.jvm.JvmName
 
+@JvmName("create")
 public fun PokeApi(
   baseUrl: String = "https://pokeapi.co/api/v2/",
   cacheStorage: CacheStorage? = null,

src/jvmMain/kotlin/co/pokeapi/pokekotlin/internal/FutureConverter.kt renamed to src/jvmMain/kotlin/co/pokeapi/pokekotlin/internal/CompletableFutureConverter.kt

@@ -4,21 +4,20 @@ import de.jensklingenberg.ktorfit.Ktorfit
 import de.jensklingenberg.ktorfit.converter.Converter
 import de.jensklingenberg.ktorfit.converter.KtorfitResult
 import de.jensklingenberg.ktorfit.converter.TypeData
-import io.ktor.client.statement.HttpResponse
-import java.util.concurrent.Future
+import io.ktor.client.statement.*
+import java.util.concurrent.CompletableFuture
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.DelicateCoroutinesApi
-import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.future.future
 
-internal class FutureConverter(typeData: TypeData) :
-  Converter.ResponseConverter<HttpResponse, Future<*>> {
+internal class CompletableFutureConverter(typeData: TypeData, private val scope: CoroutineScope) :
+  Converter.ResponseConverter<HttpResponse, CompletableFuture<*>> {
 
   private val resultConverter = ResultConverter(typeData)
 
   @OptIn(DelicateCoroutinesApi::class)
-  override fun convert(getResponse: suspend () -> HttpResponse): Future<*> {
-    // safe to use GlobalScope as it'll be the Java code's responsibility to handle the future
-    return GlobalScope.future {
+  override fun convert(getResponse: suspend () -> HttpResponse): CompletableFuture<*> {
+    return scope.future {
       val result =
         try {
           KtorfitResult.Success(getResponse())
@@ -29,9 +28,13 @@ internal class FutureConverter(typeData: TypeData) :
     }
   }
 
-  internal object Factory : Converter.Factory {
-    override fun responseConverter(typeData: TypeData, ktorfit: Ktorfit): FutureConverter? {
-      return if (typeData.typeInfo.type != Future::class) null else FutureConverter(typeData)
+  internal class Factory(private val scope: CoroutineScope) : Converter.Factory {
+    override fun responseConverter(
+      typeData: TypeData,
+      ktorfit: Ktorfit,
+    ): CompletableFutureConverter? {
+      return if (typeData.typeInfo.type != CompletableFuture::class) null
+      else CompletableFutureConverter(typeData, scope)
     }
   }
 }