Add customization of HTTP client configuration (#10).

mr3y-the-programmer · Nov 11, 2024 · b33e1d7 · b33e1d7
1 parent 4697e1e
commit b33e1d7
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Next release
+
+- Added: customize HTTP client configuration.
+
 ## v0.3.6 - 2024-10-15
 
 - BREAKING: Remove `Authentication` from Public API surface. this shouldn't have been used by anyone, it was just used internally, and its usages are refactored now.

diff --git a/README.md b/README.md
@@ -134,6 +134,17 @@ val client = PodcastIndexClient(...) {
     defaultTimeout = 5_000L // 5 seconds
 }
 ```
+- Specify optional custom HttpClient configuration (see [HttpClientConfig](https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client/-http-client-config/index.html)):
+```kotlin
+val client = PodcastIndexClient(...) {
+    customHttpClientConfig = {
+        install(MyCustomPlugin)
+        engine {
+            ...
+        }
+    }
+}
+```
 
 ## Support table
 Some endpoints are still work-in-progress and not implemented yet (⌛)

diff --git a/podcastindex-ktor2/src/commonMain/kotlin/com/mr3y/podcastindex/ktor2/PodcastIndexClient.kt b/podcastindex-ktor2/src/commonMain/kotlin/com/mr3y/podcastindex/ktor2/PodcastIndexClient.kt
@@ -35,6 +35,9 @@ public fun PodcastIndexClient(
             if (config.enableTimeout) {
                 installTimeoutPlugin(config.defaultTimeout)
             }
+            with(config) {
+                customHttpClientConfig()
+            }
         },
     )
 }
diff --git a/podcastindex-ktor3/src/commonMain/kotlin/com/mr3y/podcastindex/ktor3/PodcastIndexClient.kt b/podcastindex-ktor3/src/commonMain/kotlin/com/mr3y/podcastindex/ktor3/PodcastIndexClient.kt
@@ -35,6 +35,9 @@ public fun PodcastIndexClient(
             if (config.enableTimeout) {
                 installTimeoutPlugin(config.defaultTimeout)
             }
+            with(config) {
+                customHttpClientConfig()
+            }
         },
     )
 }
diff --git a/...astindex-sdk-base/src/commonMain/kotlin/com/mr3y/podcastindex/PodcastIndexClientConfig.kt b/...astindex-sdk-base/src/commonMain/kotlin/com/mr3y/podcastindex/PodcastIndexClientConfig.kt
@@ -1,5 +1,7 @@
 package com.mr3y.podcastindex
 
+import io.ktor.client.HttpClientConfig
+
 @DslMarker
 @InternalPodcastIndexApi
 public annotation class PodcastIndexConfigDsl
@@ -34,4 +36,9 @@ public class PodcastIndexClientConfig {
      * The default timeout for requests in milliseconds. Default is 10_000.
      */
     public var defaultTimeout: Long = 10_000
+
+    /**
+     * Additional custom configuration block. Default is empty.
+     */
+    public var customHttpClientConfig: HttpClientConfig<*>.() -> Unit = {}
 }