класс 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.
# It can be read using the signed method `cookies.signed[:name]`
cookies.signed[:user_id] = current_user.id

# Sets an encrypted cookie value before sending it to the client which
# prevent users from reading and tampering with its value.
# It can be read using the encrypted method `cookies.encrypted[:name]`
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.