kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Copy-edit the MessageVerifier documentation [ci skip]

Browse source
This commit is contained in:
Rafael Mendonça França 2014-12-04 14:09:47 -02:00
parent 6061c540ac
commit f7c7bcd9c2
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
activesupport/lib/active_support/message_verifier.rb
View file

@ -55,23 +55,22 @@ module ActiveSupport
# verifier = ActiveSupport::MessageVerifier.new 's3Krit' # verifier = ActiveSupport::MessageVerifier.new 's3Krit'
# #
# signed_message = verifier.generate 'a private message' # 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. # Returns +nil+ if the message was not signed with the same secret.
# #
# other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit' # 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. # Returns +nil+ if the message is not Base64-encoded.
# #
# invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d" # invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d"
# verifier.verified(invalid_message) #=> nil # verifier.verified(invalid_message) # => nil
# #
# Raises any error raised while decoding the signed message. # Raises any error raised while decoding the signed message.
# #
# incompatible_message = "test--dad7b06c94abba8d46a15fafaef56c327665d5ff" # 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) def verified(signed_message)
if valid_message?(signed_message) if valid_message?(signed_message)
begin begin
@ -89,13 +88,13 @@ module ActiveSupport
# verifier = ActiveSupport::MessageVerifier.new 's3Krit' # verifier = ActiveSupport::MessageVerifier.new 's3Krit'
# signed_message = verifier.generate 'a private message' # 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 # Raises +InvalidSignature+ if the message was not signed with the same
# secret or was not Base64-encoded. # secret or was not Base64-encoded.
# #
# other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit' # 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) def verify(signed_message)
verified(signed_message) || raise(InvalidSignature) verified(signed_message) || raise(InvalidSignature)
end end