Spec-Zone.ru › Ruby on Rails 5.0

класс ActionDispatch::Cookies

Родитель:
Объект

Куки считываются и записываются через ActionController#cookies.

Считываемые куки — это куки, полученные вместе с запросом, а записываемые куки будут отправлены вместе с ответом. Чтение куки не возвращает сам объект куки, а только значение, которое он хранит.

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

# 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.from_now }

# Sets a signed cookie, which prevents users from tampering with its value.
# The cookie is signed by your app's `secrets.secret_key_base` 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.
# The cookie is signed by your app's `secrets.secret_key_base` 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.permanent.signed[: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.from_now,
  domain: 'domain.com'
}

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

Символьные обозначения параметров для установки куки:

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

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

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

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

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

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

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

Константы

COOKIES_DIGEST
COOKIES_SERIALIZER
CookieOverflow

Выбрасывается при хранении более 4К данных сессии.

ENCRYPTED_COOKIE_SALT
ENCRYPTED_SIGNED_COOKIE_SALT
GENERATOR_KEY
HTTP_HEADER
MAX_COOKIE_SIZE

Куки обычно могут хранить 4096 байт.

SECRET_KEY_BASE
SECRET_TOKEN
SIGNED_COOKIE_SALT

Открытые методы класса

new(app) Показать исходный код
# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 606
def initialize(app)
  @app = app
end

Открытые методы экземпляра

call(env) Показать исходный код
# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 610
def call(env)
  request = ActionDispatch::Request.new env

  status, headers, body = @app.call(env)

  if request.have_cookie_jar?
    cookie_jar = request.cookie_jar
    unless cookie_jar.committed?
      cookie_jar.write(headers)
      if headers[HTTP_HEADER].respond_to?(:join)
        headers[HTTP_HEADER] = headers[HTTP_HEADER].join("\n")
      end
    end
  end

  [status, headers, body]
end

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API