ucb_rails_session_timeout 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eec79400b51768c1573bed8ff84536507dbc9e1b4f46bde74f14c01b20888498
+  data.tar.gz: 5e6f7db2019778890f0b9e21684adf69d357160bec91d8fa68b271888e6daaf7
+SHA512:
+  metadata.gz: 8751d53d5f07d428f571f534b52e886a26af511346f68240f6e4947ae4e9f3dee1ea4c9ffe48e2fa5dc21a25ed89652108660da757f0c5d6c10c49e998ddedd1
+  data.tar.gz: 216d18fd7232bbe2f06a1149d2f6ac2679f61f94852822526c917bd225bb23fbc3d436e35eba75acd93ac4cd97a53f91dfbc09573744e49e8df62afb28eaf227

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2025-02-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Darin Wilson
+
+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

@@ -0,0 +1,134 @@
+# UCB Rails Session Timeout
+
+Rails gem that provides configurable session timeouts and warning notifications. When users are inactive, they receive a warning dialog and can choose to extend their session or be logged out.
+
+## Features
+- Configurable timeout and warning periods
+- Native HTML dialog warning
+- Automatic session tracking
+- No external dependencies
+- Supports Rails 7+
+
+## Installation
+
+```ruby
+gem "ucb_rails_session_timeout"
+```
+
+## Ruby Setup
+
+Add to your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include UcbRailsSessionTimeout
+
+  ...
+end
+```
+
+By default, the warning popup will appear after 13 minutes, the session will timeout after 15 minutes, and the current page will reload (which should fail, as the user should already be logged out). You can customize any/all of these behaviors by creating an initializer and changing the values:
+
+```ruby
+# config/initializers/ucb_rails_session_timeout.rb
+
+UcbRailsSessionTimeout.configure do |config|
+  # timeout length as a duration - default is 15.minutes
+  config.timeout_length = 20.minutes
+
+  # warning length as a duration: the warning will popup this length of time before the timeout - default is 2.minutes
+  config.warning_length = 5.minutes
+
+  # the URL to redirect to when the session times out - default is the current URL
+  # for more reliable behavior, set this to a path that will actually log the user out
+  config.redirect_url = "/logout"
+end
+```
+
+If you want to do something besides redirecting the user after the session times out, you can override the `handle_session_timeout` method in the `ApplicationController` and implement whatever behavior you'd like:
+
+```ruby
+class ApplicationController < ActionController::Base
+  ...
+
+  def handle_session_timeout
+    logger.info "Session timed out"
+    redirect_to "/login", alert: "You have been logged out"
+  end
+
+  ...
+end
+```
+
+## JavaScript Setup (optional)
+
+If you don't want the popup warning, you can skip this step.
+
+### Propshaft setup
+
+Import the timer so it's available to the view.
+
+```javascript
+// app/javascript/application.js
+import { ActivityTimer } from "@ucb_rails_session_timeout/activity_timer"
+```
+
+
+### Sprockets setup
+
+Add this to your `application.js`
+
+```javascript
+//= require ucb_rails_session_timeout
+```
+
+### Add the popup script to your view
+
+The `ucb_rails_session_timeout_script` helper will insert a JavaScript snippet that initializes the timer for the popup. Call the helper from anywhere in your view layer (e.g. your application layout file):
+
+```haml
+= ucb_rails_session_timeout_script()
+```
+
+Most likely, you'll only want the popup warning on pages where the user is actually logged in:
+
+```haml
+- if current_user.present?
+  = ucb_rails_session_timeout_script()
+```
+
+
+## Styling
+
+The warning dialog uses the native HTML `<dialog>` element with a CSS class `.ucb-rails-session-timeout-dialog`. You can use the class in your CSS files as a hook to style the dialog however you'd like:
+
+```css
+.ucb-rails-session-timeout-dialog {
+  /* override dialog styles */
+}
+```
+
+If you're using Bootstrap with SASS, you can use the `@extend` feature to integrate Bootstrap's modal styles:
+
+```scss
+.ucb-rails-session-timeout-dialog {
+  @extend .modal;
+
+  header {
+    @extend .modal-header;
+  }
+
+  main {
+    @extend .modal-body;
+  }
+
+  footer {
+    @extend .modal-footer;
+
+    button {
+      @extend .btn;
+      @extend .btn-primary;
+    }
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/javascript/ucb_rails_session_timeout/activity_timer.js

@@ -0,0 +1,75 @@
+export class ActivityTimer {
+  constructor(timeoutLengthInSeconds, warningLengthInSeconds, redirectUrl) {
+    this.timeoutLengthInSeconds = timeoutLengthInSeconds
+    this.warningLengthInSeconds = warningLengthInSeconds
+    this.redirectUrl = redirectUrl
+    this.dialog = this.setupDialog()
+    this.setupTimer()
+  }
+
+  setupDialog() {
+    const dialog = document.createElement("dialog")
+    dialog.className = "ucb-rails-session-timeout-dialog"
+    dialog.innerHTML = `
+      <header>
+        <h3>Session Timeout Warning</h3>
+      </header>
+      <main>
+        Your session will expire in <span id="session_timeout_countdown"></span>
+      </main>
+      <footer>
+        <button>Stay Logged In</button>
+      </footer>
+    `
+    document.body.appendChild(dialog)
+    dialog.querySelector("button").addEventListener("click", () => {
+      this.extendSession()
+      dialog.close()
+    })
+    return dialog
+  }
+
+  setupTimer() {
+    this.timer = setTimeout(() => {
+      if (!this.dialog.open) {
+        this.showWarning()
+      }
+    }, (this.timeoutLengthInSeconds - this.warningLengthInSeconds) * 1000)
+  }
+
+  showWarning() {
+    document.querySelector("dialog.ucb-rails-session-timeout-dialog").showModal()
+    this.startCountdown()
+  }
+
+  startCountdown() {
+    const countdownEl = document.getElementById("session_timeout_countdown")
+    const timeoutAt = Date.now() + (this.warningLengthInSeconds * 1000)
+
+    const updateCountdown = () => {
+      const remainingSeconds = Math.max(0, Math.round((timeoutAt - Date.now()) / 1000))
+      const minutes = Math.floor(remainingSeconds / 60)
+      const seconds = remainingSeconds % 60
+
+      countdownEl.textContent = `${minutes}:${seconds.toString().padStart(2, "0")}`
+
+      if (remainingSeconds <= 0) {
+        clearInterval(this.countdownTimer)
+        if (this.redirectUrl) {
+          window.location.href = this.redirectUrl
+        } else {
+          window.location.reload()
+        }
+      }
+    }
+
+    updateCountdown() // Initial update
+    this.countdownTimer = setInterval(updateCountdown, 1000)
+  }
+
+  extendSession() {
+    fetch(window.location.href).catch(() => {})
+    clearInterval(this.countdownTimer)
+    this.setupTimer()
+  }
+}

data/lib/ucb_rails_session_timeout/activity_tracker.rb

@@ -0,0 +1,34 @@
+require "active_support/core_ext/numeric/time"
+
+module UcbRailsSessionTimeout
+  module ActivityTracker
+    extend ActiveSupport::Concern
+
+    # build in a little wiggle room to account for timing differences between front-end and back-end
+    GRACE_PERIOD = 15.seconds
+
+    included do
+      before_action :check_timeout
+      after_action :track_activity
+    end
+
+    def handle_session_timeout
+      redirect_to UcbRailsSessionTimeout.configuration.redirect_url || request.original_url
+    end
+
+    private
+
+    def track_activity
+      session[:last_active_at] = Time.current.strftime("%d/%m/%Y, %H:%M:%S")
+    end
+
+    def check_timeout
+      return if session[:last_active_at].blank?
+      time_since_last_activity = Time.current - Time.parse(session[:last_active_at])
+      if time_since_last_activity > (UcbRailsSessionTimeout.configuration.timeout_length + GRACE_PERIOD)
+        reset_session
+        handle_session_timeout()
+      end
+    end
+  end
+end

data/lib/ucb_rails_session_timeout/config.rb

@@ -0,0 +1,41 @@
+require "active_support/core_ext/numeric/time"
+
+module UcbRailsSessionTimeout
+  class << self
+    def configuration
+      @configuration ||= UcbRailsSessionTimeout::Config.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+
+  class Config
+    attr_accessor :timeout_length, :warning_length, :redirect_url
+
+    def initialize
+      @timeout_length = 15.minutes
+      @warning_length = 2.minutes
+      @redirect_url = nil
+    end
+
+    def timeout_length=(value)
+      validate_duration!(:timeout_length, value)
+      @timeout_length = value
+    end
+
+    def warning_length=(value)
+      validate_duration!(:warning_length, value)
+      @warning_length = value
+    end
+
+    private
+
+    def validate_duration!(field, value)
+      unless value.is_a?(ActiveSupport::Duration)
+        raise UcbRailsSessionTimeout::Error.new("#{field} must be an instance of ActiveSupport::Duration (e.g. 15.minutes, 60.seconds, etc)")
+      end
+    end
+  end
+end

data/lib/ucb_rails_session_timeout/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UcbRailsSessionTimeout
+  VERSION = "1.0.0"
+end

data/lib/ucb_rails_session_timeout/view_helper.rb

@@ -0,0 +1,18 @@
+require "action_view"
+
+module UcbRailsSessionTimeout
+  module ViewHelper
+    def ucb_rails_session_timeout_script
+      js = <<-JS
+        document.addEventListener("DOMContentLoaded", () => { new ActivityTimer(
+          #{UcbRailsSessionTimeout.configuration.timeout_length.to_i},
+          #{UcbRailsSessionTimeout.configuration.warning_length.to_i},
+          #{"'" + UcbRailsSessionTimeout.configuration.redirect_url + "'" || "null"}
+        ) })
+      JS
+      content_tag(:script, js.html_safe)
+    end
+  end
+end
+
+ActionView::Base.send :include, UcbRailsSessionTimeout::ViewHelper

data/lib/ucb_rails_session_timeout.rb

@@ -0,0 +1,15 @@
+require "active_support"
+require "ucb_rails_session_timeout/activity_tracker"
+require "ucb_rails_session_timeout/config"
+require "ucb_rails_session_timeout/view_helper"
+
+module UcbRailsSessionTimeout
+  class Error < StandardError; end
+
+  class Engine < ::Rails::Engine
+  end
+
+  def self.included(base)
+    base.include ActivityTracker
+  end
+end

data/sig/ucb_rails_session_timeout.rbs

@@ -0,0 +1,4 @@
+module UcbRailsSessionTimeout
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/vendor/assets/javascripts/ucb_rails_session_timeout.js

@@ -0,0 +1,75 @@
+class ActivityTimer {
+  constructor(timeoutLengthInSeconds, warningLengthInSeconds, redirectUrl) {
+    this.timeoutLengthInSeconds = timeoutLengthInSeconds
+    this.warningLengthInSeconds = warningLengthInSeconds
+    this.redirectUrl = redirectUrl
+    this.dialog = this.setupDialog()
+    this.setupTimer()
+  }
+
+  setupDialog() {
+    const dialog = document.createElement("dialog")
+    dialog.className = "ucb-rails-session-timeout-dialog"
+    dialog.innerHTML = `
+      <header>
+        <h3>Session Timeout Warning</h3>
+      </header>
+      <main>
+        Your session will expire in <span id="session_timeout_countdown"></span>
+      </main>
+      <footer>
+        <button>Stay Logged In</button>
+      </footer>
+    `
+    document.body.appendChild(dialog)
+    dialog.querySelector("button").addEventListener("click", () => {
+      this.extendSession()
+      dialog.close()
+    })
+    return dialog
+  }
+
+  setupTimer() {
+    this.timer = setTimeout(() => {
+      if (!this.dialog.open) {
+        this.showWarning()
+      }
+    }, (this.timeoutLengthInSeconds - this.warningLengthInSeconds) * 1000)
+  }
+
+  showWarning() {
+    document.querySelector("dialog.ucb-rails-session-timeout-dialog").showModal()
+    this.startCountdown()
+  }
+
+  startCountdown() {
+    const countdownEl = document.getElementById("session_timeout_countdown")
+    const timeoutAt = Date.now() + (this.warningLengthInSeconds * 1000)
+
+    const updateCountdown = () => {
+      const remainingSeconds = Math.max(0, Math.round((timeoutAt - Date.now()) / 1000))
+      const minutes = Math.floor(remainingSeconds / 60)
+      const seconds = remainingSeconds % 60
+
+      countdownEl.textContent = `${minutes}:${seconds.toString().padStart(2, "0")}`
+
+      if (remainingSeconds <= 0) {
+        clearInterval(this.countdownTimer)
+        if (this.redirectUrl) {
+          window.location.href = this.redirectUrl
+        } else {
+          window.location.reload()
+        }
+      }
+    }
+
+    updateCountdown() // Initial update
+    this.countdownTimer = setInterval(updateCountdown, 1000)
+  }
+
+  extendSession() {
+    fetch(window.location.href).catch(() => {})
+    clearInterval(this.countdownTimer)
+    this.setupTimer()
+  }
+}

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ucb_rails_session_timeout
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Darin Wilson
+- Michael Valenza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides configurable session timeout with warning notifications
+email:
+- darinwilson@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/javascript/ucb_rails_session_timeout/activity_timer.js
+- lib/ucb_rails_session_timeout.rb
+- lib/ucb_rails_session_timeout/activity_tracker.rb
+- lib/ucb_rails_session_timeout/config.rb
+- lib/ucb_rails_session_timeout/version.rb
+- lib/ucb_rails_session_timeout/view_helper.rb
+- sig/ucb_rails_session_timeout.rbs
+- vendor/assets/javascripts/ucb_rails_session_timeout.js
+homepage: https://gitlab.com/ucb-bit/cad/aa/ucb_rails_session_timeout
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ucb-bit/cad/aa/ucb_rails_session_timeout
+  source_code_uri: https://gitlab.com/ucb-bit/cad/aa/ucb_rails_session_timeout
+  changelog_uri: https://gitlab.com/ucb-bit/cad/aa/ucb_rails_session_timeout/-/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Auto-logout functionality for Rails applications
+test_files: []