feat: work on batch actions trait

Author: phpsa

src/Http/Api/Contracts/HasBatchActions.php

@@ -1,21 +1,33 @@
 <?php
 
-/**
-Note this is still experimental
-**/
-
-namespace Phpsa\LaravelApiController\Http\Api\Contracts;
+namespace App\Models\Contracts;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Phpsa\LaravelApiController\Events\Created;
+use Phpsa\LaravelApiController\Events\Updated;
 use Phpsa\LaravelApiController\Exceptions\ApiException;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
 
 trait HasBatchActions
 {
 
-    public function handleBatchStoreAction($request, array $extraParams)
+    public function getBatchData(): Collection
+    {
+        return collect($this->request->get('data', []));
+    }
+
+    /**
+     * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
+     * @param array $extraParams
+     *
+     * @return mixed
+     */
+    public function handleBatchStoreAction($request, array $extraParams = [])
     {
         $this->validateRequestType($request);
         $this->addCustomParams($extraParams);
+
         $this->authoriseUserAction('create');
 
         $this->validate($this->request, $this->rulesForBatchCreate());
@@ -25,45 +37,168 @@ public function handleBatchStoreAction($request, array $extraParams)
         $this->unguardIfNeeded();
 
         try {
-            $records = collect($this->request->get('data'), [])->map(function ($item) {
-                $data = $this->qualifyStoreQuery($item);
-                $insert = $this->addTableData($data);
-                $diff = array_diff(array_keys($data), array_keys($insert));
-                $item = self::$model->create($insert);
+            $records = $this->processStoreQuery(collect($this->getBatchData()));
+
+            DB::commit();
+
+            return $this->handleBatchStoreResponse($records);
+        } catch (\Exception $exception) {
+            $message = config('app.debug') ? $exception->getMessage() : 'Failed to create Records';
 
-                $this->storeRelated($item, $diff, $data);
+            DB::rollback();
+            throw new ApiException($message, (int) $exception->getCode(), $exception);
+        }
+    }
 
-                return $item;
-            });
+    protected function processStoreQuery(Collection $items): Collection
+    {
+        return $items->map(function ($item) {
+            $data = $this->qualifyStoreQuery($item);
+            $insert = $this->addTableData($data);
+            $diff = array_diff(array_keys($data), array_keys($insert));
+            $item = self::$model->create($insert);
+
+            $this->storeRelated($item, $diff, $data);
+
+            event(new Created($item, $this->request));
+
+            return $item;
+        });
+    }
+
+    /**
+     * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
+     *
+     * @return mixed
+     */
+    public function handleBatchUpdateAction($request, array $extraParams = [])
+    {
+        $this->validateRequestType($request);
+        $this->addCustomParams($extraParams);
+
+        $this->validate($this->request, $this->rulesForBatchUpdate());
+
+        DB::beginTransaction();
+
+        $this->unguardIfNeeded();
+
+        try {
+            $records = $this->processUpdateQuery(collect($this->getBatchData()));
 
             DB::commit();
 
-            return $this->handleStoreResponse($records);
+            return $this->handleBatchUpdateResponse($records);
         } catch (\Exception $exception) {
             $message = config('app.debug') ? $exception->getMessage() : 'Failed to create Records';
 
             DB::rollback();
-            throw new ApiException($message, (int) $exception->getCode(), $exception);
+            match (get_class($exception)) {
+                ModelNotFoundException::class => throw $exception,
+                default => throw new ApiException($message, (int) $exception->getCode(), $exception)
+            };
         }
     }
 
+    protected function processUpdateQuery(Collection $items): Collection
+    {
+        return $items->map(function ($item) {
+
+            $key = self::$model->getKeyName();
+
+            $id = $item[$key];
+            $existing = $this->builder->where($key, $id)->firstOrFail();
+            $this->authoriseUserAction('update', $existing);
+
+            $data = $this->qualifyUpdateQuery($item);
 
-    protected function handleBatchStoreResponse($items)
+            $updates = $this->addTableData($data);
+
+            $diff = array_diff(array_keys($data), array_keys($updates));
+
+            $existing->fill($updates);
+            $existing->save();
+
+            $this->storeRelated($existing, $diff, $data);
+
+            event(new Updated($existing, $this->request));
+
+            return $existing;
+        });
+    }
+
+
+      /**
+     * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
+     *
+     * @return mixed
+     */
+    public function handleBatchStoreOrUpdateAction($request, array $extraParams = [])
+    {
+        $this->validateRequestType($request);
+        $this->addCustomParams($extraParams);
+
+        $key = self::$model->getKeyName();
+        $records = $this->getBatchData();
+
+        DB::beginTransaction();
+
+        $this->unguardIfNeeded();
+
+        try {
+            $existing = $this->processUpdateQuery($records->filter(function ($record) use ($key) {
+                return ! isset($record[$key]) ||  empty($record[$key]);
+            }));
+
+            $new = $this->processStoreQuery($records->filter(function ($record) use ($key) {
+                return isset($record[$key]) && ! empty($record[$key]);
+            }));
+
+            DB::commit();
+
+            return $this->handleBatchStoreOrUpdateResponse($existing->merge($new));
+        } catch (\Exception $exception) {
+            $message = config('app.debug') ? $exception->getMessage() : 'Failed to create Records';
+
+            DB::rollback();
+            match (get_class($exception)) {
+                ModelNotFoundException::class => throw $exception,
+                default => throw new ApiException($message, (int) $exception->getCode(), $exception)
+            };
+        }
+    }
+
+
+
+    /**
+     * @return mixed Response|jsonResponse
+     */
+    protected function handleBatchStoreResponse(Collection $items)
     {
         return $this->respondWithResource($this->/** @scrutinizer ignore-call */getResourceCollection(), $items, 201);
     }
 
-    protected function handleBatchUpdateResponse($items)
+    /**
+     * @return mixed Response|jsonResponse
+     */
+    protected function handleBatchUpdateResponse(Collection $items)
     {
         return $this->respondWithResource($this->/** @scrutinizer ignore-call */getResourceCollection(), $items, 200);
     }
 
-    protected function rulesForBatchCreate() : array
+    /**
+     * @return mixed Response|jsonResponse
+     */
+    protected function handleBatchStoreOrUpdateResponse(Collection $items)
+    {
+        return $this->respondWithResource($this->getResourceCollection(), $items, 200);
+    }
+
+    protected function rulesForBatchCreate(): array
     {
         return [];
     }
 
-    protected function rulesForBatchUpdate() : array
+    protected function rulesForBatchUpdate(): array
     {
         return [];
     }