Merge branch 'feature/285' into develop

Close #285

Author: weierophinney

CHANGELOG.md

@@ -6,7 +6,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#285](https://github.com/zendframework/zend-diactoros/pull/285) adds a new
+  custom response type, `Zend\Diactoros\Response\XmlResponse`, for generating
+  responses representing XML. Usage is the same as with the `HtmlResponse` or
+  `TextResponse`; the response generated will have a `Content-Type:
+  application/xml` header by default.
 
 ### Changed
 

doc/book/custom-responses.md

@@ -58,6 +58,28 @@ $response = new HtmlResponse($htmlContent, 200, [ 'Content-Type' => ['applicatio
 Headers must be in the same format as you would provide to the
 [Response constructor](api.md#response-message).
 
+## XML Responses
+
+- Since 1.7.0
+
+`Zend\Diactoros\Response\XmlResponse` allows specifying XML as a payload, and sets the
+`Content-Type` header to `application/xml` by default:
+
+```php
+$response = new XmlResponse($xml);
+```
+
+The constructor allows passing two additional arguments: a status code, and an array of headers.
+These allow you to further seed the initial state of the response, as well as to override the
+`Content-Type` header if desired:
+
+```php
+$response = new XmlResponse($xml, 200, [ 'Content-Type' => ['application/hal+xml']]);
+```
+
+Headers must be in the same format as you would provide to the
+[Response constructor](api.md#response-message).
+
 ## JSON Responses
 
 `Zend\Diactoros\Response\JsonResponse` accepts a data structure to convert to JSON, and sets

src/Response/XmlResponse.php

@@ -0,0 +1,74 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Zend\Diactoros\Response;
+
+use InvalidArgumentException;
+use Psr\Http\Message\StreamInterface;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\Stream;
+
+/**
+ * XML response.
+ *
+ * Allows creating a response by passing an XML string to the constructor; by default,
+ * sets a status code of 200 and sets the Content-Type header to application/xml.
+ */
+class XmlResponse extends Response
+{
+    use InjectContentTypeTrait;
+
+    /**
+     * Create an XML response.
+     *
+     * Produces an XML response with a Content-Type of application/xml and a default
+     * status of 200.
+     *
+     * @param string|StreamInterface $xml String or stream for the message body.
+     * @param int $status Integer status code for the response; 200 by default.
+     * @param array $headers Array of headers to use at initialization.
+     * @throws InvalidArgumentException if $text is neither a string or stream.
+     */
+    public function __construct(
+        $xml,
+        $status = 200,
+        array $headers = []
+    ) {
+        parent::__construct(
+            $this->createBody($xml),
+            $status,
+            $this->injectContentType('application/xml; charset=utf-8', $headers)
+        );
+    }
+
+    /**
+     * Create the message body.
+     *
+     * @param string|StreamInterface $xml
+     * @return StreamInterface
+     * @throws InvalidArgumentException if $xml is neither a string or stream.
+     */
+    private function createBody($xml)
+    {
+        if ($xml instanceof StreamInterface) {
+            return $xml;
+        }
+
+        if (! is_string($xml)) {
+            throw new InvalidArgumentException(sprintf(
+                'Invalid content (%s) provided to %s',
+                (is_object($xml) ? get_class($xml) : gettype($xml)),
+                __CLASS__
+            ));
+        }
+
+        $body = new Stream('php://temp', 'wb+');
+        $body->write($xml);
+        $body->rewind();
+        return $body;
+    }
+}

test/Response/XmlResponseTest.php

@@ -0,0 +1,95 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+namespace ZendTest\Diactoros\Response;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\StreamInterface;
+use Zend\Diactoros\Response\XmlResponse;
+
+class XmlResponseTest extends TestCase
+{
+    public function testConstructorAcceptsBodyAsString()
+    {
+        $body = 'Super valid XML';
+
+        $response = new XmlResponse($body);
+        $this->assertSame($body, (string) $response->getBody());
+        $this->assertSame(200, $response->getStatusCode());
+    }
+
+    public function testConstructorAllowsPassingStatus()
+    {
+        $body = 'More valid XML';
+        $status = 404;
+
+        $response = new XmlResponse($body, $status);
+        $this->assertSame(404, $response->getStatusCode());
+        $this->assertSame($body, (string) $response->getBody());
+    }
+
+    public function testConstructorAllowsPassingHeaders()
+    {
+        $body = '<nearly>Valid XML</nearly>';
+        $status = 404;
+        $headers = [
+            'x-custom' => [ 'foo-bar' ],
+        ];
+
+        $response = new XmlResponse($body, $status, $headers);
+        $this->assertSame(['foo-bar'], $response->getHeader('x-custom'));
+        $this->assertSame('application/xml; charset=utf-8', $response->getHeaderLine('content-type'));
+        $this->assertSame(404, $response->getStatusCode());
+        $this->assertSame($body, (string) $response->getBody());
+    }
+
+    public function testAllowsStreamsForResponseBody()
+    {
+        $stream = $this->prophesize(StreamInterface::class);
+        $body   = $stream->reveal();
+        $response = new XmlResponse($body);
+        $this->assertSame($body, $response->getBody());
+    }
+
+    public function invalidContent()
+    {
+        return [
+            'null'       => [null],
+            'true'       => [true],
+            'false'      => [false],
+            'zero'       => [0],
+            'int'        => [1],
+            'zero-float' => [0.0],
+            'float'      => [1.1],
+            'array'      => [['php://temp']],
+            'object'     => [(object) ['php://temp']],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidContent
+     */
+    public function testRaisesExceptionforNonStringNonStreamBodyContent($body)
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        new XmlResponse($body);
+    }
+
+    /**
+     * @group 115
+     */
+    public function testConstructorRewindsBodyStream()
+    {
+        $body = '<?xml version="1.0"?>' . PHP_EOL . '<something>Valid XML</something>';
+        $response = new XmlResponse($body);
+
+        $actual = $response->getBody()->getContents();
+        $this->assertSame($body, $actual);
+    }
+}