Remove Fuel and Kovenant dependencies (#364)

readium · Jul 14, 2023 · 2d80205 · 2d80205
1 parent 57bc32b
commit 2d80205
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 203 deletions.
diff --git a/docs/migration-guide.md b/docs/migration-guide.md
@@ -67,6 +67,31 @@ navigator.addInputListener(DirectionalNavigationAdapter(
 
 `DirectionalNavigationAdapter` offers a lot of customization options. Take a look at its API.
 
+### Removal of Fuel and Kovenant
+
+Both the Fuel and Kovenant libraries have been completely removed from the toolkit. With that, several deprecated functions have also been removed.
+
+#### opds/OPDS1Parser
+
+* Both `parseURL(url: URL)` and `parseURL(headers: MutableMap<String, String>, url: URL)` have been replaced with `parseUrlString(url: String, client: HttpClient = DefaultHttpClient())`.
+* `fetchOpenSearchTemplate(feed: Feed)` has been replaced with `retrieveOpenSearchTemplate(feed: Feed)`.
+
+#### opds/OPDS2Parser
+
+* Both `parseURL(url: URL)` and `parseURL(headers: MutableMap<String, String>, url: URL)` have been replaced with `parseUrlString(url: String, client: HttpClient = DefaultHttpClient())`.
+
+#### shared/FuelPromiseExtension
+
+* `Request.promise()`
+
+#### shared/format/Deprecated
+
+* `Response.sniffFormat` has been replaced with `org.readium.r2.shared.util.mediatype.sniffMediaType`
+
+#### shared/util/mediatype/Extensions
+
+* `Response.sniffMediaType(...)` has been replaced with `org.readium.r2.shared.util.mediatype.sniffMediaType`
+
 
 ## 2.3.0
 

diff --git a/readium/opds/build.gradle.kts b/readium/opds/build.gradle.kts
@@ -49,7 +49,6 @@ dependencies {
     implementation(libs.androidx.appcompat)
     implementation(libs.timber)
     implementation(libs.joda.time)
-    implementation("nl.komponents.kovenant:kovenant:3.3.0")
     implementation(libs.kotlinx.coroutines.core)
 
     // Tests

diff --git a/readium/opds/src/main/java/org/readium/r2/opds/Extensions.kt b/readium/opds/src/main/java/org/readium/r2/opds/Extensions.kt
diff --git a/readium/opds/src/main/java/org/readium/r2/opds/OPDS1Parser.kt b/readium/opds/src/main/java/org/readium/r2/opds/OPDS1Parser.kt
@@ -10,8 +10,6 @@
 package org.readium.r2.opds
 
 import java.net.URL
-import nl.komponents.kovenant.Promise
-import nl.komponents.kovenant.then
 import org.joda.time.DateTime
 import org.readium.r2.shared.extensions.toList
 import org.readium.r2.shared.extensions.toMap
@@ -60,29 +58,6 @@ class OPDS1Parser {
             }
         }
 
-        @Deprecated(
-            "Use `parseRequest` or `parseUrlString` with coroutines instead",
-            ReplaceWith("OPDS1Parser.parseUrlString(url)"),
-            DeprecationLevel.WARNING
-        )
-        fun parseURL(url: URL): Promise<ParseData, Exception> {
-            return DefaultHttpClient().fetchPromise(HttpRequest(url.toString())) then {
-                this.parse(xmlData = it.body, url = url)
-            }
-        }
-
-        @Deprecated(
-            "Use `parseRequest` or `parseUrlString` with coroutines instead",
-            ReplaceWith("OPDS1Parser.parseUrlString(url)"),
-            DeprecationLevel.WARNING
-        )
-        @Suppress("unused")
-        fun parseURL(headers: MutableMap<String, String>, url: URL): Promise<ParseData, Exception> {
-            return DefaultHttpClient().fetchPromise(HttpRequest(url = url.toString(), headers = headers)) then {
-                this.parse(xmlData = it.body, url = url)
-            }
-        }
-
         fun parse(xmlData: ByteArray, url: URL): ParseData {
             val root = XmlParser().parse(xmlData.inputStream())
             return if (root.name == "feed")
@@ -254,65 +229,6 @@ class OPDS1Parser {
             }
         }
 
-        @Deprecated(
-            "Use `retrieveOpenSearchTemplate` with coroutines instead",
-            ReplaceWith("OPDS1Parser.retrieveOpenSearchTemplate(feed)"),
-            DeprecationLevel.WARNING
-        )
-        @Suppress("unused")
-        fun fetchOpenSearchTemplate(feed: Feed): Promise<String?, Exception> {
-
-            var openSearchURL: URL? = null
-            var selfMimeType: String? = null
-
-            for (link in feed.links) {
-                if (link.rels.contains("self")) {
-                    if (link.type != null) {
-                        selfMimeType = link.type
-                    }
-                } else if (link.rels.contains("search")) {
-                    openSearchURL = URL(link.href)
-                }
-            }
-
-            val unwrappedURL = openSearchURL?.let {
-                return@let it
-            }
-
-            return DefaultHttpClient().fetchPromise(HttpRequest(unwrappedURL.toString())) then {
-
-                val document = XmlParser().parse(it.body.inputStream())
-
-                val urls = document.get("Url", Namespaces.Search)
-
-                var typeAndProfileMatch: ElementNode? = null
-                var typeMatch: ElementNode? = null
-
-                selfMimeType?.let { s ->
-
-                    val selfMimeParams = parseMimeType(mimeTypeString = s)
-                    for (url in urls) {
-                        val urlMimeType = url.getAttr("type") ?: continue
-                        val otherMimeParams = parseMimeType(mimeTypeString = urlMimeType)
-                        if (selfMimeParams.type == otherMimeParams.type) {
-                            if (typeMatch == null) {
-                                typeMatch = url
-                            }
-                            if (selfMimeParams.parameters["profile"] == otherMimeParams.parameters["profile"]) {
-                                typeAndProfileMatch = url
-                                break
-                            }
-                        }
-                    }
-                    val match = typeAndProfileMatch ?: (typeMatch ?: urls[0])
-                    val template = match.getAttr("template")
-
-                    template
-                }
-                null
-            }
-        }
-
         private fun parseEntry(entry: ElementNode, baseUrl: URL): Publication? {
             // A title is mandatory
             val title = entry.getFirst("title", Namespaces.Atom)?.text

diff --git a/readium/opds/src/main/java/org/readium/r2/opds/OPDS2Parser.kt b/readium/opds/src/main/java/org/readium/r2/opds/OPDS2Parser.kt
@@ -10,8 +10,6 @@
 package org.readium.r2.opds
 
 import java.net.URL
-import nl.komponents.kovenant.Promise
-import nl.komponents.kovenant.then
 import org.joda.time.DateTime
 import org.json.JSONArray
 import org.json.JSONObject
@@ -53,29 +51,6 @@ class OPDS2Parser {
             }
         }
 
-        @Deprecated(
-            "Use `parseRequest` or `parseUrlString` with coroutines instead",
-            ReplaceWith("OPDS2Parser.parseUrlString(url)"),
-            DeprecationLevel.WARNING
-        )
-        fun parseURL(url: URL): Promise<ParseData, Exception> {
-            return DefaultHttpClient().fetchPromise(HttpRequest(url.toString())) then {
-                this.parse(it.body, url)
-            }
-        }
-
-        @Deprecated(
-            "Use `parseRequest` or `parseUrlString` with coroutines instead",
-            ReplaceWith("OPDS2Parser.parseUrlString(url)"),
-            DeprecationLevel.WARNING
-        )
-        @Suppress("unused")
-        fun parseURL(headers: MutableMap<String, String>, url: URL): Promise<ParseData, Exception> {
-            return DefaultHttpClient().fetchPromise(HttpRequest(url = url.toString(), headers = headers)) then {
-                this.parse(it.body, url)
-            }
-        }
-
         fun parse(jsonData: ByteArray, url: URL): ParseData {
             return if (isFeed(jsonData)) {
                 ParseData(parseFeed(jsonData, url), null, 2)

diff --git a/readium/shared/build.gradle.kts b/readium/shared/build.gradle.kts
@@ -47,16 +47,8 @@ apply(from = "$rootDir/scripts/publish-module.gradle")
 dependencies {
     implementation(libs.androidx.appcompat)
     implementation(libs.androidx.browser)
-    implementation("com.github.kittinunf.fuel:fuel-android:2.3.1")
-    implementation("com.github.kittinunf.fuel:fuel:2.3.1")
     implementation(libs.timber)
     implementation(libs.joda.time)
-    implementation("nl.komponents.kovenant:kovenant-android:3.3.0")
-    implementation("nl.komponents.kovenant:kovenant-combine:3.3.0")
-    implementation("nl.komponents.kovenant:kovenant-core:3.3.0")
-    implementation("nl.komponents.kovenant:kovenant-functional:3.3.0")
-    implementation("nl.komponents.kovenant:kovenant-jvm:3.3.0")
-    implementation("nl.komponents.kovenant:kovenant:3.3.0")
     implementation(libs.kotlin.reflect)
     implementation(libs.kotlinx.coroutines.core)
     implementation(libs.kotlinx.serialization.json)

diff --git a/readium/shared/src/main/java/org/readium/r2/shared/FuelPromiseExtension.kt b/readium/shared/src/main/java/org/readium/r2/shared/FuelPromiseExtension.kt
diff --git a/readium/shared/src/main/java/org/readium/r2/shared/format/Deprecated.kt b/readium/shared/src/main/java/org/readium/r2/shared/format/Deprecated.kt
@@ -6,7 +6,6 @@
 
 package org.readium.r2.shared.format
 
-import com.github.kittinunf.fuel.core.Response
 import java.net.HttpURLConnection
 import org.readium.r2.shared.util.mediatype.MediaType as NewMediaType
 import org.readium.r2.shared.util.mediatype.Sniffer
@@ -25,14 +24,6 @@ typealias FormatSniffers = Sniffers
 @Deprecated("Renamed SnifferContext", replaceWith = ReplaceWith("org.readium.r2.shared.util.mediatype.SnifferContext"), level = DeprecationLevel.ERROR)
 typealias FormatSnifferContext = SnifferContext
 
-@Deprecated("Renamed to another package", ReplaceWith("org.readium.r2.shared.util.mediatype.sniffMediaType"), level = DeprecationLevel.ERROR)
-suspend fun Response.sniffFormat(
-    mediaTypes: List<String> = emptyList(),
-    fileExtensions: List<String> = emptyList(),
-    sniffers: List<Sniffer> = NewMediaType.sniffers
-): NewMediaType? =
-    sniffMediaType(mediaTypes, fileExtensions, sniffers)
-
 @Deprecated("Renamed to another package", ReplaceWith("org.readium.r2.shared.util.mediatype.sniffMediaType"), level = DeprecationLevel.ERROR)
 suspend fun HttpURLConnection.sniffFormat(
     bytes: (() -> ByteArray)? = null,

diff --git a/readium/shared/src/main/java/org/readium/r2/shared/util/mediatype/Extensions.kt b/readium/shared/src/main/java/org/readium/r2/shared/util/mediatype/Extensions.kt
@@ -6,7 +6,6 @@
 
 package org.readium.r2.shared.util.mediatype
 
-import com.github.kittinunf.fuel.core.Response
 import java.net.HttpURLConnection
 import org.readium.r2.shared.extensions.extension
 
@@ -41,28 +40,3 @@ suspend fun HttpURLConnection.sniffMediaType(
         MediaType.of(mediaTypes = allMediaTypes, fileExtensions = allFileExtensions, sniffers = sniffers)
     }
 }
-
-/**
- * Resolves the format for this [Response], with optional extra file extension and media type
- * hints.
- */
-suspend fun Response.sniffMediaType(
-    mediaTypes: List<String> = emptyList(),
-    fileExtensions: List<String> = emptyList(),
-    sniffers: List<Sniffer> = MediaType.sniffers
-): MediaType? {
-    val allMediaTypes = mediaTypes.toMutableList()
-    val allFileExtensions = fileExtensions.toMutableList()
-
-    // The value of the `Content-Type` HTTP header.
-    allMediaTypes.addAll(0, headers["Content-Type"])
-
-    // The URL file extension.
-    url.extension?.let {
-        allFileExtensions.add(0, it)
-    }
-
-    // TODO: The suggested filename extension, part of the HTTP header `Content-Disposition`.
-
-    return MediaType.ofBytes({ data }, mediaTypes = allMediaTypes, fileExtensions = allFileExtensions, sniffers = sniffers)
-}