Merge pull request #136 from Facts-and-Files/feat/transcritpion

feat: new transcritpion endpoints

src/.env.example

@@ -22,10 +22,6 @@ QUEUE_CONNECTION=sync
 SESSION_DRIVER=file
 SESSION_LIFETIME=120
 
-L5_SWAGGER_GENERATE_ALWAYS=false
-L5_FORMAT_TO_USE_FOR_DOCS=yaml
-L5_SWAGGER_UI_PERSIST_AUTHORIZATION=true
-
 MEMCACHED_HOST=127.0.0.1
 
 REDIS_HOST=127.0.0.1

src/app/Http/Controllers/TranscriptionController.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\JsonResponse;
+use App\Http\Controllers\ResponseController;
+use App\Models\Transcription;
+use App\Http\Resources\TranscriptionResource;
+
+class TranscriptionController extends ResponseController
+{
+    public function index(Request $request): JsonResponse
+    {
+        $queryColumns = [
+            'ItemId' => 'ItemId',
+            'UserId' => 'UserId',
+            'EuropeanaAnnotationId' => 'EuropeanaAnnotationId',
+            'CurrentVersion' => 'CurrentVersion',
+        ];
+
+        $initialSortColumn = 'TranscriptionId';
+
+        $model = new Transcription();
+
+        if ($request['CurrentVersion']) {
+            $request['CurrentVersion'] = $request->boolean('CurrentVersion');
+        }
+
+        $data = $this->getDataByRequest($request, $model, $queryColumns, $initialSortColumn);
+
+        if (!$data) {
+            return $this->sendError('Invalid data', $request . ' not valid', 400);
+        }
+
+        $collection = TranscriptionResource::collection($data);
+
+        return $this->sendResponseWithMeta($collection, 'Transcriptions fetched.');
+    }
+
+    public function show(int $id): JsonResponse
+    {
+        try {
+            $data = Transcription::findOrFail($id);
+            $resource = new TranscriptionResource($data);
+
+            return $this->sendResponse($resource, 'Transcription fetched.');
+        } catch (\Exception $exception) {
+            return $this->sendError('Not found', $exception->getMessage());
+        }
+    }
+
+    public function store(Request $request): JsonResponse
+    {
+        try {
+            $data = new Transcription();
+
+            $data->fill($request->all());
+
+            $data->CurrentVersion = true;
+            $data->save();
+
+            Transcription::where('ItemId', $data->ItemId)
+                ->where('CurrentVersion', '=', true)
+                ->where('TranscriptionId', '!=', $data->TranscriptionId)
+                ->update(['CurrentVersion' => false]);
+
+            return $this->sendResponse(new TranscriptionResource($data), 'Transcription inserted.');
+        } catch (\Exception $exception) {
+            return $this->sendError('Invalid data', $exception->getMessage(), 400);
+        }
+    }
+}

src/app/Http/Resources/TranscriptionResource.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class TranscriptionResource extends JsonResource
+{
+    public function toArray($request): array
+    {
+        return parent::toArray($request);
+    }
+}

src/app/Models/Transcription.php

@@ -13,5 +13,10 @@ class Transcription extends Model
 
     protected $primaryKey = 'TranscriptionId';
 
-    protected  $casts = ['CurrentVersion' => 'boolean'];
+    protected  $casts = [
+        'CurrentVersion' => 'boolean',
+        'NoText' => 'boolean',
+    ];
+
+    protected $guarded = ['CurrentVersion'];
 }

src/app/Providers/AppServiceProvider.php

@@ -13,7 +13,10 @@ class AppServiceProvider extends ServiceProvider
      */
     public function register()
     {
-        //
+        if ($this->app->environment('local')) {
+            $this->app->register(\Laravel\Telescope\TelescopeServiceProvider::class);
+            $this->app->register(TelescopeServiceProvider::class);
+        }
     }
 
     /**

src/app/Providers/TelescopeServiceProvider.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\Facades\Gate;
+use Laravel\Telescope\IncomingEntry;
+use Laravel\Telescope\Telescope;
+use Laravel\Telescope\TelescopeApplicationServiceProvider;
+
+class TelescopeServiceProvider extends TelescopeApplicationServiceProvider
+{
+    /**
+     * Register any application services.
+     */
+    public function register(): void
+    {
+        // Telescope::night();
+
+        $this->hideSensitiveRequestDetails();
+
+        $isLocal = $this->app->environment('local');
+
+        Telescope::filter(function (IncomingEntry $entry) use ($isLocal) {
+            return $isLocal ||
+                   $entry->isReportableException() ||
+                   $entry->isFailedRequest() ||
+                   $entry->isFailedJob() ||
+                   $entry->isScheduledTask() ||
+                   $entry->hasMonitoredTag();
+        });
+    }
+
+    /**
+     * Prevent sensitive request details from being logged by Telescope.
+     */
+    protected function hideSensitiveRequestDetails(): void
+    {
+        if ($this->app->environment('local')) {
+            return;
+        }
+
+        Telescope::hideRequestParameters(['_token']);
+
+        Telescope::hideRequestHeaders([
+            'cookie',
+            'x-csrf-token',
+            'x-xsrf-token',
+        ]);
+    }
+
+    /**
+     * Register the Telescope gate.
+     *
+     * This gate determines who can access Telescope in non-local environments.
+     */
+    protected function gate(): void
+    {
+        Gate::define('viewTelescope', function ($user) {
+            return in_array($user->email, [
+                //
+            ]);
+        });
+    }
+}

src/composer.json

@@ -15,6 +15,7 @@
     },
     "require-dev": {
         "laravel/pint": "^1.1",
+        "laravel/telescope": "^5.3",
         "mockery/mockery": "^1.4.4",
         "nunomaduro/collision": "^6.0",
         "phpunit/phpunit": "^9.5.10"
@@ -48,7 +49,9 @@
     },
     "extra": {
         "laravel": {
-            "dont-discover": []
+            "dont-discover": [
+                "laravel/telescope"
+            ]
         }
     },
     "config": {

src/config/app.php

@@ -174,6 +174,7 @@
         // App\Providers\BroadcastServiceProvider::class,
         App\Providers\EventServiceProvider::class,
         App\Providers\RouteServiceProvider::class,
+        // App\Providers\TelescopeServiceProvider::class,
 
     ],