Merge branch 'feature/39' into develop

Close #39

Author: weierophinney

CHANGELOG.md

@@ -9,6 +9,9 @@ All notable changes to this project will be documented in this file, in reverse
 - [#45](https://github.com/zfcampus/zf-api-problem/pull/45) adds support for PHP 7.
 - [#45](https://github.com/zfcampus/zf-api-problem/pull/45) adds support for
   version 3 components of Zend Framework.
+- [#39](https://github.com/zfcampus/zf-api-problem/pull/39) adds the constant
+  `ApiProblem::CONTENT_TYPE` for specifying the Content-Type of API Problem
+  responses.
 
 ### Deprecated
 

src/ApiProblem.php

@@ -11,6 +11,11 @@
  */
 class ApiProblem
 {
+    /**
+     * Content type for api problem response
+     */
+    const CONTENT_TYPE = 'application/problem+json';
+
     /**
      * Additional details to include in report
      *

src/ApiProblemResponse.php

@@ -69,7 +69,7 @@ public function getHeaders()
     {
         $headers = parent::getHeaders();
         if (!$headers->has('content-type')) {
-            $headers->addHeaderLine('content-type', 'application/problem+json');
+            $headers->addHeaderLine('content-type', ApiProblem::CONTENT_TYPE);
         }
         return $headers;
     }

src/Listener/RenderErrorListener.php

@@ -10,6 +10,7 @@
 use Zend\EventManager\AbstractListenerAggregate;
 use Zend\Mvc\MvcEvent;
 use Zend\View\Exception\ExceptionInterface as ViewExceptionInterface;
+use ZF\ApiProblem\ApiProblem;
 
 /**
  * RenderErrorListener
@@ -89,7 +90,7 @@ public function onRenderError(MvcEvent $e)
             $payload['details'] = $details;
         }
 
-        $response->getHeaders()->addHeaderLine('content-type', 'application/problem+json');
+        $response->getHeaders()->addHeaderLine('content-type', ApiProblem::CONTENT_TYPE);
         $response->setStatusCode($status);
         $response->setContent(json_encode($payload));
 

src/View/ApiProblemStrategy.php

@@ -72,7 +72,7 @@ public function injectResponse(ViewEvent $e)
 
         $problem     = $model->getApiProblem();
         $statusCode  = $this->getStatusCodeFromApiProblem($problem);
-        $contentType = 'application/problem+json';
+        $contentType = ApiProblem::CONTENT_TYPE;
 
         // Populate response
         $response = $e->getResponse();

test/ApiProblemResponseTest.php

@@ -59,7 +59,7 @@ public function testApiProblemResponseSetsContentTypeHeader()
         $this->assertTrue($headers->has('content-type'));
         $header = $headers->get('content-type');
         $this->assertInstanceOf('Zend\Http\Header\ContentType', $header);
-        $this->assertEquals('application/problem+json', $header->getFieldValue());
+        $this->assertEquals(ApiProblem::CONTENT_TYPE, $header->getFieldValue());
     }
 
     public function testComposeApiProblemIsAccessible()

test/Listener/RenderErrorListenerTest.php

@@ -11,6 +11,7 @@
 use Zend\Http\Response;
 use Zend\Mvc\Application;
 use Zend\Mvc\MvcEvent;
+use ZF\ApiProblem\ApiProblem;
 use ZF\ApiProblem\Listener\RenderErrorListener;
 
 class RenderErrorListenerTest extends TestCase
@@ -43,7 +44,7 @@ public function testOnRenderErrorCreatesAnApiProblemResponse()
         $this->assertEquals(406, $response->getStatusCode());
         $headers = $response->getHeaders();
         $this->assertTrue($headers->has('Content-Type'));
-        $this->assertEquals('application/problem+json', $headers->get('content-type')->getFieldValue());
+        $this->assertEquals(ApiProblem::CONTENT_TYPE, $headers->get('content-type')->getFieldValue());
         $content = json_decode($response->getContent(), true);
         $this->assertArrayHasKey('status', $content);
         $this->assertArrayHasKey('title', $content);

test/View/ApiProblemStrategyTest.php

@@ -78,7 +78,7 @@ public function testInjectResponseSetsContentTypeHeaderToApiProblemForApiProblem
         $headers = $this->response->getHeaders();
         $this->assertTrue($headers->has('Content-Type'));
         $header = $headers->get('Content-Type');
-        $this->assertEquals('application/problem+json', $header->getFieldValue());
+        $this->assertEquals(ApiProblem::CONTENT_TYPE, $header->getFieldValue());
     }
 
     public function invalidStatusCodes()