fenetre 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d742e322e7ed6c94bc26878f732121911872fef3823dea593eb4141ee9c1280
-  data.tar.gz: a6e1d6633311adf8c02aacd849cbfa262e3d50e9d1810504a1ac8bbb649c5e72
+  metadata.gz: c218d212f99120aa8c395fc9f6848fd47cf55ab062ec7cc8e072f57b1f598f3a
+  data.tar.gz: 391ec2ec6dfca02e59dacbd2d13b2dbd170cfcbdde49a82c432fa9a4150324ad
 SHA512:
-  metadata.gz: 04e8007aae26b6c7d48d9071cd6faef061152e62c38907f346101538ff5581fa52104e20a41ccea712984b53682302f7f4e2c7ada1283253cde2aa6d7606ec36
-  data.tar.gz: d50582f711a81470a52739c95691a31e72529e9236dc68738489699cee5869284d4bbd81153c6be70498e772ef54e29fe7c7f52c5e3b70186994e30e8e8819a0
+  metadata.gz: 981a9969e55e179c41104dc1350676a4df76cb2b82627d3bdebb35ce51e8e5ae6e884ec7efd3deaf7c0062427134f5a98c7db3227dd47d9c328b342b20056d7d
+  data.tar.gz: d6b5ff73871ae5b05b2876e840eec7f225e3dbcb0018f2a267b16e8ad3fa942970d065f2cc5e14bf3efdb6501d0f52021d228395da4e70f65865fd56465fa6e1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) #{Time.now.year} [Your Name or Organization] # TODO: Update copyright holder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,21 +1,44 @@
 # Fenetre
 
 [![CI Status](https://github.com/andrewfader/fenetre/workflows/CI/badge.svg)](https://github.com/andrewfader/fenetre/actions)
-[![Coverage Status](https://img.shields.io/badge/coverage-78.9%25-yellow.svg)](coverage/index.html)
+[![Coverage Status](https://img.shields.io/badge/coverage-90.2%25-yellow.svg)](coverage/index.html)
 
 A Rails engine that adds WebRTC video chat to your app using ActionCable, Stimulus, and Turbo.
 
 ## Setup
 
-Fenetre automatically handles most of the necessary setup when used with `importmap-rails`:
+Add the gem, then import it once from your entrypoint:
 
-- Mounting the Action Cable server at `/cable` (if not already mounted).
-- Making the Stimulus controllers available via the import map.
-- Making the view helper available.
+```javascript
+// app/javascript/application.js
+import "fenetre"
+```
 
-**Important:**
-- Your host application **must** use `importmap-rails`.
-- Your host application's `app/javascript/application.js` should load Stimulus controllers (e.g., contain `import "./controllers"`).
+That single import registers the `fenetre--video-chat` Stimulus controller on your
+application (it reuses `window.Stimulus` when your app already started one).
+
+The engine adds its own pins to the host import map, so no `bin/importmap pin`
+is needed for `fenetre`, `@hotwired/stimulus`, or `@rails/actioncable`.
+
+**Requirements:**
+- Your host application uses `importmap-rails` and `propshaft`.
+- Action Cable is mounted (Rails mounts it at `/cable` by default).
+- Your `ApplicationCable::Connection` identifies `current_user` — the channel rejects
+  anonymous subscriptions. Identify `user_role` too if you want moderation:
+
+```ruby
+# app/channels/application_cable/connection.rb
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user, :user_role
+
+    def connect
+      self.current_user = User.find_by(id: cookies.encrypted[:user_id]) || reject_unauthorized_connection
+      self.user_role = current_user.host? ? :host : :guest
+    end
+  end
+end
+```
 
 Add the video chat container helper to any view where you want the chat interface:
 
@@ -35,10 +58,76 @@ Customize the video chat experience using options:
   room_id,
   current_user.id,
   theme: 'light',                   # 'dark' (default) or 'light'
-  # Add other options as needed based on helper definition
+  ice_servers: [                    # optional override; prefer Fenetre.configure
+    { urls: 'stun:stun.l.google.com:19302' },
+    { urls: 'turn:turn.example.com:3478', username: 'u', credential: 'p' }
+  ]
 ) %>
 ```
 
+### ICE / TURN (required for real networks)
+
+STUN alone is not enough for many NATs. Configure TURN in an initializer:
+
+```ruby
+# config/initializers/fenetre.rb
+Fenetre.configure do |c|
+  c.ice_servers = [
+    { urls: 'stun:stun.l.google.com:19302' },
+    { urls: 'turn:turn.example.com:3478', username: ENV.fetch('TURN_USER'), credential: ENV.fetch('TURN_PASS') }
+  ]
+  c.video_width = 1280
+  c.video_height = 720
+  c.frame_rate = 30
+  c.max_video_bitrate = 2_500_000
+  c.max_audio_bitrate = 128_000
+end
+```
+
+### Room policy lives on the server
+
+Nothing a browser sends decides who gets in, how many people fit, or who may
+moderate. Configure that in an initializer:
+
+```ruby
+# config/initializers/fenetre.rb
+Fenetre.configure do |c|
+  # Return false to reject the subscription outright.
+  c.authorize_room = ->(user, room_id) { Room.find_by(slug: room_id)&.member?(user) }
+
+  # Per-room settings, evaluated on every subscription.
+  c.room_options = lambda do |user, room_id|
+    {
+      max_participants: 8,          # join is refused atomically once the room is full
+      room_locked: false,           # when true, only a :host connection may subscribe
+      enable_private_chat: true,    # required before a directed chat message is delivered
+      enable_screen_sharing: true,  # false drops screen_share signals
+      room_topic: 'Daily standup'   # broadcast with the join message
+    }
+  end
+end
+```
+
+Directed chat and moderation (`kick`, `mute`, `unmute`) are delivered only to the
+target user's own stream, and only a connection whose `user_role` is `:host` may
+moderate. Chat is trimmed to 2000 characters and always rendered as text.
+
+### Presence across processes
+
+The default presence store is process-local, which is correct for a single Puma
+process and wrong for anything larger. Supply your own store with the same two
+atomic methods (`join(room, user, limit)` returning the participant list or `nil`
+when full, and `leave(room, user)`), backed by Redis or your database:
+
+```ruby
+Fenetre.presence = MyRedisPresence.new
+```
+
+### Instrumentation
+
+`join.fenetre` and `leave.fenetre` are emitted through `ActiveSupport::Notifications`
+with `user_id` and `room_id` payloads.
+
 ### JavaScript Interaction (Optional)
 
 While Fenetre works out-of-the-box, you can interact with the Stimulus controller (`fenetre--video-chat`) for advanced customization:

data/app/assets/javascripts/fenetre/application.js

@@ -1,14 +1 @@
-// This serves as an entry point for Fenetre JavaScript
-// It's meant to be pinned in the importmap for use by the host application
-
-// Re-export the main fenetre module
-import "./fenetre.js"
-
-// Load the controllers entrypoint using a relative path
-import "./controllers/index.js"
-
-// Export a basic API for the host application to use
-export const Fenetre = {
-  version: "1.0.0",
-  // Add more public API methods as needed
-}
+export { application, register, VideoChatController } from "fenetre"

data/app/assets/javascripts/fenetre/controllers/index.js

@@ -1,19 +1 @@
-// This file loads all Stimulus controllers in the fenetre engine
-// It's referenced by the importmap
-
-import { Application } from "../vendor/stimulus.umd.js"
-import VideoChatController from "./video_chat_controller.js"
-
-const application = Application.start();
-
-// Register controllers with Stimulus
-application.register("fenetre--video-chat", VideoChatController)
-
-// Expose the Stimulus application globally for testing and debugging
-// This allows tests to access controllers through window.Stimulus.application
-if (typeof window !== 'undefined') {
-  window.Stimulus = window.Stimulus || {};
-  window.Stimulus.application = application;
-}
-
-export { application };
+export { application } from "fenetre"