aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/message_verifier.rb
diff options
context:
space:
mode:
authorRafael Mendonça França <rafaelmfranca@gmail.com>2014-12-04 14:09:47 -0200
committerRafael Mendonça França <rafaelmfranca@gmail.com>2014-12-04 14:09:47 -0200
commitf7c7bcd9c2a8b0e8c2840295d001d2d4dfd4cfae (patch)
treea5ead1580b24a9aa2a4be72c68647556448af86e /activesupport/lib/active_support/message_verifier.rb
parent6061c540ac7880233a6e32de85cec72c20ed8778 (diff)
downloadrails-f7c7bcd9c2a8b0e8c2840295d001d2d4dfd4cfae.tar.gz
rails-f7c7bcd9c2a8b0e8c2840295d001d2d4dfd4cfae.tar.bz2
rails-f7c7bcd9c2a8b0e8c2840295d001d2d4dfd4cfae.zip
Copy-edit the MessageVerifier documentation [ci skip]
Diffstat (limited to 'activesupport/lib/active_support/message_verifier.rb')
-rw-r--r--activesupport/lib/active_support/message_verifier.rb13
1 files changed, 6 insertions, 7 deletions
diff --git a/activesupport/lib/active_support/message_verifier.rb b/activesupport/lib/active_support/message_verifier.rb
index 4ff7cf9617..d16c1c629b 100644
--- a/activesupport/lib/active_support/message_verifier.rb
+++ b/activesupport/lib/active_support/message_verifier.rb
@@ -55,23 +55,22 @@ module ActiveSupport
# verifier = ActiveSupport::MessageVerifier.new 's3Krit'
#
# signed_message = verifier.generate 'a private message'
- # verifier.verified(signed_message) #=> 'a private message'
+ # verifier.verified(signed_message) # => 'a private message'
#
# Returns +nil+ if the message was not signed with the same secret.
#
# other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit'
- # other_verifier.verified(signed_message) #=> nil
+ # other_verifier.verified(signed_message) # => nil
#
# Returns +nil+ if the message is not Base64-encoded.
#
# invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d"
- # verifier.verified(invalid_message) #=> nil
+ # verifier.verified(invalid_message) # => nil
#
# Raises any error raised while decoding the signed message.
#
# incompatible_message = "test--dad7b06c94abba8d46a15fafaef56c327665d5ff"
- # verifier.verified(incompatible_message) #=> TypeError: incompatible marshal file format
- #
+ # verifier.verified(incompatible_message) # => TypeError: incompatible marshal file format
def verified(signed_message)
if valid_message?(signed_message)
begin
@@ -89,13 +88,13 @@ module ActiveSupport
# verifier = ActiveSupport::MessageVerifier.new 's3Krit'
# signed_message = verifier.generate 'a private message'
#
- # verifier.verify(signed_message) #=> 'a private message'
+ # verifier.verify(signed_message) # => 'a private message'
#
# Raises +InvalidSignature+ if the message was not signed with the same
# secret or was not Base64-encoded.
#
# other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit'
- # other_verifier.verified(signed_message) #=> ActiveSupport::MessageVerifier::InvalidSignature
+ # other_verifier.verified(signed_message) # => ActiveSupport::MessageVerifier::InvalidSignature
def verify(signed_message)
verified(signed_message) || raise(InvalidSignature)
end