Add method to get Request-ID header from ApiException

Author: rbibby

src/Exception/ApiException.php

@@ -10,6 +10,11 @@ class ApiException extends UKFastException
 
     protected $response;
 
+    /**
+     * @var string
+     */
+    protected $requestId = null;
+
     public function __construct($response)
     {
         $response->getBody()->rewind();
@@ -32,6 +37,10 @@ public function __construct($response)
             $this->message = $message;
         }
 
+        if (!empty($response->getHeader('Request-ID')[0])) {
+            $this->requestId = $response->getHeader('Request-ID')[0];
+        }
+
         $this->response = $response;
     }
 
@@ -59,6 +68,11 @@ public function getResponse()
         return $this->response;
     }
 
+    public function getRequestId()
+    {
+        return $this->requestId;
+    }
+
     private function getErrorsFromBody($body)
     {
         $errors = [];

tests/ApiExceptionTest.php

@@ -14,7 +14,10 @@ class ApiExceptionTest extends TestCase
      */
     public function constructs_from_standard_api_error()
     {
-        $response = new Response(500, [], json_encode([
+        $headers = [
+            'Request-ID' => 'test-request-id',
+        ];
+        $response = new Response(500, $headers, json_encode([
             'errors' => [
                 [
                     'detail' => 'Test'
@@ -26,6 +29,7 @@ public function constructs_from_standard_api_error()
 
         $this->assertEquals(1, count($exception->getErrors()));
         $this->assertEquals('Test', $exception->getErrors()[0]->detail);
+        $this->assertEquals('test-request-id', $exception->getRequestId());
     }
 
     /**
@@ -54,4 +58,22 @@ public function throws_invalid_json_exception_when_given_bad_json()
         $this->expectException(InvalidJsonException::class);
         $exception = new ApiException($response);
     }
+
+    /**
+     * @test
+     */
+    public function request_id_is_set_to_null_if_none_is_returned()
+    {
+        $response = new Response(500, [], json_encode([
+            'errors' => [
+                [
+                    'detail' => 'Test'
+                ]
+            ]
+        ]));
+
+        $exception = new ApiException($response);
+
+        $this->assertNull($exception->getRequestId());
+    }
 }