Class: ActionDispatch::Cookies::CookieJar

Inherits:
Object
  • 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: $& => example.co.uk

example.com gives: $& => example.com

lots.of.subdomains.example.local gives: $& => example.local

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CookieJar.



112
113
114
115
116
117
118
119
120
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 112

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

Instance Attribute Details

#closed ⇒ Object (readonly) Also known as: closed?

Returns the value of attribute closed.



122
123
124
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 122

def closed
  @closed
end

Class Method Details

.build(request) ⇒ Object 



102
103
104
105
106
107
108
109
110
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 102

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.



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

def [](name)
  @cookies[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.

Raises:



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 161

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

  value = @cookies[key.to_s] = value

  handle_options(options)

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

#close! ⇒ Object 



124
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 124

def close!; @closed = true 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.



183
184
185
186
187
188
189
190
191
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 183

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

  handle_options(options)

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

#handle_options(options) ⇒ Object

:nodoc:



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 handle_options(options) #:nodoc:
  options[:path] ||= "/"

  if options[:domain] == :all
    # if there is a provided tld length then we use it otherwise default domain regexp
    domain_regexp = options[:tld_length] ? /([^.]+\.?){#{options[:tld_length]}}$/ : DOMAIN_REGEXP

    # if host is not ip and matches domain regexp
    # (ip confirms to domain regexp so we explicitly check for ip)
    options[:domain] = if (@host !~ /^[\d.]+$/) && (@host =~ domain_regexp)
      ".#{$&}"
    end
  elsif options[:domain].is_a? Array
    # if host matches one of the supplied domains without a dot in front of it
    options[:domain] = options[:domain].find {|domain| @host.include? domain[/^\.?(.*)$/, 1] }
  end
end

#key?(name) ⇒ Boolean Also known as: has_key?

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 131

def key?(name)
  @cookies.key?(name.to_s)
end

#permanent ⇒ Object

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



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

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

#signed ⇒ Object

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



221
222
223
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 221

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

#update(other_hash) ⇒ Object 



136
137
138
139
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 136

def update(other_hash)
  @cookies.update other_hash
  self
end

#write(headers) ⇒ Object 



225
226
227
228
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 225

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