Skip to content

Commit 05e01a2

Browse files
committed
chore(adapter): rename internal kotlin adapter classes to match new naming patters
1 parent 49a8eb0 commit 05e01a2

8 files changed

Lines changed: 21 additions & 23 deletions

File tree

‎UPGRADING.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,6 @@ it into `io.ably.pubsub.http`:
142142
| `io.ably.lib.liveobjects.*` | `io.ably.pubsub.liveobjects.*` |
143143
| `Defaults.HOST_REST`, `Defaults.HOST_REALTIME` | Removed. Use `endpoint` (`Defaults.ENDPOINT` is the default, `main`); see [Choose the host with `endpoint`](#6-choose-the-host-with-endpoint) |
144144
| `Defaults.HOST_FALLBACKS` | Kept, but now holds the default endpoint's fallback domains, `main.[a-e].fallback.ably-realtime.com` |
145-
| pubsub-adapter `com.ably.pubsub.RestClient`, `RestChannel`, `RestPresence` and `RestClient.createWrapperSdkProxy` | Removed with no HTTP counterpart. The adapter's `Client`, `Channel`, `Channels`, `Presence`, `RealtimeClient`, `RealtimeChannel` and `RealtimePresence` interfaces remain, and `RealtimeClient.createWrapperSdkProxy(WrapperSdkProxyOptions)` is kept. Use `PubSubHttpClient` directly for HTTP-only access. |
146145
| `io.ably.lib.types.*`, `io.ably.lib.realtime.*`, `io.ably.lib.push.*`, … | `io.ably.pubsub.types.*`, `io.ably.pubsub.realtime.*`, `io.ably.pubsub.push.*`, … |
147146

148147
`ClientOptions.idempotentRestPublishing` deliberately keeps its name, which is the specification's (TO3n).

pubsub-adapter/src/main/kotlin/com/ably/pubsub/RealtimeClient.kt renamed to pubsub-adapter/src/main/kotlin/com/ably/pubsub/PubSubRealtimeClient.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package com.ably.pubsub
22

33
import com.ably.annotations.InternalAPI
4-
import io.ably.pubsub.realtime.PubSubRealtimeClient
4+
import io.ably.pubsub.realtime.PubSubRealtimeClient as JavaPubSubRealtimeClient
55
import io.ably.pubsub.realtime.Connection
66

77
/**
@@ -10,7 +10,7 @@ import io.ably.pubsub.realtime.Connection
1010
* This class implements {@link AutoCloseable} so you can use it in
1111
* try-with-resources constructs and have the JDK close it for you.
1212
*/
13-
public interface RealtimeClient : Client {
13+
public interface PubSubRealtimeClient : Client {
1414

1515
/**
1616
* The {@link Connection} object for this instance.
@@ -28,5 +28,5 @@ public interface RealtimeClient : Client {
2828
* This property will be removed once public API for new version of ably-java is stable
2929
*/
3030
@InternalAPI
31-
public val javaClient: PubSubRealtimeClient
31+
public val javaClient: JavaPubSubRealtimeClient
3232
}

‎pubsub-adapter/src/main/kotlin/com/ably/pubsub/WrapperSdkProxy.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ public interface SdkWrapperCompatible<T> {
1212
public fun createWrapperSdkProxy(options: WrapperSdkProxyOptions): T
1313
}
1414

15-
public fun RealtimeClient.createWrapperSdkProxy(options: WrapperSdkProxyOptions): RealtimeClient =
16-
(this as SdkWrapperCompatible<*>).createWrapperSdkProxy(options) as RealtimeClient
15+
public fun PubSubRealtimeClient.createWrapperSdkProxy(options: WrapperSdkProxyOptions): PubSubRealtimeClient =
16+
(this as SdkWrapperCompatible<*>).createWrapperSdkProxy(options) as PubSubRealtimeClient

‎pubsub-adapter/src/main/kotlin/io/ably/pubsub/http/PubSubBaseInternals.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package io.ably.pubsub.http
33
/*
44
* Package-private access bridge for PubSubBase, not part of the HTTP client API.
55
*
6-
* PubSubBase declares time/stats/request as package-private, so WrapperRealtimeClient — which
6+
* PubSubBase declares time/stats/request as package-private, so WrapperPubSubRealtimeClient — which
77
* lives in the realtime package — cannot call them directly. These extensions sit in PubSubBase's
88
* own package and re-expose exactly those members, behind @InternalAPI so they are not a public
99
* contract. This file is why the realtime wrapper compiles; it is unrelated to the HTTP client

pubsub-adapter/src/main/kotlin/io/ably/pubsub/realtime/RealtimeClientAdapter.kt renamed to pubsub-adapter/src/main/kotlin/io/ably/pubsub/realtime/PubSubRealtimeClientAdapter.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package io.ably.pubsub.realtime
33
import com.ably.annotations.InternalAPI
44
import com.ably.http.HttpMethod
55
import com.ably.pubsub.*
6-
import com.ably.pubsub.RealtimeClient
6+
import com.ably.pubsub.PubSubRealtimeClient
77
import io.ably.pubsub.realtime.PubSubRealtimeClient as CoreRealtimeClient
88
import com.ably.query.OrderBy
99
import com.ably.query.TimeUnit
@@ -16,10 +16,10 @@ import io.ably.pubsub.types.*
1616
/**
1717
* Wrapper for Realtime client
1818
*/
19-
public fun RealtimeClient(javaClient: CoreRealtimeClient): RealtimeClient = RealtimeClientAdapter(javaClient)
19+
public fun PubSubRealtimeClient(javaClient: CoreRealtimeClient): PubSubRealtimeClient = PubSubRealtimeClientAdapter(javaClient)
2020

2121
@OptIn(InternalAPI::class)
22-
internal class RealtimeClientAdapter(override val javaClient: CoreRealtimeClient) : RealtimeClient, SdkWrapperCompatible<RealtimeClient> {
22+
internal class PubSubRealtimeClientAdapter(override val javaClient: CoreRealtimeClient) : PubSubRealtimeClient, SdkWrapperCompatible<PubSubRealtimeClient> {
2323
override val channels: Channels<out RealtimeChannel>
2424
get() = RealtimeChannelsAdapter(javaClient.channels)
2525
override val connection: Connection
@@ -71,9 +71,9 @@ internal class RealtimeClientAdapter(override val javaClient: CoreRealtimeClient
7171

7272
override fun close() = javaClient.close()
7373

74-
override fun createWrapperSdkProxy(options: WrapperSdkProxyOptions): RealtimeClient {
74+
override fun createWrapperSdkProxy(options: WrapperSdkProxyOptions): PubSubRealtimeClient {
7575
val httpCoreWithAgents = javaClient.httpCore.injectDynamicAgents(options.agents)
7676
val httpModule = javaClient.http.exchangeHttpCore(httpCoreWithAgents)
77-
return WrapperRealtimeClient(javaClient, this, httpModule, options.agents)
77+
return WrapperPubSubRealtimeClient(javaClient, this, httpModule, options.agents)
7878
}
7979
}

pubsub-adapter/src/main/kotlin/io/ably/pubsub/realtime/WrapperRealtimeClient.kt renamed to pubsub-adapter/src/main/kotlin/io/ably/pubsub/realtime/WrapperPubSubRealtimeClient.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package io.ably.pubsub.realtime
33
import com.ably.annotations.InternalAPI
44
import com.ably.http.HttpMethod
55
import com.ably.pubsub.*
6-
import com.ably.pubsub.RealtimeClient
6+
import com.ably.pubsub.PubSubRealtimeClient
77
import io.ably.pubsub.realtime.PubSubRealtimeClient as CoreRealtimeClient
88
import com.ably.query.OrderBy
99
import com.ably.query.TimeUnit
@@ -15,17 +15,17 @@ import io.ably.pubsub.http.*
1515
import io.ably.pubsub.types.*
1616

1717
@OptIn(InternalAPI::class)
18-
internal class WrapperRealtimeClient(
18+
internal class WrapperPubSubRealtimeClient(
1919
override val javaClient: CoreRealtimeClient,
20-
private val adapter: RealtimeClientAdapter,
20+
private val adapter: PubSubRealtimeClientAdapter,
2121
private val httpModule: HttpRequester,
2222
private val agents: Map<String, String>,
23-
) : SdkWrapperCompatible<RealtimeClient>, RealtimeClient by adapter {
23+
) : SdkWrapperCompatible<PubSubRealtimeClient>, PubSubRealtimeClient by adapter {
2424

2525
override val channels: Channels<out RealtimeChannel>
2626
get() = WrapperRealtimeChannels(javaClient.channels, httpModule, agents)
2727

28-
override fun createWrapperSdkProxy(options: WrapperSdkProxyOptions): RealtimeClient =
28+
override fun createWrapperSdkProxy(options: WrapperSdkProxyOptions): PubSubRealtimeClient =
2929
adapter.createWrapperSdkProxy(options.copy(agents = options.agents + agents))
3030

3131
override fun time(): Long = javaClient.time(httpModule)

‎pubsub-adapter/src/test/kotlin/com/ably/pubsub/SdkWrapperAgentChannelParamTest.kt‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ package com.ably.pubsub
22

33
import io.ably.pubsub.realtime.PubSubRealtimeClient
44
// the adapter factory function of the same name, no longer covered by the class import above
5-
import io.ably.pubsub.realtime.RealtimeClient
6-
import io.ably.pubsub.realtime.RealtimeClientAdapter
5+
import io.ably.pubsub.realtime.PubSubRealtimeClientAdapter
76
import io.ably.pubsub.realtime.RealtimeClientFactory
87
import io.ably.pubsub.realtime.channelOptions
98
import io.ably.pubsub.types.ChannelMode
@@ -20,7 +19,7 @@ class SdkWrapperAgentChannelParamTest {
2019
@Test
2120
fun `should add agent information to Realtime channels params`() = runTest {
2221
val javaRealtimeClient = createRealtimeClient()
23-
val realtimeClient = RealtimeClientAdapter(javaRealtimeClient)
22+
val realtimeClient = PubSubRealtimeClientAdapter(javaRealtimeClient)
2423
val wrapperSdkClient =
2524
realtimeClient.createWrapperSdkProxy(WrapperSdkProxyOptions(agents = mapOf("chat-android" to "0.1.0")))
2625

@@ -43,7 +42,7 @@ class SdkWrapperAgentChannelParamTest {
4342
@Test
4443
fun `should add agent information to Realtime channels params when channel created with custom options`() = runTest {
4544
val javaRealtimeClient = createRealtimeClient()
46-
val realtimeClient = RealtimeClient(javaRealtimeClient)
45+
val realtimeClient = PubSubRealtimeClient(javaRealtimeClient)
4746
val wrapperSdkClient =
4847
realtimeClient.createWrapperSdkProxy(WrapperSdkProxyOptions(agents = mapOf("chat-android" to "0.1.0")))
4948

‎pubsub-adapter/src/test/kotlin/com/ably/pubsub/SdkWrapperAgentHeaderTest.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class SdkWrapperAgentHeaderTest {
134134
server.stop()
135135
}
136136

137-
private fun createRealtimeClient(): RealtimeClient =
138-
io.ably.pubsub.realtime.RealtimeClient(createCoreRealtimeClient(PORT))
137+
private fun createRealtimeClient(): PubSubRealtimeClient =
138+
io.ably.pubsub.realtime.PubSubRealtimeClient(createCoreRealtimeClient(PORT))
139139
}
140140
}

0 commit comments

Comments
 (0)