Enhancement: Introduce StoryRequest object

src/Request/StoryRequest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Storyblok-Api.
+ *
+ * (c) SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Request;
+
+use Storyblok\Api\Domain\Value\Dto\Version;
+use Webmozart\Assert\Assert;
+
+/**
+ * @author Silas Joisten <[email protected]>
+ */
+final readonly class StoryRequest
+{
+    public function __construct(
+        public string $language = 'default',
+        public ?Version $version = null,
+    ) {
+        Assert::stringNotEmpty($language);
+    }
+
+    /**
+     * @return array{
+     *     language: string,
+     *     version?: string,
+     * }
+     */
+    public function toArray(): array
+    {
+        $array = [
+            'language' => $this->language,
+        ];
+
+        if (null !== $this->version) {
+            $array['version'] = $this->version->value;
+        }
+
+        return $array;
+    }
+}

src/StoriesApi.php

@@ -18,6 +18,7 @@
 use Storyblok\Api\Domain\Value\Total;
 use Storyblok\Api\Domain\Value\Uuid;
 use Storyblok\Api\Request\StoriesRequest;
+use Storyblok\Api\Request\StoryRequest;
 use Storyblok\Api\Response\StoriesResponse;
 use Storyblok\Api\Response\StoryResponse;
 use Webmozart\Assert\Assert;
@@ -80,44 +81,45 @@ public function allByContentType(string $contentType, ?StoriesRequest $request =
         );
     }
 
-    public function bySlug(string $slug, string $language = 'default', ?Version $version = null): StoryResponse
+    public function bySlug(string $slug, ?StoryRequest $request = null): StoryResponse
     {
-        Assert::stringNotEmpty($language);
         Assert::stringNotEmpty($slug);
 
+        $request ??= new StoryRequest();
+
         $response = $this->client->request('GET', \sprintf('%s/%s', self::ENDPOINT, $slug), [
             'query' => [
-                'language' => $language,
-                'version' => null !== $version ? $version->value : $this->version->value,
+                ...$request->toArray(),
+                'version' => null !== $request->version ? $request->version->value : $this->version->value,
             ],
         ]);
 
         return new StoryResponse($response->toArray());
     }
 
-    public function byUuid(Uuid $uuid, string $language = 'default', ?Version $version = null): StoryResponse
+    public function byUuid(Uuid $uuid, ?StoryRequest $request = null): StoryResponse
     {
-        Assert::stringNotEmpty($language);
+        $request ??= new StoryRequest();
 
         $response = $this->client->request('GET', \sprintf('%s/%s', self::ENDPOINT, $uuid->value), [
             'query' => [
-                'language' => $language,
+                ...$request->toArray(),
                 'find_by' => 'uuid',
-                'version' => null !== $version ? $version->value : $this->version->value,
+                'version' => null !== $request->version ? $request->version->value : $this->version->value,
             ],
         ]);
 
         return new StoryResponse($response->toArray());
     }
 
-    public function byId(Id $id, string $language = 'default', ?Version $version = null): StoryResponse
+    public function byId(Id $id, ?StoryRequest $request = null): StoryResponse
     {
-        Assert::stringNotEmpty($language);
+        $request ??= new StoryRequest();
 
         $response = $this->client->request('GET', \sprintf('/v2/cdn/stories/%s', $id->value), [
             'query' => [
-                'language' => $language,
-                'version' => null !== $version ? $version->value : $this->version->value,
+                ...$request->toArray(),
+                'version' => null !== $request->version ? $request->version->value : $this->version->value,
             ],
         ]);
 

src/StoriesApiInterface.php

@@ -13,10 +13,10 @@
 
 namespace Storyblok\Api;
 
-use Storyblok\Api\Domain\Value\Dto\Version;
 use Storyblok\Api\Domain\Value\Id;
 use Storyblok\Api\Domain\Value\Uuid;
 use Storyblok\Api\Request\StoriesRequest;
+use Storyblok\Api\Request\StoryRequest;
 use Storyblok\Api\Response\StoriesResponse;
 use Storyblok\Api\Response\StoryResponse;
 
@@ -31,9 +31,9 @@ public function all(?StoriesRequest $request = null): StoriesResponse;
 
     public function allByContentType(string $contentType, ?StoriesRequest $request = null): StoriesResponse;
 
-    public function bySlug(string $slug, string $language = 'default', ?Version $version = null): StoryResponse;
+    public function bySlug(string $slug, ?StoryRequest $request = null): StoryResponse;
 
-    public function byUuid(Uuid $uuid, string $language = 'default', ?Version $version = null): StoryResponse;
+    public function byUuid(Uuid $uuid, ?StoryRequest $request = null): StoryResponse;
 
-    public function byId(Id $id, string $language = 'default', ?Version $version = null): StoryResponse;
+    public function byId(Id $id, ?StoryRequest $request = null): StoryResponse;
 }

tests/Unit/Request/StoryRequestTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Storyblok-Api.
+ *
+ * (c) SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Tests\Unit\Request;
+
+use PHPUnit\Framework\TestCase;
+use Storyblok\Api\Domain\Value\Dto\Version;
+use Storyblok\Api\Request\StoryRequest;
+use Storyblok\Api\Tests\Util\FakerTrait;
+
+/**
+ * @author Silas Joisten <[email protected]>
+ */
+final class StoryRequestTest extends TestCase
+{
+    use FakerTrait;
+
+    /**
+     * @test
+     */
+    public function toArray(): void
+    {
+        $request = new StoryRequest(
+            language: $language = self::faker()->word(),
+            version: $version = Version::Published,
+        );
+
+        self::assertSame([
+            'language' => $language,
+            'version' => $version->value,
+        ], $request->toArray());
+    }
+
+    /**
+     * @test
+     */
+    public function toArrayWithDefaults(): void
+    {
+        $request = new StoryRequest();
+
+        self::assertSame([
+            'language' => 'default',
+        ], $request->toArray());
+    }
+
+    /**
+     * @test
+     */
+    public function toArrayWithVersion(): void
+    {
+        $request = new StoryRequest(
+            version: $version = Version::Published,
+        );
+
+        self::assertSame([
+            'language' => 'default',
+            'version' => $version->value,
+        ], $request->toArray());
+    }
+}