Test that a DownloadResponse can be created from a valid CSV string

Author: settermjd

src/Response/DownloadResponse.php

@@ -10,7 +10,9 @@
 namespace Zend\Diactoros\Response;
 
 use Zend\Diactoros\Exception\InvalidArgumentException;
+use Zend\Diactoros\Response;
 
+use Zend\Diactoros\Stream;
 use function array_keys;
 use function array_merge;
 use function implode;
@@ -37,6 +39,44 @@ class DownloadResponse extends Response
         'pragma'
     ];
 
+    /**
+     * DownloadResponse constructor.
+     * @param $body
+     * @param int $status
+     * @param string $filename
+     * @param array $headers
+     */
+    public function __construct($body, int $status = 200, string $filename = '', array $headers = [])
+    {
+        $content = new Stream('php://temp', 'wb+');
+        $content->write($body);
+        $content->rewind();
+
+        $headers = $this->prepareDownloadHeaders($filename, $headers);
+
+        parent::__construct($content, $status, $headers);
+    }
+
+    /**
+     * Get download headers
+     *
+     * @param string $filename
+     * @return array
+     */
+    private function getDownloadHeaders(string $filename): array
+    {
+        $headers = [];
+        $headers['cache-control'] = ['must-revalidate'];
+        $headers['content-description'] = ['File Transfer'];
+        $headers['content-disposition'] = [sprintf('attachment; filename=%s', $filename)];
+        $headers['content-transfer-encoding'] = ['Binary'];
+        $headers['content-type'] = ['text/csv; charset=utf-8'];
+        $headers['expires'] = ['0'];
+        $headers['pragma'] = ['Public'];
+
+        return $headers;
+    }
+
     /**
      * Check if the extra headers contain any of the download headers
      *

test/Response/DownloadResponseTest.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace ZendTest\Diactoros\Response;
+
+use org\bovigo\vfs\vfsStream;
+use PHPUnit\Framework\TestCase;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\Response\DownloadResponse;
+
+class DownloadResponseTest extends TestCase
+{
+    /**
+     * @var \org\bovigo\vfs\vfsStreamDirectory
+     */
+    private $root;
+
+    public function setUp()
+    {
+        $validCSVString = <<<EOF
+name,address,email,street,city,state,country
+Victoria Freeman,1770 Urfe Pass,[email protected],Ipziw Grove,Uzfujnic,SD,KN
+Kathryn Reynolds,861 Nircu Mill,[email protected],Kaid Court,Botpupe,CA,WS
+Dora Schmidt,703 Laufo Heights,[email protected],Sowdu Key,Pojzudiz,FL,TN
+Delia Harrison,1409 Abeeli Loop,[email protected],Dulgi Heights,Eswooke,MN,DZ
+Jordan Lane,1409 Zihoce Plaza,[email protected],Acfuh View,Dulwawa,NY,NF
+Danny Holmes,502 Fubjib Parkway,[email protected],Apsa Loop,Etaweza,CO,MQ
+Clarence Brewer,1085 Jacpa View,[email protected],Baroh Highway,Tikawi,WA,LS
+Elmer Cohen,1556 Netjol Heights,[email protected],Dacbap Trail,Kihiguk,UT,WS
+EOF;
+
+        $directoryStructure = [
+            'files' => [
+                'empty.csv' => "",
+                'valid.csv' => $validCSVString,
+                'non-readable-file.csv' => vfsStream::newFile('non-readable-file.csv', 0000)
+            ]
+        ];
+        $this->root = vfsStream::setup('root', null, $directoryStructure);
+    }
+
+    public function testCanCreateResponseFromString()
+    {
+        $csvString = file_get_contents($this->root->url() . '/files/valid.csv');
+        $response = new DownloadResponse($csvString);
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertEquals($csvString, (string) $response->getBody()->getContents());
+        $this->assertArrayHasKey('cache-control', $response->getHeaders());
+    }
+}