whoisonline 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cfe52ed55db885ffcecbedd560e7bedcce71c1e4e89f88b46c738347a792cbd
-  data.tar.gz: fda9b8968db797d1a4abee3d6c2024cec383497f709c880a421ce191125f7b69
+  metadata.gz: 8d9ca4af0f12891b59ecbceb8666fbbb49d05043bc29bce86caeb85f1fa5d92d
+  data.tar.gz: d87b7d98171a1b83793d6291c5ccaaf452a372d18554b532435522938486b5b2
 SHA512:
-  metadata.gz: 0cec3f4acbff9888c28029323d31cb20e12de31b04164871c553be2bcb2d78b40bda8cf0159cec732a982552c104436b79dac6c3732189464ceb19b98130ce5f
-  data.tar.gz: 3dff65d6deebd7dc2cd96b5d1bea5f050be32cc662817625b1bb4ecf7c6bc686388aa97ad5bfa1f8cffe3c4f1293de21b42c47a65194f882fa3bea6f311bd18f
+  metadata.gz: 889ddb36bc48126bac9d70df40140381cef90c66a083bc89c533e60b29d44bc117ff9bb1f4637a2f0b60fb6dd04b399fce74db9b232b32362e4a23bf88a0ff98
+  data.tar.gz: 102ad2155cee722972f09558454f57abc61a652453ac70a05ace23833948ced1f0191b999eb313199a6f2c17be097fd53e7b2339d74e68364199dbffcc0e259e

data/README.md

@@ -1,20 +1,22 @@
 # WhoIsOnline
 
-Track “who is online right now?” in Rails 7/8 using Redis TTL. No database writes, production-safe, and auto-hooks into controllers via a Rails Engine.
+Track "who is online right now?" in Rails 7+ using Redis TTL. No database writes, production-safe, and auto-hooks into controllers via a Rails Engine.
 
 ## Features
 - Rails Engine auto-includes a controller concern to mark users online.
 - Works with `current_user` from any auth system (Devise, custom, etc.).
 - TTL-based presence in Redis, no tables required.
+- **Automatic offline detection** when users close their browser/tab.
+- **Visible-only heartbeats**: only ping while the tab is visible/active (configurable interval).
 - Throttled Redis writes to reduce load (configurable).
 - Safe SCAN-based counting; no `KEYS`.
-- Configurable Redis client, TTL, throttle duration, user id method, controller accessor, and namespace.
+- Configurable Redis client, TTL, throttle duration, user id method, controller accessor, namespace, and heartbeat interval.
 
 ## Installation
 Add to your Gemfile:
 
 ```ruby
-gem "whoisonline", github: "rails-to-rescue/whoisonline"
+gem "whoisonline", github: "KapilDevPal/WhoIsOnline"
 ```
 
 Or install directly:
@@ -32,13 +34,24 @@ WhoIsOnline.configure do |config|
   config.ttl = 5.minutes
   config.throttle = 60.seconds
   config.user_id_method = :id
+  config.heartbeat_interval = 60.seconds # client heartbeat when tab visible
 end
 ```
 
-The engine auto-adds a concern that runs after each controller action to mark the `current_user` as online. Nothing else is required.
+The engine auto-adds a concern that runs after each controller action to mark the `current_user` as online.
+
+**To enable offline detection when users close their browser**, add this to your main layout (e.g., `app/views/layouts/application.html.erb`):
+
+```erb
+<%= whoisonline_offline_script %>
+```
+
+This will automatically mark users offline when they close the browser/tab.
+Heartbeats run only when the tab is visible/active (interval: `heartbeat_interval`, default 60s), keeping the user online without constant polling.
 
 ## Public API
 - `WhoIsOnline.track(user)` – mark a user online (auto-called by the controller concern).
+- `WhoIsOnline.offline(user)` – mark a user offline immediately.
 - `WhoIsOnline.online?(user)` – boolean.
 - `WhoIsOnline.count` – number of online users (via SCAN).
 - `WhoIsOnline.user_ids` – array of ids (strings by default).
@@ -52,6 +65,7 @@ WhoIsOnline.configure do |config|
   config.throttle = 60.seconds     # minimum time between Redis writes per user
   config.user_id_method = :id      # how to pull an ID from the user object
   config.current_user_method = :current_user # method on controllers
+  config.heartbeat_interval = 60.seconds # heartbeat frequency while tab visible
   config.namespace = "whoisonline:user"
   config.auto_hook = true          # disable if you prefer manual tracking
   config.logger = Rails.logger if defined?(Rails)
@@ -69,6 +83,9 @@ end
 # Somewhere in your controller you can also call manually:
 WhoIsOnline.track(current_user)
 
+# Mark user offline (e.g., on logout)
+WhoIsOnline.offline(current_user)
+
 # In a background job
 if WhoIsOnline.online?(user)
   # notify
@@ -79,6 +96,23 @@ end
 @online_count = WhoIsOnline.count
 ```
 
+### Layout Example
+In your main layout (`app/views/layouts/application.html.erb`):
+
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>My App</title>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+    <%= whoisonline_offline_script %>
+  </body>
+</html>
+```
+
 ## Extensibility
 - Engine-based hook is easy to extend (e.g., add ActionCable broadcast).
 - Tracker service is isolated and unit-testable.

data/lib/whoisonline/configuration.rb

@@ -5,7 +5,7 @@ module WhoIsOnline
     DEFAULT_NAMESPACE = "whoisonline:user".freeze
 
     attr_accessor :ttl, :throttle, :user_id_method, :namespace, :auto_hook,
-                  :logger, :current_user_method
+                  :logger, :current_user_method, :heartbeat_interval
     attr_writer :redis
 
     def initialize
@@ -16,6 +16,7 @@ module WhoIsOnline
       @namespace = DEFAULT_NAMESPACE
       @auto_hook = true
       @logger = default_logger
+      @heartbeat_interval = 60.seconds
     end
 
     def redis

data/lib/whoisonline/engine.rb

@@ -1,5 +1,6 @@
 require "rails/engine"
 require_relative "controller"
+require_relative "presence_controller"
 
 module WhoIsOnline
   class Engine < ::Rails::Engine
@@ -10,6 +11,19 @@ module WhoIsOnline
         include WhoIsOnline::Controller
       end
     end
+
+    initializer "whoisonline.routes" do |app|
+      app.routes.append do
+        post "/whoisonline/offline", to: "whoisonline/presence#offline", as: :whoisonline_offline
+        post "/whoisonline/heartbeat", to: "whoisonline/presence#heartbeat", as: :whoisonline_heartbeat
+      end
+    end
+
+    initializer "whoisonline.helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include WhoIsOnline::ApplicationHelper
+      end
+    end
   end
 end
 

data/lib/whoisonline/presence_controller.rb

@@ -0,0 +1,37 @@
+require "action_controller"
+
+module WhoIsOnline
+  class PresenceController < ActionController::Base
+    # Skip CSRF for sendBeacon requests (they may not include CSRF token reliably)
+    skip_before_action :verify_authenticity_token, raise: false
+    protect_from_forgery with: :null_session, only: [:offline]
+
+    def offline
+      user = resolve_whoisonline_user
+      WhoIsOnline.offline(user) if user
+      head :ok
+    rescue StandardError => e
+      WhoIsOnline.configuration.logger&.warn("whoisonline offline failed: #{e.class} #{e.message}")
+      head :ok
+    end
+
+    def heartbeat
+      user = resolve_whoisonline_user
+      WhoIsOnline.track(user) if user
+      head :ok
+    rescue StandardError => e
+      WhoIsOnline.configuration.logger&.warn("whoisonline heartbeat failed: #{e.class} #{e.message}")
+      head :ok
+    end
+
+    private
+
+    def resolve_whoisonline_user
+      method = WhoIsOnline.configuration.current_user_method
+      return public_send(method) if respond_to?(method, true)
+
+      nil
+    end
+  end
+end
+

data/lib/whoisonline/redis_store.rb

@@ -33,6 +33,13 @@ module WhoIsOnline
       []
     end
 
+    def delete_presence(key)
+      connection.del(key)
+    rescue StandardError => e
+      log(:warn, "whoisonline delete failed: #{e.class} #{e.message}")
+      nil
+    end
+
     private
 
     def log(level, message)

data/lib/whoisonline/tracker.rb

@@ -19,6 +19,15 @@ module WhoIsOnline
       @last_write_by_user[uid] = Time.now if result
     end
 
+    def offline(user)
+      uid = extract_id(user)
+      return unless uid
+
+      key = presence_key(uid)
+      @redis_store.delete_presence(key)
+      @last_write_by_user.delete(uid)
+    end
+
     def online?(user)
       uid = extract_id(user)
       return false unless uid

data/lib/whoisonline/version.rb

@@ -1,5 +1,5 @@
 module WhoIsOnline
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end
 
 

data/lib/whoisonline.rb

@@ -10,7 +10,7 @@ require_relative "whoisonline/engine"
 
 module WhoIsOnline
   class << self
-    delegate :track, :online?, :count, :user_ids, :users, to: :tracker
+    delegate :track, :offline, :online?, :count, :user_ids, :users, to: :tracker
 
     def tracker
       @_tracker ||= Tracker.new(configuration, redis_store)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whoisonline
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kapil Dev Pal
@@ -79,6 +79,7 @@ files:
 - lib/whoisonline/configuration.rb
 - lib/whoisonline/controller.rb
 - lib/whoisonline/engine.rb
+- lib/whoisonline/presence_controller.rb
 - lib/whoisonline/redis_store.rb
 - lib/whoisonline/tracker.rb
 - lib/whoisonline/version.rb