From a592be265b81bcdced8dce19ed08b8f8e47bab4b Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 13:04:45 +0000 Subject: [PATCH 1/6] Bump version to 1.2.7. --- README.md | 4 ++-- Spec/RealtimeClientConnection.swift | 2 +- Version.xcconfig | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 99dfd3a97..5dbd2a3ee 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,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.6), or clone it to get the latest, unstable and possibly underdocumented version: `git clone git@github.com:ably/ably-cocoa.git` +1. Get the code from GitHub [from the release page](https://github.com/ably/ably-cocoa/releases/tag/1.2.7), or clone it to get the latest, unstable and possibly underdocumented version: `git clone git@github.com: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. @@ -753,7 +753,7 @@ For each release, the following needs to be done: * Create a new branch `release/x.x.x` (where `x.x.x` is the new version number) from the `main` branch * Run `make bump_[major|minor|patch]` to bump the new version number (creates a Git commit) * Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). This may require some manual intervention, both in terms of how the command is run and how the change log file is modified. Your mileage may vary: - * The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-cocoa --since-tag 1.2.6 --output delta.md` + * The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-cocoa --since-tag 1.2.7 --output delta.md` * Using the command above, `--output delta.md` writes changes made after `--since-tag` to a new file * The contents of that new file (`delta.md`) then need to be manually inserted at the top of the `CHANGELOG.md`, changing the "Unreleased" heading and linking with the current version numbers * Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD` diff --git a/Spec/RealtimeClientConnection.swift b/Spec/RealtimeClientConnection.swift index a92aae516..fc00ea268 100644 --- a/Spec/RealtimeClientConnection.swift +++ b/Spec/RealtimeClientConnection.swift @@ -239,7 +239,7 @@ class RealtimeClientConnection: QuickSpec { 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.6")) + expect(query).to(haveParam("agent", hasPrefix: "ably-cocoa/1.2.7")) } else { XCTFail("MockTransport isn't working") diff --git a/Version.xcconfig b/Version.xcconfig index b9aa3b407..40a7b6d6b 100644 --- a/Version.xcconfig +++ b/Version.xcconfig @@ -1 +1 @@ -CURRENT_PROJECT_VERSION = 1.2.6 +CURRENT_PROJECT_VERSION = 1.2.7 From 9c02836cfa0cabe285e77ac104c4deddc8fef9a7 Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 13:07:26 +0000 Subject: [PATCH 2/6] Update changelog for 1.2.7 --- CHANGELOG.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eb7156598..d62d485d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,66 @@ # Change Log -## [v1.2.6](https://github.com/ably/ably-cocoa/tree/1.2.6) +## [1.2.7](https://github.com/ably/ably-cocoa/tree/1.2.7) + +[Full Changelog](https://github.com/ably/ably-cocoa/compare/1.2.6...1.2.7) + +**Implemented enhancements:** + +- Stop base64-encoding authorization headers unnecessarily [\#1185](https://github.com/ably/ably-cocoa/issues/1185) +- Conflict with XAspect with `HAVE_CONFIG_H` macro [\#1161](https://github.com/ably/ably-cocoa/issues/1161) +- Blocks supplied as properties or method arguments should have typedef [\#1032](https://github.com/ably/ably-cocoa/issues/1032) +- Unused function warnings in xdelta3.x when Ably added via CocoaPods - Unused Entity Issue [\#1031](https://github.com/ably/ably-cocoa/issues/1031) +- Add Objective-C++ build to test suite [\#968](https://github.com/ably/ably-cocoa/issues/968) +- Reduce library dependencies [\#949](https://github.com/ably/ably-cocoa/issues/949) +- Improve error message for invalid state operations [\#843](https://github.com/ably/ably-cocoa/issues/843) +- Finish implementing TI3 [\#760](https://github.com/ably/ably-cocoa/issues/760) +- Update Stats fields with latest MessageTraffic types [\#732](https://github.com/ably/ably-cocoa/issues/732) +- Address issues raised by Xcode’s static analyzer [\#694](https://github.com/ably/ably-cocoa/issues/694) +- Quick Documentation: add headerdoc comments [\#298](https://github.com/ably/ably-cocoa/issues/298) + +**Fixed bugs:** + +- Encrypt messages if a new ARTRealtimeChannelOptions or ARTChannelOptions containing cipher is set [\#1207](https://github.com/ably/ably-cocoa/issues/1207) +- Prebuilt `Ably.framework` from `make carthage_package` doesn't work in Xcode projects [\#1168](https://github.com/ably/ably-cocoa/issues/1168) +- Library version identifier invalid [\#900](https://github.com/ably/ably-cocoa/issues/900) +- Check RTN15c3 implementation [\#847](https://github.com/ably/ably-cocoa/issues/847) +- when using authUrl with authMethod=POST, authParams are sent JSON-encoded, not form-encoded [\#690](https://github.com/ably/ably-cocoa/issues/690) + +**Closed issues:** + +- Add Swift Package Manager badges to README.md [\#1204](https://github.com/ably/ably-cocoa/issues/1204) +- NSSecureCoding NSObject bypasses security [\#1188](https://github.com/ably/ably-cocoa/issues/1188) +- Add Ably-cocoa swift package to Swift Package Index [\#1141](https://github.com/ably/ably-cocoa/issues/1141) +- App Store upload problem - non-public API use [\#1104](https://github.com/ably/ably-cocoa/issues/1104) +- Memory leak\(s\) when using event emitters [\#1099](https://github.com/ably/ably-cocoa/issues/1099) +- build warning - treating a forced downcast to 'ARTClientOptions' as optional will never produce 'nil' [\#1035](https://github.com/ably/ably-cocoa/issues/1035) +- Warnings about deprecations when used in a Mac Catalyst app [\#1003](https://github.com/ably/ably-cocoa/issues/1003) +- Possible race conditions in Test Suite [\#912](https://github.com/ably/ably-cocoa/issues/912) + +**Merged pull requests:** + +- Fix `ARTChannel.setOptions` and `ARTRealtimeChannel.setOptions`: Recreate ARTDataEncoder on ARTChannel options update [\#1208](https://github.com/ably/ably-cocoa/pull/1208) ([lukasz-szyszkowski](https://github.com/lukasz-szyszkowski)) +- Add Swift Package Index badges [\#1205](https://github.com/ably/ably-cocoa/pull/1205) ([lukasz-szyszkowski](https://github.com/lukasz-szyszkowski)) +- Fix/694 static analyser issues [\#1198](https://github.com/ably/ably-cocoa/pull/1198) ([maratal](https://github.com/maratal)) +- Log message text fixed. [\#1197](https://github.com/ably/ably-cocoa/pull/1197) ([maratal](https://github.com/maratal)) +- Removed optional base64 auth header [\#1195](https://github.com/ably/ably-cocoa/pull/1195) ([maratal](https://github.com/maratal)) +- Fix/1188 Added allowed class for NSKeyedUnarchiver [\#1194](https://github.com/ably/ably-cocoa/pull/1194) ([maratal](https://github.com/maratal)) +- Added Xcodebuild Logs uploading step [\#1192](https://github.com/ably/ably-cocoa/pull/1192) ([maratal](https://github.com/maratal)) +- Make sure we all use the same version of Fastlane [\#1189](https://github.com/ably/ably-cocoa/pull/1189) ([lawrence-forooghian](https://github.com/lawrence-forooghian)) +- Assure new secret to be created only together with the deviceId [\#1187](https://github.com/ably/ably-cocoa/pull/1187) ([maratal](https://github.com/maratal)) +- Feature/760 remove hardcoded error codes [\#1182](https://github.com/ably/ably-cocoa/pull/1182) ([maratal](https://github.com/maratal)) +- Replaced bundleVersion to hardcoded ARTDefault\_version [\#1181](https://github.com/ably/ably-cocoa/pull/1181) ([maratal](https://github.com/maratal)) +- Cartfile.private updated for tests execution in Xcode 13 [\#1180](https://github.com/ably/ably-cocoa/pull/1180) ([maratal](https://github.com/maratal)) +- Remove `Copyright` and `Created by` from comment header [\#1178](https://github.com/ably/ably-cocoa/pull/1178) ([lukasz-szyszkowski](https://github.com/lukasz-szyszkowski)) +- Copied descriptions from ably.com/documentation/realtime/types [\#1176](https://github.com/ably/ably-cocoa/pull/1176) ([maratal](https://github.com/maratal)) +- New stats fields [\#1175](https://github.com/ably/ably-cocoa/pull/1175) ([maratal](https://github.com/maratal)) +- Dummy class in the test suite to check if it compiles with ably-cocoa [\#1173](https://github.com/ably/ably-cocoa/pull/1173) ([maratal](https://github.com/maratal)) +- Reattaching channels in compliance with RTN15c3 [\#1172](https://github.com/ably/ably-cocoa/pull/1172) ([maratal](https://github.com/maratal)) +- 1003 mac catalyst warnings [\#1171](https://github.com/ably/ably-cocoa/pull/1171) ([maratal](https://github.com/maratal)) +- Documentation: Add link to example app, and clarify `ARTPushRegistererDelegate` usage [\#1170](https://github.com/ably/ably-cocoa/pull/1170) ([ben-xD](https://github.com/ben-xD)) +- Blocks typedef [\#1166](https://github.com/ably/ably-cocoa/pull/1166) ([maratal](https://github.com/maratal)) + +## [1.2.6](https://github.com/ably/ably-cocoa/tree/1.2.6) [Full Changelog](https://github.com/ably/ably-cocoa/compare/1.2.5...1.2.6) From 68fca5366ab49fa600c50b1a0cbc966a35d9aac6 Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 13:08:32 +0000 Subject: [PATCH 3/6] Use latest release of AblyDeltaCodec: 1.3.2 --- Ably.podspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Ably.podspec b/Ably.podspec index f1024406a..d0ffb8216 100644 --- a/Ably.podspec +++ b/Ably.podspec @@ -21,5 +21,5 @@ Pod::Spec.new do |s| s.exclude_files = 'Source/include/', 'Source/PrivateHeaders/' s.module_map = 'Source/Ably.modulemap' s.dependency 'msgpack', '0.4.0' - s.dependency 'AblyDeltaCodec', '1.3.1' + s.dependency 'AblyDeltaCodec', '1.3.2' end From 0ada1c90858c63565bc72082b68c23bae50795f9 Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 13:47:28 +0000 Subject: [PATCH 4/6] Remove less customer-facing changelog lines --- CHANGELOG.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d62d485d8..7010e2d4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,6 @@ - Conflict with XAspect with `HAVE_CONFIG_H` macro [\#1161](https://github.com/ably/ably-cocoa/issues/1161) - Blocks supplied as properties or method arguments should have typedef [\#1032](https://github.com/ably/ably-cocoa/issues/1032) - Unused function warnings in xdelta3.x when Ably added via CocoaPods - Unused Entity Issue [\#1031](https://github.com/ably/ably-cocoa/issues/1031) -- Add Objective-C++ build to test suite [\#968](https://github.com/ably/ably-cocoa/issues/968) - Reduce library dependencies [\#949](https://github.com/ably/ably-cocoa/issues/949) - Improve error message for invalid state operations [\#843](https://github.com/ably/ably-cocoa/issues/843) - Finish implementing TI3 [\#760](https://github.com/ably/ably-cocoa/issues/760) @@ -48,13 +47,8 @@ - Added Xcodebuild Logs uploading step [\#1192](https://github.com/ably/ably-cocoa/pull/1192) ([maratal](https://github.com/maratal)) - Make sure we all use the same version of Fastlane [\#1189](https://github.com/ably/ably-cocoa/pull/1189) ([lawrence-forooghian](https://github.com/lawrence-forooghian)) - Assure new secret to be created only together with the deviceId [\#1187](https://github.com/ably/ably-cocoa/pull/1187) ([maratal](https://github.com/maratal)) -- Feature/760 remove hardcoded error codes [\#1182](https://github.com/ably/ably-cocoa/pull/1182) ([maratal](https://github.com/maratal)) -- Replaced bundleVersion to hardcoded ARTDefault\_version [\#1181](https://github.com/ably/ably-cocoa/pull/1181) ([maratal](https://github.com/maratal)) -- Cartfile.private updated for tests execution in Xcode 13 [\#1180](https://github.com/ably/ably-cocoa/pull/1180) ([maratal](https://github.com/maratal)) -- Remove `Copyright` and `Created by` from comment header [\#1178](https://github.com/ably/ably-cocoa/pull/1178) ([lukasz-szyszkowski](https://github.com/lukasz-szyszkowski)) - Copied descriptions from ably.com/documentation/realtime/types [\#1176](https://github.com/ably/ably-cocoa/pull/1176) ([maratal](https://github.com/maratal)) - New stats fields [\#1175](https://github.com/ably/ably-cocoa/pull/1175) ([maratal](https://github.com/maratal)) -- Dummy class in the test suite to check if it compiles with ably-cocoa [\#1173](https://github.com/ably/ably-cocoa/pull/1173) ([maratal](https://github.com/maratal)) - Reattaching channels in compliance with RTN15c3 [\#1172](https://github.com/ably/ably-cocoa/pull/1172) ([maratal](https://github.com/maratal)) - 1003 mac catalyst warnings [\#1171](https://github.com/ably/ably-cocoa/pull/1171) ([maratal](https://github.com/maratal)) - Documentation: Add link to example app, and clarify `ARTPushRegistererDelegate` usage [\#1170](https://github.com/ably/ably-cocoa/pull/1170) ([ben-xD](https://github.com/ben-xD)) From 184f638a6f6b0aab811af21219921184e6b14c1f Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 13:57:38 +0000 Subject: [PATCH 5/6] Revert "Use latest release of AblyDeltaCodec: 1.3.2" This reverts commit 68fca5366ab49fa600c50b1a0cbc966a35d9aac6. --- Ably.podspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Ably.podspec b/Ably.podspec index d0ffb8216..f1024406a 100644 --- a/Ably.podspec +++ b/Ably.podspec @@ -21,5 +21,5 @@ Pod::Spec.new do |s| s.exclude_files = 'Source/include/', 'Source/PrivateHeaders/' s.module_map = 'Source/Ably.modulemap' s.dependency 'msgpack', '0.4.0' - s.dependency 'AblyDeltaCodec', '1.3.2' + s.dependency 'AblyDeltaCodec', '1.3.1' end From 323b2304ef69616a12d7a0400eb5a800560f720f Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 8 Nov 2021 15:35:13 +0000 Subject: [PATCH 6/6] Update Ably Cocoa version to 1.2.7 in source code --- Source/ARTDefault.m | 2 +- Spec/ARTDefaultTests.swift | 2 +- Spec/RestClient.swift | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Source/ARTDefault.m b/Source/ARTDefault.m index 49925caab..d7c062a0a 100644 --- a/Source/ARTDefault.m +++ b/Source/ARTDefault.m @@ -9,7 +9,7 @@ static inline UInt32 conformVersionComponent(const NSInteger component) { } NSString *const ARTDefault_apiVersion = @"1.2"; -NSString *const ARTDefault_libraryVersion = @"1.2.6"; +NSString *const ARTDefault_libraryVersion = @"1.2.7"; NSString *const ARTDefaultProduction = @"production"; diff --git a/Spec/ARTDefaultTests.swift b/Spec/ARTDefaultTests.swift index 689a4e52c..ffede71be 100644 --- a/Spec/ARTDefaultTests.swift +++ b/Spec/ARTDefaultTests.swift @@ -6,6 +6,6 @@ class ARTDefaultTests: XCTestCase { func testVersions() { XCTAssertEqual(ARTDefault.apiVersion(), "1.2") - XCTAssertEqual(ARTDefault.libraryVersion(), "1.2.6") + XCTAssertEqual(ARTDefault.libraryVersion(), "1.2.7") } } diff --git a/Spec/RestClient.swift b/Spec/RestClient.swift index 229a634d0..0255bd01c 100644 --- a/Spec/RestClient.swift +++ b/Spec/RestClient.swift @@ -1592,7 +1592,7 @@ class RestClient: QuickSpec { let headerAgent = testHTTPExecutor.requests.first!.allHTTPHeaderFields?["Ably-Agent"] let ablyAgent = options.agents() expect(headerAgent).to(equal(ablyAgent)) - expect(headerAgent!.hasPrefix("ably-cocoa/1.2.6")).to(beTrue()) + expect(headerAgent!.hasPrefix("ably-cocoa/1.2.7")).to(beTrue()) done() } }