Class: Merb::Cookies

Inherits:
Object show all
Defined in:
lib/merb-core/dispatch/cookies.rb

Overview

Cookies are read and written through Merb::Controller#cookies. The cookies you read are those received in request along with those that have been set during the current request. The cookies you write will be sent out with the response. Cookies are read by value (so you won’t get the cookie object itself back – just the value it holds).

Instance Method Summary collapse

Constructor Details

#initialize(request_cookies, headers) ⇒ Cookies

Parameters

request_cookies<Hash>

Initial cookie store.

headers<Hash>

The response headers.



13
14
15
16
 
# File 'lib/merb-core/dispatch/cookies.rb', line 13

def initialize(request_cookies, headers)
  @_cookies = request_cookies
  @_headers = headers
end

Instance Method Details

#[](name) ⇒ Object

Parameters

name<~to_s>

Name of the cookie.

Returns

String

Value of the cookie.



23
24
25
 
# File 'lib/merb-core/dispatch/cookies.rb', line 23

def [](name)
  @_cookies[name]
end

#[]=(name, options) ⇒ Object

Parameters

name<~to_s>

Name of the cookie.

options<Hash, ~to_s>

Options for the cookie being set (see below).

Options (options)

:value<~to_s>

Value of the cookie

:path<String>

The path for which this cookie applies. Defaults to “/”.

:expires<Time>

Cookie expiry date.

Alternatives

If options is not a hash, it will be used as the cookie value directly.

Examples

cookies[:user] = "dave" # => Sets a simple session cookie
cookies[:token] = { :value => user.token, :expires => Time.now + 2.weeks }
  # => Will set a cookie that expires in 2 weeks



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/merb-core/dispatch/cookies.rb', line 43

def []=(name, options)
  value = ''
  if options.is_a?(Hash)
    options = Mash.new(options)
    value = options.delete(:value)
  else
    value = options
    options = Mash.new
  end
  @_cookies[name] = value
  set_cookie(name, Merb::Request.escape(value), options)
  Merb.logger.info("Cookie set: #{name} => #{value} -- #{options.inspect}")
  options
end

#delete(name, 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.

Parameters

name<~to_s>

Name of the cookie to delete.

options<Hash>

Additional options to pass to set_cookie.



64
65
66
67
68
69
70
71
 
# File 'lib/merb-core/dispatch/cookies.rb', line 64

def delete(name, options = {})
  cookie = @_cookies.delete(name)
  options = Mash.new(options)
  options[:expires] = Time.at(0)
  set_cookie(name, "", options)
  Merb.logger.info("Cookie deleted: #{name} => #{cookie.inspect}")
  cookie
end

#set_cookie(name, value, options) ⇒ Object

Parameters

name<~to_s>

Name of the cookie.

value<~to_s>

Value of the cookie.

options<Hash>

Additional options for the cookie (see below).

Options (options)

:path<String>

The path for which this cookie applies. Defaults to “/”.

:expires<Time>

Cookie expiry date.



81
82
83
84
85
86
87
88
89
 
# File 'lib/merb-core/dispatch/cookies.rb', line 81

def set_cookie(name, value, options)
  options[:path] = '/' unless options[:path]
  if expiry = options[:expires]
    options[:expires] = expiry.gmtime.strftime(Merb::Const::COOKIE_EXPIRATION_FORMAT)
  end
  # options are sorted for testing purposes
  (@_headers['Set-Cookie'] ||=[]) << "#{name}=#{value}; " +
    options.map{|k, v| "#{k}=#{v};"}.sort.join(' ')
end