Add `#verified` and `#valid_message?` to MessageVerifier

This commit adds a `#verified` method to
`ActiveSupport::MessageVerifier` which will return either `false` when
it encounters an error or the message. `#verify` continues to raise an
`InvalidSignature` exception on error.

This commit also adds a convenience boolean method on `MessageVerifier`
as a way to check if a message is valid without performing the
decoding.

1 files changed, 24 insertions, 16 deletions

diff --git a/activesupport/test/message_verifier_test.rb b/activesupport/test/message_verifier_test.rb
index 28035bc428..68f40fbb28 100644
--- a/activesupport/test/message_verifier_test.rb
+++ b/activesupport/test/message_verifier_test.rb
@@ -27,21 +27,29 @@ class MessageVerifierTest < ActiveSupport::TestCase
     @data = { :some => "data", :now => Time.local(2010) }
   end
 
+  def test_valid_message
+    data, hash = @verifier.generate(@data).split("--")
+    assert !@verifier.valid_message?(nil)
+    assert !@verifier.valid_message?("")
+    assert !@verifier.valid_message?("#{data.reverse}--#{hash}")
+    assert !@verifier.valid_message?("#{data}--#{hash.reverse}")
+    assert !@verifier.valid_message?("purejunk")
+  end
+
   def test_simple_round_tripping
     message = @verifier.generate(@data)
+    assert_equal @data, @verifier.verified(message)
     assert_equal @data, @verifier.verify(message)
   end
-
-  def test_missing_signature_raises
-    assert_not_verified(nil)
-    assert_not_verified("")
+  
+  def test_verified_returns_false_on_invalid_message
+    assert !@verifier.verified("purejunk")
   end
-
-  def test_tampered_data_raises
-    data, hash = @verifier.generate(@data).split("--")
-    assert_not_verified("#{data.reverse}--#{hash}")
-    assert_not_verified("#{data}--#{hash.reverse}")
-    assert_not_verified("purejunk")
+  
+  def test_verify_exception_on_invalid_message
+    assert_raise(ActiveSupport::MessageVerifier::InvalidSignature) do
+      @verifier.verify("purejunk")
+    end
   end
 
   def test_alternative_serialization_method
@@ -50,6 +58,7 @@ class MessageVerifierTest < ActiveSupport::TestCase
     verifier = ActiveSupport::MessageVerifier.new("Hey, I'm a secret!", :serializer => JSONSerializer.new)
     message = verifier.generate({ :foo => 123, 'bar' => Time.utc(2010) })
     exp = { "foo" => 123, "bar" => "2010-01-01T00:00:00.000Z" }
+    assert_equal exp, verifier.verified(message)
     assert_equal exp, verifier.verify(message)
   ensure
     ActiveSupport.use_standard_json_time_format = prev
@@ -63,6 +72,11 @@ class MessageVerifierTest < ActiveSupport::TestCase
     #
     valid_message = "BAh7BjoIZm9vbzonTWVzc2FnZVZlcmlmaWVyVGVzdDo6QXV0b2xvYWRDbGFzcwY6CUBmb29JIghmb28GOgZFVA==--f3ef39a5241c365083770566dc7a9eb5d6ace914"
     exception = assert_raise(ArgumentError, NameError) do
+      @verifier.verified(valid_message)
+    end
+    assert_includes ["uninitialized constant MessageVerifierTest::AutoloadClass",
+                    "undefined class/module MessageVerifierTest::AutoloadClass"], exception.message
+    exception = assert_raise(ArgumentError, NameError) do
       @verifier.verify(valid_message)
     end
     assert_includes ["uninitialized constant MessageVerifierTest::AutoloadClass",
@@ -75,12 +89,6 @@ class MessageVerifierTest < ActiveSupport::TestCase
     end
     assert_equal exception.message, 'Secret should not be nil.'
   end
-
-  def assert_not_verified(message)
-    assert_raise(ActiveSupport::MessageVerifier::InvalidSignature) do
-      @verifier.verify(message)
-    end
-  end
 end
 
 end