Rename property to server; improve javadoc

Author: gabrielfeo

library/src/integrationTest/kotlin/com/gabrielfeo/develocity/api/DevelocityApiIntegrationTest.kt

@@ -35,7 +35,7 @@ class DevelocityApiIntegrationTest {
         env = FakeEnv()
         assertDoesNotThrow {
             val config = Config(
-                develocityUrl = URL("https://example.com/"),
+                server = URL("https://example.com/"),
                 accessKey = { "example.com=example-token" }
             )
             DevelocityApi.newInstance(config)

library/src/main/kotlin/com/gabrielfeo/develocity/api/Config.kt

@@ -44,25 +44,30 @@ data class Config(
             ?: "off",
 
     /**
-     * Provides the base URL of a Develocity instance. By default, uses
-     * environment variable `DEVELOCITY_URL`. Must be a valid URL with no path segments (trailing slash OK) or query parameters.
+     * Provides the URL of a Develocity server to use in API requests. By default, uses environment
+     * variable `DEVELOCITY_URL`. Must be a valid URL with no path segments (trailing slash OK) or
+     * query parameters.
+     *
+     * Example value: `https://develocity.example.com/`
      */
-    val develocityUrl: URL =
+    val server: URL =
         env["DEVELOCITY_URL"]
             ?.let { URL(it) }
             ?: error(ERROR_NULL_DEVELOCITY_URL),
 
     /**
-     * Provides the access key for a Develocity API instance. By default, resolves to the first
-     * key from these sources that matches the host of [develocityUrl]:
+     * Provides the access key for the Develocity server. By default, resolves to the first key from
+     * these sources that matches the host of [server]:
      *
      * - variable `DEVELOCITY_ACCESS_KEY`
      * - variable `GRADLE_ENTERPRISE_ACCESS_KEY`
      * - file `$GRADLE_USER_HOME/.gradle/develocity/keys.properties` or, if `GRADLE_USER_HOME` is
      *   not set, `~/.gradle/develocity/keys.properties`
      * - file `~/.m2/.develocity/keys.properties`
      *
-     * Refer to Develocity documentation for details on the format of such variables and files:
+     * Example value: `develocity.example.com=abcdefg1234567`
+     *
+     * Refer to Develocity documentation for more details on the format of such variables and files:
      *
      * - [Develocity Gradle Plugin User Manual][1]
      * - [Develocity Maven Extension User Manual][2]
@@ -73,7 +78,7 @@ data class Config(
      * @throws IllegalArgumentException if no matching key is found.
      */
     val accessKey: () -> String = {
-        val host = develocityUrl.host
+        val host = server.host
         requireNotNull(accessKeyResolver.resolve(host)) { ERROR_NULL_ACCESS_KEY }
     },
 
@@ -119,7 +124,7 @@ data class Config(
 ) {
 
     init {
-        requireValidBaseUrl(develocityUrl)
+        requireValidBaseUrl(server)
     }
 
     /**

library/src/main/kotlin/com/gabrielfeo/develocity/api/internal/Retrofit.kt

@@ -12,7 +12,7 @@ internal fun buildRetrofit(
     client: OkHttpClient,
     moshi: Moshi,
 ) = with(Retrofit.Builder()) {
-    val base = config.develocityUrl
+    val base = config.server
     val baseStr = base.toString().let { if (it.endsWith("/")) it else "$it/" }
     baseUrl(baseStr)
     addConverterFactory(ScalarsConverterFactory.create())

library/src/test/kotlin/com/gabrielfeo/develocity/api/ConfigTest.kt

@@ -37,35 +37,35 @@ class ConfigTest {
     }
 
     @Test
-    fun `Given URL set in env, develocityUrl is env URL`() {
+    fun `Given server URL set in env, server is correct URL`() {
         (env as FakeEnv)["DEVELOCITY_URL"] = "https://example.com/"
-        assertEquals(URL("https://example.com/"), Config().develocityUrl)
+        assertEquals(URL("https://example.com/"), Config().server)
     }
 
     @Test
-    fun `Given custom URL passed, develocityUrl is custom URL`() {
-        val config = Config(develocityUrl = URL("https://custom.example.com/"))
-        assertEquals(URL("https://custom.example.com/"), config.develocityUrl)
+    fun `Given server URL set in code, server is correct URL`() {
+        val config = Config(server = URL("https://custom.example.com/"))
+        assertEquals(URL("https://custom.example.com/"), config.server)
     }
 
     @Test
     fun `Given URL with path, error`() {
         assertFails {
-            Config(develocityUrl = URL("https://example.com/foo"))
+            Config(server = URL("https://example.com/foo"))
         }
     }
 
     @Test
     fun `Given URL with query, error`() {
         assertFails {
-            Config(develocityUrl = URL("https://example.com?foo=bar"))
+            Config(server = URL("https://example.com?foo=bar"))
         }
     }
 
     @Test
     fun `Given invalid URL, error`() {
         assertFails {
-            Config(develocityUrl = URL("https:/example.com&"))
+            Config(server = URL("https:/example.com&"))
         }
     }