OP-319 - Default parcel template and label type configuration

BitBagCommerce · Aug 13, 2024 · a317a37 · a317a37
1 parent e161c2e
commit a317a37
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 20 deletions.
diff --git a/doc/installation.md b/doc/installation.md
@@ -423,6 +423,24 @@ By a standard, the `webpack.config.js` file should be available in your reposito
     ```
 
 
+## Default parameters configuration
+In the .env file, the default parcel size and label type can be specified by adding:
+
+````
+BITBAG_INPOST_DEFAULT_PARCEL_TEMPLATE='medium'
+BITBAG_INPOST_DEFAULT_LABEL_TYPE='normal'
+````
+
+Three types of parcel templates are allowed:
+- 'small'
+- 'medium'
+- 'large'
+
+Two types of labels are allowed:
+- 'normal'
+- 'A6'
+
+
 ## Testing & running the plugin
 
 ```bash

diff --git a/spec/Api/WebClientSpec.php b/spec/Api/WebClientSpec.php
@@ -28,13 +28,16 @@ final class WebClientSpec extends ObjectBehavior
 
     public const LABEL_TYPE = "normal";
 
+    public const PARCEL_TEMPLATE = "medium";
+
+
     public function let(
         ClientInterface $client,
         RequestFactoryInterface $requestFactory,
         StreamFactoryInterface $streamFactory,
     ): void
     {
-        $this->beConstructedWith($client, $requestFactory, $streamFactory, self::LABEL_TYPE);
+        $this->beConstructedWith($client, $requestFactory, $streamFactory, self::LABEL_TYPE, self::PARCEL_TEMPLATE);
     }
 
     public function it_is_initializable(): void

diff --git a/spec/EventListener/ShippingExportEventListenerSpec.php b/spec/EventListener/ShippingExportEventListenerSpec.php
@@ -52,7 +52,8 @@ public function let(
         WebClientInterface $webClient,
         InPostShippingExportActionProviderInterface $shippingExportActionProvider,
         RequestStack $requestStack,
-        LoggerInterface $logger
+        LoggerInterface $logger,
+
     ): void {
         $this->beConstructedWith($webClient, $shippingExportActionProvider, $requestStack, $logger);
     }

diff --git a/src/Api/WebClient.php b/src/Api/WebClient.php
@@ -42,20 +42,22 @@ final class WebClient implements WebClientInterface
 
     private ShippingGatewayInterface $shippingGateway;
 
-    private ?ShippingExportInterface $shippingExport = null;
+    private ?string $labelType = null;
 
-    private string $labelType = 'normal';
+    private ?string $parcelTemplate = null;
 
     public function __construct(
         ClientInterface $client,
         RequestFactoryInterface $requestFactory,
         StreamFactoryInterface $streamFactory,
         string $labelType,
+        string $parcelTemplate,
     ) {
         $this->apiClient = $client;
         $this->requestFactory = $requestFactory;
         $this->streamFactory = $streamFactory;
         $this->labelType = $labelType;
+        $this->parcelTemplate = $parcelTemplate;
     }
 
     public function setShippingGateway(ShippingGatewayInterface $shippingGateway): WebClientInterface
@@ -154,10 +156,8 @@ public function getShipments(): ?array
 
     public function createShipment(
         ShipmentInterface $shipment,
-        ?ShippingExportInterface $shippingExport = null,
+        ShippingExportInterface $shippingExport,
     ): array {
-        $this->shippingExport = $shippingExport;
-
         /** @var OrderInterface $order */
         $order = $shipment->getOrder();
 
@@ -168,7 +168,7 @@ public function createShipment(
             'external_customer_id' => $customer->getId(),
             'receiver' => $this->createReceiverDetails($order),
             'custom_attributes' => $this->createCustomAttributes($shipment),
-            'parcels' => [$this->createParcel($shipment)],
+            'parcels' => [$this->createParcel($shipment, $shippingExport)],
             'service' => $this->getShippingGatewayConfig('service'),
             'additional_services' => $this->getAdditionalServices(),
             'reference' => 'Order: ' . $order->getNumber(),
@@ -326,12 +326,10 @@ private function isCashOnDelivery(OrderInterface $order): bool
 
     private function createParcel(
         ShipmentInterface $shipment,
+        ShippingExportInterface $shippingExport,
     ): array {
         $weight = $shipment->getShippingWeight();
-        $template = 'large';
-        if (null !== $this->shippingExport) {
-            $template = $this->shippingExport->getParcelTemplate();
-        }
+        $template = $shippingExport->getParcelTemplate();
 
         return [
             'id' => $shipment->getId(),
@@ -340,7 +338,7 @@ private function createParcel(
                 'unit' => 'kg',
             ],
             'dimensions' => [],
-            'template' => $template,
+            'template' => $template ?? $this->parcelTemplate,
             'tracking_number' => null,
             'is_non_standard' => false,
         ];

diff --git a/src/Api/WebClientInterface.php b/src/Api/WebClientInterface.php
@@ -79,7 +79,7 @@ public function getLabels(array $shipmentIds): ?string;
 
     public function getAuthorizedHeaderWithContentType(): array;
 
-    public function createShipment(ShipmentInterface $shipment, ?ShippingExportInterface $shippingExport = null): array;
+    public function createShipment(ShipmentInterface $shipment, ShippingExportInterface $shippingExport): array;
 
     public function request(
         string $method,

diff --git a/src/Resources/config/config.yml b/src/Resources/config/config.yml
@@ -1,10 +1,17 @@
 parameters:
-    bitbag.inpost.label_type: 'normal'
+    bitbag.inpost.label_type: '%env(BITBAG_INPOST_DEFAULT_LABEL_TYPE)%'
+    bitbag.inpost.parcel_template: '%env(BITBAG_INPOST_DEFAULT_PARCEL_TEMPLATE)%'
+    env(BITBAG_INPOST_DEFAULT_LABEL_TYPE): 'normal'
+    env(BITBAG_INPOST_DEFAULT_PARCEL_TEMPLATE): 'large'
+
 imports:
     - { resource: "@BitBagSyliusInPostPlugin/Resources/config/services.xml" }
     - { resource: "@BitBagSyliusInPostPlugin/Resources/config/resource/bitbag_inpost.yml" }
     - { resource: "@BitBagSyliusInPostPlugin/Resources/config/sylius_ui.yml" }
     - { resource: "@BitBagSyliusInPostPlugin/Resources/config/grid/*" }
+
 twig:
     globals:
         inpost_client: '@bitbag.sylius_inpost_plugin.api.web_client'
+        bitbag_inpost_parcel_template: '%env(BITBAG_INPOST_DEFAULT_PARCEL_TEMPLATE)%'
+
diff --git a/src/Resources/config/services.xml b/src/Resources/config/services.xml
@@ -52,6 +52,7 @@
             <argument type="service" id="sylius.request_factory"/>
             <argument type="service" id="sylius.stream_factory"/>
             <argument>%bitbag.inpost.label_type%</argument>
+            <argument>%bitbag.inpost.parcel_template%</argument>
         </service>
 
         <service

diff --git a/src/Resources/views/ShippingExport/Grid/Field/ParcelTemplate/_inpost_template.html.twig b/src/Resources/views/ShippingExport/Grid/Field/ParcelTemplate/_inpost_template.html.twig
@@ -1,10 +1,6 @@
 {% set parcelTemplate = data.getParcelTemplate %}
-
 {% if parcelTemplate is null %}
-    <span class="ui label">
-        {{ 'bitbag_sylius_inpost_plugin.ui.parcel_template.select_template'|trans }}
-    </span>
-    <div class="ui divider"></div>
+    {% set parcelTemplate = bitbag_inpost_parcel_template %}
 {% endif %}
 
 {% set templates = {} %}

diff --git a/tests/Application/.env b/tests/Application/.env
@@ -15,6 +15,9 @@ APP_SECRET=EDITME
 DATABASE_URL=mysql://[email protected]/bitbag_sylius_inpost_plugin_%kernel.environment%
 ###< doctrine/doctrine-bundle ###
 
+BITBAG_INPOST_DEFAULT_LABEL_TYPE='normal'
+BITBAG_INPOST_DEFAULT_PARCEL_TEMPLATE='medium'
+
 ###> lexik/jwt-authentication-bundle ###
 JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
 JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem