класс ActionDispatch::Cookies

Чтение и запись данных в куки через ActionController::Cookies#cookies.

При чтении данных куки данные считываются из заголовка HTTP-запроса, Cookie. При записи данных куки данные отправляются в заголовке HTTP-ответа, Set-Cookie.

Примеры записи:

# Sets a simple session cookie.
# This cookie will be deleted when the user's browser is closed.
cookies[:user_name] = "david"

# Cookie values are String-based. Other data types need to be serialized.
cookies[:lat_lon] = JSON.generate([47.68, -122.37])

# Sets a cookie that expires in 1 hour.
cookies[:login] = { value: "XJ-122", expires: 1.hour }

# Sets a cookie that expires at a specific time.
cookies[:login] = { value: "XJ-122", expires: Time.utc(2020, 10, 15, 5) }

# Sets a signed cookie, which prevents users from tampering with its value.
cookies.signed[:user_id] = current_user.id
# It can be read using the signed method.
cookies.signed[:user_id] # => 123

# Sets an encrypted cookie value before sending it to the client which
# prevent users from reading and tampering with its value.
cookies.encrypted[:discount] = 45
# It can be read using the encrypted method.
cookies.encrypted[:discount] # => 45

# Sets a "permanent" cookie (which expires in 20 years from now).
cookies.permanent[:login] = "XJ-122"

# You can also chain these methods:
cookies.signed.permanent[:login] = "XJ-122"

Примеры чтения:

cookies[:user_name]           # => "david"
cookies.size                  # => 2
JSON.parse(cookies[:lat_lon]) # => [47.68, -122.37]
cookies.signed[:login]        # => "XJ-122"
cookies.encrypted[:discount]  # => 45

Пример удаления:

cookies.delete :user_name

Обратите внимание, что если вы укажете :domain при настройке куки, вы также должны указать домен при удалении куки:

cookies[:name] = {
  value: 'a yummy cookie',
  expires: 1.year,
  domain: 'domain.com'
}

cookies.delete(:name, domain: 'domain.com')

Символы параметров для настройки куки:

• :value - значение куки.

• :path - путь, для которого действует данная куки. По умолчанию корень приложения.

• :domain - домен, для которого действует данная куки, позволяя ограничить её доменным уровнем. Если вы используете схему, как www.example.com, и хотите поделиться сессией с user.example.com, установите :domain в :all. Для поддержки нескольких доменов укажите массив, и будет использован первый соответствующий request.host домен. Не забудьте указать опцию :domain с :all или Array при удалении куки. Для большей гибкости вы можете установить домен на основе каждого запроса, указав :domain с процедурой.

  domain: nil  # Does not set cookie domain. (default)
  domain: :all # Allow the cookie for the top most level
               # domain and subdomains.
  domain: %w(.example.com .example.org) # Allow the cookie
                                        # for concrete domain names.
  domain: proc { Tenant.current.cookie_domain } # Set cookie domain dynamically
  domain: proc { |req| ".sub.#{req.host}" }     # Set cookie domain dynamically based on request

• :tld_length - при использовании :domain => :all, этот параметр может быть использован для явного указания длины TLD при использовании короткого (≤ 3 символов) домена, который интерпретируется как часть TLD. Например, чтобы обмениваться куками между user1.lvh.me и user2.lvh.me, установите :tld_length в 2.

• :expires - время истечения срока действия куки, как объект Time или ActiveSupport::Duration.

• :secure - указывает, передаётся ли данная куки только серверам HTTPS. Значение по умолчанию false.

• :httponly - указывает, доступна ли данная куки через скрипты или только через HTTP. Значение по умолчанию false.

• :same_site - значение атрибута SameSite куки, которое определяет, как данная куки должна быть ограничена в контекстах между сайтами. Возможные значения nil, :none, :lax, и :strict. Значение по умолчанию :lax.