Return the response instead of its body for a streamed resource

Author: LaurentPetard

spec/Api/ProductMediaFileApiSpec.php

@@ -279,11 +279,13 @@ function it_throws_an_exception_if_the_uri_of_the_created_media_file_is_invalid(
             ->during('create', [$fileResource, $product]);
     }
 
-    function it_downloads_a_media_file($resourceClient, StreamInterface $streamBody)
+    function it_downloads_a_media_file($resourceClient, ResponseInterface $response, StreamInterface $streamBody)
     {
         $resourceClient
             ->getStreamedResource(ProductMediaFileApi::MEDIA_FILE_DOWNLOAD_URI, ['42.jpg'])
-            ->willReturn($streamBody);
+            ->willReturn($response);
+
+        $response->getBody()->willReturn($streamBody);
 
         $this->download('42.jpg')->shouldReturn($streamBody);
     }

spec/Client/ResourceClientSpec.php

@@ -469,8 +469,7 @@ function it_deletes_a_resource(
     function it_gets_a_streamed_resource(
         $httpClient,
         $uriGenerator,
-        ResponseInterface $response,
-        StreamInterface $responseBody
+        ResponseInterface $response
     ) {
         $uri = 'http://akeneo.com/api/rest/v1/media-files/42.jpg/download';
 
@@ -480,9 +479,7 @@ function it_gets_a_streamed_resource(
 
         $httpClient->sendRequest('GET', $uri, ['Accept' => '*/*'])->willReturn($response);
 
-        $response->getBody()->willReturn($responseBody);
-
-        $this->getStreamedResource('api/rest/v1/media-files/%s/download', ['42.jpg'])->shouldReturn($responseBody);
+        $this->getStreamedResource('api/rest/v1/media-files/%s/download', ['42.jpg'])->shouldReturn($response);
     }
 
     protected function getSampleOfResources()

src/Api/ProductMediaFileApi.php

@@ -113,7 +113,7 @@ public function create($mediaFile, array $data)
      */
     public function download($code)
     {
-        return $this->resourceClient->getStreamedResource(static::MEDIA_FILE_DOWNLOAD_URI, [$code]);
+        return $this->resourceClient->getStreamedResource(static::MEDIA_FILE_DOWNLOAD_URI, [$code])->getBody();
     }
 
     /**

src/Client/ResourceClient.php

@@ -226,6 +226,6 @@ public function getStreamedResource($uri, array $uriParameters = [])
         $uri = $this->uriGenerator->generate($uri, $uriParameters);
         $response = $this->httpClient->sendRequest('GET', $uri, ['Accept' => '*/*']);
 
-        return $response->getBody();
+        return $response;
     }
 }

src/Client/ResourceClientInterface.php

@@ -140,7 +140,7 @@ public function deleteResource($uri, array $uriParameters = []);
      *
      * @throws HttpException If the request failed
      *
-     * @return StreamInterface
+     * @return ResponseInterface The response of the streamed resource request
      */
     public function getStreamedResource($uri, array $uriParameters = []);
 }