module DeviseRemote

Shared behavior for determining if a user is valid based on the headers passed into the Rails application from the authenticating service. At Penn State, this typically happens via WebAccess. Once the user is authenticated, the user's network id (ex. abc123) is passed to the Passenger instance running the Rails application as an HTTP header. This module reads the headers to determine if there is a valid user present.

We can include this module in controllers to determine if user's are valid. This is useful when making a public versus authenticated decision.

@example

class ApplicationController < ActionController::Base
  include Devise::Remote::HttpHeaderAuthenticatableBehavior
end

Constants

VERSION

Attributes

destroy_redirect_url[RW]
new_session_redirect_url[RW]
web_access_url[RW]

Public Class Methods

setup() { |self| ... } click to toggle source

@note Mimics the same configuration process with Devise

# File lib/devise_remote.rb, line 15
def self.setup
  yield self
end