From 77eed7036ecc5d1981512b8670ffba2f9aebf001 Mon Sep 17 00:00:00 2001
From: Maksym Novik <novik.kor@gmail.com>
Date: Mon, 1 Apr 2019 23:10:54 +0300
Subject: [PATCH] Add "Ready for Pickup" button on the Order page in Admin
 Panel which notifies Customer that Order could be picked up #2034.
 Implemented synchronous email sending with custom email template for
 storepickup. Added even more TODOs

---
 .../Model/NotifyOrderIsReadyAndShip.php       | 38 ++++++--
 .../Container/ReadyForPickupIdentity.php      | 91 +++++++++++++++++++
 .../Order/Email/ReadyForPickupNotifier.php    | 51 +++++++++++
 .../Order/Email/ReadyForPickupSender.php      | 88 ++++++++++++++++++
 InventoryInStorePickup/composer.json          |  3 +-
 InventoryInStorePickup/etc/config.xml         | 26 ++++++
 InventoryInStorePickup/etc/di.xml             |  6 +-
 .../etc/email_templates.xml                   | 12 +++
 InventoryInStorePickup/etc/module.xml         |  1 +
 .../email/order_ready_for_pickup.html         | 53 +++++++++++
 .../NotifyOrderIsReadyAndShipInterface.php    |  4 +-
 11 files changed, 363 insertions(+), 10 deletions(-)
 create mode 100644 InventoryInStorePickup/Model/Order/Email/Container/ReadyForPickupIdentity.php
 create mode 100644 InventoryInStorePickup/Model/Order/Email/ReadyForPickupNotifier.php
 create mode 100644 InventoryInStorePickup/Model/Order/Email/ReadyForPickupSender.php
 create mode 100644 InventoryInStorePickup/etc/config.xml
 create mode 100644 InventoryInStorePickup/etc/email_templates.xml
 create mode 100644 InventoryInStorePickup/view/frontend/email/order_ready_for_pickup.html

diff --git a/InventoryInStorePickup/Model/NotifyOrderIsReadyAndShip.php b/InventoryInStorePickup/Model/NotifyOrderIsReadyAndShip.php
index c065ee5ba523..276d2ef5b7dc 100644
--- a/InventoryInStorePickup/Model/NotifyOrderIsReadyAndShip.php
+++ b/InventoryInStorePickup/Model/NotifyOrderIsReadyAndShip.php
@@ -23,32 +23,58 @@ class NotifyOrderIsReadyAndShip implements NotifyOrderIsReadyAndShipInterface
      */
     private $shipOrder;
 
+    /**
+     * @var \Magento\InventoryInStorePickup\Model\Order\Email\ReadyForPickupNotifier
+     */
+    private $emailNotifier;
+
+    /**
+     * @var \Magento\Sales\Api\OrderRepositoryInterface
+     */
+    private $orderRepository;
+
     /**
      * NotifyOrderIsReadyAndShip constructor.
      *
-     * @param \Magento\InventoryInStorePickupApi\Api\IsOrderReadyForPickupInterface $isOrderReadyForPickup
-     * @param \Magento\Sales\Api\ShipOrderInterface                                 $shipOrder
+     * @param \Magento\InventoryInStorePickupApi\Api\IsOrderReadyForPickupInterface    $isOrderReadyForPickup
+     * @param \Magento\Sales\Api\ShipOrderInterface                                    $shipOrder
+     * @param \Magento\InventoryInStorePickup\Model\Order\Email\ReadyForPickupNotifier $emailNotifier
+     * @param \Magento\Sales\Api\OrderRepositoryInterface                              $orderRepository
      */
     public function __construct(
         IsOrderReadyForPickupInterface $isOrderReadyForPickup,
-        \Magento\Sales\Api\ShipOrderInterface $shipOrder
+        \Magento\Sales\Api\ShipOrderInterface $shipOrder,
+        Order\Email\ReadyForPickupNotifier $emailNotifier,
+        \Magento\Sales\Api\OrderRepositoryInterface $orderRepository
     ) {
         $this->isOrderReadyForPickup = $isOrderReadyForPickup;
         $this->shipOrder = $shipOrder;
+        $this->emailNotifier = $emailNotifier;
+        $this->orderRepository = $orderRepository;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function execute(int $orderId):int
+    public function execute(int $orderId):?int
     {
         if (!$this->isOrderReadyForPickup->execute($orderId)) {
             throw new OrderIsNotReadyForPickupException();
         }
 
-        /* TODO: send email */
+        $this->emailNotifier->notify($this->getOrder($orderId));
         /* TODO: add order comment? */
 
-        return $this->shipOrder->execute($orderId);
+        return (int)$this->shipOrder->execute($orderId);
+    }
+
+    /**
+     * @param int $orderId
+     *
+     * @return \Magento\Sales\Api\Data\OrderInterface|\Magento\Sales\Model\Order
+     */
+    private function getOrder(int $orderId)
+    {
+        return $this->orderRepository->get($orderId);
     }
 }
diff --git a/InventoryInStorePickup/Model/Order/Email/Container/ReadyForPickupIdentity.php b/InventoryInStorePickup/Model/Order/Email/Container/ReadyForPickupIdentity.php
new file mode 100644
index 000000000000..88719b363600
--- /dev/null
+++ b/InventoryInStorePickup/Model/Order/Email/Container/ReadyForPickupIdentity.php
@@ -0,0 +1,91 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\Order\Email\Container;
+
+use Magento\Sales\Model\Order\Email\Container\Container;
+use Magento\Sales\Model\Order\Email\Container\IdentityInterface;
+
+class ReadyForPickupIdentity extends Container implements IdentityInterface
+{
+    /**
+     * Configuration paths
+     */
+    const XML_PATH_EMAIL_COPY_METHOD    = 'storepickup_email/order_ready_for_pickup/copy_method';
+    const XML_PATH_EMAIL_COPY_TO        = 'storepickup_email/order_ready_for_pickup/copy_to';
+    const XML_PATH_EMAIL_IDENTITY       = 'storepickup_email/order_ready_for_pickup/identity';
+    const XML_PATH_EMAIL_GUEST_TEMPLATE = 'storepickup_email/order_ready_for_pickup/guest_template';
+    const XML_PATH_EMAIL_TEMPLATE       = 'storepickup_email/order_ready_for_pickup/template';
+    const XML_PATH_EMAIL_ENABLED        = 'storepickup_email/order_ready_for_pickup/enabled';
+
+    /**
+     * @return bool
+     */
+    public function isEnabled()
+    {
+        return $this->scopeConfig->isSetFlag(
+            self::XML_PATH_EMAIL_ENABLED,
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
+            $this->getStore()->getStoreId()
+        );
+    }
+
+    /**
+     * Return email copy_to list
+     *
+     * @return array|bool
+     */
+    public function getEmailCopyTo()
+    {
+        $data = $this->getConfigValue(self::XML_PATH_EMAIL_COPY_TO, $this->getStore()->getStoreId());
+        if (!empty($data)) {
+            return explode(',', $data);
+        }
+
+        return false;
+    }
+
+    /**
+     * Return copy method
+     *
+     * @return mixed
+     */
+    public function getCopyMethod()
+    {
+        return $this->getConfigValue(self::XML_PATH_EMAIL_COPY_METHOD, $this->getStore()->getStoreId());
+    }
+
+    /**
+     * Return guest template id
+     *
+     * @return mixed
+     */
+    public function getGuestTemplateId()
+    {
+        return $this->getConfigValue(self::XML_PATH_EMAIL_GUEST_TEMPLATE, $this->getStore()->getStoreId());
+    }
+
+    /**
+     * Return template id
+     *
+     * @return mixed
+     */
+    public function getTemplateId()
+    {
+        return $this->getConfigValue(self::XML_PATH_EMAIL_TEMPLATE, $this->getStore()->getStoreId());
+    }
+
+    /**
+     * Return email identity
+     *
+     * @return mixed
+     */
+    public function getEmailIdentity()
+    {
+        return $this->getConfigValue(self::XML_PATH_EMAIL_IDENTITY, $this->getStore()->getStoreId());
+    }
+}
diff --git a/InventoryInStorePickup/Model/Order/Email/ReadyForPickupNotifier.php b/InventoryInStorePickup/Model/Order/Email/ReadyForPickupNotifier.php
new file mode 100644
index 000000000000..786362f81399
--- /dev/null
+++ b/InventoryInStorePickup/Model/Order/Email/ReadyForPickupNotifier.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\Order\Email;
+
+use Magento\Sales\Model\Order\Email\Sender\OrderSender;
+use Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory;
+use Psr\Log\LoggerInterface as Logger;
+
+/**
+ * Class ReadyForPickupNotifier
+ *
+ * @package Magento\InventoryInStorePickup\Model\Order\Email
+ * TODO: probaly remove this class
+ */
+class ReadyForPickupNotifier extends \Magento\Sales\Model\AbstractNotifier
+{
+    /**
+     * @var CollectionFactory
+     */
+    protected $historyCollectionFactory;
+
+    /**
+     * @var \Psr\Log\LoggerInterface
+     */
+    protected $logger;
+
+    /**
+     * @var OrderSender
+     */
+    protected $sender;
+
+    /**
+     * @param CollectionFactory                                                      $historyCollectionFactory
+     * @param Logger                                                                 $logger
+     * @param \Magento\InventoryInStorePickup\Model\Order\Email\ReadyForPickupSender $sender
+     */
+    public function __construct(
+        CollectionFactory $historyCollectionFactory,
+        Logger $logger,
+        ReadyForPickupSender $sender
+    ) {
+        $this->historyCollectionFactory = $historyCollectionFactory;
+        $this->logger = $logger;
+        $this->sender = $sender;
+    }
+}
diff --git a/InventoryInStorePickup/Model/Order/Email/ReadyForPickupSender.php b/InventoryInStorePickup/Model/Order/Email/ReadyForPickupSender.php
new file mode 100644
index 000000000000..45a9985b4a44
--- /dev/null
+++ b/InventoryInStorePickup/Model/Order/Email/ReadyForPickupSender.php
@@ -0,0 +1,88 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\Order\Email;
+
+use Magento\Framework\DataObject;
+
+/**
+ * Class ReadyForPickupSender
+ *
+ * @package Magento\InventoryInStorePickup\Model\Order\Email
+ * TODO: refactor
+ * TODO: Implement asynchronous email sending
+ */
+class ReadyForPickupSender extends \Magento\Sales\Model\Order\Email\Sender
+{
+    /**
+     * @var \Magento\Framework\Event\ManagerInterface
+     */
+    private $eventManager;
+
+    /**
+     * ReadyForPickupSender constructor.
+     *
+     * @param \Magento\Sales\Model\Order\Email\Container\Template          $templateContainer
+     * @param \Magento\Sales\Model\Order\Email\Container\IdentityInterface $identityContainer
+     * @param \Magento\Sales\Model\Order\Email\SenderBuilderFactory        $senderBuilderFactory
+     * @param \Psr\Log\LoggerInterface                                     $logger
+     * @param \Magento\Sales\Model\Order\Address\Renderer                  $addressRenderer
+     * @param \Magento\Framework\Event\ManagerInterface                    $eventManager
+     */
+    public function __construct(
+        \Magento\Sales\Model\Order\Email\Container\Template $templateContainer,
+        \Magento\Sales\Model\Order\Email\Container\IdentityInterface $identityContainer,
+        \Magento\Sales\Model\Order\Email\SenderBuilderFactory $senderBuilderFactory,
+        \Psr\Log\LoggerInterface $logger,
+        \Magento\Sales\Model\Order\Address\Renderer $addressRenderer,
+        \Magento\Framework\Event\ManagerInterface $eventManager
+    ) {
+        parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger, $addressRenderer);
+
+        $this->eventManager = $eventManager;
+    }
+
+    /**
+     * @param \Magento\Sales\Model\Order $order
+     *
+     * @return bool
+     */
+    public function send(\Magento\Sales\Model\Order $order):bool
+    {
+        return $this->checkAndSend($order);
+    }
+
+    /**
+     * Prepare email template with variables
+     *
+     * @param \Magento\Sales\Model\ $order
+     *
+     * @return void
+     */
+    protected function prepareTemplate(\Magento\Sales\Model\Order $order)
+    {
+        $transport = [
+            'order'                    => $order,
+            'store'                    => $order->getStore(),
+            'formattedShippingAddress' => $this->getFormattedShippingAddress($order),
+        ];
+        $transportObject = new DataObject($transport);
+
+        /**
+         * Event argument `transport` is @deprecated. Use `transportObject` instead.
+         */
+        $this->eventManager->dispatch(
+            'email_ready_for_pickup_set_template_vars_before',
+            ['sender' => $this, 'transport' => $transportObject, 'transportObject' => $transportObject]
+        );
+
+        $this->templateContainer->setTemplateVars($transportObject->getData());
+
+        parent::prepareTemplate($order);
+    }
+
+}
diff --git a/InventoryInStorePickup/composer.json b/InventoryInStorePickup/composer.json
index caa00eafee06..8d438f55a232 100644
--- a/InventoryInStorePickup/composer.json
+++ b/InventoryInStorePickup/composer.json
@@ -6,7 +6,8 @@
         "magento/framework": "*",
         "magento/module-inventory-in-store-pickup-api": "*",
         "magento/module-inventory-api": "*",
-        "magento/module-sales": "*"
+        "magento/module-sales": "*",
+        "magento/module-store": "*"
     },
     "type": "magento2-module",
     "license": [
diff --git a/InventoryInStorePickup/etc/config.xml b/InventoryInStorePickup/etc/config.xml
new file mode 100644
index 000000000000..33c4380f25c2
--- /dev/null
+++ b/InventoryInStorePickup/etc/config.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <storepickup_email>
+            <order_ready_for_pickup>
+                <enabled>1</enabled>
+                <template>inventory_instorepickup_order_ready_for_pickup_template</template>
+                <guest_template>inventory_instorepickup_order_ready_for_pickup_template</guest_template>
+                <identity>storepickup</identity>
+                <copy_method>bcc</copy_method>
+            </order_ready_for_pickup>
+        </storepickup_email>
+        <trans_email>
+            <ident_storepickup>
+                <email>sales@example.com</email>
+                <name>Store pickup</name>
+            </ident_storepickup>
+        </trans_email>
+    </default>
+</config>
diff --git a/InventoryInStorePickup/etc/di.xml b/InventoryInStorePickup/etc/di.xml
index f76750e559df..3c4229917676 100644
--- a/InventoryInStorePickup/etc/di.xml
+++ b/InventoryInStorePickup/etc/di.xml
@@ -30,5 +30,9 @@
             type="\Magento\InventoryInStorePickup\Model\NotifyOrderIsReadyAndShip"/>
     <preference for="\Magento\InventoryInStorePickupApi\Api\IsOrderReadyForPickupInterface"
             type="\Magento\InventoryInStorePickup\Model\IsOrderReadyForPickup"/>
-
+    <type name="\Magento\InventoryInStorePickup\Model\Order\Email\ReadyForPickupSender">
+        <arguments>
+            <argument name="identityContainer" xsi:type="object">\Magento\InventoryInStorePickup\Model\Order\Email\Container\ReadyForPickupIdentity</argument>
+        </arguments>
+    </type>
 </config>
diff --git a/InventoryInStorePickup/etc/email_templates.xml b/InventoryInStorePickup/etc/email_templates.xml
new file mode 100644
index 000000000000..58fb410e0239
--- /dev/null
+++ b/InventoryInStorePickup/etc/email_templates.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
+    <template id="inventory_instorepickup_order_ready_for_pickup_template" label="Order is Ready for Pickup"
+            file="order_ready_for_pickup.html" type="html" module="Magento_InventoryInStorePickup" area="frontend"
+    />
+</config>
diff --git a/InventoryInStorePickup/etc/module.xml b/InventoryInStorePickup/etc/module.xml
index 345728250831..3d5b65c23e23 100644
--- a/InventoryInStorePickup/etc/module.xml
+++ b/InventoryInStorePickup/etc/module.xml
@@ -11,6 +11,7 @@
             <module name="Magento_Inventory"/>
             <module name="Magento_InventoryInStorePickupApi"/>
             <module name="Magento_Sales" />
+            <module name="Magento_Store" />
         </sequence>
     </module>
 </config>
diff --git a/InventoryInStorePickup/view/frontend/email/order_ready_for_pickup.html b/InventoryInStorePickup/view/frontend/email/order_ready_for_pickup.html
new file mode 100644
index 000000000000..908ec0a30a70
--- /dev/null
+++ b/InventoryInStorePickup/view/frontend/email/order_ready_for_pickup.html
@@ -0,0 +1,53 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<!--@subject {{trans "Your %store_name order is ready for pickup" store_name=$store.getFrontendName()}} @-->
+<!--@vars {
+"var order.getEmailCustomerNote()":"Email Order Note",
+"var order.increment_id":"Order Id",
+"var formattedShippingAddress|raw":"Shipping Address",
+"var order.getShippingDescription()":"Shipping Description",
+} @-->
+
+{{template config_path="design/email/header_template"}}
+
+<table>
+    <tr class="email-intro">
+        <td>
+            <p class="greeting">{{trans "%customer_name," customer_name=$order.getCustomerName()}}</p>
+            <p>
+                {{trans "Your order placed from %store_name is ready for pickup." store_name=$store.getFrontendName()}}
+            </p>
+        </td>
+    </tr>
+    <tr class="email-summary">
+        <td>
+            <h1>{{trans 'Your Order <span class="no-link">#%increment_id</span> is complete'
+                increment_id=$order.increment_id |raw}}</h1>
+            <p>{{trans "Please fell free to pickup your order now."}}</p>
+        </td>
+    </tr>
+    <tr class="email-information">
+        <td>
+            <table class="order-details">
+                <tr>
+                    <td class="address-details">
+                        <h3>{{trans "Shipping Info"}}</h3>
+                        <p>{{var formattedShippingAddress|raw}}</p>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="method-info">
+                        <h3>{{trans "Shipping Method"}}</h3>
+                        <p>{{var order.getShippingDescription()}}</p>
+                    </td>
+                </tr>
+            </table>
+        </td>
+    </tr>
+</table>
+
+{{template config_path="design/email/footer_template"}}
diff --git a/InventoryInStorePickupApi/Api/NotifyOrderIsReadyAndShipInterface.php b/InventoryInStorePickupApi/Api/NotifyOrderIsReadyAndShipInterface.php
index 0f06a28fa99e..db82ef862b82 100644
--- a/InventoryInStorePickupApi/Api/NotifyOrderIsReadyAndShipInterface.php
+++ b/InventoryInStorePickupApi/Api/NotifyOrderIsReadyAndShipInterface.php
@@ -12,11 +12,11 @@ interface NotifyOrderIsReadyAndShipInterface
     /**
      * @param int $orderId
      *
-     * @return int Id of created Shipment
+     * @return int|null Id of created Shipment
      *
      * @throws \Magento\Framework\Exception\NoSuchEntityException
      * @throws \Magento\InventoryInStorePickupApi\Exception\OrderIsNotReadyForPickupException
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    public function execute(int $orderId):int;
+    public function execute(int $orderId):?int;
 }