Class: ActionDispatch::Cookies::CookieJar

Inherits:
Hash
  • Object
show all
Defined in:
lib/action_dispatch/middleware/cookies.rb

Overview

:nodoc:

Direct Known Subclasses

PermanentCookieJar, SignedCookieJar

Constant Summary collapse

DOMAIN_REGEXP =

This regular expression is used to split the levels of a domain. The top level domain can be any string without a period or *.*, **.* style TLDs like co.uk or com.au

www.example.co.uk gives: $1 => example $2 => co.uk

example.com gives: $1 => example $2 => com

lots.of.subdomains.example.local gives: $1 => example $2 => local

/([^.]*)\.([^.]*|..\...|...\...)$/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret = nil, host = nil, secure = false) ⇒ CookieJar

Returns a new instance of CookieJar.


115
116
117
118
119
120
121
122
123
# File 'lib/action_dispatch/middleware/cookies.rb', line 115

def initialize(secret = nil, host = nil, secure = false)
  @secret = secret
  @set_cookies = {}
  @delete_cookies = {}
  @host = host
  @secure = secure

  super()
end

Class Method Details

.build(request) ⇒ Object


105
106
107
108
109
110
111
112
113
# File 'lib/action_dispatch/middleware/cookies.rb', line 105

def self.build(request)
  secret = request.env[TOKEN_KEY]
  host = request.host
  secure = request.ssl?

  new(secret, host, secure).tap do |hash|
    hash.update(request.cookies)
  end
end

Instance Method Details

#[](name) ⇒ Object

Returns the value of the cookie by name, or nil if no such cookie exists.


126
127
128
# File 'lib/action_dispatch/middleware/cookies.rb', line 126

def [](name)
  super(name.to_s)
end

#[]=(key, options) ⇒ Object

Sets the cookie named name. The second argument may be the very cookie value, or a hash of options as documented above.


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/action_dispatch/middleware/cookies.rb', line 141

def []=(key, options)
  if options.is_a?(Hash)
    options.symbolize_keys!
    value = options[:value]
  else
    value = options
    options = { :value => value }
  end

  value = super(key.to_s, value)

  handle_options(options)

  @set_cookies[key] = options
  @delete_cookies.delete(key)
  value
end

#delete(key, options = {}) ⇒ Object

Removes the cookie on the client machine by setting the value to an empty string and setting its expiration date into the past. Like []=, you can pass in an options hash to delete cookies with extra data such as a :path.


162
163
164
165
166
167
168
169
170
# File 'lib/action_dispatch/middleware/cookies.rb', line 162

def delete(key, options = {})
  options.symbolize_keys!

  handle_options(options)

  value = super(key.to_s)
  @delete_cookies[key] = options
  value
end

#handle_options(options) ⇒ Object

:nodoc:


130
131
132
133
134
135
136
137
# File 'lib/action_dispatch/middleware/cookies.rb', line 130

def handle_options(options) #:nodoc:
  options[:path] ||= "/"

  if options[:domain] == :all
    @host =~ DOMAIN_REGEXP
    options[:domain] = ".#{$1}.#{$2}"
  end
end

#permanentObject

Returns a jar that'll automatically set the assigned cookies to have an expiration date 20 years from now. Example:

cookies.permanent[:prefers_open_id] = true
# => Set-Cookie: prefers_open_id=true; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT

This jar is only meant for writing. You'll read permanent cookies through the regular accessor.

This jar allows chaining with the signed jar as well, so you can set permanent, signed cookies. Examples:

cookies.permanent.signed[:remember_me] = current_user.id
# => Set-Cookie: remember_me=BAhU--848956038e692d7046deab32b7131856ab20e14e; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT

183
184
185
# File 'lib/action_dispatch/middleware/cookies.rb', line 183

def permanent
  @permanent ||= PermanentCookieJar.new(self, @secret)
end

#signedObject

Returns a jar that'll automatically generate a signed representation of cookie value and verify it when reading from the cookie again. This is useful for creating cookies with values that the user is not supposed to change. If a signed cookie was tampered with by the user (or a 3rd party), an ActiveSupport::MessageVerifier::InvalidSignature exception will be raised.

This jar requires that you set a suitable secret for the verification on your app's config.secret_token.

Example:

cookies.signed[:discount] = 45
# => Set-Cookie: discount=BAhpMg==--2c1c6906c90a3bc4fd54a51ffb41dffa4bf6b5f7; path=/

cookies.signed[:discount] # => 45

200
201
202
# File 'lib/action_dispatch/middleware/cookies.rb', line 200

def signed
  @signed ||= SignedCookieJar.new(self, @secret)
end

#write(headers) ⇒ Object


204
205
206
207
# File 'lib/action_dispatch/middleware/cookies.rb', line 204

def write(headers)
  @set_cookies.each { |k, v| ::Rack::Utils.set_cookie_header!(headers, k, v) if write_cookie?(v) }
  @delete_cookies.each { |k, v| ::Rack::Utils.delete_cookie_header!(headers, k, v) }
end