hotsock-turbo 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +14 -2
- data/lib/hotsock/turbo/streams_helper.rb +1 -1
- data/lib/hotsock/turbo/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aa8e10033b8676f3818b4c8988046b24f410258c07f0632cd4082e9a1ed9865d
|
|
4
|
+
data.tar.gz: 575ebb35a85d1bc5ab915b6ab83c32dba6bdb542cd36c8fde03c6ad21a38946b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 443b7bae1effc3d21e06d5d1249cf8d93fda03a38f8876eacc60d9d414360887e8b20d88689a508a7b181124493bdd2ca8af2b81750fbeafc8324903bec3aa4d
|
|
7
|
+
data.tar.gz: b29f910dd278d6143812b0ab65ebbb01deb75dbde72614084880e10be081a1a1450fe7730d443a119f9e4230f09191275f100143f0d43525fb2177121f82f1c9
|
data/README.md
CHANGED
|
@@ -64,14 +64,26 @@ import "@hotsock/hotsock-js"
|
|
|
64
64
|
import "hotsock-turbo"
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
+
### Mount the Engine
|
|
68
|
+
|
|
69
|
+
Add to your `config/routes.rb`:
|
|
70
|
+
|
|
71
|
+
```ruby
|
|
72
|
+
mount Hotsock::Turbo::Engine => "/hotsock"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
This provides a `POST /hotsock/connect` endpoint that returns connection tokens for the WebSocket client.
|
|
76
|
+
|
|
67
77
|
## Configuration
|
|
68
78
|
|
|
69
79
|
Create an initializer at `config/initializers/hotsock_turbo.rb`:
|
|
70
80
|
|
|
71
81
|
```ruby
|
|
72
82
|
Hotsock::Turbo.configure do |config|
|
|
73
|
-
# Required: Path to
|
|
74
|
-
|
|
83
|
+
# Required: Path to the engine's connect endpoint (or your own custom
|
|
84
|
+
# endpoint). This path must accept a POST request and return a JSON object
|
|
85
|
+
# with a `token` field that contains a connect-scoped JWT. {"token":"ey..."}
|
|
86
|
+
config.connect_token_path = "/hotsock/connect"
|
|
75
87
|
|
|
76
88
|
# Required: Your Hotsock WebSocket URL
|
|
77
89
|
config.wss_url = "wss://your-hotsock-instance.example.com"
|
|
@@ -27,7 +27,7 @@ module Hotsock
|
|
|
27
27
|
def create_subscription_token(channel_name)
|
|
28
28
|
Hotsock.issue_token(
|
|
29
29
|
scope: "subscribe",
|
|
30
|
-
channels: {channel_name => {
|
|
30
|
+
channels: {channel_name => {omitFromSubCount: true, subscribe: true}},
|
|
31
31
|
uid:,
|
|
32
32
|
exp: 1.week.from_now.to_i
|
|
33
33
|
)
|