Merge pull request rails#43334 from federicoaldunate/add-that-raises-exception-message-encryptor

jonathanhefner · web-flow · commit 414e8dea599d · 2021-09-29T12:15:59.000-05:00
Update MessageEncryptor guide to show that an exception is raised [ci-skip]
diff --git a/activesupport/lib/active_support/message_encryptor.rb b/activesupport/lib/active_support/message_encryptor.rb
@@ -22,6 +22,11 @@ module ActiveSupport
   #   crypt = ActiveSupport::MessageEncryptor.new(key)                            # => #<ActiveSupport::MessageEncryptor ...>
   #   encrypted_data = crypt.encrypt_and_sign('my secret data')                   # => "NlFBTTMwOUV5UlA1QlNEN2xkY2d6eThYWWh..."
   #   crypt.decrypt_and_verify(encrypted_data)                                    # => "my secret data"
+  # The +decrypt_and_verify+ method will raise an
+  # <tt>ActiveSupport::MessageEncryptor::InvalidMessage</tt> exception if the data
+  # provided cannot be decrypted or verified.
+  #
+  #   crypt.decrypt_and_verify('not encrypted data') # => ActiveSupport::MessageEncryptor::InvalidMessage
   #
   # === Confining messages to a specific purpose
   #

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,11 @@ module ActiveSupport`
`22`	`22`	`# crypt = ActiveSupport::MessageEncryptor.new(key) # => #<ActiveSupport::MessageEncryptor ...>`
`23`	`23`	`# encrypted_data = crypt.encrypt_and_sign('my secret data') # => "NlFBTTMwOUV5UlA1QlNEN2xkY2d6eThYWWh..."`
`24`	`24`	`# crypt.decrypt_and_verify(encrypted_data) # => "my secret data"`
	`25`	`+ # The +decrypt_and_verify+ method will raise an`
	`26`	`+ # <tt>ActiveSupport::MessageEncryptor::InvalidMessage</tt> exception if the data`
	`27`	`+ # provided cannot be decrypted or verified.`
	`28`	`+ #`
	`29`	`+ # crypt.decrypt_and_verify('not encrypted data') # => ActiveSupport::MessageEncryptor::InvalidMessage`
`25`	`30`	`#`
`26`	`31`	`# === Confining messages to a specific purpose`
`27`	`32`	`#`