Implement request and retrieve offer export file API commands

src/Client.php

@@ -8,10 +8,10 @@
 namespace BolCom\RetailerApi;
 
 use BolCom\RetailerApi\Client\ClientConfigInterface;
-use BolCom\RetailerApi\Client\JsonResponseMiddleware;
 use BolCom\RetailerApi\Client\AcceptHeaderMiddleware;
 use BolCom\RetailerApi\Client\Oauth2Middleware;
 use BolCom\RetailerApi\Client\RequestExceptionMiddleware;
+use BolCom\RetailerApi\Client\ResponseSelectorMiddleware;
 use BolCom\RetailerApi\Model\ClientInterface;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Middleware;
@@ -58,7 +58,7 @@ protected function handlerStack(ClientConfigInterface $clientConfig, LoggerInter
         $stack->push(GuzzleRetryMiddleware::factory());
 
         $logger && $stack->push(Middleware::log($logger, new \GuzzleHttp\MessageFormatter()));
-        $stack->push(new JsonResponseMiddleware());
+        $stack->push(new ResponseSelectorMiddleware());
 
         return $stack;
     }

src/Client/CsvResponse.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Client;
+
+use GuzzleHttp\Psr7\StreamDecoratorTrait;
+use Psr\Http\Message\StreamInterface;
+
+class CsvResponse implements StreamInterface
+{
+    use StreamDecoratorTrait;
+
+    public function csv()
+    {
+    	$data = [];
+		foreach (explode("\n", $this->getContents()) as $line) {
+			$line = trim($line);
+			if (!$line) continue;
+			$data[] = str_getcsv($line);
+		}
+        return $data;
+    }
+}

src/Client/CsvResponseMiddleware.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Client;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class CsvResponseMiddleware
+{
+    public function __invoke(callable $handler)
+    {
+        return function (RequestInterface $request, array $options) use ($handler) {
+            return $handler($request, $options)->then(
+                function (ResponseInterface $response) {
+                    return $response->withBody(new CsvResponse($response->getBody()));
+                }
+            );
+        };
+    }
+}

src/Client/ResponseSelectorMiddleware.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Client;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class ResponseSelectorMiddleware
+{
+    public function __invoke(callable $handler)
+    {
+        return function (RequestInterface $request, array $options) use ($handler) {
+            return $handler($request, $options)->then(
+                function (ResponseInterface $response) {
+                	$contentTypes = $response->getHeader('content-type');
+                	$csvContentTypes = array_filter($contentTypes, function ($val) {return false !== stripos($val, 'csv');});
+                	if ($csvContentTypes) {
+                		return $response->withBody(new CsvResponse($response->getBody()));
+					}
+					return $response->withBody(new JsonResponse($response->getBody()));
+                }
+            );
+        };
+    }
+}

src/Handler/Offer/CreateOfferExportHandler.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Handler\Offer;
+
+use BolCom\RetailerApi\Client;
+use BolCom\RetailerApi\Model\Offer\Command\CreateOfferExport;
+use BolCom\RetailerApi\Model\Offer\CommandHandler\CreateOffersExportFileHandlerInterface;
+use BolCom\RetailerApi\Model\ProcessStatus\ProcessStatus;
+
+class CreateOfferExportHandler implements CreateOffersExportFileHandlerInterface
+{
+    /** @var Client $client */
+    private $client;
+
+    /**
+     * @param Client $client
+     */
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __invoke(CreateOfferExport $createOffersExportFile): ProcessStatus
+    {
+        $response = $this->client->post('offers/export', [
+            'json' => ['format' => $createOffersExportFile->format()],
+            'headers' => [
+                'Accept' => 'application/vnd.retailer.v3+json'
+            ]
+        ]);
+
+        // Current return includes milliseconds: 2018-12-20T11:34:50.237+01:00
+        // Convert this timestamp into ISO 8601 format.
+        $response = $response->getBody()->json();
+        $response['createTimestamp'] = (new \DateTime($response['createTimestamp']))->format(\DateTime::ATOM);
+
+        return ProcessStatus::fromArray($response);
+    }
+}

src/Handler/Offer/GetOfferExportHandler.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Handler\Offer;
+
+use BolCom\RetailerApi\Client;
+use BolCom\RetailerApi\Model\Offer\Query\GetOfferExport;
+use BolCom\RetailerApi\Model\Offer\QueryHandler\GetOfferExportHandlerInterface;
+use BolCom\RetailerApi\Model\Offer\RetailerOfferExportList;
+
+class GetOfferExportHandler implements GetOfferExportHandlerInterface
+{
+    /** @var Client $client */
+    private $client;
+
+    /**
+     * @param Client $client
+     */
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __invoke(GetOfferExport $offerExport): RetailerOfferExportList
+    {
+        $response = $this->client->get("offers/export/{$offerExport->offerExportId()->toString()}", [
+            'headers' => [
+                'Accept' => 'application/vnd.retailer.v3+csv'
+            ]
+        ]);
+        $data = $this->addCsvHeaderAsKey($response->getBody()->csv());
+        return RetailerOfferExportList::fromArray($data);
+    }
+
+    private function addCsvHeaderAsKey(array $data): array
+	{
+		$header = array_shift($data);
+		$mapFunc = function (array $line) use ($header) {
+			return array_combine($header, $line);
+		};
+		return array_map($mapFunc, $data);
+	}
+}

src/Infrastructure/MessageBus.php

@@ -11,7 +11,9 @@
 use BolCom\RetailerApi\Handler\Commission\GetCommissionListHandler;
 use BolCom\RetailerApi\Handler\Inventory\GetInventoryHandler;
 use BolCom\RetailerApi\Handler\Offer\CreateOfferHandler;
+use BolCom\RetailerApi\Handler\Offer\CreateOfferExportHandler;
 use BolCom\RetailerApi\Handler\Offer\DeleteOfferHandler;
+use BolCom\RetailerApi\Handler\Offer\GetOfferExportHandler;
 use BolCom\RetailerApi\Handler\Offer\GetOfferHandler;
 use BolCom\RetailerApi\Handler\Offer\UpdateOfferHandler;
 use BolCom\RetailerApi\Handler\Offer\UpdateOfferPriceHandler;
@@ -35,11 +37,13 @@
 use BolCom\RetailerApi\Model\Inventory\Query\GetInventory;
 use BolCom\RetailerApi\Model\MessageBusInterface;
 use BolCom\RetailerApi\Model\Offer\Command\CreateOffer;
+use BolCom\RetailerApi\Model\Offer\Command\CreateOfferExport;
 use BolCom\RetailerApi\Model\Offer\Command\DeleteOffer;
 use BolCom\RetailerApi\Model\Offer\Command\UpdateOffer;
 use BolCom\RetailerApi\Model\Offer\Command\UpdateOfferPrice;
 use BolCom\RetailerApi\Model\Offer\Command\UpdateOfferStock;
 use BolCom\RetailerApi\Model\Offer\Query\GetOffer;
+use BolCom\RetailerApi\Model\Offer\Query\GetOfferExport;
 use BolCom\RetailerApi\Model\Order\Command\CancelOrder;
 use BolCom\RetailerApi\Model\Order\Command\ShipOrderItem;
 use BolCom\RetailerApi\Model\Order\Query\GetAllOpenOrders;
@@ -89,7 +93,9 @@ public function __construct(ClientPoolInterface $clientPool)
             GetStatusByProcessIds::class => GetStatusByProcessIdsHandler::class,
             GetShipment::class => GetShipmentHandler::class,
             GetShipmentList::class => GetShipmentListHandler::class,
-            GetInventory::class => GetInventoryHandler::class
+            GetInventory::class => GetInventoryHandler::class,
+			CreateOfferExport::class => CreateOfferExportHandler::class,
+			GetOfferExport::class => GetOfferExportHandler::class
         ];
 
         $this->clientPool = $clientPool;

src/Model/Offer/Command/CreateOfferExport.php

@@ -0,0 +1,37 @@
+<?php
+
+// phpcs:ignoreFile
+// this file is auto-generated by prolic/fpp
+// don't edit this file manually
+
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Model\Offer\Command;
+
+final class CreateOfferExport extends \Prooph\Common\Messaging\Command
+{
+    use \Prooph\Common\Messaging\PayloadTrait;
+
+    const MESSAGE_NAME = 'BolCom\RetailerApi\Model\Offer\Command\CreateOfferExport';
+
+    protected $messageName = self::MESSAGE_NAME;
+
+    public function format(): string
+    {
+        return $this->payload['format'];
+    }
+
+    public static function with(string $format = 'CSV'): CreateOfferExport
+    {
+        return new self(['format' => $format]);
+    }
+
+    protected function setPayload(array $payload)
+    {
+        if (! isset($payload['format']) || strtolower($payload['format']) !== 'csv' ) {
+            throw new \InvalidArgumentException("Key 'format' is missing in payload or is not supported format");
+        }
+
+        $this->payload = $payload;
+    }
+}

src/Model/Offer/CommandHandler/CreateOffersExportFileHandlerInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Reach Digital (https://www.reachdigital.io/)
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Model\Offer\CommandHandler;
+
+use BolCom\RetailerApi\Model\Offer\Command\CreateOfferExport;
+use BolCom\RetailerApi\Model\ProcessStatus\ProcessStatus;
+
+interface CreateOffersExportFileHandlerInterface
+{
+    /**
+     * @param CreateOfferExport $createOffersExportFile
+     *
+     * @return ProcessStatus
+     *@throws \RuntimeException
+     *
+     */
+    public function __invoke(CreateOfferExport $createOffersExportFile): ProcessStatus;
+}

src/Model/Offer/OfferExportId.php

@@ -0,0 +1,44 @@
+<?php
+
+// phpcs:ignoreFile
+// this file is auto-generated by prolic/fpp
+// don't edit this file manually
+
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Model\Offer;
+
+final class OfferExportId
+{
+    private $uuid;
+
+    public static function generate(): OfferExportId
+    {
+        return new self(\Ramsey\Uuid\Uuid::uuid4());
+    }
+
+    public static function fromString(string $offerExportId): OfferExportId
+    {
+        return new self(\Ramsey\Uuid\Uuid::fromString($offerExportId));
+    }
+
+    private function __construct(\Ramsey\Uuid\UuidInterface $offerExportId)
+    {
+        $this->uuid = $offerExportId;
+    }
+
+    public function toString(): string
+    {
+        return $this->uuid->toString();
+    }
+
+    public function __toString(): string
+    {
+        return $this->uuid->toString();
+    }
+
+    public function equals(OfferExportId $other): bool
+    {
+        return $this->uuid->equals($other->uuid);
+    }
+}

src/Model/Offer/Query/GetOfferExport.php

@@ -0,0 +1,39 @@
+<?php
+
+// phpcs:ignoreFile
+// this file is auto-generated by prolic/fpp
+// don't edit this file manually
+
+declare(strict_types=1);
+
+namespace BolCom\RetailerApi\Model\Offer\Query;
+
+final class GetOfferExport extends \Prooph\Common\Messaging\Query
+{
+    use \Prooph\Common\Messaging\PayloadTrait;
+
+    const MESSAGE_NAME = 'BolCom\RetailerApi\Model\Offer\Query\GetOfferExport';
+
+    protected $messageName = self::MESSAGE_NAME;
+
+    public function offerExportId(): \BolCom\RetailerApi\Model\Offer\OfferExportId
+    {
+        return \BolCom\RetailerApi\Model\Offer\OfferExportId::fromString($this->payload['offerExportId']);
+    }
+
+    public static function with(\BolCom\RetailerApi\Model\Offer\OfferExportId $offerExportId): GetOfferExport
+    {
+        return new self([
+            'offerExportId' => $offerExportId->toString(),
+        ]);
+    }
+
+    protected function setPayload(array $payload)
+    {
+        if (! isset($payload['offerExportId']) || ! \is_string($payload['offerExportId'])) {
+            throw new \InvalidArgumentException("Key 'offerExportId' is missing in payload or is not a string");
+        }
+
+        $this->payload = $payload;
+    }
+}