Merge branch 'master' into correct-getNextPage-method-description

tomglvng · web-flow · commit 2e0ba29fe02b · 2022-01-19T11:48:16.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,86 @@
+version: 2.1
+
+jobs:
+    build:
+        docker:
+            -   image: akeneo/php:7.2
+        steps:
+            -   checkout
+            -   run: composer install
+            -   persist_to_workspace:
+                    root: ~/
+                    paths:
+                        - project
+
+    test_php:
+        docker:
+            -   image: akeneo/php:7.2
+        steps:
+            -   attach_workspace:
+                    at: ~/
+            -   run: bin/phpunit -c phpunit.xml.dist
+            -   run: bin/phpspec run
+
+    test_php_code_style:
+        docker:
+            -   image: akeneo/php:7.2
+        steps:
+            -   attach_workspace:
+                    at: ~/
+            -   run: bin/php-cs-fixer fix --diff --dry-run --config=.php_cs.php -vvv
+
+    workflow_success:
+        docker:
+            -   image: akeneo/php:7.2
+        steps:
+            - run:
+                  name: Success
+                  command: echo "The build has run with success! Let's merge :)"
+
+workflows:
+    pull_request:
+        jobs:
+            -   wait_for_user_approval:
+                    type: approval
+                    filters:
+                        branches:
+                            ignore:
+                                - master
+            -   build:
+                    requires:
+                        - wait_for_user_approval
+            -   test_php:
+                    requires:
+                        - build
+            -   test_php_code_style:
+                    requires:
+                        - build
+            -   workflow_success:
+                    requires:
+                        - test_php
+                        - test_php_code_style
+
+    after_merge:
+        jobs:
+            -   build:
+                    filters:
+                        branches:
+                            only:
+                                - master
+            -   test_php:
+                    requires:
+                        - build
+            -   test_php_code_style:
+                    requires:
+                        - build
+
+    nightly:
+        when:
+            and:
+                -   equal: [ scheduled_pipeline, << pipeline.trigger_source >> ]
+                -   equal: [ "nightly_master", << pipeline.schedule.name >> ]
+        jobs:
+            -   build
+            -   test_php:
+                    requires:
+                        -   build
diff --git a/.travis.yml b/.travis.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing
+
+Want to do your bit for our PHP client? All contributions are warmly welcomed!
+
+## Contribution process
+
+First and foremost, please accept and sign our [Contributor License Agreement](https://www.akeneo.com/contributor-license-agreement/).
+
+And then, do your magic :
+* Fork our repository
+* Create a branch (choose a descriptive name)
+* Work on your own code (don't forget to add necessessaries tests)
+* Commit your branch and submit a pull request to our projet
+
+At this moment, the ball is in our court: we will check your PR and add comments or suggestions if needed.
+
+When everything is ok, we merge your work.
+
+Congratulations, you are officially a contributor to our dear PHP client!
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Matrix compatibility:
 | v2.1 - v2.2     | v2.0                    |  March 2019    | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=2.0)](https://travis-ci.org/akeneo/api-php-client)   |
 | v2.3            | v3.0                    |  December 2019 | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=3.0)](https://travis-ci.org/akeneo/api-php-client)   |
 | v3.0            | v4.0                    |  August 2020   | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=4.0)](https://travis-ci.org/akeneo/api-php-client)   |
-| -               | master                  |  -             | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=master)](https://travis-ci.org/akeneo/api-php-client)|
+| -               | master                  |  -             | [![CircleCI](https://circleci.com/gh/akeneo/api-php-client/tree/master.svg?style=svg)](https://circleci.com/gh/akeneo/api-php-client/tree/master)|
 
 Note that our PHP client is backward compatible.
 For example, if your PIM is currently a v2.3, you can still use a 1.0 version of the PHP client. The new endpoints available in v2.3 will not be available in the v1.0 of the PHP client.
@@ -161,3 +161,9 @@ The support of this client is made in best effort by our Akeneo team.
 
 If you find a bug or want to submit an improvement, don't hesitate to raise an issue on Github.
 Also, you can ask questions and discuss about the PHP client with the community in the [Slack User Group](https://akeneopim-ug.slack.com/messages/web-api/).
+
+## Contributing
+
+As this PHP client is an open-source project, all contributions are very welcome!
+
+For more information, please consult [the contributing section](CONTRIBUTING.md)
diff --git a/spec/Api/ProductMediaFileApiSpec.php b/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)
diff --git a/src/Api/ProductMediaFileApi.php b/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.');
         }
 
diff --git a/src/Api/ProductModelApi.php b/src/Api/ProductModelApi.php
@@ -122,4 +122,12 @@ public function upsertList($productModels): \Traversable
     {
         return $this->resourceClient->upsertStreamResourceList(static::PRODUCT_MODELS_URI, [], $productModels);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete(string $code): int
+    {
+        return $this->resourceClient->deleteResource(static::PRODUCT_MODEL_URI, [$code]);
+    }
 }
diff --git a/src/Api/ProductModelApiInterface.php b/src/Api/ProductModelApiInterface.php
@@ -3,6 +3,7 @@
 namespace Akeneo\Pim\ApiClient\Api;
 
 use Akeneo\Pim\ApiClient\Api\Operation\CreatableResourceInterface;
+use Akeneo\Pim\ApiClient\Api\Operation\DeletableResourceInterface;
 use Akeneo\Pim\ApiClient\Api\Operation\GettableResourceInterface;
 use Akeneo\Pim\ApiClient\Api\Operation\ListableResourceInterface;
 use Akeneo\Pim\ApiClient\Api\Operation\UpsertableResourceInterface;
@@ -20,6 +21,7 @@ interface ProductModelApiInterface extends
     CreatableResourceInterface,
     UpsertableResourceInterface,
     UpsertableResourceListInterface,
-    ListableResourceInterface
+    ListableResourceInterface,
+    DeletableResourceInterface
 {
 }
diff --git a/tests/Api/CreateProductMediaFileTest.php b/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);
+    }
 }
diff --git a/tests/Api/DeleteProductModelTest.php b/tests/Api/DeleteProductModelTest.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\tests\Api;
+
+use Akeneo\Pim\ApiClient\Api\ProductModelApi;
+use donatj\MockWebServer\RequestInfo;
+use donatj\MockWebServer\Response;
+use donatj\MockWebServer\ResponseStack;
+use PHPUnit\Framework\Assert;
+
+class DeleteProductModelTest extends ApiTestCase
+{
+    public function test_delete_product_model()
+    {
+        $this->server->setResponseOfPath(
+            '/'. sprintf(ProductModelApi::PRODUCT_MODEL_URI, 'docks_white'),
+            new ResponseStack(
+                new Response('', [], 204)
+            )
+        );
+
+        $api = $this->createClient()->getProductModelApi();
+
+        $response = $api->delete('docks_white');
+
+        Assert::assertSame($this->server->getLastRequest()->jsonSerialize()[RequestInfo::JSON_KEY_METHOD], 'DELETE');
+        Assert::assertSame(204, $response);
+    }
+}
diff --git a/travis.php.ini b/travis.php.ini

Original file line number	Diff line number	Diff line change
`@@ -130,14 +130,13 @@ public function download(string $code): ResponseInterface`
`130`	`130`	`*/`
`131`	`131`	`protected function extractCodeFromCreationResponse(ResponseInterface $response)`
`132`	`132`	`{`
`133`		`- $headers = $response->getHeaders();`
`134`		`-`
`135`		`- if (!isset($headers['Location'][0])) {`
	`133`	`+ if (!$response->hasHeader('location')) {`
`136`	`134`	`throw new RuntimeException('The response does not contain the URI of the created media-file.');`
`137`	`135`	`}`
	`136`	`+ $locationHeader = $response->getHeader('location')[0];`
`138`	`137`
`139`	`138`	`$matches = [];`
`140`		`- if (1 !== preg_match(static::MEDIA_FILE_URI_CODE_REGEX, $headers['Location'][0], $matches)) {`
	`139`	`+ if (1 !== preg_match(static::MEDIA_FILE_URI_CODE_REGEX, $locationHeader, $matches)) {`
`141`	`140`	`throw new RuntimeException('Unable to find the code in the URI of the created media-file.');`
`142`	`141`	`}`
`143`	`142`
Original file line number	Diff line number	Diff line change
`@@ -122,4 +122,12 @@ public function upsertList($productModels): \Traversable`
`122`	`122`	`{`
`123`	`123`	`return $this->resourceClient->upsertStreamResourceList(static::PRODUCT_MODELS_URI, [], $productModels);`
`124`	`124`	`}`
	`125`	`+`
	`126`	`+ /**`
	`127`	`+ * {@inheritdoc}`
	`128`	`+ */`
	`129`	`+ public function delete(string $code): int`
	`130`	`+ {`
	`131`	`+ return $this->resourceClient->deleteResource(static::PRODUCT_MODEL_URI, [$code]);`
	`132`	`+ }`
`125`	`133`	`}`