Merge pull request #152 from codebar-ag/feature-l11

Feature l11
codebar-ag · Jul 31, 2024 · 2e46af5 · 2e46af5
2 parents 44fb052 + 9d597a8
commit 2e46af5
Show file tree

Hide file tree

Showing 15 changed files with 302 additions and 188 deletions.
diff --git a/.phpunit.cache/test-results b/.phpunit.cache/test-results
diff --git a/README.md b/README.md
@@ -214,7 +214,7 @@ $connector = new DocuWareConnector(
 );
 ```
 
-### Extending the connector
+### Extending the connector (EXAMPLE)
 
 We understand it may be repetitive to pass the configuration every time you create a new connector.
 
@@ -230,7 +230,7 @@ namespace App\Connectors;
 use CodebarAg\DocuWare\Connectors\DocuWareConnector;
 use CodebarAg\DocuWare\DTO\Config\ConfigWithCredentials;
 
-class CustomDocuWareConnector extends DocuWareConnector
+class YourOwnDocuWareConnector extends DocuWareConnector
 {
     public function __construct() {
         $configuration = new ConfigWithCredentials(
@@ -249,7 +249,7 @@ class CustomDocuWareConnector extends DocuWareConnector
 use App\Connectors\CustomDocuWareConnector;
 use CodebarAg\DocuWare\DTO\Config\ConfigWithCredentials;
 
-$connector = new CustomDocuWareConnector();
+$connector = new YourOwnDocuWareConnector();
 ```
 
 
@@ -461,6 +461,7 @@ $image = $connector->send(new GetDocumentPreviewRequest($fileCabinetId, $documen
 #### Create Data Record
 ```php
 use CodebarAg\DocuWare\Requests\FileCabinets\Upload\CreateDataRecord;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTextDTO;
 
 $document = $connector->send(new CreateDataRecord(
     $fileCabinetId,
@@ -472,9 +473,48 @@ $document = $connector->send(new CreateDataRecord(
 ))->dto();
 ```
 
+#### Create Table Data Record
+```php
+use CodebarAg\DocuWare\Requests\FileCabinets\Upload\CreateDataRecord;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateTimeDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDecimalDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexNumericDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTableDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTextDTO;
+
+$tableRows = collect([
+    collect([
+        IndexTextDTO::make('TEXT', 'project_1'),
+        IndexNumericDTO::make('INT', 1),
+        IndexDecimalDTO::make('DECIMAL', 1.1),
+        IndexDateDTO::make('DATE', $now),
+        IndexDateTimeDTO::make('DATETIME', $now),
+    ]),
+    collect([
+        IndexTextDTO::make('TEXT', 'project_2'),
+        IndexNumericDTO::make('INT', 2),
+        IndexDecimalDTO::make('DECIMAL', 2.2),
+        IndexDateDTO::make('DATE', $now),
+        IndexDateTimeDTO::make('DATETIME', $now),
+    ]),
+]);
+
+
+$document = $connector->send(new CreateDataRecord(
+    $fileCabinetId,
+    null,
+    null,
+    collect([
+        IndexTableDTO::make('TABLE_NAME', $tableRows)
+    ]),
+))->dto();
+```
+
 #### Update Index Values
 ```php
 use CodebarAg\DocuWare\Requests\Documents\UpdateIndexValues\UpdateIndexValues;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO;
 
 $response = $connector->send(new UpdateIndexValues(
     $fileCabinetId,
@@ -484,6 +524,44 @@ $response = $connector->send(new UpdateIndexValues(
     ])
 ))->dto();
 ```
+
+#### Update Table Data Record
+```php
+use CodebarAg\DocuWare\Requests\Documents\UpdateIndexValues\UpdateIndexValues;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateTimeDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDecimalDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexNumericDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTableDTO;
+use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTextDTO;
+
+$tableRows = collect([
+    collect([
+        IndexTextDTO::make('TEXT', 'project_1'),
+        IndexNumericDTO::make('INT', 1),
+        IndexDecimalDTO::make('DECIMAL', 1.1),
+        IndexDateDTO::make('DATE', $now),
+        IndexDateTimeDTO::make('DATETIME', $now),
+    ]),
+    collect([
+        IndexTextDTO::make('TEXT', 'project_2'),
+        IndexNumericDTO::make('INT', 2),
+        IndexDecimalDTO::make('DECIMAL', 2.2),
+        IndexDateDTO::make('DATE', $now),
+        IndexDateTimeDTO::make('DATETIME', $now),
+    ]),
+]);
+
+
+$document = $connector->send(new UpdateIndexValues(
+    $fileCabinetId,
+    null,
+    null,
+    collect([
+        IndexTableDTO::make('TABLE_NAME', $tableRows)
+    ]),
+))->dto();
+```
 </details>
 
 
@@ -1017,51 +1095,43 @@ CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTextDTO {
 
 ```php
 CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexNumericDTO {
-  +name: "FIELD_NUMERIC"                                 // string
-  +value: 1                                             // null|int
+  +name: "FIELD_NUMERIC"                            // string
+  +value: 1                                         // null|int
 }
 ```
 
 ```php
 CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDecimalDTO {
-  +name: "FIELD_DECIMAL"                                  // string
-  +value: 1.00                                           // null|int|float
+  +name: "FIELD_DECIMAL"                            // string
+  +value: 1.00                                      // null|int|float
 }
 ```
 
 ```php
- {
-  +name: "FIELD_DATE"                                      // string
-  +value: now(),                                           // null|Carbon
+CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO {
+  +name: "FIELD_DATE"                               // string
+  +value: now(),                                    // null|Carbon
 }
 ```
 
 ```php
- {
-  +name: "FIELD_DATETIME"                                     // string
-  +value: now(),                                             // null|Carbon
+CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateTimeDTO {
+  +name: "FIELD_DATETIME"                           // string
+  +value: now(),                                    // null|Carbon
 }
 ```
 
 ```php
- {
-  +name: "FIELD_TABLE"                                        // string
-  +value: collect([
-      0 => [
-         [
-            'NAME' => 'TABLE_ID',
-            'VALUE' => '1',
-         ],
-         [
-            'NAME' => 'TABLE_DATE',
-            'VALUE' => Carbon::class 
-         ],
-         [
-            'NAME' => 'TABLE_DECIMALE',
-            'VALUE' => 1.00,
-         ],
-      ]
-])                                                         // null|Collection|array
+CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexKeywordDTO {
+  +name: "FIELD_KEYWORD"                            // string
+  +value: "Value"                                   // null|string
+}
+```
+
+```php
+CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexMemoDTO {
+  +name: "FIELD_MEMO"                               // string
+  +value: "Value"                                   // null|string
 }
 ```
 

diff --git a/src/Connectors/DocuWareConnector.php b/src/Connectors/DocuWareConnector.php
@@ -89,7 +89,7 @@ protected function getOrCreateNewOAuthToken()
 
     protected function getAuthenticationTokenEndpoint(): IdentityServiceConfiguration
     {
-        $responsibleIdentityServiceResponse = (new GetResponsibleIdentityService)->send();
+        $responsibleIdentityServiceResponse = (new GetResponsibleIdentityService($this->configuration->url))->send();
 
         $identityServiceConfigurationResponse = (new GetIdentityServiceConfiguration(
             identityServiceUrl: $responsibleIdentityServiceResponse->dto()->identityServiceUrl

diff --git a/src/DTO/Documents/DocumentIndex/IndexKeywordDTO.php b/src/DTO/Documents/DocumentIndex/IndexKeywordDTO.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace CodebarAg\DocuWare\DTO\Documents\DocumentIndex;
+
+class IndexKeywordDTO
+{
+    public function __construct(
+        public string $name,
+        public ?string $value,
+    ) {}
+
+    public static function make(string $name, ?string $value): self
+    {
+        return new self($name, $value);
+    }
+
+    public function values(): array
+    {
+        return [
+            'FieldName' => $this->name,
+            'Item' => $this->value,
+            'ItemElementName' => 'Keyword',
+        ];
+    }
+}
diff --git a/src/DTO/Documents/DocumentIndex/IndexMemoDTO.php b/src/DTO/Documents/DocumentIndex/IndexMemoDTO.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace CodebarAg\DocuWare\DTO\Documents\DocumentIndex;
+
+class IndexMemoDTO
+{
+    public function __construct(
+        public string $name,
+        public ?string $value,
+    ) {}
+
+    public static function make(string $name, ?string $value): self
+    {
+        return new self($name, $value);
+    }
+
+    public function values(): array
+    {
+        return [
+            'FieldName' => $this->name,
+            'Item' => $this->value,
+            'ItemElementName' => 'Memo',
+        ];
+    }
+}
diff --git a/src/DTO/Documents/DocumentIndex/IndexTableDTO.php b/src/DTO/Documents/DocumentIndex/IndexTableDTO.php
@@ -2,7 +2,6 @@
 
 namespace CodebarAg\DocuWare\DTO\Documents\DocumentIndex;
 
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
 class IndexTableDTO
@@ -12,7 +11,7 @@ public function __construct(
         public null|Collection|array $rows,
     ) {}
 
-    public static function make(string $name, null|Collection|array $rows): self
+    public static function make(string $name, Collection|array $rows): self
     {
         return new self($name, $rows);
     }
@@ -32,40 +31,18 @@ public function values(): array
     protected function rowsCollection(): array
     {
         return collect($this->rows ?? [])->map(function ($row) {
-
-            $indexes = collect($row)->map(function ($column) {
-
-                if (! Arr::has($column, ['NAME', 'VALUE'])) {
-                    return null;
-                }
-
-                $name = Arr::get($column, 'NAME');
-                $value = Arr::get($column, 'VALUE');
-
-                return PrepareTableDTO::make($name, $value);
-
-            })
-                ->filter()
-                ->values();
-
-            if ($indexes->isEmpty()) {
-                return null;
-            }
-
-            return self::makeRowContent($indexes);
-
+            return self::makeRowContent(collect($row));
         })
             ->filter()
             ->values()
             ->toArray();
-
     }
 
     public static function makeRowContent(Collection $indexes): array
     {
         return [
             'ColumnValue' => $indexes
-                ->map(fn (IndexTextDTO|IndexDateDTO|IndexDecimalDTO $index) => $index->values())
+                ->map(fn (IndexTextDTO|IndexNumericDTO|IndexDecimalDTO|IndexDateDTO|IndexDateTimeDTO|IndexKeywordDTO|IndexMemoDTO $index) => $index->values())
                 ->filter()
                 ->values()
                 ->toArray(),

diff --git a/src/DTO/Documents/DocumentIndex/PrepareDTO.php b/src/DTO/Documents/DocumentIndex/PrepareDTO.php
@@ -6,24 +6,11 @@
 
 class PrepareDTO
 {
-    public static function guess(string $name, mixed $value): mixed
-    {
-        $type = gettype($value);
-
-        return match ($type) {
-            'integer' => IndexNumericDTO::make($name, $value),
-            'string' => IndexTextDTO::make($name, $value),
-            'double' => IndexDecimalDTO::make($name, $value),
-            'object' => IndexDateDTO::makeWithFallback($name, $value),
-            default => null,
-        };
-    }
-
     public static function makeFields(Collection $indexes): array
     {
         return [
             'Fields' => $indexes
-                ->map(fn (IndexTextDTO|IndexDateDTO|IndexDateTimeDTO|IndexNumericDTO|IndexDecimalDTO|IndexTableDTO $index) => $index->values())
+                ->map(fn (IndexTextDTO|IndexDateDTO|IndexDateTimeDTO|IndexNumericDTO|IndexDecimalDTO|IndexTableDTO|IndexKeywordDTO|IndexMemoDTO $index) => $index->values())
                 ->filter()
                 ->values(),
         ];
@@ -33,7 +20,7 @@ public static function makeField(Collection $indexes, bool $forceUpdate = false)
     {
         return [
             'Field' => $indexes
-                ->map(fn (IndexTextDTO|IndexDateDTO|IndexDateTimeDTO|IndexNumericDTO|IndexDecimalDTO|IndexTableDTO $index) => $index->values())
+                ->map(fn (IndexTextDTO|IndexDateDTO|IndexDateTimeDTO|IndexNumericDTO|IndexDecimalDTO|IndexTableDTO|IndexKeywordDTO|IndexMemoDTO $index) => $index->values())
                 ->filter()
                 ->values(),
             'ForceUpdate' => $forceUpdate,

diff --git a/src/DTO/Documents/DocumentIndex/PrepareTableDTO.php b/src/DTO/Documents/DocumentIndex/PrepareTableDTO.php
diff --git a/src/Requests/Authentication/OAuth/GetResponsibleIdentityService.php b/src/Requests/Authentication/OAuth/GetResponsibleIdentityService.php
@@ -18,6 +18,10 @@ class GetResponsibleIdentityService extends SoloRequest implements Cacheable
 
     protected Method $method = Method::GET;
 
+    public function __construct(
+        protected ?string $url = null
+    ) {}
+
     public function resolveEndpoint(): string
     {
         $base = config('laravel-docuware.credentials.url').'/DocuWare/Platform';

diff --git a/tests/Feature/Requests/FileCabinets/Search/GetDocumentsFromAFileCabinetTest.php b/tests/Feature/Requests/FileCabinets/Search/GetDocumentsFromAFileCabinetTest.php
@@ -23,5 +23,7 @@
         config('laravel-docuware.tests.file_cabinet_id')
     ))->dto();
 
+    ray($documents);
+
     Event::assertDispatched(DocuWareResponseLog::class);
 });