Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add customization of HTTP client configuration (#10). #11

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public fun PodcastIndexClient(
require(userAgent.isNotBlank()) { "User agent cannot be blank" }
val config = PodcastIndexClientConfig().apply { block() }
return PodcastIndexClient(
httpClientConfig = {
defaultHttpClientConfig = {
installAuthenticationPlugin(authKey, authSecret, userAgent)
installRetryPlugin(authKey, authSecret, maxRetries = config.maxRetries)
installSerializationPlugin()
Expand All @@ -36,5 +36,6 @@ public fun PodcastIndexClient(
installTimeoutPlugin(config.defaultTimeout)
}
},
podcastIndexClientConfig = config
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public fun PodcastIndexClient(
require(userAgent.isNotBlank()) { "User agent cannot be blank" }
val config = PodcastIndexClientConfig().apply { block() }
return PodcastIndexClient(
httpClientConfig = {
defaultHttpClientConfig = {
installAuthenticationPlugin(authKey, authSecret, userAgent)
installRetryPlugin(authKey, authSecret, maxRetries = config.maxRetries)
installSerializationPlugin()
Expand All @@ -36,5 +36,6 @@ public fun PodcastIndexClient(
installTimeoutPlugin(config.defaultTimeout)
}
},
podcastIndexClientConfig = config
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ import io.ktor.client.HttpClientConfig
public class PodcastIndexClient
@InternalPodcastIndexApi
constructor(
private val httpClientConfig: HttpClientConfig<*>.() -> Unit,
defaultHttpClientConfig: HttpClientConfig<*>.() -> Unit,
podcastIndexClientConfig: PodcastIndexClientConfig
) {

private val client: HttpClient = HttpClient(defaultHttpClientEngineFactory()) {
httpClientConfig()
}
private val client: HttpClient =
podcastIndexClientConfig.httpClientBuilder().config(defaultHttpClientConfig)

public val podcasts: Podcasts = Podcasts(client)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
package com.mr3y.podcastindex

import io.ktor.client.HttpClient
import io.ktor.client.HttpClientConfig
import io.ktor.client.engine.HttpClientEngineConfig
import io.ktor.client.engine.HttpClientEngineFactory

@DslMarker
@InternalPodcastIndexApi
public annotation class PodcastIndexConfigDsl
Expand All @@ -10,6 +15,9 @@ public annotation class PodcastIndexConfigDsl
@PodcastIndexConfigDsl
public class PodcastIndexClientConfig {

internal var httpClientBuilder: (() -> HttpClient) =
{ HttpClient(defaultHttpClientEngineFactory()) }

/**
* Maximum number of retries for failed requests before giving up. Default is 3.
*/
Expand All @@ -34,4 +42,20 @@ public class PodcastIndexClientConfig {
* The default timeout for requests in milliseconds. Default is 10_000.
*/
public var defaultTimeout: Long = 10_000

/**
* Creates an custom [HttpClient] with the specified [HttpClientEngineFactory] and optional
* [block] configuration.
*
* Note that [block] configuration doesn't replace the existing default configuration added by
* this library. It will be applied on top of it.
*/
public fun <T : HttpClientEngineConfig> httpClient(
engineFactory: HttpClientEngineFactory<T>,
block: HttpClientConfig<T>.() -> Unit = {}
) {
httpClientBuilder = {
HttpClient(engineFactory, block)
}
}
}