feat: introduce DEI import endpoint, marks new major release

.gitignore

@@ -3,6 +3,7 @@
 /src/public/storage
 /src/storage/*.key
 /src/storage/export_cache
+/src/storage/imports
 /src/vendor
 /local-data
 .env*

Makefile

@@ -46,6 +46,10 @@ test: serve
 	@clear
 	@bash docker_artisan.sh test --without-tty --colors=always --filter "$(FILTER)"
 
+stan: serve
+	@clear
+	./src/vendor/bin/phpstan analyze src/app src/database src/config src/routes --level "$(LEVEL)"
+
 lint: serve
 	@clear
 	./src/vendor/bin/pint --test -v src/app src/tests src/routes --preset per

src/.env.example

@@ -43,3 +43,7 @@ MAIL_PASSWORD=password
 MAIL_ENCRYPTION=tls
 MAIL_FROM_ADDRESS="no-reply@example.com"
 MAIL_FROM_NAME="Transcribathon"
+
+ENRICH_EUROPEANA_IIIF_SSO_URL=sso_url
+ENRICH_EUROPEANA_IIIF_CLIENT_SECRET=secret
+ENRICH_EUROPEANA_IIIF_CLIENT_ID=client

src/app/Console/Commands/GenerateAuthToken.php

@@ -14,7 +14,7 @@ class GenerateAuthToken extends Command
         {--ro : Shorthand for read-only}
         {--rw : Shorthand for full access}';
 
-        protected $description = 'Generates an api client auth token for api usage';
+    protected $description = 'Generates an api client auth token for api usage';
 
     public function handle(): int
     {

src/app/Console/Kernel.php

@@ -27,7 +27,7 @@ protected function schedule(Schedule $schedule)
      */
     protected function commands()
     {
-        $this->load(__DIR__.'/Commands');
+        $this->load(__DIR__ . '/Commands');
 
         require base_path('routes/console.php');
     }

src/app/Exceptions/AltoNotPreparedException.php

@@ -9,12 +9,11 @@
 
 final class AltoNotPreparedException extends RuntimeException
 {
-
     public function __construct(
         private readonly int $storyId,
         string $message = 'The ALTO export has not been prepared.',
         int $code = 0,
-        ?Throwable $previous = null
+        ?Throwable $previous = null,
     ) {
         parent::__construct($message, $code, $previous);
     }
@@ -27,7 +26,7 @@ public function render($_request): JsonResponse
                 'prepare_post_url' => url("/stories/{$this->storyId}/items/export/mets"),
                 $this->getMessage(),
             ],
-            409
+            409,
         );
     }
 }

src/app/Exceptions/Handler.php

@@ -2,19 +2,15 @@
 
 namespace App\Exceptions;
 
-use App\Exceptions\AltoNotPreparedException;
 use App\Http\Controllers\ResponseController;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
-use Illuminate\Http\JsonResponse;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Validation\ValidationException;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
-use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
-
 class Handler extends ExceptionHandler
 {
     /**
@@ -44,12 +40,12 @@ public function register(): void
         });
     }
 
-    protected function unauthenticated($request, AuthenticationException $exception): JsonResponse
+    protected function unauthenticated($request, AuthenticationException $exception)
     {
         return ResponseController::sendError($exception->getMessage(), '', 401);
     }
 
-    public function render($request, Throwable $exception): Response
+    public function render($request, Throwable $exception)
     {
         if ($exception instanceof AuthenticationException) {
             return ResponseController::sendError($exception->getMessage(), '', 401);

src/app/Http/Controllers/AutoEnrichmentController.php

@@ -2,9 +2,9 @@
 
 namespace App\Http\Controllers;
 
+use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
-use App\Http\Controllers\ResponseController;
 use App\Models\AutoEnrichment;
 use App\Models\Item;
 use App\Models\Story;
@@ -18,7 +18,7 @@ public function index(Request $request): JsonResponse
             'Name' => 'Name',
             'Type' => 'Type',
             'StoryId' => 'StoryId',
-            'ItemId' => 'ItemId'
+            'ItemId' => 'ItemId',
         ];
 
         $initialSortColumn = 'AutoEnrichmentId';
@@ -27,8 +27,8 @@ public function index(Request $request): JsonResponse
 
         $data = $this->getDataByRequest($request, $model, $queryColumns, $initialSortColumn);
 
-        if(!$data) {
-            return $this->sendError('Invalid data', $request, ' not valid', 400);
+        if (!$data) {
+            return $this->sendError('Invalid data', $request . ' not valid', 400);
         }
 
         $collection = AutoEnrichmentResource::collection($data);
@@ -48,7 +48,7 @@ public function store(Request $request): JsonResponse
             $resource = new AutoEnrichmentResource($data);
 
             return $this->sendResponse($resource, 'Auto Enrichment inserted.');
-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }
@@ -76,22 +76,23 @@ public function storeBulk(Request $request): JsonResponse
         }
 
         $instertedResource = new AutoEnrichmentResource($inserted);
-        $errorResource = new AutoEnrichmentResource($errors);
 
         $insertedCount = count($inserted);
         $errorsCount = count($errors);
 
-        if ($insertedCount === 0 && $errorsCount > 0) {
-            return $this->sendError('Invalid data', $errors, 400);
+        if ($errorsCount > 0 && $insertedCount > 0) {
+            return $this->sendPartlyResponse($instertedResource, $errors, 'Some Auto Enrichments inserted.');
         }
 
-        if ($insertedCount > 0 && $errorsCount === 0) {
-            return $this->sendResponse($instertedResource, 'All Auto Enrichments inserted.');
+        if ($errorsCount > 0) {
+            return $this->sendError('Invalid data', $errors, 400);
         }
 
-        if ($insertedCount > 0 && $errorsCount > 0) {
-            return $this->sendPartlyResponse($instertedResource, $errorResource, 'Some Auto Enrichments inserted.');
+        if ($insertedCount === 0) {
+            return $this->sendError('Invalid data', 'Nothing imported.', 400);
         }
+
+        return $this->sendResponse($instertedResource, 'All Auto Enrichments inserted.');
     }
 
     public function show(int $id): JsonResponse
@@ -134,7 +135,7 @@ public function update(Request $request, int $id): JsonResponse
             $autoEnrichmentData->save();
 
             return $this->sendResponse(new AutoEnrichmentResource($autoEnrichmentData), 'Auto Enrichment updated.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }
@@ -148,7 +149,7 @@ public function destroy(int $id): JsonResponse
             $autoEnrichmentData->delete();
 
             return $this->sendResponse($resource, 'Auto Enrichment deleted.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }

src/app/Http/Controllers/CampaignController.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
-use App\Http\Controllers\ResponseController;
 use App\Models\Campaign;
 use App\Http\Resources\CampaignResource;
 
@@ -14,7 +13,7 @@ public function index(Request $request): JsonResponse
     {
         $queryColumns = [
             'Name' => 'Name',
-            'DatasetId' => 'DatasetId'
+            'DatasetId' => 'DatasetId',
         ];
 
         $initialSortColumn = 'CampaignId';
@@ -81,7 +80,7 @@ public function update(Request $request, int $id): JsonResponse
             }
 
             return $this->sendResponse(new CampaignResource($campaign), 'Campaign updated.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }
@@ -95,7 +94,7 @@ public function destroy(int $id): JsonResponse
             $campaign->delete();
 
             return $this->sendResponse($resource, 'Campaign deleted.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }

src/app/Http/Controllers/CampaignStatsController.php

@@ -2,7 +2,6 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Controllers\ResponseController;
 use App\Http\Resources\CampaignStatsResource;
 use App\Models\Campaign;
 use App\Models\Score;
@@ -43,7 +42,7 @@ public function show(int $id): JsonResponse
                 'CampaignId' => $id,
                 'Summary'    => $summary,
                 'Teams'      => $teams,
-                'Users'      => $users
+                'Users'      => $users,
             ];
 
             $resource = new CampaignStatsResource($grouped);
@@ -67,7 +66,7 @@ protected function buildTeamStatistics(int $campaignId): array
         foreach ($campaign->teams as $team) {
             $teamStats = [
                 'TeamId' => $team['TeamId'],
-                'Miles' => 0
+                'Miles' => 0,
             ];
 
             $teamScoreIds = DB::table('TeamScore')
@@ -99,7 +98,7 @@ protected function buildTeamStatistics(int $campaignId): array
                 ->filter(function ($story) use ($teamCampaignScores) {
                     $itemIds = array_merge(
                         $story->ItemIds->all(),
-                        $teamCampaignScores->pluck('ItemId')->all()
+                        $teamCampaignScores->pluck('ItemId')->all(),
                     );
                     return count(array_unique($itemIds)) > 0 ? true : false;
                 })
@@ -132,7 +131,7 @@ protected function buildStatistics(Collection $collection): array
             'Enrichments'          => $collection->pluck('Enrichments')->sum(),
             'Descriptions'         => $collection->pluck('Descriptions')->sum(),
             'HTRTranscriptions'    => $collection->pluck('HTRTranscriptions')->sum(),
-            'Miles'                => ceil($collection->pluck('Miles')->sum())
+            'Miles'                => ceil($collection->pluck('Miles')->sum()),
         ];
     }
 }

src/app/Http/Controllers/Controller.php

@@ -9,5 +9,7 @@
 
 class Controller extends BaseController
 {
-    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+    use AuthorizesRequests;
+    use DispatchesJobs;
+    use ValidatesRequests;
 }

src/app/Http/Controllers/DatasetController.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
-use App\Http\Controllers\ResponseController;
 use App\Models\Dataset;
 use App\Http\Resources\DatasetResource;
 
@@ -14,7 +13,7 @@ public function index(Request $request): JsonResponse
     {
         $queryColumns = [
             'Name' => 'Name',
-            'ProjectId' => 'ProjectId'
+            'ProjectId' => 'ProjectId',
         ];
 
         $initialSortColumn = 'DatasetId';
@@ -71,7 +70,7 @@ public function update(Request $request, int $id): JsonResponse
             $dataset->save();
 
             return $this->sendResponse(new DatasetResource($dataset), 'Dataset updated.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }
@@ -90,7 +89,7 @@ public function destroy(int $id): JsonResponse
             $dataset->delete();
 
             return $this->sendResponse($resource, 'Dataset deleted.');
-        } catch(\Exception $exception) {
+        } catch (\Exception $exception) {
             return $this->sendError('Invalid data', $exception->getMessage(), 400);
         }
     }

src/app/Http/Controllers/HealthController.php

@@ -2,10 +2,10 @@
 
 namespace App\Http\Controllers;
 
+use Exception;
 use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\DB;
-use App\Http\Controllers\ResponseController;
 use App\Http\Resources\HealthResource;
 
 class HealthController extends ResponseController
@@ -66,7 +66,7 @@ protected function checkDatabaseConnection(): array
 
             $data['conected'] = 'Ok' ;
             $data['time'] = round(($end - $start) * 1000);
-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {
             $data['conected'] = 'Failed';
             $data['time'] = 0;
         }
@@ -82,7 +82,7 @@ protected function checkDatabaseExecutionTime(): int
             $end = microtime(true);
 
             return round(($end - $start) * 1000);
-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {
             return 0;
         }
     }
@@ -102,7 +102,8 @@ protected function checkNetworkConnection(): array
                 $data['conected'] = 'Ok';
                 $data['time'] = round(($end - $start) * 1000);
             }
-        } catch(Exception $exception) { }
+        } catch (Exception $exception) {
+        }
 
         return $data;
     }
@@ -117,8 +118,8 @@ protected function checkApiV1Connection(): array
             $start = microtime(true);
 
             $ch = curl_init();
-            curl_setopt($ch, CURLOPT_URL,'http://transcribathon.eu/tp-api/projects/');
-            curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
+            curl_setopt($ch, CURLOPT_URL, 'http://transcribathon.eu/tp-api/projects/');
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
             curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
             curl_setopt($ch, CURLOPT_TIMEOUT, 30);
 
@@ -134,7 +135,8 @@ protected function checkApiV1Connection(): array
             }
 
             curl_close($ch);
-        } catch (Exception $exception) { }
+        } catch (Exception $exception) {
+        }
 
         return $data;
     }