Merge pull request #18 from innobraingmbh/feat/request-middleware

Feat/request middleware
innobraingmbh · Oct 11, 2024 · 1dc3373 · 1dc3373
2 parents 8e0f285 + 20546d6
commit 1dc3373
Show file tree

Hide file tree

Showing 12 changed files with 532 additions and 102 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 ## main
+- Refactored the passing of the request to the on office service
+- Added a method to get the last request response pair from the repository
+- Added die and dump functions to the queries
+- Fixed ImprintBuilder cannot return imprint with find
 
 ## v1.3.0
 - Added a throw to stub responses

diff --git a/README.md b/README.md
@@ -131,6 +131,55 @@ Config::set('onoffice.secret', 'secret');
 Config::set('onoffice.api_claim', 'api_claim');
 ```
 
+### Middlewares
+```php
+use Illuminate\Support\Facades\Log;
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::query()
+    ->before(static function (OnOfficeRequest $request) {
+        Log::info('About to send request', [
+            'request' => $request->toArray(),
+        ]);
+    })
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+```
+
+### Debugging
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::query()
+    ->dd()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+```
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::record();
+
+BaseRepository::query()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+$result = BaseRepository::lastRecorded();
+
+/*
+    $result = [
+        OnOfficeRequest,
+        OnOfficeResponse,
+    ];
+*/
+```
+
 ### Usage in tests
 ```php
 use Innobrain\OnOfficeAdapter\Facades\EstateRepository;

diff --git a/docs/BaseRepository.md b/docs/BaseRepository.md
@@ -31,3 +31,97 @@ BaseRepository::query()
         },
     );
 ```
+
+## dd, dump
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::query()
+    ->dd()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+// → will dump the request and die
+```
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::query()
+    ->dump()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+// → will dump the request
+```
+
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::query()
+    ->raw()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+// → will dump the request exactly as fired and die
+```
+
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::record();
+
+BaseRepository::query()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+$result = BaseRepository::lastRecorded();
+
+/*
+    $result = [
+        OnOfficeRequest,
+        OnOfficeResponse,
+    ];
+*/
+```
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::record();
+
+BaseRepository::query()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+$result = BaseRepository::lastRecordedRequest();
+
+/*
+    $result = OnOfficeRequest;
+*/
+```
+```php
+use Innobrain\OnOfficeAdapter\Facades\BaseRepository;
+
+BaseRepository::record();
+
+BaseRepository::query()
+    ->call(new OnOfficeRequest(
+        OnOfficeAction::Read,
+        OnOfficeResourceType::Estate,
+    ));
+
+$result = BaseRepository::lastRecordedResponse();
+
+/*
+    $result = OnOfficeResponse;
+*/
+```
diff --git a/src/Dtos/OnOfficeRequest.php b/src/Dtos/OnOfficeRequest.php
@@ -4,9 +4,11 @@
 
 namespace Innobrain\OnOfficeAdapter\Dtos;
 
+use Illuminate\Support\Carbon;
 use Innobrain\OnOfficeAdapter\Enums\OnOfficeAction;
 use Innobrain\OnOfficeAdapter\Enums\OnOfficeResourceId;
 use Innobrain\OnOfficeAdapter\Enums\OnOfficeResourceType;
+use Innobrain\OnOfficeAdapter\Services\OnOfficeService;
 
 class OnOfficeRequest
 {
@@ -28,4 +30,34 @@ public function toArray(): array
             'parameters' => $this->parameters,
         ];
     }
+
+    public function toRequestArray(): array
+    {
+        /** @var OnOfficeService $onOfficeService */
+        $onOfficeService = app(OnOfficeService::class);
+
+        if (! empty($onOfficeService->getApiClaim())) {
+            $this->parameters = array_replace([OnOfficeService::EXTENDEDCLAIM => $onOfficeService->getApiClaim()], $this->parameters);
+        }
+
+        return [
+            'token' => $onOfficeService->getToken(),
+            'request' => [
+                'actions' => [
+                    [
+                        'actionid' => $this->actionId->value,
+                        'resourceid' => $this->resourceId instanceof OnOfficeResourceId
+                            ? $this->resourceId->value
+                            : $this->resourceId,
+                        'resourcetype' => $this->resourceType->value,
+                        'identifier' => $this->identifier,
+                        'timestamp' => Carbon::now()->timestamp,
+                        'hmac' => $onOfficeService->getHmac($this->actionId, $this->resourceType),
+                        'hmac_version' => 2,
+                        'parameters' => $this->parameters,
+                    ],
+                ],
+            ],
+        ];
+    }
 }
diff --git a/src/Facades/BaseRepository.php b/src/Facades/BaseRepository.php
@@ -5,6 +5,7 @@
 namespace Innobrain\OnOfficeAdapter\Facades;
 
 use Illuminate\Support\Facades\Facade;
+use Innobrain\OnOfficeAdapter\Dtos\OnOfficeRequest;
 use Innobrain\OnOfficeAdapter\Dtos\OnOfficeResponse;
 use Innobrain\OnOfficeAdapter\Dtos\OnOfficeResponsePage;
 use Innobrain\OnOfficeAdapter\Enums\OnOfficeAction;
@@ -87,6 +88,21 @@ public static function stopRecording(): RootRepository
         return static::getFacadeRoot()->stopRecording();
     }
 
+    public static function lastRecorded(): ?array
+    {
+        return static::getFacadeRoot()->lastRecorded();
+    }
+
+    public static function lastRecordedRequest(): ?OnOfficeRequest
+    {
+        return static::getFacadeRoot()->lastRecordedRequest();
+    }
+
+    public static function lastRecordedResponse(): ?array
+    {
+        return static::getFacadeRoot()->lastRecordedResponse();
+    }
+
     public static function assertSent(?callable $callback = null): void
     {
         static::getFacadeRoot()->assertSent($callback);

diff --git a/src/Query/Builder.php b/src/Query/Builder.php
@@ -19,6 +19,7 @@
 use Innobrain\OnOfficeAdapter\Repositories\BaseRepository;
 use Innobrain\OnOfficeAdapter\Services\OnOfficeService;
 use JsonException;
+use Symfony\Component\VarDumper\VarDumper;
 use Throwable;
 
 class Builder implements BuilderInterface
@@ -97,6 +98,11 @@ class Builder implements BuilderInterface
      */
     private ?OnOfficeResponse $responseCache = null;
 
+    /**
+     * The before sending middlewares.
+     */
+    protected array $beforeSendingCallbacks = [];
+
     public function __construct() {}
 
     protected function getOnOfficeService(): OnOfficeService
@@ -130,24 +136,52 @@ public function preventStrayRequests(bool $value = true): static
         return $this;
     }
 
+    public function before(callable $callback): static
+    {
+        $this->beforeSendingCallbacks[] = $callback;
+
+        return $this;
+    }
+
+    public function dump(): static
+    {
+        return $this->before(static function (OnOfficeRequest $request) {
+            VarDumper::dump($request);
+        });
+    }
+
+    public function dd(): static
+    {
+        return $this->before(static function (OnOfficeRequest $request) {
+            VarDumper::dump($request);
+
+            exit(1);
+        });
+    }
+
+    public function raw(): static
+    {
+        return $this->before(static function (OnOfficeRequest $request) {
+            VarDumper::dump($request->toRequestArray());
+
+            exit(1);
+        });
+    }
+
     /**
      * @throws OnOfficeException
      * @throws Throwable
      */
     public function requestApi(OnOfficeRequest $request): Response
     {
+        $request = $this->runBeforeSendingCallbacks($request);
+
         $response = $this->getStubCallable($request);
 
         if (is_null($response)) {
             throw_if($this->preventStrayRequests, new StrayRequestException(request: $request));
 
-            $response = $this->getOnOfficeService()->requestApi(
-                $request->actionId,
-                $request->resourceType,
-                $request->resourceId,
-                $request->identifier,
-                $request->parameters,
-            );
+            $response = $this->getOnOfficeService()->requestApi($request);
         } else {
             $this->getOnOfficeService()->throwIfResponseIsFailed($response);
         }
@@ -157,6 +191,19 @@ public function requestApi(OnOfficeRequest $request): Response
         return $response;
     }
 
+    protected function runBeforeSendingCallbacks(OnOfficeRequest $request): OnOfficeRequest
+    {
+        return tap($request, function (OnOfficeRequest &$request) {
+            collect($this->beforeSendingCallbacks)->each(function (callable $callback) use (&$request) {
+                $result = $callback($request);
+
+                if ($result instanceof OnOfficeRequest) {
+                    $request = $result;
+                }
+            });
+        });
+    }
+
     /**
      * @throws OnOfficeException
      */

diff --git a/src/Query/ImprintBuilder.php b/src/Query/ImprintBuilder.php
@@ -55,11 +55,11 @@ public function first(): ?array
     }
 
     /**
-     * @throws OnOfficeException
+     * @throws Throwable<OnOfficeException>
      */
     public function find(int $id): array
     {
-        $response = $this->onOfficeService->requestApi(
+        $request = new OnOfficeRequest(
             OnOfficeAction::Read,
             OnOfficeResourceType::Impressum,
             resourceId: $id,
@@ -69,6 +69,7 @@ public function find(int $id): array
             ]
         );
 
-        return $response->json('response.results.0.data.records.0');
+        return $this->requestApi($request)
+            ->json('response.results.0.data.records.0');
     }
 }
diff --git a/src/Repositories/BaseRepository.php b/src/Repositories/BaseRepository.php
@@ -186,6 +186,21 @@ public function recordRequestResponsePair(OnOfficeRequest $request, array $respo
         return $this;
     }
 
+    public function lastRecorded(): ?array
+    {
+        return collect($this->recorded)->last();
+    }
+
+    public function lastRecordedRequest(): ?OnOfficeRequest
+    {
+        return collect($this->recorded)->last()[0] ?? null;
+    }
+
+    public function lastRecordedResponse(): ?array
+    {
+        return collect($this->recorded)->last()[1] ?? null;
+    }
+
     /**
      * Get a collection of the request / response pairs matching the given truth test.
      */