hotsock-turbo 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acb980991920b0cf9f918c2eb1415f7236cd68a1b7d32ef32fb23e61ef123ec1
-  data.tar.gz: 501175af602730032c80b888b419050d3dd9f95258e9c6d3b96c850c91b583e9
+  metadata.gz: aa8e10033b8676f3818b4c8988046b24f410258c07f0632cd4082e9a1ed9865d
+  data.tar.gz: 575ebb35a85d1bc5ab915b6ab83c32dba6bdb542cd36c8fde03c6ad21a38946b
 SHA512:
-  metadata.gz: d4f52b687ea9e85db973edad805dac02761ec3f0c1ec602c36473c13a7c38dafd51f6b864004cad85f9db5dd6230d11d0236bf3445e97f6b5ba7b20a74405017
-  data.tar.gz: 509e133c9a296026acaf7ed40ed161075c688c08da13a9a6379208dbe5317c18cb9932fcf4a561d6feff8285e5f2958f15a55c6f0895dda5f2895236890b3dca
+  metadata.gz: 443b7bae1effc3d21e06d5d1249cf8d93fda03a38f8876eacc60d9d414360887e8b20d88689a508a7b181124493bdd2ca8af2b81750fbeafc8324903bec3aa4d
+  data.tar.gz: b29f910dd278d6143812b0ab65ebbb01deb75dbde72614084880e10be081a1a1450fe7730d443a119f9e4230f09191275f100143f0d43525fb2177121f82f1c9

data/README.md

@@ -64,14 +64,26 @@ import "@hotsock/hotsock-js"
 import "hotsock-turbo"
 ```
 
+### Mount the Engine
+
+Add to your `config/routes.rb`:
+
+```ruby
+mount Hotsock::Turbo::Engine => "/hotsock"
+```
+
+This provides a `POST /hotsock/connect` endpoint that returns connection tokens for the WebSocket client.
+
 ## Configuration
 
 Create an initializer at `config/initializers/hotsock_turbo.rb`:
 
 ```ruby
 Hotsock::Turbo.configure do |config|
-  # Required: Path to an endpoint that returns Hotsock connection tokens
-  config.connect_token_path = "/hotsock/connect_token"
+  # Required: Path to the engine's connect endpoint (or your own custom
+  # endpoint). This path must accept a POST request and return a JSON object
+  # with a `token` field that contains a connect-scoped JWT. {"token":"ey..."}
+  config.connect_token_path = "/hotsock/connect"
 
   # Required: Your Hotsock WebSocket URL
   config.wss_url = "wss://your-hotsock-instance.example.com"
@@ -96,6 +108,7 @@ end
 | `log_level`                    | `"warn"`                  | JavaScript client log level (`"debug"`, `"info"`, `"warn"`, `"error"`) |
 | `parent_controller`            | `"ApplicationController"` | Base controller for generated routes                                   |
 | `override_turbo_broadcastable` | `false`                   | When `true`, overrides standard Turbo broadcast methods to use Hotsock |
+| `suppress_broadcasts`          | `false`                   | When `true`, suppresses all Hotsock turbo broadcasts globally          |
 
 ## Usage
 
@@ -273,6 +286,17 @@ message.broadcast_replace_later_to(board)
 
 ### Suppressing Broadcasts
 
+#### Global Suppression (Test Environments)
+
+Disable all broadcasts globally, useful for test environments where you don't want to require a Hotsock configuration:
+
+```ruby
+# config/environments/test.rb
+Hotsock::Turbo.config.suppress_broadcasts = true
+```
+
+#### Block-based Suppression
+
 Temporarily disable broadcasts within a block:
 
 ```ruby

data/lib/hotsock/turbo/config.rb

@@ -3,7 +3,7 @@
 module Hotsock
   module Turbo
     class Config
-      attr_accessor :parent_controller, :connect_token_path, :wss_url, :log_level, :override_turbo_broadcastable
+      attr_accessor :parent_controller, :connect_token_path, :wss_url, :log_level, :override_turbo_broadcastable, :suppress_broadcasts
 
       def initialize
         @parent_controller = "ApplicationController"
@@ -11,6 +11,7 @@ module Hotsock
         @wss_url = nil
         @log_level = "warn"
         @override_turbo_broadcastable = false
+        @suppress_broadcasts = false
       end
     end
   end

data/lib/hotsock/turbo/streams_channel.rb

@@ -74,6 +74,8 @@ module Hotsock
       end
 
       def self.broadcast_to(stream_or_streamable, content, options = {})
+        return if Hotsock::Turbo.config.suppress_broadcasts
+
         unless enabled?
           fail "Turbo Streams is not enabled. Please install turbo-rails to use this method."
         end
@@ -145,11 +147,15 @@ module Hotsock
       end
 
       def self.broadcast_refresh_later_to(*streamables, request_id: nil)
+        return if Hotsock::Turbo.config.suppress_broadcasts
+
         stream_name = serialize_broadcasting(streamables)
         Hotsock::Turbo::BroadcastRefreshJob.perform_later(stream_name, request_id: request_id)
       end
 
       def self.broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, attributes: {}, **rendering)
+        return if Hotsock::Turbo.config.suppress_broadcasts
+
         stream_name = serialize_broadcasting(streamables)
         Hotsock::Turbo::ActionBroadcastJob.perform_later(
           stream_name,
@@ -194,6 +200,8 @@ module Hotsock
       end
 
       def self.broadcast_render_later_to(*streamables, **rendering)
+        return if Hotsock::Turbo.config.suppress_broadcasts
+
         stream_name = serialize_broadcasting(streamables)
         Hotsock::Turbo::BroadcastJob.perform_later(stream_name, **rendering)
       end

data/lib/hotsock/turbo/streams_helper.rb

@@ -27,7 +27,7 @@ module Hotsock
       def create_subscription_token(channel_name)
         Hotsock.issue_token(
           scope: "subscribe",
-          channels: {channel_name => {omitSubCount: true, subscribe: true}},
+          channels: {channel_name => {omitFromSubCount: true, subscribe: true}},
           uid:,
           exp: 1.week.from_now.to_i
         )

data/lib/hotsock/turbo/version.rb

@@ -2,6 +2,6 @@
 
 module Hotsock
   module Turbo
-    VERSION = "0.1.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotsock-turbo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - James Miller