feat(client): support setting base URL via env var (#397)

Author: stainless-app[bot]

README.md

@@ -46,7 +46,7 @@ import com.withorb.api.client.okhttp.OrbOkHttpClient;
 import com.withorb.api.models.Customer;
 import com.withorb.api.models.CustomerCreateParams;
 
-// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
+// Configures using the `ORB_API_KEY`, `ORB_WEBHOOK_SECRET` and `ORB_BASE_URL` environment variables
 OrbClient client = OrbOkHttpClient.fromEnv();
 
 CustomerCreateParams params = CustomerCreateParams.builder()
@@ -64,7 +64,7 @@ Configure the client using environment variables:
 import com.withorb.api.client.OrbClient;
 import com.withorb.api.client.okhttp.OrbOkHttpClient;
 
-// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
+// Configures using the `ORB_API_KEY`, `ORB_WEBHOOK_SECRET` and `ORB_BASE_URL` environment variables
 OrbClient client = OrbOkHttpClient.fromEnv();
 ```
 
@@ -86,18 +86,19 @@ import com.withorb.api.client.OrbClient;
 import com.withorb.api.client.okhttp.OrbOkHttpClient;
 
 OrbClient client = OrbOkHttpClient.builder()
-    // Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
+    // Configures using the `ORB_API_KEY`, `ORB_WEBHOOK_SECRET` and `ORB_BASE_URL` environment variables
     .fromEnv()
     .apiKey("My API Key")
     .build();
 ```
 
 See this table for the available options:
 
-| Setter          | Environment variable | Required | Default value |
-| --------------- | -------------------- | -------- | ------------- |
-| `apiKey`        | `ORB_API_KEY`        | true     | -             |
-| `webhookSecret` | `ORB_WEBHOOK_SECRET` | false    | -             |
+| Setter          | Environment variable | Required | Default value                  |
+| --------------- | -------------------- | -------- | ------------------------------ |
+| `apiKey`        | `ORB_API_KEY`        | true     | -                              |
+| `webhookSecret` | `ORB_WEBHOOK_SECRET` | false    | -                              |
+| `baseUrl`       | `ORB_BASE_URL`       | true     | `"https://api.withorb.com/v1"` |
 
 > [!TIP]
 > Don't create more than one client in the same application. Each client has a connection pool and
@@ -128,7 +129,7 @@ import com.withorb.api.models.Customer;
 import com.withorb.api.models.CustomerCreateParams;
 import java.util.concurrent.CompletableFuture;
 
-// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
+// Configures using the `ORB_API_KEY`, `ORB_WEBHOOK_SECRET` and `ORB_BASE_URL` environment variables
 OrbClient client = OrbOkHttpClient.fromEnv();
 
 CustomerCreateParams params = CustomerCreateParams.builder()
@@ -147,7 +148,7 @@ import com.withorb.api.models.Customer;
 import com.withorb.api.models.CustomerCreateParams;
 import java.util.concurrent.CompletableFuture;
 
-// Configures using the `ORB_API_KEY` and `ORB_WEBHOOK_SECRET` environment variables
+// Configures using the `ORB_API_KEY`, `ORB_WEBHOOK_SECRET` and `ORB_BASE_URL` environment variables
 OrbClientAsync client = OrbOkHttpClientAsync.fromEnv();
 
 CustomerCreateParams params = CustomerCreateParams.builder()

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClient.kt

@@ -29,14 +29,10 @@ class OrbOkHttpClient private constructor() {
     class Builder internal constructor() {
 
         private var clientOptions: ClientOptions.Builder = ClientOptions.builder()
-        private var baseUrl: String = ClientOptions.PRODUCTION_URL
         private var timeout: Timeout = Timeout.default()
         private var proxy: Proxy? = null
 
-        fun baseUrl(baseUrl: String) = apply {
-            clientOptions.baseUrl(baseUrl)
-            this.baseUrl = baseUrl
-        }
+        fun baseUrl(baseUrl: String) = apply { clientOptions.baseUrl(baseUrl) }
 
         /**
          * Whether to throw an exception if any of the Jackson versions detected at runtime are
@@ -177,7 +173,7 @@ class OrbOkHttpClient private constructor() {
                 clientOptions
                     .httpClient(
                         OkHttpClient.builder()
-                            .baseUrl(baseUrl)
+                            .baseUrl(clientOptions.baseUrl())
                             .timeout(timeout)
                             .proxy(proxy)
                             .build()

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClientAsync.kt

@@ -29,14 +29,10 @@ class OrbOkHttpClientAsync private constructor() {
     class Builder internal constructor() {
 
         private var clientOptions: ClientOptions.Builder = ClientOptions.builder()
-        private var baseUrl: String = ClientOptions.PRODUCTION_URL
         private var timeout: Timeout = Timeout.default()
         private var proxy: Proxy? = null
 
-        fun baseUrl(baseUrl: String) = apply {
-            clientOptions.baseUrl(baseUrl)
-            this.baseUrl = baseUrl
-        }
+        fun baseUrl(baseUrl: String) = apply { clientOptions.baseUrl(baseUrl) }
 
         /**
          * Whether to throw an exception if any of the Jackson versions detected at runtime are
@@ -177,7 +173,7 @@ class OrbOkHttpClientAsync private constructor() {
                 clientOptions
                     .httpClient(
                         OkHttpClient.builder()
-                            .baseUrl(baseUrl)
+                            .baseUrl(clientOptions.baseUrl())
                             .timeout(timeout)
                             .proxy(proxy)
                             .build()

orb-java-core/src/main/kotlin/com/withorb/api/core/ClientOptions.kt

@@ -197,7 +197,10 @@ private constructor(
 
         fun removeAllQueryParams(keys: Set<String>) = apply { queryParams.removeAll(keys) }
 
+        fun baseUrl(): String = baseUrl
+
         fun fromEnv() = apply {
+            System.getenv("ORB_BASE_URL")?.let { baseUrl(it) }
             System.getenv("ORB_API_KEY")?.let { apiKey(it) }
             System.getenv("ORB_WEBHOOK_SECRET")?.let { webhookSecret(it) }
         }