Merge pull request #313 from OneBusAway/release-please--branches--main--changes--next

release: 0.1.0-alpha.72

Author: Ahmedhossamdev

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.71"
+  ".": "0.1.0-alpha.72"
 }

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.0-alpha.72 (2025-06-13)
+
+Full Changelog: [v0.1.0-alpha.71...v0.1.0-alpha.72](https://github.com/OneBusAway/kotlin-sdk/compare/v0.1.0-alpha.71...v0.1.0-alpha.72)
+
+### Features
+
+* **client:** add a `withOptions` method ([10fb83f](https://github.com/OneBusAway/kotlin-sdk/commit/10fb83fbc9d18ac7965672431fa7ba0d3fc68af5))
+* **client:** implement per-endpoint base URL support ([3c2b9e1](https://github.com/OneBusAway/kotlin-sdk/commit/3c2b9e1a1ce967946ffa26d0378fe718318c410a))
+
 ## 0.1.0-alpha.71 (2025-05-22)
 
 Full Changelog: [v0.1.0-alpha.70...v0.1.0-alpha.71](https://github.com/OneBusAway/kotlin-sdk/compare/v0.1.0-alpha.70...v0.1.0-alpha.71)

README.md

@@ -2,8 +2,8 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/org.onebusaway/onebusaway-sdk-kotlin)](https://central.sonatype.com/artifact/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.71)
-[![javadoc](https://javadoc.io/badge2/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.71/javadoc.svg)](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.71)
+[![Maven Central](https://img.shields.io/maven-central/v/org.onebusaway/onebusaway-sdk-kotlin)](https://central.sonatype.com/artifact/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.72)
+[![javadoc](https://javadoc.io/badge2/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.72/javadoc.svg)](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.72)
 
 <!-- x-release-please-end -->
 
@@ -15,7 +15,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 <!-- x-release-please-start-version -->
 
-The REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org). KDocs are available on [javadoc.io](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.71).
+The REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org). KDocs are available on [javadoc.io](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-kotlin/0.1.0-alpha.72).
 
 <!-- x-release-please-end -->
 
@@ -26,7 +26,7 @@ The REST API documentation can be found on [developer.onebusaway.org](https://de
 ### Gradle
 
 ```kotlin
-implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.71")
+implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.72")
 ```
 
 ### Maven
@@ -35,7 +35,7 @@ implementation("org.onebusaway:onebusaway-sdk-kotlin:0.1.0-alpha.71")
 <dependency>
   <groupId>org.onebusaway</groupId>
   <artifactId>onebusaway-sdk-kotlin</artifactId>
-  <version>0.1.0-alpha.71</version>
+  <version>0.1.0-alpha.72</version>
 </dependency>
 ```
 
@@ -106,6 +106,21 @@ See this table for the available options:
 > Don't create more than one client in the same application. Each client has a connection pool and
 > thread pools, which are more efficient to share between requests.
 
+### Modifying configuration
+
+To temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:
+
+```kotlin
+import org.onebusaway.client.OnebusawaySdkClient
+
+val clientWithOptions: OnebusawaySdkClient = client.withOptions {
+    it.baseUrl("https://example.com")
+    it.maxRetries(42)
+}
+```
+
+The `withOptions()` method does not affect the original client or service.
+
 ## Requests and responses
 
 To send a request to the Onebusaway SDK API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "org.onebusaway"
-    version = "0.1.0-alpha.71" // x-release-please-version
+    version = "0.1.0-alpha.72" // x-release-please-version
 }
 
 subprojects {

onebusaway-sdk-kotlin-client-okhttp/src/main/kotlin/org/onebusaway/client/okhttp/OkHttpClient.kt

@@ -7,7 +7,6 @@ import java.time.Duration
 import kotlinx.coroutines.suspendCancellableCoroutine
 import okhttp3.Call
 import okhttp3.Callback
-import okhttp3.HttpUrl
 import okhttp3.HttpUrl.Companion.toHttpUrl
 import okhttp3.MediaType
 import okhttp3.MediaType.Companion.toMediaType
@@ -19,7 +18,6 @@ import okhttp3.logging.HttpLoggingInterceptor
 import okio.BufferedSink
 import org.onebusaway.core.RequestOptions
 import org.onebusaway.core.Timeout
-import org.onebusaway.core.checkRequired
 import org.onebusaway.core.http.Headers
 import org.onebusaway.core.http.HttpClient
 import org.onebusaway.core.http.HttpMethod
@@ -28,8 +26,7 @@ import org.onebusaway.core.http.HttpRequestBody
 import org.onebusaway.core.http.HttpResponse
 import org.onebusaway.errors.OnebusawaySdkIoException
 
-class OkHttpClient
-private constructor(private val okHttpClient: okhttp3.OkHttpClient, private val baseUrl: HttpUrl) :
+class OkHttpClient private constructor(private val okHttpClient: okhttp3.OkHttpClient) :
     HttpClient {
 
     override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse {
@@ -146,11 +143,7 @@ private constructor(private val okHttpClient: okhttp3.OkHttpClient, private val
         }
 
     private fun HttpRequest.toUrl(): String {
-        url?.let {
-            return it
-        }
-
-        val builder = baseUrl.newBuilder()
+        val builder = baseUrl.toHttpUrl().newBuilder()
         pathSegments.forEach(builder::addPathSegment)
         queryParams.keys().forEach { key ->
             queryParams.values(key).forEach { builder.addQueryParameter(key, it) }
@@ -200,12 +193,9 @@ private constructor(private val okHttpClient: okhttp3.OkHttpClient, private val
 
     class Builder internal constructor() {
 
-        private var baseUrl: HttpUrl? = null
         private var timeout: Timeout = Timeout.default()
         private var proxy: Proxy? = null
 
-        fun baseUrl(baseUrl: String) = apply { this.baseUrl = baseUrl.toHttpUrl() }
-
         fun timeout(timeout: Timeout) = apply { this.timeout = timeout }
 
         fun timeout(timeout: Duration) = timeout(Timeout.builder().request(timeout).build())
@@ -220,8 +210,7 @@ private constructor(private val okHttpClient: okhttp3.OkHttpClient, private val
                     .writeTimeout(timeout.write())
                     .callTimeout(timeout.request())
                     .proxy(proxy)
-                    .build(),
-                checkRequired("baseUrl", baseUrl),
+                    .build()
             )
     }
 }

onebusaway-sdk-kotlin-client-okhttp/src/main/kotlin/org/onebusaway/client/okhttp/OnebusawaySdkOkHttpClient.kt

@@ -163,13 +163,7 @@ class OnebusawaySdkOkHttpClient private constructor() {
         fun build(): OnebusawaySdkClient =
             OnebusawaySdkClientImpl(
                 clientOptions
-                    .httpClient(
-                        OkHttpClient.builder()
-                            .baseUrl(clientOptions.baseUrl())
-                            .timeout(timeout)
-                            .proxy(proxy)
-                            .build()
-                    )
+                    .httpClient(OkHttpClient.builder().timeout(timeout).proxy(proxy).build())
                     .build()
             )
     }

onebusaway-sdk-kotlin-client-okhttp/src/main/kotlin/org/onebusaway/client/okhttp/OnebusawaySdkOkHttpClientAsync.kt

@@ -164,13 +164,7 @@ class OnebusawaySdkOkHttpClientAsync private constructor() {
         fun build(): OnebusawaySdkClientAsync =
             OnebusawaySdkClientAsyncImpl(
                 clientOptions
-                    .httpClient(
-                        OkHttpClient.builder()
-                            .baseUrl(clientOptions.baseUrl())
-                            .timeout(timeout)
-                            .proxy(proxy)
-                            .build()
-                    )
+                    .httpClient(OkHttpClient.builder().timeout(timeout).proxy(proxy).build())
                     .build()
             )
     }

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/client/OnebusawaySdkClient.kt

@@ -2,6 +2,7 @@
 
 package org.onebusaway.client
 
+import org.onebusaway.core.ClientOptions
 import org.onebusaway.services.blocking.AgenciesWithCoverageService
 import org.onebusaway.services.blocking.AgencyService
 import org.onebusaway.services.blocking.ArrivalAndDepartureService
@@ -60,6 +61,13 @@ interface OnebusawaySdkClient {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: (ClientOptions.Builder) -> Unit): OnebusawaySdkClient
+
     fun agenciesWithCoverage(): AgenciesWithCoverageService
 
     fun agency(): AgencyService
@@ -134,6 +142,15 @@ interface OnebusawaySdkClient {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: (ClientOptions.Builder) -> Unit
+        ): OnebusawaySdkClient.WithRawResponse
+
         fun agenciesWithCoverage(): AgenciesWithCoverageService.WithRawResponse
 
         fun agency(): AgencyService.WithRawResponse

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/client/OnebusawaySdkClientAsync.kt

@@ -2,6 +2,7 @@
 
 package org.onebusaway.client
 
+import org.onebusaway.core.ClientOptions
 import org.onebusaway.services.async.AgenciesWithCoverageServiceAsync
 import org.onebusaway.services.async.AgencyServiceAsync
 import org.onebusaway.services.async.ArrivalAndDepartureServiceAsync
@@ -60,6 +61,13 @@ interface OnebusawaySdkClientAsync {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: (ClientOptions.Builder) -> Unit): OnebusawaySdkClientAsync
+
     fun agenciesWithCoverage(): AgenciesWithCoverageServiceAsync
 
     fun agency(): AgencyServiceAsync
@@ -135,6 +143,15 @@ interface OnebusawaySdkClientAsync {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: (ClientOptions.Builder) -> Unit
+        ): OnebusawaySdkClientAsync.WithRawResponse
+
         fun agenciesWithCoverage(): AgenciesWithCoverageServiceAsync.WithRawResponse
 
         fun agency(): AgencyServiceAsync.WithRawResponse

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/client/OnebusawaySdkClientAsyncImpl.kt

@@ -191,6 +191,9 @@ class OnebusawaySdkClientAsyncImpl(private val clientOptions: ClientOptions) :
 
     override fun withRawResponse(): OnebusawaySdkClientAsync.WithRawResponse = withRawResponse
 
+    override fun withOptions(modifier: (ClientOptions.Builder) -> Unit): OnebusawaySdkClientAsync =
+        OnebusawaySdkClientAsyncImpl(clientOptions.toBuilder().apply(modifier).build())
+
     override fun agenciesWithCoverage(): AgenciesWithCoverageServiceAsync = agenciesWithCoverage
 
     override fun agency(): AgencyServiceAsync = agency
@@ -366,6 +369,13 @@ class OnebusawaySdkClientAsyncImpl(private val clientOptions: ClientOptions) :
             ShapeServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
 
+        override fun withOptions(
+            modifier: (ClientOptions.Builder) -> Unit
+        ): OnebusawaySdkClientAsync.WithRawResponse =
+            OnebusawaySdkClientAsyncImpl.WithRawResponseImpl(
+                clientOptions.toBuilder().apply(modifier).build()
+            )
+
         override fun agenciesWithCoverage(): AgenciesWithCoverageServiceAsync.WithRawResponse =
             agenciesWithCoverage