класс ActionDispatch::Cookies

Чтение и запись данных в файлы cookie с помощью ActionController::Cookies#cookies.

При чтении данных cookie они считываются из заголовка HTTP-запроса Cookie. При записи данных 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

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

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

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

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

• :value — значение cookie.

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

• :domain — домен, для которого действует этот cookie, позволяющий ограничить его область действия уровнем домена. Если вы используете схему вроде www.example.com и хотите делиться сессией с user.example.com, задайте для :domain значение :all. Чтобы поддерживать несколько доменов, передайте массив; будет использован первый домен, соответствующий request.host. При удалении cookie обязательно укажите параметр :domain со значением :all или снова Array. Для большей гибкости можно задавать домен отдельно для каждого запроса, указав :domain с proc.

  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. Например, чтобы делиться cookie между user1.lvh.me и user2.lvh.me, задайте для :tld_length значение 2.

• :expires — время истечения срока действия этого cookie в виде объекта Time или ActiveSupport::Duration.

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

• :httponly — указывает, доступен ли этот cookie через скрипты или только по HTTP. По умолчанию — false.

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