ably-rest 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18051ab71848bfca14ce1fdde6b281ff6b4f1aa251d4a932f321de2b0ed3e00
-  data.tar.gz: d166a634e5f0b55a9be8474dc91a5785dd8f71e2dcbd86b105219a3f16e1813f
+  metadata.gz: 62c1883b254f4b60fa3068a2f8a168720400a27226f469ef82c432aecf0ebbfe
+  data.tar.gz: be4d77bc5b690059bd84114760dbd92099ff30a9cf584a20ff059e6dfc52747b
 SHA512:
-  metadata.gz: 8b040d73ddb0978ad5b9a53dc33dded9ce51355781c82aebe5b9a380bac46229f71161cf5561a8eb806b5425574b95c6ac189a3116d9a4f0ad28332dc372ca07
-  data.tar.gz: 328492908a17a0d6c45f37a2de66cf3851a89ddeaa898a6e22d87b6e0c98df8ea888c3834ebc491e68f97502471205af747a63e5c991197de72d9a6ce48d6708
+  metadata.gz: d1f6797287a76123ff62183b501e534c348052885c5c78da9352c66322a40a1c1eb406f1e55e1cc07deec10c6fbef6e255bb103a48b35041a107b909ba900690
+  data.tar.gz: 2d890d7652099fbab87f9b674dbb5bcc04d314826ed3407a29b6049cc1791a0e00c162df499cd5e910aed625df88007b90f11a8a794414ffbb90ef791884ac2f

data/README.md

@@ -161,14 +161,17 @@ Please note that the bulk of this repo is in fact a submodule of the [Ably Ruby
 
 ## Release Process
 
-1. From the `main` branch, `cd lib/submodules/ably-ruby`
-2. `git fetch origin && git fetch --tags`
-3. Reset to the tagged version released in ably-ruby, e.g. `git reset v1.0.5 --hard`
-4. Ensure submodules of this submodule are up to date (`git submodule update`)
-5. cd to `ably-ruby-rest`
-6. Stage changes `git add .`
-7. Commit version upgrade (`git commit -m "Version upgrade to v1.0.5"`)
-8. Run `rake release`
+1. Create a branch for the release, named like `release/1.2.3` (where `1.2.3` is the new version number)
+2. Change dir to `cd lib/submodules/ably-ruby` and `git fetch origin && git fetch --tags`
+3. Reset to the tagged version released in ably-ruby, e.g. `git reset v1.2.3 --hard`
+4. Ensure submodules of this submodule are up to date using `git submodule update`
+5. Change dir back to root / `ably-ruby-rest`
+6. Stage changes made at submodule file `git add lib/submodules/ably-ruby`
+7. Commit the change `git commit -m "Version upgrade to v1.2.3"` and push the changes.
+8. Make a PR against `main`. Once the PR is approved, merge it into `main`
+9. Add a tag to the new `main` head commit and push to origin such as `git tag v1.2.3 && git push origin v1.2.3`
+10. Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry. 
+11. Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably-rest)
 
 See the [Ably Ruby release process notes](https://github.com/ably/ably-ruby#release-process).
 

data/lib/submodules/ably-ruby/.github/workflows/check.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '3.0', '3.1' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2', '3.3' ]
         protocol: [ 'json', 'msgpack' ]
         type: [ 'unit', 'acceptance' ]
     steps:

data/lib/submodules/ably-ruby/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [v1.2.6](https://github.com/ably/ably-ruby/tree/v1.2.6)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.5...v1.2.6)
+
+**Implemented enhancements:**
+
+- [ably-ruby][no-connection-serial] Implement connection resume/recover [\#393](https://github.com/ably/ably-ruby/issues/393)
+- [ably-ruby][no-connection-serial] Implement missing internal presence [\#392](https://github.com/ably/ably-ruby/issues/392)
+- [ably-ruby][no-connection-serial] Implement code + tests for no-connection-serial [\#378](https://github.com/ably/ably-ruby/issues/378)
+
+**Closed issues:**
+
+- Remove unimplemented push activation methods [\#417](https://github.com/ably/ably-ruby/issues/417)
+- Failing Test - updates attach\_serial [\#415](https://github.com/ably/ably-ruby/issues/415)
+- Failing Test - retrieves two pages of messages before channel was attached [\#414](https://github.com/ably/ably-ruby/issues/414)
+- [ably-ruby] Fix failing tests [\#394](https://github.com/ably/ably-ruby/issues/394)
+
 ## [v1.2.5](https://github.com/ably/ably-ruby/tree/v1.2.5)
 
 This contains an important fix for a TLS certificate validation bug which prevented the library from being able to use Realtime fallback hosts.

data/lib/submodules/ably-ruby/README.md

@@ -7,7 +7,7 @@
 
 _[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation)._
 
-This is a Ruby client library for Ably. The library currently targets the [Ably 1.2 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
+This is a Ruby client library for Ably. The library currently targets the [Ably 2.0.0 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
 
 ## Supported platforms
 
@@ -97,6 +97,14 @@ client.connection.on do |state_change|
 end
 ```
 
+Retrieve connection id, state etc
+
+```ruby
+connection_id = client.connection.id
+state = client.connection.state
+recovery_key = client.connection.create_recovery_key # https://ably.com/docs/connect/states?q=recovery#connection-state-recover-options
+```
+
 ### Subscribing to a channel
 
 Given a channel is created as follows:
@@ -331,9 +339,18 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
 
 This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
 
-* Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
-* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the `CHANGELOG` update has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Ideally, run `rake doc:spec` to generate a new [spec file](./SPEC.md). Then commit these changes.
-* Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
-* Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
-* Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably)
-* Release the [REST-only library `ably-ruby-rest`](https://github.com/ably/ably-ruby-rest#release-process)
+1. Create a branch for the release, named like `release/1.2.3` (where `1.2.3` is the new version number)
+2. Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
+3. 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-ruby --since-tag v1.2.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
+   - 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`
+4. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
+5. Ideally, run `rake doc:spec` to generate a new [spec file](./SPEC.md). Then commit these changes.
+6. Make a PR against `main`. Once the PR is approved, merge it into `main`.
+7. Add a tag to the new `main` head commit and push to origin such as `git tag v1.0.3 && git push origin v1.0.3`.
+8. Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
+9. Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably).
+10. Release the [REST-only library `ably-ruby-rest`](https://github.com/ably/ably-ruby-rest#release-process).
+11. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)).