[API] Pick up cart implementation

Sylius · May 28, 2020 · eaa0179 · eaa0179
1 parent cf116f2
commit eaa0179
Show file tree

Hide file tree

Showing 20 changed files with 352 additions and 19 deletions.
diff --git a/features/cart/shopping_cart/viewing_cart_summary.feature b/features/cart/shopping_cart/viewing_cart_summary.feature
@@ -7,7 +7,7 @@ Feature: Viewing a cart summary
     Background:
         Given the store operates on a single channel in "United States"
 
-    @ui
+    @ui @api
     Scenario: Viewing information about empty cart
         When I see the summary of my cart
         Then my cart should be empty
diff --git a/src/Sylius/Behat/Client/ApiClientInterface.php b/src/Sylius/Behat/Client/ApiClientInterface.php
@@ -26,7 +26,7 @@ public function subResourceIndex(string $subResource, string $id): Response;
 
     public function show(string $id): Response;
 
-    public function create(): Response;
+    public function create(?RequestInterface $request = null): Response;
 
     public function update(): Response;
 

diff --git a/src/Sylius/Behat/Client/ApiPlatformClient.php b/src/Sylius/Behat/Client/ApiPlatformClient.php
@@ -61,9 +61,9 @@ public function show(string $id): Response
         return $this->request(Request::show($this->resource, $id, $this->sharedStorage->get('token')));
     }
 
-    public function create(): Response
+    public function create(?RequestInterface $request = null): Response
     {
-        return $this->request($this->request);
+        return $this->request($request ?? $this->request);
     }
 
     public function update(): Response
@@ -118,7 +118,8 @@ public function upload(): Response
 
     public function buildCreateRequest(): void
     {
-        $this->request = Request::create($this->resource, $this->sharedStorage->get('token'));
+        $this->request = Request::create($this->resource);
+        $this->request->authorize($this->sharedStorage->get('token'));
     }
 
     public function buildUpdateRequest(string $id): void

diff --git a/src/Sylius/Behat/Client/Request.php b/src/Sylius/Behat/Client/Request.php
@@ -67,12 +67,12 @@ public static function show(string $resource, string $id, string $token): Reques
         );
     }
 
-    public static function create(string $resource, string $token): RequestInterface
+    public static function create(string $resource): RequestInterface
     {
         return new self(
             sprintf('/new-api/%s', $resource),
             HttpRequest::METHOD_POST,
-            ['CONTENT_TYPE' => 'application/json', 'HTTP_Authorization' => 'Bearer ' . $token]
+            ['CONTENT_TYPE' => 'application/ld+json']
         );
     }
 
@@ -190,6 +190,11 @@ public function removeSubResource(string $subResource, string $id): void
         }
     }
 
+    public function authorize(string $token): void
+    {
+        $this->headers['HTTP_Authorization'] = 'Bearer ' . $token;
+    }
+
     private function mergeArraysUniquely(array $firstArray, array $secondArray): array
     {
         foreach ($secondArray as $key => $value) {

diff --git a/src/Sylius/Behat/Client/RequestInterface.php b/src/Sylius/Behat/Client/RequestInterface.php
@@ -21,7 +21,7 @@ public static function subResourceIndex(string $resource, string $id, string $su
 
     public static function show(string $resource, string $id, string $token): self;
 
-    public static function create(string $resource, string $token): self;
+    public static function create(string $resource): self;
 
     public static function update(string $resource, string $id, string $token): self;
 
@@ -56,4 +56,6 @@ public function updateFiles(array $newFiles): void;
     public function addSubResource(string $key, array $subResource): void;
 
     public function removeSubResource(string $subResource, string $id): void;
+
+    public function authorize(string $token): void;
 }
diff --git a/src/Sylius/Behat/Context/Api/Admin/ManagingOrdersContext.php b/src/Sylius/Behat/Context/Api/Admin/ManagingOrdersContext.php
@@ -75,7 +75,7 @@ public function iBrowseOrders(): void
      */
     public function iSeeTheOrder(OrderInterface $order): void
     {
-        $this->client->show($order->getNumber());
+        $this->client->show($order->getTokenValue());
     }
 
     /**
@@ -84,7 +84,7 @@ public function iSeeTheOrder(OrderInterface $order): void
     public function iCancelThisOrder(OrderInterface $order): void
     {
         $this->client->applyTransition(
-            $this->responseChecker->getValue($this->client->show($order->getNumber()), 'number'),
+            $this->responseChecker->getValue($this->client->show($order->getTokenValue()), 'tokenValue'),
             OrderTransitions::TRANSITION_CANCEL
         );
     }
@@ -129,9 +129,10 @@ public function iShouldSeeASingleOrderFromCustomer(CustomerInterface $customer):
      */
     public function iShouldBeNotifiedAboutItHasBeenSuccessfullyCanceled(): void
     {
+        $response = $this->client->getLastResponse();
         Assert::true(
-            $this->responseChecker->isUpdateSuccessful($this->client->getLastResponse()),
-            'Resource could not be completed'
+            $this->responseChecker->isUpdateSuccessful($response),
+            'Resource could not be completed. Reason: ' . $response->getContent()
         );
     }
 
@@ -143,7 +144,7 @@ public function itsStateShouldBe(string $state): void
     {
         /** @var OrderInterface $order */
         $order = $this->sharedStorage->get('order');
-        $orderState = $this->responseChecker->getValue($this->client->show($order->getNumber()), 'state');
+        $orderState = $this->responseChecker->getValue($this->client->show($order->getTokenValue()), 'state');
 
         Assert::same($orderState, strtolower($state));
     }
@@ -154,7 +155,7 @@ public function itsStateShouldBe(string $state): void
     public function itShouldHaveShipmentState(string $state): void
     {
         $shipmentsIri = $this->responseChecker->getValue(
-            $this->client->show($this->sharedStorage->get('order')->getNumber()),
+            $this->client->show($this->sharedStorage->get('order')->getTokenValue()),
             'shipments'
         );
 
@@ -170,7 +171,7 @@ public function itShouldHaveShipmentState(string $state): void
     public function itShouldHavePaymentState($state): void
     {
         $paymentsIri = $this->responseChecker->getValue(
-            $this->client->show($this->sharedStorage->get('order')->getNumber()),
+            $this->client->show($this->sharedStorage->get('order')->getTokenValue()),
             'payments'
         );
 
@@ -186,7 +187,7 @@ public function itShouldHavePaymentState($state): void
     public function theOrderShouldHaveNumberOfPayments(int $number): void
     {
         Assert::count(
-            $this->responseChecker->getValue($this->client->show($this->sharedStorage->get('order')->getNumber()), 'payments'),
+            $this->responseChecker->getValue($this->client->show($this->sharedStorage->get('order')->getTokenValue()), 'payments'),
             $number
         );
     }
@@ -197,8 +198,8 @@ public function theOrderShouldHaveNumberOfPayments(int $number): void
     public function theOrderShouldHavePaymentState(OrderInterface $order, string $paymentState): void
     {
         Assert::true(
-            $this->responseChecker->hasValue($this->client->show($order->getNumber()), 'paymentState', strtolower($paymentState)),
-            sprintf('Order %s does not have %s payment state', $order->getNumber(), $paymentState)
+            $this->responseChecker->hasValue($this->client->show($order->getTokenValue()), 'paymentState', strtolower($paymentState)),
+            sprintf('Order %s does not have %s payment state', $order->getTokenValue(), $paymentState)
         );
     }
 

diff --git a/src/Sylius/Behat/Context/Api/Shop/CartContext.php b/src/Sylius/Behat/Context/Api/Shop/CartContext.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Behat\Context\Api\Shop;
+
+use Behat\Behat\Context\Context;
+use Sylius\Behat\Client\ApiClientInterface;
+use Sylius\Behat\Client\Request;
+use Sylius\Behat\Client\ResponseCheckerInterface;
+use Webmozart\Assert\Assert;
+
+final class CartContext implements Context
+{
+    /** @var ApiClientInterface */
+    private $cartsClient;
+
+    /** @var ResponseCheckerInterface */
+    private $responseChecker;
+
+    public function __construct(ApiClientInterface $cartsClient, ResponseCheckerInterface $responseChecker)
+    {
+        $this->cartsClient = $cartsClient;
+        $this->responseChecker = $responseChecker;
+    }
+
+    /**
+     * @When I see the summary of my cart
+     */
+    public function iSeeTheSummaryOfMyCart(): void
+    {
+        $this->cartsClient->create(Request::create('carts'));
+    }
+
+    /**
+     * @Then my cart should be empty
+     */
+    public function myCartShouldBeEmpty(): void
+    {
+        $response = $this->cartsClient->getLastResponse();
+        Assert::true(
+            $this->responseChecker->isCreationSuccessful($response),
+            'Cart has not been created. Reason: ' . $response->getContent()
+        );
+    }
+}
diff --git a/src/Sylius/Behat/Resources/config/services/api.xml b/src/Sylius/Behat/Resources/config/services/api.xml
@@ -74,6 +74,10 @@
             <argument>provinces</argument>
         </service>
 
+        <service id="sylius.behat.api_platform_client.cart" class="Sylius\Behat\Client\ApiPlatformClient" parent="sylius.behat.api_platform_client">
+            <argument>carts</argument>
+        </service>
+
         <service id="sylius.behat.api_platform_client.shipping_category" class="Sylius\Behat\Client\ApiPlatformClient" parent="sylius.behat.api_platform_client">
             <argument>shipping-categories</argument>
         </service>

diff --git a/src/Sylius/Behat/Resources/config/services/contexts/api/shop.xml b/src/Sylius/Behat/Resources/config/services/contexts/api/shop.xml
@@ -18,6 +18,11 @@
     <services>
         <defaults public="true" />
 
+        <service id="sylius.behat.context.api.shop.cart" class="Sylius\Behat\Context\Api\Shop\CartContext">
+            <argument type="service" id="sylius.behat.api_platform_client.cart" />
+            <argument type="service" id="Sylius\Behat\Client\ResponseCheckerInterface" />
+        </service>
+
         <service id="sylius.behat.context.api.shop.channel" class="Sylius\Behat\Context\Api\Shop\ChannelContext">
             <argument type="service" id="sylius.behat.shared_storage" />
         </service>

diff --git a/src/Sylius/Behat/Resources/config/suites.yml b/src/Sylius/Behat/Resources/config/suites.yml
@@ -7,6 +7,7 @@ imports:
     - suites/api/addressing/managing_countries.yml
     - suites/api/addressing/managing_zones.yml
     - suites/api/admin/login.yml
+    - suites/api/cart/shopping_cart.yml
     - suites/api/channel/managing_channels.yml
     - suites/api/currency/managing_currencies.yml
     - suites/api/currency/managing_exchange_rates.yml

diff --git a/src/Sylius/Behat/Resources/config/suites/api/cart/shopping_cart.yml b/src/Sylius/Behat/Resources/config/suites/api/cart/shopping_cart.yml
@@ -0,0 +1,15 @@
+# This file is part of the Sylius package.
+# (c) Paweł Jędrzejewski
+
+default:
+    suites:
+        api_shopping_cart:
+            contexts:
+                - sylius.behat.context.hook.doctrine_orm
+
+                - sylius.behat.context.setup.channel
+
+                - sylius.behat.context.api.shop.cart
+
+            filters:
+                tags: "@shopping_cart && @api"
diff --git a/src/Sylius/Bundle/ApiBundle/Command/PickupCart.php b/src/Sylius/Bundle/ApiBundle/Command/PickupCart.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Paweł Jędrzejewski
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\Command;
+
+/**
+ * @psalm-immutable
+ */
+class PickupCart
+{
+}
diff --git a/src/Sylius/Bundle/ApiBundle/CommandHandler/PickupCartHandler.php b/src/Sylius/Bundle/ApiBundle/CommandHandler/PickupCartHandler.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace Sylius\Bundle\ApiBundle\CommandHandler;
+
+use Doctrine\Persistence\ObjectManager;
+use Sylius\Bundle\ApiBundle\Command\PickupCart;
+use Sylius\Bundle\ApiBundle\Command\RegisterShopUser;
+use Sylius\Component\Channel\Context\ChannelContextInterface;
+use Sylius\Component\Core\Model\ChannelInterface;
+use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\Component\Currency\Model\CurrencyInterface;
+use Sylius\Component\Locale\Model\LocaleInterface;
+use Sylius\Component\Resource\Factory\FactoryInterface;
+use Sylius\Component\Resource\Generator\RandomnessGeneratorInterface;
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+final class PickupCartHandler implements MessageHandlerInterface
+{
+    /** @var FactoryInterface */
+    private $cartFactory;
+
+    /** @var ChannelContextInterface */
+    private $channelContext;
+
+    /** @var ObjectManager */
+    private $orderManager;
+
+    /** @var RandomnessGeneratorInterface */
+    private $generator;
+
+    public function __construct(
+        FactoryInterface $cartFactory,
+        ChannelContextInterface $channelContext,
+        ObjectManager $orderManager,
+        RandomnessGeneratorInterface $generator
+    ) {
+        $this->cartFactory = $cartFactory;
+        $this->channelContext = $channelContext;
+        $this->orderManager = $orderManager;
+        $this->generator = $generator;
+    }
+
+    public function __invoke(PickupCart $pickupCart)
+    {
+        /** @var OrderInterface $cart */
+        $cart = $this->cartFactory->createNew();
+
+        /** @var ChannelInterface $channel */
+        $channel = $this->channelContext->getChannel();
+        /** @var LocaleInterface $locale */
+        $locale = $channel->getDefaultLocale();
+        /** @var CurrencyInterface $currency */
+        $currency = $channel->getBaseCurrency();
+
+        $cart->setChannel($channel);
+        $cart->setLocaleCode($locale->getCode());
+        $cart->setCurrencyCode($currency->getCode());
+        $cart->setTokenValue($this->generator->generateUriSafeString(10));
+
+        $this->orderManager->persist($cart);
+
+        return $cart;
+    }
+}
diff --git a/src/Sylius/Bundle/ApiBundle/PropertyInfo/Extractor/EmptyPropertyListExtractor.php b/src/Sylius/Bundle/ApiBundle/PropertyInfo/Extractor/EmptyPropertyListExtractor.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\PropertyInfo\Extractor;
+
+use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
+
+final class EmptyPropertyListExtractor implements PropertyListExtractorInterface
+{
+    public function getProperties(string $class, array $context = []): ?array
+    {
+        if(class_exists($class)) {
+            return [];
+        }
+
+        return null;
+    }
+}
diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Order.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Order.xml
@@ -28,6 +28,14 @@
             <collectionOperation name="get">
                 <attribute name="security">is_granted('ROLE_API_ACCESS')</attribute>
             </collectionOperation>
+            <collectionOperation name="post">
+                <attribute name="security">is_granted('IS_AUTHENTICATED_ANONYMOUSLY')</attribute>
+                <attribute name="openapi_context">
+                    <attribute name="summary">Pickup a new cart</attribute>
+                </attribute>
+                <attribute name="messenger">input</attribute>
+                <attribute name="input">Sylius\Bundle\ApiBundle\Command\PickupCart</attribute>
+            </collectionOperation>
         </collectionOperations>
 
         <itemOperations>
@@ -51,7 +59,8 @@
         </itemOperations>
 
         <property name="id" identifier="false" writable="false" />
-        <property name="number" identifier="true" writable="false" />
+        <property name="number" identifier="false" writable="false" />
+        <property name="tokenValue" identifier="true" writable="false" />
         <property name="channel" writable="false" />
         <property name="customer" writable="false" />
         <property name="payments" writable="false" />