Merge pull request #2027 from ably/release/1.2.38

Release version 1.2.38

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [1.2.38](https://github.com/ably/ably-cocoa/tree/1.2.38)
+
+## What's Changed
+
+* Add `NSCopying` support to `ART*ChannelOptions` by @lawrence-forooghian in https://github.com/ably/ably-cocoa/pull/2018
+* Introduction of a new API intended for use by Ably-authored SDKs by @lawrence-forooghian in https://github.com/ably/ably-cocoa/pull/2014
+
+**Full Changelog**: https://github.com/ably/ably-cocoa/compare/1.2.37...1.2.38
+
 ## [1.2.37](https://github.com/ably/ably-cocoa/tree/1.2.37)
 
 **Full Changelog**: https://github.com/ably/ably-cocoa/compare/1.2.36...1.2.37

README.md

@@ -61,7 +61,7 @@ You can install Ably for iOS and macOS through Package Manager, CocoaPods, Carth
     - [This apple guide](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) explains the steps in more detail.
 - To install the `ably-cocoa` package in another **Swift Package**, then add the following to your `Package.Swift`:
 ```swift
- .package(url: "https://github.com/ably/ably-cocoa", from: "1.2.37"),
+ .package(url: "https://github.com/ably/ably-cocoa", from: "1.2.38"),
 ```
 ### Installing through [CocoaPods](https://cocoapods.org/)
 
@@ -101,7 +101,7 @@ If you see, for example, a `dyld: Library not loaded: @rpath/AblyDeltaCodec.fram
 
 ### Manual installation 
 
-1. Get the code from GitHub [from the release page](https://github.com/ably/ably-cocoa/releases/tag/1.2.37), or clone it to get the latest, unstable and possibly underdocumented version: `git clone [email protected]:ably/ably-cocoa.git`
+1. Get the code from GitHub [from the release page](https://github.com/ably/ably-cocoa/releases/tag/1.2.38), or clone it to get the latest, unstable and possibly underdocumented version: `git clone [email protected]:ably/ably-cocoa.git`
 2. Drag the directory `ably-cocoa/ably-cocoa` into your project as a group.
 3. Ably depends on our [MessagePack Fork](https://github.com/ably-forks/msgpack-objective-C) 0.2.0; get it [from the releases page](https://github.com/ably-forks/msgpack-objective-C/releases/tag/0.2.0-ably-1) and link it into your project.
 

Scripts/jazzy.sh

@@ -6,7 +6,7 @@ bundle exec jazzy \
   --objc \
   --clean \
   --author Ably \
-  --module-version 1.2.37 \
+  --module-version 1.2.38 \
   --umbrella-header Source/include/Ably/AblyPublic.h \
   --framework-root Source \
   --module Ably \

Scripts/set-version.sh

@@ -34,6 +34,7 @@ other_files=(
   "Test/Tests/ClientInformationTests.swift"
   "Test/Tests/RealtimeClientConnectionTests.swift"
   "Test/Tests/RestClientTests.swift"
+  "Test/Tests/WrapperSDKProxyTests.swift"
 )
 
 for file in ${other_files[@]};

Source/ARTClientInformation.m

@@ -6,7 +6,7 @@
 #import <sys/utsname.h>
 
 NSString *const ARTClientInformationAgentNotVersioned = @"ARTClientInformationAgentNotVersioned";
-NSString *const ARTClientInformation_libraryVersion = @"1.2.37";
+NSString *const ARTClientInformation_libraryVersion = @"1.2.38";
 static NSString *const _libraryName = @"ably-cocoa";
 
 // NSOperatingSystemVersion has NSInteger as version components for some reason, so mitigate it here.

Test/Tests/ARTDefaultTests.swift

@@ -6,6 +6,6 @@ class ARTDefaultTests: XCTestCase {
 
     func testVersions() {
         XCTAssertEqual(ARTDefault.apiVersion(), "2")
-        XCTAssertEqual(ARTDefault.libraryVersion(), "1.2.37")
+        XCTAssertEqual(ARTDefault.libraryVersion(), "1.2.38")
     }
 }

Test/Tests/ClientInformationTests.swift

@@ -9,7 +9,7 @@ final class ClientInformationTests: XCTestCase {
 
         XCTAssertEqual(agents.keys.count, 2)
 
-        XCTAssertEqual(agents["ably-cocoa"], "1.2.37")
+        XCTAssertEqual(agents["ably-cocoa"], "1.2.38")
 
         #if os(iOS)
         XCTAssertTrue(agents.keys.contains("iOS"))
@@ -27,7 +27,7 @@ final class ClientInformationTests: XCTestCase {
     // CR3, CR3b
     func testAgentIdentifierWithAdditionalAgents_withNilAdditionalAgents() {
         let expectedIdentifier = [
-            "ably-cocoa/1.2.37",
+            "ably-cocoa/1.2.38",
             ARTDefault.platformAgent()
         ].sorted().joined(separator: " ")
 
@@ -42,7 +42,7 @@ final class ClientInformationTests: XCTestCase {
         ]
 
         let expectedIdentifier = [
-            "ably-cocoa/1.2.37",
+            "ably-cocoa/1.2.38",
             "demolib/0.0.1",
             "morelib",
             ARTDefault.platformAgent()

Test/Tests/RealtimeClientConnectionTests.swift

@@ -384,7 +384,7 @@ class RealtimeClientConnectionTests: XCTestCase {
                     done()
                 case .connected:
                     if let transport = client.internal.transport as? TestProxyTransport, let query = transport.lastUrl?.query {
-                        expect(query).to(haveParam("agent", hasPrefix: "ably-cocoa/1.2.37"))
+                        expect(query).to(haveParam("agent", hasPrefix: "ably-cocoa/1.2.38"))
                     } else {
                         XCTFail("MockTransport isn't working")
                     }

Test/Tests/RestClientTests.swift

@@ -1736,7 +1736,7 @@ class RestClientTests: XCTestCase {
                 let headerAgent = testHTTPExecutor.requests.first!.allHTTPHeaderFields?["Ably-Agent"]
                 let ablyAgent = ARTClientInformation.agentIdentifier(withAdditionalAgents: options.agents)
                 XCTAssertEqual(headerAgent, ablyAgent)
-                XCTAssertTrue(headerAgent!.hasPrefix("ably-cocoa/1.2.37"))
+                XCTAssertTrue(headerAgent!.hasPrefix("ably-cocoa/1.2.38"))
                 done()
             }
         }

Test/Tests/WrapperSDKProxyTests.swift

@@ -220,7 +220,7 @@ class WrapperSDKProxyTests: XCTestCase {
         let request = try XCTUnwrap(testHTTPExecutor.requests.first)
 
         let expectedIdentifier = [
-            "ably-cocoa/1.2.37",
+            "ably-cocoa/1.2.38",
             ARTDefault.platformAgent(),
             "my-wrapper-sdk/1.0.0"
         ].sorted().joined(separator: " ")
@@ -309,7 +309,7 @@ class WrapperSDKProxyTests: XCTestCase {
         XCTAssertEqual(testHTTPExecutor.requests.count, 3) // initial `request()`, `first()`, `next()`
 
         let expectedIdentifier = [
-            "ably-cocoa/1.2.37",
+            "ably-cocoa/1.2.38",
             ARTDefault.platformAgent(),
             "my-wrapper-sdk/1.0.0"
         ].sorted().joined(separator: " ")

Version.xcconfig

@@ -1 +1 @@
-CURRENT_PROJECT_VERSION = 1.2.37
+CURRENT_PROJECT_VERSION = 1.2.38