Module: Merb::SessionMixin::RequestMixin
- Defined in:
- lib/merb-core/dispatch/session.rb
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
Instance Method Summary collapse
-
#default_cookies ⇒ Object
Assign default cookie values.
-
#default_session_store ⇒ Object
The default session store type.
-
#destroy_session_cookie ⇒ Object
Destroy the session cookie.
-
#finalize_session ⇒ Object
(also: #finalize_sessions)
Teardown and/or persist the current sessions.
-
#session(session_store = nil) ⇒ Object
Returns session container.
-
#session=(new_session) ⇒ Object
Parameters new_session<Merb::SessionContainer>:: A session store instance.
-
#session?(session_store = nil) ⇒ Boolean
Whether a session has been setup.
-
#session_cookie_value ⇒ Object
(also: #session_id)
Returns String:: The value of the session cookie; either the session id or the actual encoded data.
-
#session_stores ⇒ Object
Returns Hash:: All active session stores by type.
-
#set_session_cookie_value(value, options = {}) ⇒ Object
(also: #set_session_id_cookie)
Sets session cookie value.
Class Method Details
.included(base) ⇒ Object
94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/merb-core/dispatch/session.rb', line 94 def self.included(base) base.extend ClassMethods # Keep track of all known session store types. base.cattr_accessor :registered_session_types base.registered_session_types = Dictionary.new base.class_inheritable_accessor :_session_id_key, :_session_secret_key, :_session_expiry base._session_id_key = Merb::Config[:session_id_key] || '_session_id' base._session_expiry = Merb::Config[:session_expiry] || Merb::Const::WEEK * 2 base._session_secret_key = Merb::Config[:session_secret_key] end |
Instance Method Details
#default_cookies ⇒ Object
Assign default cookie values
187 188 189 190 191 192 193 194 |
# File 'lib/merb-core/dispatch/session.rb', line 187 def defaults = {} if route && route.allow_fixation? && params.key?(_session_id_key) Merb.logger.info("Fixated session id: #{_session_id_key}") defaults[_session_id_key] = params[_session_id_key] end defaults end |
#default_session_store ⇒ Object
The default session store type.
123 124 125 |
# File 'lib/merb-core/dispatch/session.rb', line 123 def default_session_store Merb::Config[:session_store] && Merb::Config[:session_store].to_sym end |
#destroy_session_cookie ⇒ Object
Destroy the session cookie.
214 215 216 |
# File 'lib/merb-core/dispatch/session.rb', line 214 def .delete(_session_id_key) end |
#finalize_session ⇒ Object Also known as: finalize_sessions
Teardown and/or persist the current sessions.
181 182 183 |
# File 'lib/merb-core/dispatch/session.rb', line 181 def finalize_session session_stores.each { |name, store| store.finalize(self) } end |
#session(session_store = nil) ⇒ Object
Returns session container. Merb is able to handle multiple session stores, hence a parameter to pick it.
Parameters
- session_store<String>
-
The type of session store to access,
defaults to default_session_store.
Notes
If no suitable session store type is given, it defaults to cookie-based sessions.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/merb-core/dispatch/session.rb', line 143 def session(session_store = nil) session_store ||= default_session_store if class_name = self.class.registered_session_types[session_store] session_stores[session_store] ||= Object.full_const_get(class_name).setup(self) elsif fallback = self.class.registered_session_types.keys.first Merb.logger.warn "Session store '#{session_store}' not found. Check your configuration in init file." Merb.logger.warn "Falling back to #{fallback} session store." session(fallback) else msg = "No session store set. Set it in init file like this: c[:session_store] = 'activerecord'" Merb.logger.error!(msg) raise NoSessionContainer, msg end end |
#session=(new_session) ⇒ Object
Parameters
- new_session<Merb::SessionContainer>
-
A session store instance.
Notes
The session is assigned internally by its session_store_type key.
163 164 165 166 167 168 169 170 171 |
# File 'lib/merb-core/dispatch/session.rb', line 163 def session=(new_session) if self.session?(new_session.class.session_store_type) original_session_id = self.session(new_session.class.session_store_type).session_id if new_session.session_id != original_session_id (new_session.session_id) end end session_stores[new_session.class.session_store_type] = new_session end |
#session?(session_store = nil) ⇒ Boolean
Whether a session has been setup
174 175 176 177 178 |
# File 'lib/merb-core/dispatch/session.rb', line 174 def session?(session_store = nil) (session_store ? [session_store] : session_stores).any? do |type, store| store.is_a?(Merb::SessionContainer) end end |
#session_cookie_value ⇒ Object Also known as: session_id
Returns
- String
-
The value of the session cookie; either the session id or the actual encoded data.
208 209 210 |
# File 'lib/merb-core/dispatch/session.rb', line 208 def [_session_id_key] end |
#session_stores ⇒ Object
Returns
- Hash
-
All active session stores by type.
129 130 131 |
# File 'lib/merb-core/dispatch/session.rb', line 129 def session_stores @session_stores ||= {} end |
#set_session_cookie_value(value, options = {}) ⇒ Object Also known as:
Sets session cookie value.
Parameters
- value<String>
-
The value of the session cookie; either the session id or the actual encoded data.
- options<Hash>
-
Cookie options like domain, path and expired.
201 202 203 |
# File 'lib/merb-core/dispatch/session.rb', line 201 def (value, = {}) .(_session_id_key, value, { :expires => Time.now + _session_expiry }.merge()) end |