Added StockEndpoint::getByProductId

Author: loevgaard

src/Client/ClientInterface.php

@@ -37,7 +37,7 @@ public function getLastResponse(): ?ResponseInterface;
     public function request(RequestInterface $request): ResponseInterface;
 
     /**
-     * @param Query|array<string, scalar|\Stringable|\DateTimeInterface> $query
+     * @param Query|array<string, scalar|\Stringable|\DateTimeInterface|null> $query The query parameters. Parameters with null values are removed.
      *
      * @throws ClientExceptionInterface if an error happens while processing the request
      * @throws InternalServerErrorException if the server reports an internal server error

src/Client/Endpoint/StockEndpoint.php

@@ -4,9 +4,11 @@
 
 namespace Setono\PeakWMS\Client\Endpoint;
 
+use Setono\PeakWMS\DataTransferObject\Collection;
 use Setono\PeakWMS\DataTransferObject\PaginatedCollection;
 use Setono\PeakWMS\DataTransferObject\Stock\Stock;
 use Setono\PeakWMS\Request\Query\KeySetPageQuery;
+use Setono\PeakWMS\Request\Query\Query;
 
 /**
  * @extends Endpoint<Stock>
@@ -34,6 +36,21 @@ public function getPage(KeySetPageQuery $query = null): PaginatedCollection
             );
     }
 
+    public function getByProductId(string $productId, string $variantId = null): Collection
+    {
+        /** @var class-string<Collection<Stock>> $signature */
+        $signature = sprintf('%s<%s>', Collection::class, self::getDataClass());
+
+        return $this->mapperBuilder
+            ->mapper()
+            ->map(
+                $signature,
+                $this->createSource(
+                    $this->client->get(sprintf('%s/%s', $this->endpoint, $productId), new Query(['variantId' => $variantId])),
+                ),
+            );
+    }
+
     /**
      * @return \Generator<Stock>
      */

src/Client/Endpoint/StockEndpointInterface.php

@@ -4,6 +4,7 @@
 
 namespace Setono\PeakWMS\Client\Endpoint;
 
+use Setono\PeakWMS\DataTransferObject\Collection;
 use Setono\PeakWMS\DataTransferObject\PaginatedCollection;
 use Setono\PeakWMS\DataTransferObject\Stock\Stock;
 use Setono\PeakWMS\Request\Query\KeySetPageQuery;
@@ -18,6 +19,11 @@ interface StockEndpointInterface extends EndpointInterface
      */
     public function getPage(KeySetPageQuery $query = null): PaginatedCollection;
 
+    /**
+     * @return Collection<Stock>
+     */
+    public function getByProductId(string $productId, string $variantId = null): Collection;
+
     /**
      * @return iterable<Stock>
      */

src/DataTransferObject/Collection.php

@@ -50,6 +50,14 @@ public function filter(callable $callback): self
         return new self(array_values(array_filter($this->items, $callback)));
     }
 
+    /**
+     * @param callable(T):numeric $callback
+     */
+    public function sum(callable $callback): int|float
+    {
+        return array_sum(array_map($callback, $this->items));
+    }
+
     /**
      * @return list<T>
      */

src/Request/Query/Query.php

@@ -6,12 +6,19 @@
 
 class Query implements \Stringable
 {
-    public function __construct(
-        /**
-         * @var array<string, scalar|\Stringable|\DateTimeInterface> $parameters
-         */
-        protected array $parameters = [],
-    ) {
+    /** @var array<string, scalar|\Stringable|\DateTimeInterface> */
+    protected array $parameters;
+
+    /**
+     * Parameters with null values are removed
+     *
+     * @param array<string, scalar|\Stringable|\DateTimeInterface|null> $parameters
+     */
+    public function __construct(array $parameters = [])
+    {
+        $this->parameters = array_filter($parameters, static function ($element) {
+            return null !== $element;
+        });
     }
 
     public function isEmpty(): bool
@@ -22,7 +29,7 @@ public function isEmpty(): bool
     public function toString(): string
     {
         return http_build_query(array_map(static function ($element) {
-            return $element instanceof \DateTimeInterface ? $element->format(\DATE_ATOM) : $element;
+            return $element instanceof \DateTimeInterface ? $element->format(\DATE_ATOM) : (string) $element;
         }, $this->parameters), '', '&', \PHP_QUERY_RFC3986);
     }
 

tests/DataTransferObject/CollectionTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\PeakWMS\DataTransferObject;
+
+use PHPUnit\Framework\TestCase;
+use Setono\PeakWMS\DataTransferObject\Stock\Stock;
+
+final class CollectionTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_sums(): void
+    {
+        $collection = new Collection([
+            new Stock(quantity: 1),
+            new Stock(quantity: 3),
+            new Stock(quantity: 5),
+        ]);
+
+        self::assertSame(9, $collection->sum(fn (Stock $stock): int => (int) $stock->quantity));
+    }
+}