MET-23: Add measurement family endpoints

Author: SamirBoulil

src/AkeneoPimClient.php

@@ -13,6 +13,7 @@
 use Akeneo\Pim\ApiClient\Api\FamilyVariantApiInterface;
 use Akeneo\Pim\ApiClient\Api\LocaleApiInterface;
 use Akeneo\Pim\ApiClient\Api\MeasureFamilyApiInterface;
+use Akeneo\Pim\ApiClient\Api\MeasurementFamilyApiInterface;
 use Akeneo\Pim\ApiClient\Api\MediaFileApiInterface;
 use Akeneo\Pim\ApiClient\Api\ProductApiInterface;
 use Akeneo\Pim\ApiClient\Api\ProductModelApiInterface;
@@ -72,6 +73,9 @@ class AkeneoPimClient implements AkeneoPimClientInterface
     /** @var ProductModelApiInterface */
     protected $productModelApi;
 
+    /** @var MeasurementFamilyApiInterface */
+    private $measurementFamilyApi;
+
     public function __construct(
         Authentication $authentication,
         ProductApiInterface $productApi,
@@ -85,6 +89,7 @@ public function __construct(
         ChannelApiInterface $channelApi,
         CurrencyApiInterface $currencyApi,
         MeasureFamilyApiInterface $measureFamilyApi,
+        MeasurementFamilyApiInterface $measurementFamilyApi,
         AssociationTypeApiInterface $associationTypeApi,
         FamilyVariantApiInterface $familyVariantApi,
         ProductModelApiInterface $productModelApi
@@ -101,6 +106,7 @@ public function __construct(
         $this->channelApi = $channelApi;
         $this->currencyApi = $currencyApi;
         $this->measureFamilyApi = $measureFamilyApi;
+        $this->measurementFamilyApi = $measurementFamilyApi;
         $this->associationTypeApi = $associationTypeApi;
         $this->familyVariantApi = $familyVariantApi;
         $this->productModelApi = $productModelApi;
@@ -210,6 +216,14 @@ public function getMeasureFamilyApi(): MeasureFamilyApiInterface
         return $this->measureFamilyApi;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getMeasurementFamilyApi(): MeasurementFamilyApiInterface
+    {
+        return $this->measurementFamilyApi;
+    }
+
     /**
      * {@inheritdoc}
      */

src/AkeneoPimClientBuilder.php

@@ -14,6 +14,7 @@
 use Akeneo\Pim\ApiClient\Api\FamilyVariantApi;
 use Akeneo\Pim\ApiClient\Api\LocaleApi;
 use Akeneo\Pim\ApiClient\Api\MeasureFamilyApi;
+use Akeneo\Pim\ApiClient\Api\MeasurementFamilyApi;
 use Akeneo\Pim\ApiClient\Api\ProductApi;
 use Akeneo\Pim\ApiClient\Api\ProductMediaFileApi;
 use Akeneo\Pim\ApiClient\Api\ProductModelApi;
@@ -152,7 +153,7 @@ public function buildAuthenticatedByToken(string $clientId, string $secret, stri
      */
     protected function buildAuthenticatedClient(Authentication $authentication): AkeneoPimClientInterface
     {
-        list($resourceClient, $pageFactory, $cursorFactory, $fileSystem) = $this->setUp($authentication);
+        [$resourceClient, $pageFactory, $cursorFactory, $fileSystem] = $this->setUp($authentication);
 
         $client = new AkeneoPimClient(
             $authentication,
@@ -167,6 +168,7 @@ protected function buildAuthenticatedClient(Authentication $authentication): Ake
             new ChannelApi($resourceClient, $pageFactory, $cursorFactory),
             new CurrencyApi($resourceClient, $pageFactory, $cursorFactory),
             new MeasureFamilyApi($resourceClient, $pageFactory, $cursorFactory),
+            new MeasurementFamilyApi($resourceClient),
             new AssociationTypeApi($resourceClient, $pageFactory, $cursorFactory),
             new FamilyVariantApi($resourceClient, $pageFactory, $cursorFactory),
             new ProductModelApi($resourceClient, $pageFactory, $cursorFactory)

src/AkeneoPimClientInterface.php

@@ -13,6 +13,7 @@
 use Akeneo\Pim\ApiClient\Api\FamilyVariantApiInterface;
 use Akeneo\Pim\ApiClient\Api\LocaleApiInterface;
 use Akeneo\Pim\ApiClient\Api\MeasureFamilyApiInterface;
+use Akeneo\Pim\ApiClient\Api\MeasurementFamilyApiInterface;
 use Akeneo\Pim\ApiClient\Api\MediaFileApiInterface;
 use Akeneo\Pim\ApiClient\Api\ProductApiInterface;
 use Akeneo\Pim\ApiClient\Api\ProductModelApiInterface;
@@ -52,6 +53,8 @@ public function getCurrencyApi(): CurrencyApiInterface;
 
     public function getMeasureFamilyApi(): MeasureFamilyApiInterface;
 
+    public function getMeasurementFamilyApi(): MeasurementFamilyApiInterface;
+
     public function getAssociationTypeApi(): AssociationTypeApiInterface;
 
     public function getFamilyVariantApi(): FamilyVariantApiInterface;

src/Api/MeasurementFamilyApi.php

@@ -3,10 +3,6 @@
 namespace Akeneo\Pim\ApiClient\Api;
 
 use Akeneo\Pim\ApiClient\Client\ResourceClientInterface;
-use Akeneo\Pim\ApiClient\Pagination\PageFactoryInterface;
-use Akeneo\Pim\ApiClient\Pagination\PageInterface;
-use Akeneo\Pim\ApiClient\Pagination\ResourceCursorFactoryInterface;
-use Akeneo\Pim\ApiClient\Pagination\ResourceCursorInterface;
 
 /**
  * API implementation to manage measuremeent families.
@@ -22,45 +18,20 @@ class MeasurementFamilyApi implements MeasurementFamilyApiInterface
     /** @var ResourceClientInterface */
     protected $resourceClient;
 
-    /** @var PageFactoryInterface */
-    protected $pageFactory;
-
-    /** @var ResourceCursorFactoryInterface */
-    protected $cursorFactory;
-
     /**
-     * @param ResourceClientInterface        $resourceClient
-     * @param PageFactoryInterface           $pageFactory
-     * @param ResourceCursorFactoryInterface $cursorFactory
+     * @param ResourceClientInterface $resourceClient
      */
-    public function __construct(
-        ResourceClientInterface $resourceClient,
-        PageFactoryInterface $pageFactory,
-        ResourceCursorFactoryInterface $cursorFactory
-    ) {
-        $this->resourceClient = $resourceClient;
-        $this->pageFactory = $pageFactory;
-        $this->cursorFactory = $cursorFactory;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function listPerPage(int $limit = 100, bool $withCount = false, array $queryParameters = []): PageInterface
+    public function __construct(ResourceClientInterface $resourceClient)
     {
-        $data = $this->resourceClient->getResources(static::MEASUREMENT_FAMILIES_URI, [], $limit, $withCount, $queryParameters);
-
-        return $this->pageFactory->createPage($data);
+        $this->resourceClient = $resourceClient;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function all(int $pageSize = 100, array $queryParameters = []): ResourceCursorInterface
+    public function all(): array
     {
-        $firstPage = $this->listPerPage($pageSize, false, $queryParameters);
-
-        return $this->cursorFactory->createCursor($pageSize, $firstPage);
+        return $this->resourceClient->getResource(static::MEASUREMENT_FAMILIES_URI);
     }
 
     /**

src/Api/MeasurementFamilyApiInterface.php

@@ -2,8 +2,7 @@
 
 namespace Akeneo\Pim\ApiClient\Api;
 
-use Akeneo\Pim\ApiClient\Api\Operation\ListableResourceInterface;
-use Akeneo\Pim\ApiClient\Api\Operation\UpsertableResourceListInterface;
+use Akeneo\Pim\ApiClient\Exception\HttpException;
 
 /**
  * API to manage the measurement families.
@@ -12,16 +11,25 @@
  * @copyright 2020 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  */
-interface MeasurementFamilyApiInterface extends ListableResourceInterface
+interface MeasurementFamilyApiInterface
 {
+    /**
+     * Gets a cursor to iterate over all the measurement families
+     *
+     * @throws HttpException If the request failed.
+     *
+     * @return array
+     */
+    public function all(): array;
+
     /**
      * Updates or creates several resources.
      *
-     * @param array|StreamInterface $resources array or StreamInterface object containing the resources to create or update
+     * @param array $resources array object containing the measurement families to create or update
      *
      * @throws HttpException
      *
-     * @return array returns an array, each entry corresponding to the response of the upserted resource
+     * @return array returns an array, each entry corresponding to the response of the upserted measurement families
      */
     public function upsertList($resources): array;
 }