Add resource client method to upsert resources using a JSON string

Author: LaurentPetard

spec/Client/ResourceClientSpec.php

@@ -197,7 +197,7 @@ function it_upserts_a_resource(
             ->shouldReturn(201);
     }
 
-    function it_upserts_a_list_of_resources_from_an_array(
+    function it_upserts_a_list_of_streamed_resources_from_an_array(
         $httpClient,
         $uriGenerator,
         $responseFactory,
@@ -244,7 +244,7 @@ function it_upserts_a_list_of_resources_from_an_array(
             ->shouldReturn($listResponse);
     }
 
-    function it_upserts_a_list_of_resources_from_an_stream(
+    function it_upserts_a_list_of_streamed_resources_from_an_stream(
         $httpClient,
         $uriGenerator,
         $responseFactory,
@@ -275,6 +275,71 @@ function it_upserts_a_list_of_resources_from_an_stream(
             ->shouldReturn($listResponse);
     }
 
+    function it_upserts_a_list_of_json_resources(
+        HttpClient $httpClient,
+        UriGeneratorInterface $uriGenerator,
+        ResponseInterface $response,
+        StreamInterface $responseBody
+    ) {
+        $uri = 'http://akeneo.com/api/rest/v1/reference-entities/designer/records';
+
+        $uriGenerator
+            ->generate('api/rest/v1/reference-entities/%s/records', ['designer'])
+            ->willReturn($uri);
+
+        $body = <<<JSON
+[{"code":"designer_1"},{"code":"designer_2"},{"code":"designer_3"}]
+JSON;
+
+        $httpClient
+            ->sendRequest('PATCH', $uri, ['Content-Type' => 'application/json'], $body)
+            ->willReturn($response);
+
+        $response
+            ->getBody()
+            ->willReturn($responseBody);
+
+        $upsertResponse = <<<JSON
+        [
+          {
+            "code": "designer_1",
+            "status_code": 204
+          },
+          {
+            "code": "designer_2",
+            "status_code": 204
+          },
+          {
+            "code": "designer_3",
+            "status_code": 201
+          }
+        ]
+JSON;
+
+        $responseBody
+            ->getContents()
+            ->willReturn($upsertResponse);
+
+        $this->upsertJsonResourceList('api/rest/v1/reference-entities/%s/records', ['designer'], [
+            ['code' => 'designer_1'],
+            ['code' => 'designer_2'],
+            ['code' => 'designer_3'],
+        ])->shouldReturn([
+            [
+                'code' => 'designer_1',
+                'status_code' =>204
+            ],
+            [
+                'code' => 'designer_2',
+                'status_code' =>204
+            ],
+            [
+                'code' => 'designer_3',
+                'status_code' =>201
+            ]
+        ]);
+    }
+
     function it_throws_an_exception_if_limit_is_defined_in_additional_parameters_to_get_resources()
     {
         $this

src/Client/ResourceClient.php

@@ -1,8 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Akeneo\Pim\ApiClient\Client;
 
 use Akeneo\Pim\ApiClient\Exception\InvalidArgumentException;
+use Akeneo\Pim\ApiClient\Exception\RuntimeException;
 use Akeneo\Pim\ApiClient\Routing\UriGeneratorInterface;
 use Akeneo\Pim\ApiClient\Stream\MultipartStreamBuilderFactory;
 use Akeneo\Pim\ApiClient\Stream\UpsertResourceListResponseFactory;
@@ -182,6 +185,27 @@ public function upsertStreamResourceList($uri, array $uriParameters = [], $resou
         return $this->upsertListResponseFactory->create($response->getBody());
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function upsertJsonResourceList(string $uri, array $uriParameters = [], array $resources = []): array
+    {
+        $uri = $this->uriGenerator->generate($uri, $uriParameters);
+        $response = $this->httpClient->sendRequest(
+            'PATCH',
+            $uri,
+            ['Content-Type' => 'application/json'],
+            json_encode($resources)
+        );
+
+        $response = json_decode($response->getBody()->getContents(), true);
+        if (!is_array($response)) {
+            throw new RuntimeException('The server response is not a valid JSON');
+        }
+
+        return $response;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Client/ResourceClientInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Akeneo\Pim\ApiClient\Client;
 
 use Akeneo\Pim\ApiClient\Exception\HttpException;
@@ -90,7 +92,7 @@ public function createMultipartResource($uri, array $uriParameters = [], array $
     public function upsertResource($uri, array $uriParameters = [], array $body = []);
 
     /**
-     * Updates or creates several resources using a stream.
+     * Updates or creates several resources using a stream for the request and the response.
      *
      * @param string                $uri           URI of the resource
      * @param array                 $uriParameters URI parameters of the resource
@@ -104,6 +106,20 @@ public function upsertResource($uri, array $uriParameters = [], array $body = []
      */
     public function upsertStreamResourceList($uri, array $uriParameters = [], $resources = []);
 
+    /**
+     * Updates or creates several resources using a single JSON string for the request and the response.
+     *
+     * @param string $uri           URI of the resource
+     * @param array  $uriParameters URI parameters of the resource
+     * @param array  $resources     array of resources to create or update.
+     *
+     * @throws HttpException            If the request failed.
+     * @throws InvalidArgumentException If the resources or any part thereof are invalid.
+     *
+     * @return array
+     */
+    public function upsertJsonResourceList(string $uri, array $uriParameters = [], array $resources = []): array;
+
     /**
      * Deletes a resource.
      *