SFCHAN-3328: Add UploadOrderDocument operation to SF SDK

src/Api/Order/OrderOperation.php

@@ -1,23 +1,26 @@
 <?php
 namespace ShoppingFeed\Sdk\Api\Order;
 
+use GuzzleHttp\Psr7\MultipartStream;
 use ShoppingFeed\Sdk\Api;
 use ShoppingFeed\Sdk\Hal;
 use ShoppingFeed\Sdk\Operation;
 use ShoppingFeed\Sdk\Exception;
+use GuzzleHttp\Psr7\Utils;
 
 class OrderOperation extends Operation\AbstractBulkOperation
 {
     /**
      * Operation types
      */
-    const TYPE_ACCEPT        = 'accept';
-    const TYPE_CANCEL        = 'cancel';
-    const TYPE_REFUSE        = 'refuse';
-    const TYPE_SHIP          = 'ship';
-    const TYPE_REFUND        = 'refund';
-    const TYPE_ACKNOWLEDGE   = 'acknowledge';
-    const TYPE_UNACKNOWLEDGE = 'unacknowledge';
+    const TYPE_ACCEPT           = 'accept';
+    const TYPE_CANCEL           = 'cancel';
+    const TYPE_REFUSE           = 'refuse';
+    const TYPE_SHIP             = 'ship';
+    const TYPE_REFUND           = 'refund';
+    const TYPE_ACKNOWLEDGE      = 'acknowledge';
+    const TYPE_UNACKNOWLEDGE    = 'unacknowledge';
+    const TYPE_UPLOAD_DOCUMENTS = 'upload-documents';
 
     /**
      * @var array
@@ -30,6 +33,7 @@ class OrderOperation extends Operation\AbstractBulkOperation
         self::TYPE_REFUND,
         self::TYPE_ACKNOWLEDGE,
         self::TYPE_UNACKNOWLEDGE,
+        self::TYPE_UPLOAD_DOCUMENTS,
     ];
 
     /**
@@ -179,6 +183,22 @@ public function unacknowledge($reference, $channelName)
         return $this;
     }
 
+    public function uploadDocuments(
+        $reference,
+        $channelName,
+        UploadOrderDocumentCollection $collection
+    ): self
+    {
+        $this->addOperation(
+            $reference,
+            $channelName,
+            self::TYPE_UPLOAD_DOCUMENTS,
+            ['documents' => $collection->getDocuments()]
+        );
+
+        return $this;
+    }
+
     /**
      * Execute all declared operations
      *
@@ -225,14 +245,84 @@ function (Hal\HalResource $batch) use ($resources) {
     private function createRequestGenerator($type, Hal\HalLink $link, \ArrayAccess $requests)
     {
         return function (array $chunk) use ($type, $link, &$requests) {
-            $requests[] = $link->createRequest(
-                'POST',
-                ['operation' => $type],
-                ['order' => $chunk]
-            );
+            if ($type === self::TYPE_UPLOAD_DOCUMENTS) {
+                $requests[] = $this->createUploadDocumentRequest($link, $chunk);
+            } else {
+                $requests[] = $link->createRequest(
+                    'POST',
+                    ['operation' => $type],
+                    ['order' => $chunk]
+                );
+            }
         };
     }
 
+    /**
+     * Create custom request generation callback for uploadDocument
+     *
+     * @param Hal\HalLink $link
+     * @param array       $requests
+     *
+     * @return \Psr\Http\Message\RequestInterface
+     */
+    private function createUploadDocumentRequest(Hal\HalLink $link, array $chunk)
+    {
+        $client = $link->getHalClient();
+
+        $files   = [];
+        $payload = [
+            'order' => [],
+        ];
+
+        foreach ($chunk as $operation) {
+            $reference   = $operation['reference'];
+            $channelName = $operation['channelName'];
+
+            $documents = [];
+
+            foreach ($operation['documents'] as $document) {
+                /** @var UploadOrderDocument $document */
+                $files[]     = [
+                    'name'     => 'files[]',
+                    'contents' => fopen($document->getPath(), 'rb'),
+                ];
+                $documents[] = ['type' => $document->getType()];
+            }
+
+            $payload['order'][] = [
+                'reference'   => $reference,
+                'channelName' => $channelName,
+                'documents'   => $documents,
+            ];
+        }
+
+        $multipart = new MultipartStream(
+            array_merge(
+                $files,
+                [
+                    [
+                        'name'     => 'body',
+                        'contents' => json_encode($payload),
+                    ],
+                ]
+            )
+        );
+
+        $request = $client->createRequest(
+            'POST',
+            $link->getUri(['operation' => self::TYPE_UPLOAD_DOCUMENTS]),
+            [
+                'Content-Type' => 'multipart/form-data',
+            ],
+            Utils::streamFor($multipart)
+        );
+
+        $modify['set_headers']['Content-Type'] = 'multipart/form-data; boundary='
+            . $request->getBody()->getBoundary();
+
+        return Utils::modifyRequest($request, $modify);
+    }
+
     /**
      * Add operation to queue
      *

src/Api/Order/UploadOrderDocument.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace ShoppingFeed\Sdk\Api\Order;
+
+use ShoppingFeed\Sdk\Exception;
+
+class UploadOrderDocument
+{
+    public const INVOICE = 'invoice';
+
+    private const TYPES = [
+        self::INVOICE,
+    ];
+
+    /**
+     * @var string
+     */
+    private $path;
+
+    /**
+     * @var string
+     */
+    private $type;
+
+    public function __construct(
+        string $path,
+        string $type
+    ) {
+        if (! $this->isAllowedType($type)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Only %s types are accepted',
+                implode(', ', self::TYPES)
+            ));
+        }
+
+        $this->path = $path;
+        $this->type = $type;
+    }
+
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    private function isAllowedType(string $type): bool
+    {
+        return in_array($type, self::TYPES);
+    }
+}

src/Api/Order/UploadOrderDocumentCollection.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace ShoppingFeed\Sdk\Api\Order;
+
+class UploadOrderDocumentCollection
+{
+    /** @var array  */
+    private $documents = [];
+
+    public function addDocument(UploadOrderDocument $document): void
+    {
+        $this->documents[] = $document;
+    }
+
+    public function getDocuments(): array
+    {
+        return $this->documents;
+    }
+}

src/Client/ClientOptions.php

@@ -9,7 +9,7 @@ class ClientOptions
     /**
      * @var bool
      */
-    private $baseUri = 'https://api.shopping-feed.com';
+    private $baseUri = 'http://api.shopping-feed.lan';
 
     /**
      * @var bool

src/Hal/HalLink.php

@@ -302,4 +302,9 @@ private function createExceptionCallback(callable $callback = null)
             call_user_func($callback, $exception);
         };
     }
+
+    public function getHalClient()
+    {
+        return $this->client;
+    }
 }

test_sdk.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ShoppingFeed\Sdk;
+
+use ShoppingFeed\Sdk\Api\Order\UploadOrderDocument;
+use ShoppingFeed\Sdk\Api\Order\UploadOrderDocumentCollection;
+
+$credential = new Credential\Password('login', 'password');
+$session    = Client\Client::createSession($credential);
+
+$orderApi = $session->getMainStore()
+    ->getOrderApi();
+
+$uploadDocument = new UploadOrderDocument('/Users/kevinfrydman/Downloads/FA105411.pdf', UploadOrderDocument::INVOICE);
+$collection = new UploadOrderDocumentCollection();
+$collection->addDocument($uploadDocument);
+
+$operation = new \ShoppingFeed\Sdk\Api\Order\OrderOperation();
+$operation
+    ->uploadDocuments('001-23144L16805-A', 'leroymerlin', $collection);
+
+$orderApi->execute($operation);
+