Integrate new functionalities

Author: midesweb

README.md

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EscuelaIT\APIKit;
+
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Validator;
+use Negartarh\APIWrapper\Facades\APIResponse;
+
+trait ActionHandler
+{
+    public function handleAction(ActionService $actionService) {
+        $user = Auth::user();
+
+        $validator = Validator::make(request()->all(), [
+            'type' => ['required', 'string', 'max:250'],
+            'relatedIds' => ['required', 'array'],
+            'data' => ['present'],
+        ]);
+
+        if($validator->fails()) {
+            return APIResponse::unprocessableEntity($validator->errors());
+        }
+
+        if(! $actionService->hasActionType(request()->type)) {
+            return APIResponse::unprocessableEntity([], 'The action type is not valid.');
+        }
+
+        $response = $actionService->processAction($validator->validated(), $user);
+        if ($response->isSuccess()) {
+            return APIResponse::ok($response->getData(), $response->getMessage());
+        }
+        return APIResponse::unprocessableEntity($response->getErrors(), $response->getMessage());
+    }
+}

README_es.md

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EscuelaIT\APIKit;
+
+class ActionResult
+{
+  private bool $success;
+  private array $errors = [];
+  private string $message;
+  private array $data = [];
+
+  private function __construct($success, $message = '', $errors = [], $data = []) {
+    $this->success = $success;
+    $this->message = $message;
+    $this->errors = $errors;
+    $this->data = $data;
+  }
+
+  public static function success(string $message = 'Ok', array $data = []): self {
+    return new self(true, $message, [], $data);
+  }
+
+  public static function error(array $errors = [], string $message = 'Error'): self {
+    $normalizedErrors = [];
+    foreach ($errors as $field => $value) {
+      $normalizedErrors[$field] = is_string($value) ? [$value] : $value;
+    }
+
+    return new self(false, $message, $normalizedErrors);
+  }
+
+  public function isSuccess(): bool {
+    return $this->success;
+  }
+  public function getErrors(): array {
+    return $this->errors;
+  }
+  public function getMessage(): string {
+    return $this->message;
+  }
+  public function getData(): array {
+    return $this->data;
+  }
+
+  public function toArray(): array {
+    return [
+      'success' => $this->success,
+      'errors' => $this->errors,
+      'message' => $this->message,
+      'data' => $this->data,
+    ];
+  }
+}

src/ActionHandler.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EscuelaIT\APIKit;
+
+use Illuminate\Notifications\Action;
+use EscuelaIT\APIKit\Exceptions\ActionModelNotDefinedException;
+
+class ActionService
+{
+    protected string $actionModel;
+    protected array $actionTypes = [];
+    protected int $maxModelsPerAction = 100;
+    protected string $identifierField = 'id';
+    protected array $actionData;
+    protected $query;
+    protected $user;
+
+    public function hasActionType(string $type): bool
+    {
+        return isset($this->actionTypes[$type]);
+    }
+
+    public function processAction($actionData, $user): ActionResult {
+      $this->actionData = $actionData;
+      $this->user = $user;
+      $this->query = $this->createQuery();
+      $this->queryModels();
+
+      if($this->query->count() > $this->maxModelsPerAction) {
+        return ActionResult::error(
+          [],
+          "The number of models to process exceeds the maximum allowed ({$this->maxModelsPerAction})."
+        );
+      }
+
+      return $this->getActionClass()->processAction();
+    }
+
+    protected function createQuery()
+    {
+        if (empty($this->actionModel)) {
+            throw new ActionModelNotDefinedException(static::class);
+        }
+        return $this->actionModel::query();
+    }
+
+    public function queryModels() {
+      return $this->query->whereIn($this->identifierField, $this->actionData['relatedIds']);
+    }
+
+    private function getModels() {
+      return $this->query->get();
+    }
+
+    private function getActionClass() : CrudAction
+    {
+      $actionClass = $this->actionTypes[$this->actionData['type']];
+      return new $actionClass($this->getModels(), $this->actionData['data'], $this->user);
+    }
+}

src/ActionResult.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace EscuelaIT\APIKit\Actions;
+
+use EscuelaIT\APIKit\CrudAction;
+use EscuelaIT\APIKit\ActionResult;
+use EscuelaIT\APIKit\Exceptions\UnauthenticatedActionException;
+
+class DeleteAction extends CrudAction {
+    public function handle(): ActionResult {
+        if(! $this->user) {
+            throw new UnauthenticatedActionException();
+        }
+        $numDeleted = 0;
+        $deleteElems = [];
+        foreach($this->models as $model) {
+            if($this->user->can('delete', $model)) {
+                $model->delete();
+                $deleteElems[] = $model->id;
+                $numDeleted++;
+            }
+        }
+        $message = "Borrados $numDeleted " . ($numDeleted == 1 ? 'elemento' : 'elementos') . " con éxito";
+        return $this->createActionResultSuccess($message, [
+            'delete_count' => $numDeleted,
+            'delete_elems' => $deleteElems,
+        ]);
+    }
+}

src/ActionService.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EscuelaIT\APIKit;
+
+use Illuminate\Notifications\Action;
+use Illuminate\Support\Facades\Validator;
+
+abstract class CrudAction
+{
+
+    protected $models;
+    protected $data;
+    protected $user;
+    protected $validationErrors;
+
+    public function __construct($models, $data, $user) {
+        $this->models = $models;
+        $this->data = $data;
+        $this->user = $user;
+    }
+
+    abstract public function handle(): ActionResult;
+
+    public function processAction(): ActionResult
+    {
+        if( $this->isValidData() ) {
+            return $this->handle();
+        } else {
+            return ActionResult::error(
+                $this->validationErrors ?? [],
+                'The provided data is not valid.'
+            );
+        }
+    }
+
+    protected function validationRules(): array {
+        return [];
+    }
+
+    protected function isValidData(): bool {
+        $validator = Validator::make($this->data, $this->validationRules());
+        $this->validationErrors = $validator->errors()->toArray();
+        return ! $validator->fails();
+    }
+
+    public function getModels() {
+        return $this->models;
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    public function getUser() {
+        return $this->user;
+    }
+
+    protected function createActionResultSuccess(string $message, array $data = []): ActionResult {
+        return ActionResult::success($message, [
+                'msg' => $message,
+                'action' => class_basename(static::class),
+                'data' => $data,
+        ]);
+    }
+
+    protected function createActionResultError(string $message = "Unprocessable action", array $errors = []): ActionResult {
+        return ActionResult::error($errors, $message);
+    }
+}

src/Actions/DeleteAction.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EscuelaIT\APIKit\Exceptions;
+
+class ActionModelNotDefinedException extends \Exception
+{
+    public function __construct(string $class = '')
+    {
+        $message = "The 'actionModel' property is not defined in the {$class} class. "
+                 .'You must define the model to use in your ActionService derived class.';
+
+        parent::__construct($message);
+    }
+}

src/CrudAction.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace EscuelaIT\APIKit\Exceptions;
+
+class UnauthenticatedActionException extends \Exception
+{
+    public function __construct()
+    {
+        parent::__construct('This action requires an authenticated user.');
+    }
+}

src/Exceptions/ActionModelNotDefinedException.php

@@ -10,6 +10,7 @@
 class ListService
 {
     protected string $listModel;
+    protected string $identifierField = 'id';
     protected $query;
     protected bool $paginated = true;
     protected ?array $availableFilterColumns = null;
@@ -88,6 +89,12 @@ public function getResults()
         return $this->query->get();
     }
 
+    public function getAllIds() {
+        $this->paginated = false;
+        $this->getResults();
+        return $this->query->get()->pluck($this->identifierField);
+    }
+
     public function setSearchConfiguration(array $config): ListService
     {
         foreach ($config as $key => $value) {