mackuba.eu
A Ruby gem for streaming data from the Bluesky/ATProto firehose
release 0.5.0
+6
-4
CHANGELOG.md
+6
-4
CHANGELOG.md
···
1
-
## [Unreleased]
1
+
## [0.5.0] - 2024-11-15
2
2
3
-
Jetstream support! You can now connect to Jetstream sources using `Skyfall::Jetstream` (see readme).
3
+
Jetstream support! You can now connect to [Jetstream](https://github.com/bluesky-social/jetstream) sources using `Skyfall::Jetstream` (see readme).
4
4
5
5
This required some breaking changes in the existing API:
6
6
7
7
- `Skyfall::Stream` has been renamed to `Skyfall::Firehose`, `Skyfall::Stream` is now a base class of both `Firehose` and `Jetstream`; the existing `Skyfall::Stream` constructor works for now but will be removed soon
8
8
- `Skyfall::WebsocketMessage` and its subclasses have been separated into two parallel families under `Skyfall::Firehose` and `Skyfall::Jetstream`, with the base classes just named `Message`
9
9
- same thing happened with `Skyfall::Operation`
10
-
- `data_object` and `type_object` properties are considered semi-private API now ("nodoc")
10
+
- `data_object` and `type_object` properties in `WebsocketMessage` are considered semi-private API now ("nodoc")
11
+
12
+
In most cases, you should only need to update the `Skyfall::Stream` class name in the constructor. If you've referenced message classes like `Skyfall::CommitMessage` directly, it's probably better to just check the `#type` property instead.
11
13
12
-
In most cases, you should only need to update the class name in the constructor. If you've referenced message classes like `Skyfall::CommitMessage` directly, it's probably better to just check the `#type` property instead.
14
+
Also, small change to the user agent API: `Skyfall::Stream` now has an additional metod `version_string`, which will always return `Skyfall/0.x.y` - it's recommended to use that instead of `default_user_agent` to build your own user agent string that includes the library version. `default_user_agent` now passes through to `version_string`, but it could be changed in future to return something else.
13
15
14
16
## [0.4.1] - 2024-10-04
15
17