Merge pull request #200 from jorenvh/product-media-file-extract-code-from-response

Product media file api: bugfix: make header location check case insensitive

Author: mmetayer

spec/Api/ProductMediaFileApiSpec.php

@@ -129,9 +129,11 @@ function it_creates_a_media_file_from_a_path($resourceClient, $fileSystem, Respo
             ]
         ];
 
-        $response->getHeaders()->willReturn(['Location' => [
+        $response->hasHeader('location')->willReturn(true);
+
+        $response->getHeader('location')->willReturn([
             'http://localhost/api/rest/v1/media-files/1/e/e/d/1eed10f108bde68b279d6f903f17b4b053e9d89d_akeneo.png'
-        ]]);
+        ]);
 
         $resourceClient
             ->createMultipartResource(ProductMediaFileApi::MEDIA_FILES_URI, [], $requestParts)
@@ -164,9 +166,10 @@ function it_creates_a_media_file_from_a_resource($resourceClient, $fileSystem, R
             ]
         ];
 
-        $response->getHeaders()->willReturn(['Location' => [
+        $response->hasHeader('location')->willReturn(true);
+        $response->getHeader('location')->willReturn([
             'http://localhost/api/rest/v1/media-files/1/e/e/d/1eed10f108bde68b279d6f903f17b4b053e9d89d_akeneo.png'
-        ]]);
+        ]);
 
         $resourceClient
             ->createMultipartResource(ProductMediaFileApi::MEDIA_FILES_URI, [], $requestParts)
@@ -202,9 +205,10 @@ function it_creates_a_media_file_for_a_product_model($resourceClient, $fileSyste
             ]
         ];
 
-        $response->getHeaders()->willReturn(['Location' => [
+        $response->hasHeader('location')->willReturn(true);
+        $response->getHeader('location')->willReturn([
             'http://localhost/api/rest/v1/media-files/1/e/e/d/1eed10f108bde68b279d6f903f17b4b053e9d89d_akeneo.png'
-        ]]);
+        ]);
 
         $resourceClient
             ->createMultipartResource(ProductMediaFileApi::MEDIA_FILES_URI, [], $requestParts)
@@ -236,7 +240,7 @@ function it_throws_an_exception_if_the_response_does_not_contain_the_uri_of_the_
             ]
         ];
 
-        $response->getHeaders()->willReturn(['Location' => '']);
+        $response->hasHeader('location')->willReturn(false);
 
         $resourceClient
             ->createMultipartResource(ProductMediaFileApi::MEDIA_FILES_URI, [], $requestParts)
@@ -268,7 +272,8 @@ function it_throws_an_exception_if_the_uri_of_the_created_media_file_is_invalid(
             ]
         ];
 
-        $response->getHeaders()->willReturn(['Location' => ['http://localhost/api/rest/v1/products/foo']]);
+        $response->hasHeader('location')->willReturn(true);
+        $response->getHeader('location')->willReturn(['http://localhost/api/rest/v1/products/foo']);
 
         $resourceClient
             ->createMultipartResource(ProductMediaFileApi::MEDIA_FILES_URI, [], $requestParts)

src/Api/ProductMediaFileApi.php

@@ -130,14 +130,13 @@ public function download(string $code): ResponseInterface
      */
     protected function extractCodeFromCreationResponse(ResponseInterface $response)
     {
-        $headers = $response->getHeaders();
-
-        if (!isset($headers['Location'][0])) {
+        if (!$response->hasHeader('location')) {
             throw new RuntimeException('The response does not contain the URI of the created media-file.');
         }
+        $locationHeader = $response->getHeader('location')[0];
 
         $matches = [];
-        if (1 !== preg_match(static::MEDIA_FILE_URI_CODE_REGEX, $headers['Location'][0], $matches)) {
+        if (1 !== preg_match(static::MEDIA_FILE_URI_CODE_REGEX, $locationHeader, $matches)) {
             throw new RuntimeException('Unable to find the code in the URI of the created media-file.');
         }
 

tests/Api/CreateProductMediaFileTest.php

@@ -41,4 +41,29 @@ public function test_create_media_file()
 
         Assert::assertSame('f/b/0/6/fb068ccc9e3c5609d73c28d852812ba5faeeab28_akeneo.png', $response);
     }
+
+    public function test_get_created_media_file_location_regardless_of_the_header_case()
+    {
+        $mediaFileURI = $this->server->getServerRoot(
+            ) . '/' . ProductMediaFileApi::MEDIA_FILES_URI . '/f/b/0/6/fb068ccc9e3c5609d73c28d852812ba5faeeab28_akeneo.png';
+        $this->server->setResponseOfPath(
+            '/' . ProductMediaFileApi::MEDIA_FILES_URI,
+            new ResponseStack(
+                new Response('', ['LOcaTiON' => $mediaFileURI], 201)
+            )
+        );
+
+        $api = $this->createClient()->getProductMediaFileApi();
+        $mediaFile = realpath(__DIR__ . '/../fixtures/akeneo.png');
+
+        $productInfos = [
+            'identifier' => 'medium_boot',
+            'attribute' => 'side_view',
+            'scope' => null,
+            'locale' => null,
+        ];
+
+        $response = $api->create($mediaFile, $productInfos);
+        Assert::assertSame('f/b/0/6/fb068ccc9e3c5609d73c28d852812ba5faeeab28_akeneo.png', $response);
+    }
 }