Add Ruby Getting Started guide #2669
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
m-hulbert
reviewed
Jun 17, 2025
GregHolmes
force-pushed
the
EDU-1980-Create-Ruby-getting-started-guide
branch
from
80b250a to
161cb67
Compare
m-hulbert
reviewed
Jun 18, 2025
GregHolmes
force-pushed
the
EDU-1980-Create-Ruby-getting-started-guide
branch
from
5890c0a to
c13038b
Compare
m-hulbert
approved these changes
Jun 19, 2025
| bundle install | ||
| ``` | ||
|
|
||
| The realtime interface of the Ruby SDK must be run within an "EventMachine":https://github.com/eventmachine/eventmachine reactor which provides an asynchronous evented framework for the library. All functionality within this guide runs within an EventMachine.run block. |
There was a problem hiding this comment.
Suggested change
| The realtime interface of the Ruby SDK must be run within an "EventMachine":https://github.com/eventmachine/eventmachine reactor which provides an asynchronous evented framework for the library. All functionality within this guide runs within an EventMachine.run block. | |
| The realtime interface of the Ruby SDK must be run within an "EventMachine":https://github.com/eventmachine/eventmachine reactor which provides an asynchronous evented framework for the library. All functionality within this guide runs within an @EventMachine.run@ block. |
(don't know if there's a way to make it do syntax highlighting?)
| end | ||
|
|
||
|
|
||
| realtime_client.connection.once(:connected) do |
There was a problem hiding this comment.
It's not very clear to me what's going on here — why do we have two different :connected handlers?
| To publish a message in your code, you can add the following line to your @get_started@ method after subscribing to the channel: | ||
|
|
||
| ```[ruby] | ||
| channel.publish 'example', 'A message sent from my first client!' |
There was a problem hiding this comment.
I'm not sure it's clear to the user why there are two arguments here, especially given that the CLI publish call above only took one argument?
| channel.presence.enter("I'm here!") | ||
| ``` | ||
|
|
||
| * In the "dev console":https://ably.com/accounts/any/apps/any/console of your first app, attach to @my-first-channel@. Enter a @client_id@, such as @my-dev-console@, and then join the presence set of the channel. You'll see that @my-first-client@ is already present in the channel. In your terminal you'll see that an event was received when the dev console client joined the channel. |
There was a problem hiding this comment.
Maybe I've missed something, but is there a reason that we use both the dev console and the CLI as the "other" Ably client within the same guide? Wouldn't one tool suffice?
|
|
||
| You can retrieve previously sent messages using the history feature. Ably stores all messages for 2 minutes by default in the event a client experiences network connectivity issues. This can be extended for longer if required. | ||
|
|
||
| If more than 2 minutes has passed since you published a regular message (excluding the presence events), then you can publish some more before trying out history. You can use the Pub/Sub SDK, Ably CLI or the dev console to do this. |
There was a problem hiding this comment.
Suggested change
| If more than 2 minutes has passed since you published a regular message (excluding the presence events), then you can publish some more before trying out history. You can use the Pub/Sub SDK, Ably CLI or the dev console to do this. | |
| If more than 2 minutes has passed since you published a regular message (excluding the presence events), then publish some more before trying out history. You can use the Pub/Sub SDK, Ably CLI or the dev console to do this. |
"you can" makes it sound optional, which it's not — they won't see anything in history!
|
|
||
| ```[ruby] | ||
| # Close the connection after 10 seconds | ||
| Thread.new do |
There was a problem hiding this comment.
Perhaps it would be better to use EventMachine.add_timer 10 do … instead of mixing concurrency idioms?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist