Merge pull request #26 from TSchuermans/feature/rpc-error-data

Added JSON-RPC 2.0 error data to response
graze · Jan 7, 2016 · a94d2b2 · a94d2b2
2 parents 7e0dc22 + f39fbc1
commit a94d2b2
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 1 deletion.
diff --git a/src/Message/Response.php b/src/Message/Response.php
@@ -39,6 +39,16 @@ public function getRpcErrorMessage()
         return isset($error['message']) ? $error['message'] : null;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getRpcErrorData()
+    {
+        $error = $this->getFieldFromBody('error');
+
+        return isset($error['data']) ? $error['data'] : null;
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Message/ResponseInterface.php b/src/Message/ResponseInterface.php
@@ -28,6 +28,11 @@ public function getRpcErrorCode();
      */
     public function getRpcErrorMessage();
 
+    /**
+     * @return mixed
+     */
+    public function getRpcErrorData();
+
     /**
      * @return mixed
      */

diff --git a/test/functional/RequestFunctionalTest.php b/test/functional/RequestFunctionalTest.php
@@ -48,6 +48,7 @@ public function testConcatRequest()
         $this->assertEquals($id, $response->getRpcId());
         $this->assertEquals(null, $response->getRpcErrorCode());
         $this->assertEquals(null, $response->getRpcErrorMessage());
+        $this->assertEquals(null, $response->getRpcErrorData());
     }
 
     public function testConcatAsyncRequest()
@@ -69,6 +70,7 @@ public function testConcatAsyncRequest()
             $this->assertEquals($id, $response->getRpcId());
             $this->assertEquals(null, $response->getRpcErrorCode());
             $this->assertEquals(null, $response->getRpcErrorMessage());
+            $this->assertEquals(null, $response->getRpcErrorData());
         });
     }
 
@@ -90,6 +92,7 @@ public function testSumRequest()
         $this->assertEquals($id, $response->getRpcId());
         $this->assertEquals(null, $response->getRpcErrorCode());
         $this->assertEquals(null, $response->getRpcErrorMessage());
+        $this->assertEquals(null, $response->getRpcErrorData());
     }
 
     public function testSumAsyncRequest()
@@ -111,6 +114,7 @@ public function testSumAsyncRequest()
             $this->assertEquals($id, $response->getRpcId());
             $this->assertEquals(null, $response->getRpcErrorCode());
             $this->assertEquals(null, $response->getRpcErrorMessage());
+            $this->assertEquals(null, $response->getRpcErrorData());
         });
     }
 
@@ -131,6 +135,7 @@ public function testFooRequest()
         $this->assertEquals($id, $response->getRpcId());
         $this->assertEquals(null, $response->getRpcErrorCode());
         $this->assertEquals(null, $response->getRpcErrorMessage());
+        $this->assertEquals(null, $response->getRpcErrorData());
     }
 
     public function testFooAsyncRequest()
@@ -151,6 +156,7 @@ public function testFooAsyncRequest()
             $this->assertEquals($id, $response->getRpcId());
             $this->assertEquals(null, $response->getRpcErrorCode());
             $this->assertEquals(null, $response->getRpcErrorMessage());
+            $this->assertEquals(null, $response->getRpcErrorData());
         });
     }
 
@@ -171,6 +177,7 @@ public function testBarRequest()
         $this->assertEquals($id, $response->getRpcId());
         $this->assertTrue(is_int($response->getRpcErrorCode()));
         $this->assertTrue(is_string($response->getRpcErrorMessage()));
+        $this->assertEquals(null, $response->getRpcErrorData());
     }
 
     public function testBarAsyncRequest()
@@ -191,6 +198,7 @@ public function testBarAsyncRequest()
             $this->assertEquals($id, $response->getRpcId());
             $this->assertTrue(is_int($response->getRpcErrorCode()));
             $this->assertTrue(is_string($response->getRpcErrorMessage()));
+            $this->assertEquals(null, $response->getRpcErrorData());
         });
     }
 

diff --git a/test/unit/Message/ResponseTest.php b/test/unit/Message/ResponseTest.php
@@ -73,7 +73,23 @@ public function testGetRpcErrorMessageIsNull()
     {
         $response = new Response(200);
 
-        $this->assertNull($response->getRpcErrorCode());
+        $this->assertNull($response->getRpcErrorMessage());
+    }
+
+    public function testGetRpcErrorData()
+    {
+        $response = new Response(200, [], json_encode([
+            'error' => ['data' => array()]
+        ]));
+
+        $this->assertEquals(array(), $response->getRpcErrorData());
+    }
+
+    public function testGetRpcErrorDataIsNull()
+    {
+        $response = new Response(200);
+
+        $this->assertNull($response->getRpcErrorData());
     }
 
     public function testGetRpcResult()