[API] Password reset

features/account/resetting_password.feature

@@ -9,15 +9,15 @@ Feature: Resetting a password
         And that channel allows to shop using "English (United States)" and "Polish (Poland)" locales
         And there is a user "goodman@example.com" identified by "heisenberg"
 
-    @ui @email
+    @ui @email @api
     Scenario: Resetting an account password
         When I want to reset password
-        And I specify the email as "goodman@example.com"
+        And I specify customer email as "goodman@example.com"
         And I reset it
         Then I should be notified that email with reset instruction has been sent
         And an email with reset token should be sent to "goodman@example.com"
 
-    @ui @email
+    @ui @email @api
     Scenario: Resetting an account password in different locale than the default one
         When I reset password for email "goodman@example.com" in "Polish (Poland)" locale
         Then an email with reset token should be sent to "goodman@example.com" in "Polish (Poland)" locale

features/account/resetting_password_validation.feature

@@ -8,7 +8,7 @@ Feature: Resetting a password validation
         Given the store operates on a single channel in "United States"
         And there is a user "goodman@example.com" identified by "heisenberg"
 
-    @ui
+    @ui @api
     Scenario: Trying to reset password without specifying email
         When I want to reset password
         And I do not specify the email

src/Sylius/Behat/Context/Api/EmailContext.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Behat\Context\Api;
+
+use Behat\Behat\Context\Context;
+use Sylius\Component\Core\Test\Services\EmailCheckerInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Webmozart\Assert\Assert;
+
+class EmailContext implements Context
+{
+    /** @var EmailCheckerInterface */
+    private $emailChecker;
+
+    /** @var TranslatorInterface */
+    private $translator;
+
+    public function __construct(EmailCheckerInterface $emailChecker, TranslatorInterface $translator)
+    {
+        $this->emailChecker = $emailChecker;
+        $this->translator = $translator;
+    }
+
+    /**
+     * @Then an email with reset token should be sent to :recipient
+     * @Then an email with reset token should be sent to :recipient in :localeCode locale
+     */
+    public function anEmailWithResetTokenShouldBeSentTo(string $recipient, string $localeCode = 'en_US'): void
+    {
+        $this->assertEmailContainsMessageTo(
+            $this->translator->trans('sylius.email.password_reset.reset_your_password', [], null, $localeCode),
+            $recipient
+        );
+    }
+
+    private function assertEmailContainsMessageTo(string $message, string $recipient): void
+    {
+        Assert::true($this->emailChecker->hasMessageTo($message, $recipient));
+    }
+}

src/Sylius/Behat/Context/Api/Shop/LoginContext.php

@@ -14,17 +14,34 @@
 namespace Sylius\Behat\Context\Api\Shop;
 
 use Behat\Behat\Context\Context;
+use Sylius\Behat\Client\ApiClientInterface;
 use Sylius\Behat\Client\ApiSecurityClientInterface;
+use Sylius\Behat\Client\Request;
+use Sylius\Behat\Client\ResponseCheckerInterface;
 use Webmozart\Assert\Assert;
 
 final class LoginContext implements Context
 {
     /** @var ApiSecurityClientInterface */
     private $client;
 
-    public function __construct(ApiSecurityClientInterface $client)
-    {
+    /** @var ApiClientInterface */
+    private $apiClient;
+
+    /** @var ResponseCheckerInterface */
+    private $responseChecker;
+
+    /** @var Request */
+    private $request;
+
+    public function __construct(
+        ApiSecurityClientInterface $client,
+        ApiClientInterface $apiClient,
+        ResponseCheckerInterface $responseChecker
+    ) {
         $this->client = $client;
+        $this->apiClient = $apiClient;
+        $this->responseChecker = $responseChecker;
     }
 
     /**
@@ -43,6 +60,34 @@ public function iWantToLogIn(): void
         $this->client->prepareLoginRequest();
     }
 
+    /**
+     * @When I want to reset password
+     */
+    public function iWantToResetPassword(): void
+    {
+        $this->request = Request::create('shop', 'password-reset-request', 'Bearer');
+    }
+
+    /**
+     * @When I reset password for email :email in :localeCode locale
+     */
+    public function iResetPasswordForEmailInLocale(string $email, string $localeCode): void
+    {
+        $this->iWantToResetPassword();
+        $this->iSpecifyTheEmail($email);
+        $this->addLocaleCode($localeCode);
+        $this->iResetIt();
+    }
+
+    /**
+     * @When I reset it
+     * @When I try to reset it
+     */
+    public function iResetIt(): void
+    {
+        $this->apiClient->executeCustomRequest($this->request);
+    }
+
     /**
      * @When I specify the username as :username
      */
@@ -51,6 +96,15 @@ public function iSpecifyTheUsername(string $username): void
         $this->client->setEmail($username);
     }
 
+    /**
+     * @When I specify customer email as :email
+     * @When I do not specify the email
+     */
+    public function iSpecifyTheEmail(string $email = ''): void
+    {
+        $this->request->setContent(['email' => $email]);
+    }
+
     /**
      * @When I specify the password as :password
      */
@@ -111,4 +165,18 @@ public function iShouldBeNotifiedAboutBadCredentials(): void
     {
         Assert::same($this->client->getErrorMessage(), 'Invalid credentials.');
     }
+
+    /**
+     * @Then I should be notified that email with reset instruction has been sent
+     */
+    public function iShouldBeNotifiedThatEmailWithResetInstructionWasSent(): void
+    {
+        $response = $this->apiClient->getLastResponse();
+        Assert::same($response->getStatusCode(), 202);
+    }
+
+    private function addLocaleCode(string $localeCode): void
+    {
+        $this->request->updateContent(['localeCode' => $localeCode]);
+    }
 }

src/Sylius/Behat/Context/Ui/Shop/LoginContext.php

@@ -119,7 +119,7 @@ public function iSpecifyTheUsername(?string $username = null): void
     }
 
     /**
-     * @When I specify the email as :email
+     * @When I specify customer email as :email
      * @When I do not specify the email
      */
     public function iSpecifyTheEmail(?string $email = null): void

src/Sylius/Behat/Resources/config/services/contexts/api.xml

@@ -18,5 +18,6 @@
     <imports>
         <import resource="api/admin.xml" />
         <import resource="api/shop.xml" />
+        <import resource="api/email.xml" />
     </imports>
 </container>

src/Sylius/Behat/Resources/config/services/contexts/api/email.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ 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.
+
+-->
+
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <defaults public="true" />
+        <service id="sylius.behat.context.api.email" class="Sylius\Behat\Context\Api\EmailContext">
+            <argument type="service" id="sylius.behat.email_checker" />
+            <argument type="service" id="translator" />
+        </service>
+    </services>
+</container>

src/Sylius/Behat/Resources/config/services/contexts/api/shop.xml

@@ -74,6 +74,8 @@
 
         <service id="sylius.behat.context.api.shop.login" class="Sylius\Behat\Context\Api\Shop\LoginContext">
             <argument type="service" id="sylius.behat.client.shop_api_platform_security_client" />
+            <argument type="service" id="sylius.behat.api_platform_client.shop.account" />
+            <argument type="service" id="Sylius\Behat\Client\ResponseCheckerInterface" />
         </service>
 
         <service id="sylius.behat.context.api.shop.product" class="Sylius\Behat\Context\Api\Shop\ProductContext">

src/Sylius/Behat/Resources/config/suites/api/account/login.yml

@@ -6,12 +6,18 @@ default:
         api_customer_login:
             contexts:
                 - sylius.behat.context.hook.doctrine_orm
+                - sylius.behat.context.hook.email_spool
 
+                - sylius.behat.context.transform.locale  
+                - sylius.behat.context.transform.shared_storage
                 - sylius.behat.context.transform.user
 
                 - sylius.behat.context.setup.channel
+                - sylius.behat.context.setup.locale
                 - sylius.behat.context.setup.user
 
+                - sylius.behat.context.api.email
+                - sylius.behat.context.api.shop.customer
                 - sylius.behat.context.api.shop.login
 
             filters:

src/Sylius/Bundle/ApiBundle/Command/LocaleCodeAwareInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\Command;
+
+interface LocaleCodeAwareInterface extends CommandAwareDataTransformerInterface
+{
+    public function getLocaleCode(): ?string;
+
+    public function setLocaleCode(?string $localeCode): void;
+}

src/Sylius/Bundle/ApiBundle/Command/ResetPassword.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\Command;
+
+class ResetPassword implements ChannelCodeAwareInterface, LocaleCodeAwareInterface
+{
+    /** @var string */
+    public $email;
+
+    /** @var string|null */
+    private $channelCode;
+
+    /** @var string|null */
+    private $localeCode;
+
+    public function __construct(string $email)
+    {
+        $this->email = $email;
+    }
+
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+
+    public function getChannelCode(): ?string
+    {
+        return $this->channelCode;
+    }
+
+    public function setChannelCode(?string $channelCode): void
+    {
+        $this->channelCode = $channelCode;
+    }
+
+    public function getLocaleCode(): ?string
+    {
+        return $this->localeCode;
+    }
+
+    public function setLocaleCode(?string $localeCode): void
+    {
+        $this->localeCode = $localeCode;
+    }
+}

src/Sylius/Bundle/ApiBundle/Command/SendResetPasswordEmail.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\Command;
+
+class SendResetPasswordEmail
+{
+    /** @var string */
+    public $email;
+
+    /** @var string */
+    private $channelCode;
+
+    /** @var string */
+    private $localeCode;
+
+    public function __construct(
+        string $email,
+        string $channelCode,
+        string $localeCode
+    ) {
+        $this->email = $email;
+        $this->channelCode = $channelCode;
+        $this->localeCode = $localeCode;
+    }
+
+    public function email(): string
+    {
+        return $this->email;
+    }
+
+    public function channelCode(): string
+    {
+        return $this->channelCode;
+    }
+
+    public function localeCode(): string
+    {
+        return $this->localeCode;
+    }
+}

src/Sylius/Bundle/ApiBundle/CommandHandler/ResetPasswordHandler.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\CommandHandler;
+
+use Sylius\Bundle\ApiBundle\Command\ResetPassword;
+use Sylius\Bundle\ApiBundle\Event\ResetPasswordRequested;
+use Sylius\Component\User\Repository\UserRepositoryInterface;
+use Sylius\Component\User\Security\Generator\GeneratorInterface;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Stamp\DispatchAfterCurrentBusStamp;
+use Webmozart\Assert\Assert;
+
+class ResetPasswordHandler
+{
+    /** @var UserRepositoryInterface */
+    private $userRepository;
+
+    /** @var MessageBusInterface */
+    private $eventBus;
+
+    /** @var GeneratorInterface */
+    private $generator;
+
+    public function __construct(
+        UserRepositoryInterface $userRepository,
+        MessageBusInterface $eventBus,
+        GeneratorInterface $generator
+    ) {
+        $this->userRepository = $userRepository;
+        $this->eventBus = $eventBus;
+        $this->generator = $generator;
+    }
+
+    public function __invoke(ResetPassword $command): void
+    {
+        $user = $this->userRepository->findOneByEmail($command->getEmail());
+        Assert::notNull($user);
+
+        $user->setPasswordResetToken($this->generator->generate());
+        $user->setPasswordRequestedAt(new \DateTime());
+
+        $this->eventBus->dispatch(
+            new ResetPasswordRequested($command->getEmail(), $command->getChannelCode(), $command->getLocaleCode()),
+            [new DispatchAfterCurrentBusStamp()
+        ]);
+    }
+}