From 31cf5322c807a146d8cf93b22bf0d58df61f8f49 Mon Sep 17 00:00:00 2001
From: Roshyo <stefdecock68@gmail.com>
Date: Fri, 27 Aug 2021 11:44:27 +0200
Subject: [PATCH] Expose Gift card balance

---
 .../Action/GiftCardBalanceAction.php          | 25 +++++++++
 .../config/api_resources/GiftCard.xml         | 14 +++++
 .../config/serialization/GiftCardBalance.xml  | 20 +++++++
 .../config/services/api/controller.xml        |  7 +++
 .../Action/GiftCardBalanceActionTest.php      | 56 +++++++++++++++++++
 5 files changed, 122 insertions(+)
 create mode 100644 src/Api/Controller/Action/GiftCardBalanceAction.php
 create mode 100644 src/Resources/config/serialization/GiftCardBalance.xml
 create mode 100644 tests/Unit/Api/Controller/Action/GiftCardBalanceActionTest.php

diff --git a/src/Api/Controller/Action/GiftCardBalanceAction.php b/src/Api/Controller/Action/GiftCardBalanceAction.php
new file mode 100644
index 00000000..8589f1cc
--- /dev/null
+++ b/src/Api/Controller/Action/GiftCardBalanceAction.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Controller\Action;
+
+use Setono\SyliusGiftCardPlugin\Model\GiftCardBalanceCollection;
+use Setono\SyliusGiftCardPlugin\Repository\GiftCardRepositoryInterface;
+
+final class GiftCardBalanceAction
+{
+    private GiftCardRepositoryInterface $giftCardRepository;
+
+    public function __construct(GiftCardRepositoryInterface $giftCardRepository)
+    {
+        $this->giftCardRepository = $giftCardRepository;
+    }
+
+    public function __invoke(): GiftCardBalanceCollection
+    {
+        return GiftCardBalanceCollection::createFromGiftCards(
+            $this->giftCardRepository->findEnabled()
+        );
+    }
+}
diff --git a/src/Resources/config/api_resources/GiftCard.xml b/src/Resources/config/api_resources/GiftCard.xml
index b3617163..0f85aae2 100644
--- a/src/Resources/config/api_resources/GiftCard.xml
+++ b/src/Resources/config/api_resources/GiftCard.xml
@@ -27,6 +27,20 @@
                 </attribute>
             </collectionOperation>
 
+            <collectionOperation name="admin_get_balance">
+                <attribute name="method">GET</attribute>
+                <attribute name="path">/admin/gift-cards/balance</attribute>
+                <attribute name="controller">setono_sylius_gift_card.controller.action.get_balance</attribute>
+                <attribute name="pagination_enabled">false</attribute>
+                <attribute name="openapi_context">
+                    <attribute name="summary">Get the gift cards balance.</attribute>
+                </attribute>
+                <attribute name="normalization_context">
+                    <attribute name="groups">admin:gift_card_balance:read</attribute>
+                </attribute>
+                <attribute name="output">Setono\SyliusGiftCardPlugin\Model\GiftCardBalance</attribute>
+            </collectionOperation>
+
             <collectionOperation name="shop_get">
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/shop/gift-cards</attribute>
diff --git a/src/Resources/config/serialization/GiftCardBalance.xml b/src/Resources/config/serialization/GiftCardBalance.xml
new file mode 100644
index 00000000..ad5d7f9f
--- /dev/null
+++ b/src/Resources/config/serialization/GiftCardBalance.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+
+<serializer xmlns="http://symfony.com/schema/dic/serializer-mapping"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/serializer-mapping https://symfony.com/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd"
+>
+    <class name="Setono\SyliusGiftCardPlugin\Model\GiftCardBalance">
+        <attribute name="currencyCode">
+            <group>admin:gift_card_balance:read</group>
+        </attribute>
+
+        <attribute name="count">
+            <group>admin:gift_card_balance:read</group>
+        </attribute>
+
+        <attribute name="total">
+            <group>admin:gift_card_balance:read</group>
+        </attribute>
+    </class>
+</serializer>
diff --git a/src/Resources/config/services/api/controller.xml b/src/Resources/config/services/api/controller.xml
index c1d6f0f4..779afc92 100644
--- a/src/Resources/config/services/api/controller.xml
+++ b/src/Resources/config/services/api/controller.xml
@@ -29,5 +29,12 @@
 
             <tag name="controller.service_arguments" />
         </service>
+
+        <service id="setono_sylius_gift_card.controller.action.get_balance"
+                 class="Setono\SyliusGiftCardPlugin\Api\Controller\Action\GiftCardBalanceAction">
+            <argument type="service" id="setono_sylius_gift_card.repository.gift_card"/>
+
+            <tag name="controller.service_arguments" />
+        </service>
     </services>
 </container>
diff --git a/tests/Unit/Api/Controller/Action/GiftCardBalanceActionTest.php b/tests/Unit/Api/Controller/Action/GiftCardBalanceActionTest.php
new file mode 100644
index 00000000..c08352ce
--- /dev/null
+++ b/tests/Unit/Api/Controller/Action/GiftCardBalanceActionTest.php
@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Setono\SyliusGiftCardPlugin\Unit\Api\Controller\Action;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Setono\SyliusGiftCardPlugin\Api\Controller\Action\GiftCardBalanceAction;
+use Setono\SyliusGiftCardPlugin\Model\GiftCard;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardBalanceCollection;
+use Setono\SyliusGiftCardPlugin\Repository\GiftCardRepositoryInterface;
+
+final class GiftCardBalanceActionTest extends TestCase
+{
+    use ProphecyTrait;
+
+    /**
+     * @test
+     */
+    public function it_returns_the_balance(): void
+    {
+        $giftCard1 = new GiftCard();
+        $giftCard1->setCurrencyCode('EUR');
+        $giftCard1->setAmount(25);
+        $giftCard2 = new GiftCard();
+        $giftCard2->setCurrencyCode('EUR');
+        $giftCard2->setAmount(56);
+
+        $giftCard3 = new GiftCard();
+        $giftCard3->setCurrencyCode('USD');
+        $giftCard3->setAmount(31);
+        $giftCard4 = new GiftCard();
+        $giftCard4->setCurrencyCode('USD');
+        $giftCard4->setAmount(84);
+        $giftCard5 = new GiftCard();
+        $giftCard5->setCurrencyCode('USD');
+        $giftCard5->setAmount(86);
+
+        $expectedBalanceCollection = new GiftCardBalanceCollection();
+        $expectedBalanceCollection->addGiftCard($giftCard1);
+        $expectedBalanceCollection->addGiftCard($giftCard2);
+        $expectedBalanceCollection->addGiftCard($giftCard3);
+        $expectedBalanceCollection->addGiftCard($giftCard4);
+        $expectedBalanceCollection->addGiftCard($giftCard5);
+
+        $giftCardRepository = $this->prophesize(GiftCardRepositoryInterface::class);
+
+        $giftCardRepository->findEnabled()->willReturn([$giftCard1, $giftCard2, $giftCard3, $giftCard4, $giftCard5]);
+
+        $giftCardBalanceAction = new GiftCardBalanceAction($giftCardRepository->reveal());
+        $returnedBalanceCollection = $giftCardBalanceAction();
+
+        self::assertEquals($expectedBalanceCollection, $returnedBalanceCollection);
+    }
+}