Class: Rack::Session::Abstract::Persisted
- Inherits:
-
Object
- Object
- Rack::Session::Abstract::Persisted
- Defined in:
- lib/rack/session/abstract/id.rb
Overview
ID sets up a basic framework for implementing an id based sessioning service. Cookies sent to the client for maintaining sessions will only contain an id reference. Only #find_session and #write_session are required to be overwritten.
All parameters are optional.
-
:key determines the name of the cookie, by default it is ‘rack.session’
-
:path, :domain, :expire_after, :secure, and :httponly set the related cookie options as by Rack::Response#add_cookie
-
:skip will not a set a cookie in the response nor update the session state
-
:defer will not set a cookie in the response but still update the session state if it is used with a backend
-
:renew (implementation dependent) will prompt the generation of a new session id, and migration of data to be referenced at the new id. If :defer is set, it will be overridden and the cookie will be set.
-
:sidbits sets the number of bits in length that a generated session id will be.
These options can be set on a per request basis, at the location of env['rack.session.options']
. Additionally the id of the session can be found within the options hash at the key :id. It is highly not recommended to change its value.
Is Rack::Utils::Context compatible.
Not included by default; you must require ‘rack/session/abstract/id’ to use.
Constant Summary collapse
- DEFAULT_OPTIONS =
{ :key => RACK_SESSION, :path => '/', :domain => nil, :expire_after => nil, :secure => false, :httponly => true, :defer => false, :renew => false, :sidbits => 128, :cookie_only => true, :secure_random => ::SecureRandom }
Instance Attribute Summary collapse
-
#default_options ⇒ Object
readonly
Returns the value of attribute default_options.
-
#key ⇒ Object
readonly
Returns the value of attribute key.
-
#sid_secure ⇒ Object
readonly
Returns the value of attribute sid_secure.
Instance Method Summary collapse
- #call(env) ⇒ Object
-
#commit_session(req, res) ⇒ Object
Acquires the session from the environment and the session id from the session options and passes them to #write_session.
- #context(env, app = @app) ⇒ Object
-
#initialize(app, options = {}) ⇒ Persisted
constructor
A new instance of Persisted.
Constructor Details
#initialize(app, options = {}) ⇒ Persisted
Returns a new instance of Persisted.
207 208 209 210 211 212 213 |
# File 'lib/rack/session/abstract/id.rb', line 207 def initialize(app, ={}) @app = app @default_options = self.class::DEFAULT_OPTIONS.merge() @key = @default_options.delete(:key) @cookie_only = @default_options.delete(:cookie_only) initialize_sid end |
Instance Attribute Details
#default_options ⇒ Object (readonly)
Returns the value of attribute default_options.
205 206 207 |
# File 'lib/rack/session/abstract/id.rb', line 205 def @default_options end |
#key ⇒ Object (readonly)
Returns the value of attribute key.
205 206 207 |
# File 'lib/rack/session/abstract/id.rb', line 205 def key @key end |
#sid_secure ⇒ Object (readonly)
Returns the value of attribute sid_secure.
205 206 207 |
# File 'lib/rack/session/abstract/id.rb', line 205 def sid_secure @sid_secure end |
Instance Method Details
#call(env) ⇒ Object
215 216 217 |
# File 'lib/rack/session/abstract/id.rb', line 215 def call(env) context(env) end |
#commit_session(req, res) ⇒ Object
Acquires the session from the environment and the session id from the session options and passes them to #write_session. If successful and the :defer option is not true, a cookie will be added to the response with the session’s id.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/rack/session/abstract/id.rb', line 329 def commit_session(req, res) session = req.get_header RACK_SESSION = session. if [:drop] || [:renew] session_id = delete_session(req, session.id || generate_sid, ) return unless session_id end return unless commit_session?(req, session, ) session.send(:load!) unless loaded_session?(session) session_id ||= session.id session_data = session.to_hash.delete_if { |k,v| v.nil? } if not data = write_session(req, session_id, session_data, ) req.get_header(RACK_ERRORS).puts("Warning! #{self.class.name} failed to save session. Content dropped.") elsif [:defer] and not [:renew] req.get_header(RACK_ERRORS).puts("Deferring cookie for #{session_id}") if $VERBOSE else = Hash.new [:value] = data [:expires] = Time.now + [:expire_after] if [:expire_after] [:expires] = Time.now + [:max_age] if [:max_age] (req, res, .merge!()) end end |
#context(env, app = @app) ⇒ Object
219 220 221 222 223 224 225 226 |
# File 'lib/rack/session/abstract/id.rb', line 219 def context(env, app=@app) req = make_request env prepare_session(req) status, headers, body = app.call(req.env) res = Rack::Response::Raw.new status, headers commit_session(req, res) [status, headers, body] end |