Rename ObservableWebSocketClient to ObservableWebSocket

backslash-f · backslash-f · commit 497f0401b605 · 2026-02-16T14:06:29.000+01:00
diff --git a/Package.swift b/Package.swift
@@ -3,15 +3,15 @@
 import PackageDescription
 
 let package = Package(
-    name: "ObservableWebSocketClient",
+    name: "ObservableWebSocket",
     platforms: [
         .iOS(.v17),
         .macOS(.v14)
     ],
     products: [
         .library(
-            name: "ObservableWebSocketClient",
-            targets: ["ObservableWebSocketClient"]
+            name: "ObservableWebSocket",
+            targets: ["ObservableWebSocket"]
         )
     ],
     dependencies: [
@@ -22,7 +22,7 @@ let package = Package(
     ],
     targets: [
         .target(
-            name: "ObservableWebSocketClient",
+            name: "ObservableWebSocket",
             dependencies: [
                 .product(
                     name: "Toolbox",
@@ -31,8 +31,8 @@ let package = Package(
             ]
         ),
         .testTarget(
-            name: "ObservableWebSocketClientTests",
-            dependencies: ["ObservableWebSocketClient"]
+            name: "ObservableWebSocketTests",
+            dependencies: ["ObservableWebSocket"]
         )
     ]
 )
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![license](https://img.shields.io/badge/license-MIT-67ac5b.svg?logo=googledocs&logoColor=white)](https://en.wikipedia.org/wiki/MIT_License)
 [![release](https://github.com/thatfactory/observable-websocket-client/actions/workflows/release.yml/badge.svg)](https://github.com/thatfactory/observable-websocket-client/actions/workflows/release.yml)
 
-# ObservableWebSocketClient ⚡
+# ObservableWebSocket ⚡
 A Swift package that establishes [WebSocket connections](https://en.wikipedia.org/wiki/WebSocket) and publishes received messages and errors from an [Observable Object](https://developer.apple.com/documentation/combine/observableobject).
 
 ## Usage
@@ -14,7 +14,7 @@ A Swift package that establishes [WebSocket connections](https://en.wikipedia.or
 
 ```swift
 let websocketURL = URL(string: "wss://websocket-endpoint.com")!
-let wsClient = ObservableWebSocketClient(websocketURL: websocketURL)
+let wsClient = ObservableWebSocket(websocketURL: websocketURL)
 
 /*
  A `URLSessionWebSocketTask` is created and resumed just after the
@@ -67,7 +67,7 @@ Passing in a `pingTimerInterval` during the client initialization will cause a t
 
 ```swift
 let websocketURL = URL(string: "wss://endpoint.com")!
-let wsClient = ObservableWebSocketClient(
+let wsClient = ObservableWebSocket(
     websocketURL: websocketURL,
     pingTimerInterval: 18, // Every 18 seconds
     pingMessage: "{\"type\": \"ping\"}" // The format is defined by the WS server
@@ -79,7 +79,7 @@ To generate a unique ID for the ping-type message, use the closure in `pingMessa
 
 ```swift
 let websocketURL = URL(string: "wss://endpoint.com")!
-let wsClient = ObservableWebSocketClient(
+let wsClient = ObservableWebSocket(
     websocketURL: websocketURL,
     pingTimerInterval: 18, // Every 18 seconds
     pingMessageWithGeneratedId: { generatedId in
@@ -89,14 +89,14 @@ let wsClient = ObservableWebSocketClient(
 ```
 
 ### Sending messages
-After the client is initialized and a connection is established, messages can be sent via the `ObservableWebSocketClient.sendMessage(_:)` API:
+After the client is initialized and a connection is established, messages can be sent via the `ObservableWebSocket.sendMessage(_:)` API:
 
 ```swift
 wsClient.sendMessage("A String WebSocket message")
 ```
 
 ## Demo
-In this demo app, the `ObservableWebSocketClient` connects to a [Kucoin WebSocket server](https://www.kucoin.com/docs/websocket/introduction) and sends `ping` messages every `pingTimerInterval` to keep the connection alive. The server responds with `welcome` and `pong` messages:
+In this demo app, the `ObservableWebSocket` connects to a [Kucoin WebSocket server](https://www.kucoin.com/docs/websocket/introduction) and sends `ping` messages every `pingTimerInterval` to keep the connection alive. The server responds with `welcome` and `pong` messages:
 
 https://github.com/thatfactory/observable-websocket-client/assets/664951/2c8897e4-6d25-413b-9f12-d61b32ebbf0d
 
@@ -107,7 +107,7 @@ Use Xcode's [built-in support for SPM](https://developer.apple.com/documentation
 *or...*
 
 ### Package.swift
-In your `Package.swift`, add `ObservableWebSocketClient` as a dependency:
+In your `Package.swift`, add `ObservableWebSocket` as a dependency:
 
 ```swift
 dependencies: [
@@ -126,7 +126,7 @@ targets: [
         name: "YourTarget",
         dependencies: [
             .product(
-                name: "ObservableWebSocketClient",
+                name: "ObservableWebSocket",
                 package: "observable-websocket-client"
             )
         ]
diff --git a/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Codable.swift b/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Codable.swift
@@ -1,5 +1,5 @@
 //
-//  ObservableWebSocketClient+Codable.swift
+//  ObservableWebSocket+Codable.swift
 //
 //
 //  Created by Fernando Fernandes on 06.03.24.
@@ -10,7 +10,7 @@ import Toolbox
 
 /// Required for encoding/decoding an observable object class. Refer to:
 /// https://www.hackingwithswift.com/books/ios-swiftui/encoding-an-observableobject-class
-extension ObservableWebSocketClient {
+extension ObservableWebSocket {
     public enum CodingKeys: String, CodingKey {
         case id
         case websocketURL
diff --git a/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Equatable.swift b/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Equatable.swift
@@ -1,15 +1,15 @@
 //
-//  ObservableWebSocketClient+Equatable.swift
+//  ObservableWebSocket+Equatable.swift
 //
 //
 //  Created by Fernando Fernandes on 28.02.24.
 //
 
 import Foundation
 
-extension ObservableWebSocketClient {
-    public static func == (lhs: ObservableWebSocketClient,
-                           rhs: ObservableWebSocketClient) -> Bool {
+extension ObservableWebSocket {
+    public static func == (lhs: ObservableWebSocket,
+                           rhs: ObservableWebSocket) -> Bool {
         lhs.id == rhs.id &&
         lhs.websocketURL == rhs.websocketURL &&
         lhs.isConnected == rhs.isConnected &&
diff --git a/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Observation.swift b/Sources/ObservableWebSocket/Extensions/ObservableWebSocket+Observation.swift
@@ -1,13 +1,13 @@
 //
-//  ObservableWebSocketClient+Observation.swift
+//  ObservableWebSocket+Observation.swift
 //
 //
 //  Created by Fernando Fernandes on 17.04.24.
 //
 
 import Foundation
 
-extension ObservableWebSocketClient {
+extension ObservableWebSocket {
 
     func observeWebSocketConnection() {
 
diff --git a/Sources/ObservableWebSocket/Interface/ObservableWebSocket+Connection.swift b/Sources/ObservableWebSocket/Interface/ObservableWebSocket+Connection.swift
@@ -1,13 +1,13 @@
 //
-//  ObservableWebSocketClient+Connection.swift
+//  ObservableWebSocket+Connection.swift
 //  
 //
 //  Created by Fernando Fernandes on 18.04.24.
 //
 
 import Foundation
 
-public extension ObservableWebSocketClient {
+public extension ObservableWebSocket {
 
     /// Sends a close frame with an optional close reason.
     ///
diff --git a/Sources/ObservableWebSocket/Interface/ObservableWebSocket+Messages.swift b/Sources/ObservableWebSocket/Interface/ObservableWebSocket+Messages.swift
@@ -1,20 +1,20 @@
 //
-//  ObservableWebSocketClient+Messages.swift
+//  ObservableWebSocket+Messages.swift
 //
 //
 //  Created by Fernando Fernandes on 17.04.24.
 //
 
 import Foundation
 
-public extension ObservableWebSocketClient {
+public extension ObservableWebSocket {
 
     /// Sends the WebSocket server the given message, as is.
     ///
     /// Message replies/errors can be observed via:
     /// ```
-    /// ObservableWebSocketClient.getter:codableMessage
-    /// ObservableWebSocketClient.getter:error
+    /// ObservableWebSocket.getter:codableMessage
+    /// ObservableWebSocket.getter:error
     /// ```
     ///
     /// - Parameters:
@@ -39,8 +39,8 @@ public extension ObservableWebSocketClient {
     ///
     /// Message replies/errors can be observed via:
     /// ```
-    /// ObservableWebSocketClient.getter:codableMessage
-    /// ObservableWebSocketClient.getter:error
+    /// ObservableWebSocket.getter:codableMessage
+    /// ObservableWebSocket.getter:error
     /// ```
     ///
     /// - Parameters:
diff --git a/Sources/ObservableWebSocket/Interface/ObservableWebSocket.swift b/Sources/ObservableWebSocket/Interface/ObservableWebSocket.swift
@@ -1,5 +1,5 @@
 //
-//  ObservableWebSocketClient.swift
+//  ObservableWebSocket.swift
 //
 //
 //  Created by Fernando Fernandes on 28.02.24.
@@ -11,7 +11,7 @@ import Toolbox
 
 /// Establishes a WebSocket connection using the given `websocketURL`.
 /// Publishes received messages and errors.
-public final class ObservableWebSocketClient: Identifiable, Equatable, Codable, ObservableObject {
+public final class ObservableWebSocket: Identifiable, Equatable, Codable, ObservableObject {
 
     /// Publishes received messages after the connection is successfully established.
     @Published public var codableMessage: CodableWebSocketMessage?
@@ -37,7 +37,7 @@ public final class ObservableWebSocketClient: Identifiable, Equatable, Codable,
 
     // MARK: - Lifecycle
 
-    /// Creates an `ObservableWebSocketClient` instance.
+    /// Creates an `ObservableWebSocket` instance.
     ///
     /// - Parameters:
     ///   - id: Optional unique ID of the instance. If absent, an instance of `UUID` will be used instead.
@@ -99,7 +99,7 @@ public final class ObservableWebSocketClient: Identifiable, Equatable, Codable,
 
 // MARK: - Private
 
-private extension ObservableWebSocketClient {
+private extension ObservableWebSocket {
     func startPingTimer() {
         guard let pingTimerInterval,
               pingMessage?.isEmpty == false || pingMessageWithGeneratedId != nil
diff --git a/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage+Codable.swift b/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage+Codable.swift
@@ -29,7 +29,7 @@ public extension CodableWebSocketMessage {
             message = .data(messageData)
         default:
             let codableError = CodableWebSocketMessage.unknownMessageTypeError(isEncoding: false)
-            throw ObservableWebSocketClientError.decodingMessage(codableError)
+            throw ObservableWebSocketError.decodingMessage(codableError)
         }
     }
 
@@ -47,7 +47,7 @@ public extension CodableWebSocketMessage {
             try container.encode(messageData, forKey: .messageData)
         @unknown default:
             let codableError = CodableWebSocketMessage.unknownMessageTypeError(isEncoding: true)
-            throw ObservableWebSocketClientError.encodingMessage(codableError)
+            throw ObservableWebSocketError.encodingMessage(codableError)
         }
     }
 }
diff --git a/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage+Equatable.swift b/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage+Equatable.swift
diff --git a/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage.swift b/Sources/ObservableWebSocket/Model/CodableWebSocketMessage/CodableWebSocketMessage.swift
diff --git a/Sources/ObservableWebSocket/Model/Error/ObservableWebSocketError/ObservableWebSocketError+Localization.swift b/Sources/ObservableWebSocket/Model/Error/ObservableWebSocketError/ObservableWebSocketError+Localization.swift
@@ -1,13 +1,13 @@
 //
-//  ObservableWebSocketClientError+Localization.swift
+//  ObservableWebSocketError+Localization.swift
 //
 //
 //  Created by Fernando Fernandes on 28.02.24.
 //
 
 import Foundation
 
-extension ObservableWebSocketClientError: LocalizedError {
+extension ObservableWebSocketError: LocalizedError {
     public var errorDescription: String? {
         switch self {
         case .decodingMessage(let error):
diff --git a/Sources/ObservableWebSocket/Model/Error/ObservableWebSocketError/ObservableWebSocketError.swift b/Sources/ObservableWebSocket/Model/Error/ObservableWebSocketError/ObservableWebSocketError.swift
@@ -1,5 +1,5 @@
 //
-//  ObservableWebSocketClientError.swift
+//  ObservableWebSocketError.swift
 //
 //
 //  Created by Fernando Fernandes on 03.01.24.
@@ -8,7 +8,7 @@
 import Foundation
 import Toolbox
 
-public enum ObservableWebSocketClientError: Error, Equatable, Codable {
+public enum ObservableWebSocketError: Error, Equatable, Codable {
     case decodingMessage(CodableError)
     case encodingMessage(CodableError)
 }
diff --git a/Sources/ObservableWebSocket/Network/ObservableWebSocketService.swift b/Sources/ObservableWebSocket/Network/ObservableWebSocketService.swift
diff --git a/Tests/ObservableWebSocketClientTests/ObservableWebSocketClientTests.swift b/Tests/ObservableWebSocketClientTests/ObservableWebSocketClientTests.swift
diff --git a/Tests/ObservableWebSocketTests/ObservableWebSocketTests.swift b/Tests/ObservableWebSocketTests/ObservableWebSocketTests.swift
@@ -0,0 +1,4 @@
+import XCTest
+@testable import ObservableWebSocket
+
+final class ObservableWebSocketTests: XCTestCase {}

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public extension CodableWebSocketMessage {`
`29`	`29`	`message = .data(messageData)`
`30`	`30`	`default:`
`31`	`31`	`let codableError = CodableWebSocketMessage.unknownMessageTypeError(isEncoding: false)`
`32`		`- throw ObservableWebSocketClientError.decodingMessage(codableError)`
	`32`	`+ throw ObservableWebSocketError.decodingMessage(codableError)`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
`@@ -47,7 +47,7 @@ public extension CodableWebSocketMessage {`
`47`	`47`	`try container.encode(messageData, forKey: .messageData)`
`48`	`48`	`@unknown default:`
`49`	`49`	`let codableError = CodableWebSocketMessage.unknownMessageTypeError(isEncoding: true)`
`50`		`- throw ObservableWebSocketClientError.encodingMessage(codableError)`
	`50`	`+ throw ObservableWebSocketError.encodingMessage(codableError)`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`	`}`