Add TwitterOAuthException#parsedMessage

Author: abraham

src/TwitterOAuthException.php

@@ -9,5 +9,19 @@
  */
 class TwitterOAuthException extends \Exception
 {
-    // force phpcbf and prettier to format the same way
+    /**
+     * Attempts to parse message as JSON. If parsing fails, returns message directly.
+     *
+     * @return array|object|string
+     */
+    public function parsedMessage()
+    {
+        $decoded = json_decode($this->message, false);
+
+        if (json_last_error() === JSON_ERROR_NONE) {
+            return $decoded;
+        }
+
+        return $this->message;
+    }
 }

tests/TwitterOAuthExceptionTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Abraham\TwitterOAuth\Test;
+
+use PHPUnit\Framework\TestCase;
+use Abraham\TwitterOAuth\TwitterOAuthException;
+
+class TwitterOAuthExceptionTest extends TestCase
+{
+    public function testParseMessageWithValidJson()
+    {
+        $jsonString = '{"error":"rate limit exceeded","code":88}';
+        $result = new TwitterOAuthException($jsonString);
+
+        $this->assertIsObject($result->parsedMessage());
+        $this->assertEquals(
+            'rate limit exceeded',
+            $result->parsedMessage()->error,
+        );
+        $this->assertEquals(88, $result->parsedMessage()->code);
+    }
+
+    public function testParseMessageWithInvalidJson()
+    {
+        $plainString = 'This is not JSON';
+        $result = new TwitterOAuthException($plainString);
+
+        $this->assertIsString($result->parsedMessage());
+        $this->assertEquals('This is not JSON', $result->parsedMessage());
+    }
+
+    public function testParseMessageWithEmptyString()
+    {
+        $emptyString = '';
+        $result = new TwitterOAuthException($emptyString);
+
+        $this->assertIsString($result->parsedMessage());
+        $this->assertEquals('', $result->parsedMessage());
+    }
+}