aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_dispatch/middleware
diff options
context:
space:
mode:
authorVijay Dev <vijaydev.cse@gmail.com>2012-05-06 09:58:02 -0700
committerVijay Dev <vijaydev.cse@gmail.com>2012-05-06 09:58:02 -0700
commit89376004b103e5fbaf0e9389a57f7f298c065932 (patch)
tree03101f7322bb603f172dcfd615eb40b18018bad4 /actionpack/lib/action_dispatch/middleware
parent80cfb5ff7048f94badc06e61fd7c4bf8f7e5524b (diff)
parent3527852dba6e68eca1c4ed3d8024c10e6a0ec008 (diff)
downloadrails-89376004b103e5fbaf0e9389a57f7f298c065932.tar.gz
rails-89376004b103e5fbaf0e9389a57f7f298c065932.tar.bz2
rails-89376004b103e5fbaf0e9389a57f7f298c065932.zip
Merge pull request #5924 from cjolly/signed-cookies-docs
Improve signed cookies documentation
Diffstat (limited to 'actionpack/lib/action_dispatch/middleware')
-rw-r--r--actionpack/lib/action_dispatch/middleware/cookies.rb8
1 files changed, 5 insertions, 3 deletions
diff --git a/actionpack/lib/action_dispatch/middleware/cookies.rb b/actionpack/lib/action_dispatch/middleware/cookies.rb
index de9c55d96c..3a5442918d 100644
--- a/actionpack/lib/action_dispatch/middleware/cookies.rb
+++ b/actionpack/lib/action_dispatch/middleware/cookies.rb
@@ -29,6 +29,7 @@ module ActionDispatch
# # Sets a signed cookie, which prevents a user from tampering with its value.
# # The cookie is signed by your app's <tt>config.secret_token</tt> value.
# # Rails generates this value by default when you create a new Rails app.
+ # # Signed cookies must read with the signed method <tt>cookies.signed[:key]</tt>
# cookies.signed[:user_id] = current_user.id
#
# # Sets a "permanent" cookie (which expires in 20 years from now).
@@ -39,9 +40,10 @@ module ActionDispatch
#
# Examples for reading:
#
- # cookies[:user_name] # => "david"
- # cookies.size # => 2
- # cookies[:lat_lon] # => [47.68, -122.37]
+ # cookies[:user_name] # => "david"
+ # cookies.size # => 2
+ # cookies[:lat_lon] # => [47.68, -122.37]
+ # cookies.signed[:login] # => "XJ-122"
#
# Example for deleting:
#