feat: add imprint to settings repository

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 ## main
 
+## v0.7.4
+- Added imprint to the settings repository
+
 ## v0.7.3
 - Added an exception when the file is not found in a estate file query
 - Added a modify method for estate files

src/Enums/OnOfficeResourceType.php

@@ -15,4 +15,5 @@ enum OnOfficeResourceType: string
     case Regions = 'regions';
     case UploadFile = 'uploadfile';
     case FileRelation = 'fileRelation';
+    case Impressum = 'impressum';
 }

src/Facades/SettingRepository.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Facades\Facade;
 use Katalam\OnOfficeAdapter\Facades\Testing\SettingRepositoryFake;
+use Katalam\OnOfficeAdapter\Query\ImprintBuilder;
 use Katalam\OnOfficeAdapter\Query\RegionBuilder;
 use Katalam\OnOfficeAdapter\Query\UserBuilder;
 
@@ -12,6 +13,7 @@
  *
  * @method static UserBuilder users()
  * @method static RegionBuilder regions()
+ * @method static ImprintBuilder imprint()
  */
 class SettingRepository extends Facade
 {

src/Facades/Testing/SettingRepositoryFake.php

@@ -2,6 +2,7 @@
 
 namespace Katalam\OnOfficeAdapter\Facades\Testing;
 
+use Katalam\OnOfficeAdapter\Query\Testing\ImprintBuilderFake;
 use Katalam\OnOfficeAdapter\Query\Testing\RegionBuilderFake;
 use Katalam\OnOfficeAdapter\Query\Testing\UserBuilderFake;
 
@@ -24,4 +25,12 @@ public function regions(): RegionBuilderFake
     {
         return new RegionBuilderFake($this->fakeResponses);
     }
+
+    /**
+     * Returns a new fake imprint builder instance.
+     */
+    public function imprint(): ImprintBuilderFake
+    {
+        return new ImprintBuilderFake($this->fakeResponses);
+    }
 }

src/Query/ImprintBuilder.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Katalam\OnOfficeAdapter\Query;
+
+use Illuminate\Support\Collection;
+use Katalam\OnOfficeAdapter\Enums\OnOfficeAction;
+use Katalam\OnOfficeAdapter\Enums\OnOfficeResourceType;
+use Katalam\OnOfficeAdapter\Exceptions\OnOfficeException;
+use Katalam\OnOfficeAdapter\Query\Concerns\NonFilterable;
+use Katalam\OnOfficeAdapter\Query\Concerns\NonOrderable;
+use Katalam\OnOfficeAdapter\Services\OnOfficeService;
+
+class ImprintBuilder extends Builder
+{
+    use NonFilterable;
+    use NonFilterable;
+    use NonOrderable;
+
+    public function __construct(
+        private readonly OnOfficeService $onOfficeService,
+    ) {
+    }
+
+    public function get(): Collection
+    {
+        $columns = $this->columns;
+        $listLimit = $this->limit;
+        $listOffset = $this->offset;
+
+        return $this->onOfficeService->requestAll(/**
+         * @throws OnOfficeException
+         */ function () use ($columns) {
+            return $this->onOfficeService->requestApi(
+                OnOfficeAction::Read,
+                OnOfficeResourceType::Impressum,
+                parameters: [
+                    OnOfficeService::DATA => $columns,
+                ]
+            );
+        }, pageSize: $listLimit, offset: $listOffset);
+    }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function first(): array
+    {
+        $columns = $this->columns;
+
+        $response = $this->onOfficeService->requestApi(
+            OnOfficeAction::Read,
+            OnOfficeResourceType::Impressum,
+            parameters: [
+                OnOfficeService::DATA => $columns,
+            ]
+        );
+
+        return $response->json('response.results.0.data.records.0');
+    }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function find(int $id): array
+    {
+        $columns = $this->columns;
+
+        $response = $this->onOfficeService->requestApi(
+            OnOfficeAction::Read,
+            OnOfficeResourceType::Impressum,
+            resourceId: $id,
+            parameters: [
+                OnOfficeService::DATA => $columns,
+            ]
+        );
+
+        return $response->json('response.results.0.data.records.0');
+    }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function each(callable $callback): void
+    {
+        throw new OnOfficeException('Not implemented');
+    }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
+}

src/Query/Testing/ImprintBuilderFake.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Katalam\OnOfficeAdapter\Query\Testing;
+
+class ImprintBuilderFake extends BaseFake
+{
+}

src/Repositories/SettingRepository.php

@@ -2,6 +2,7 @@
 
 namespace Katalam\OnOfficeAdapter\Repositories;
 
+use Katalam\OnOfficeAdapter\Query\ImprintBuilder;
 use Katalam\OnOfficeAdapter\Query\RegionBuilder;
 use Katalam\OnOfficeAdapter\Query\UserBuilder;
 use Katalam\OnOfficeAdapter\Services\OnOfficeService;
@@ -28,4 +29,12 @@ public function regions(): RegionBuilder
     {
         return new RegionBuilder($this->onOfficeService);
     }
+
+    /*
+     * Returns a new imprint builder instance.
+     */
+    public function imprint(): ImprintBuilder
+    {
+        return new ImprintBuilder($this->onOfficeService);
+    }
 }

tests/Query/ImprintBuilderTest.php

@@ -0,0 +1,20 @@
+<?php
+
+use Illuminate\Support\Facades\Http;
+use Katalam\OnOfficeAdapter\Facades\SettingRepository;
+use Katalam\OnOfficeAdapter\Tests\Stubs\GetImprintResponse;
+
+it('works', function () {
+    Http::preventStrayRequests();
+    Http::fake([
+        '*' => GetImprintResponse::make(),
+    ]);
+
+    $imprint = SettingRepository::imprint()
+        ->get();
+
+    expect($imprint)
+        ->toHaveCount(1)
+        ->and(data_get($imprint, '0.elements.firstname'))
+        ->toBe('Max');
+});

tests/Stubs/GetImprintResponse.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Katalam\OnOfficeAdapter\Tests\Stubs;
+
+use GuzzleHttp\Promise\PromiseInterface;
+use Illuminate\Support\Facades\Http;
+
+class GetImprintResponse
+{
+    public static function make(array $data = []): PromiseInterface
+    {
+        return Http::response(self::getBody($data));
+    }
+
+    private static function getBody(array $data): array
+    {
+        return array_merge_recursive([
+            'status' => [
+                'code' => 200,
+                'errorcode' => 0,
+                'message' => 'OK',
+            ],
+            'response' => [
+                'results' => [
+                    [
+                        'actionid' => 'urn:onoffice-de-ns:smart:2.5:smartml:action:read',
+                        'resourceid' => '21',
+                        'resourcetype' => 'impressum',
+                        'cacheable' => true,
+                        'identifier' => '',
+                        'data' => [
+                            'meta' => [
+                                'cntabsolute' => null,
+                            ],
+                            'records' => [
+                                [
+                                    'id' => 'impressum',
+                                    'type' => null,
+                                    'elements' => [
+                                        'title' => 'Mr.',
+                                        'firstname' => 'Max',
+                                        'lastname' => 'Mustermann',
+                                        'firma' => 'onOffice GmbH',
+                                        'country' => 'Germany',
+                                    ],
+                                ],
+                            ],
+                        ],
+                        'status' => [
+                            'errorcode' => 0,
+                            'message' => 'OK',
+                        ],
+                    ],
+                ],
+            ],
+        ], $data);
+    }
+}