Develop

.travis.yml

@@ -8,11 +8,12 @@ notifications:
         on_failure: always
 
 php:
-  - 7.1
   - 7.2
+  - 7.3
+  - 7.4
 
 env:
-  - LARAVEL_VERSION=5.8.*
+  - LARAVEL_VERSION=6.*
 
 before_install:
   - travis_retry composer self-update --stable -n

README.md

@@ -120,7 +120,8 @@ By default all fields are returned, you can limit that to specific fields in the
 * Api Controller parameter `$defaultFields` default as `protected $defaultFields = ['*'];` - switch to include an array of fields
 * fields param in url querystring: ie `fields=id,name,age` = will only return those, this will also override the above.
 * in your response resource you can set the static::allowedFields to lock down which fields are returnable
-* addfields and removefields params in url querystring will work with these.
+* `addfields` and `removefields` params in url querystring will work with these.
+* Use laravel [eloquent model `$appends`](https://laravel.com/docs/6.x/eloquent-serialization#appending-values-to-json) property to automatically include custom attribute accessors.
 
 ## Relationships
 

composer.json

@@ -15,12 +15,12 @@
     }
   ],
   "require": {
-    "php": ">=7.1.3",
-    "illuminate/support": "~5.8.0|^6.0"
+    "php": ">=7.2",
+    "illuminate/support": "^6.0"
   },
   "require-dev": {
-    "orchestra/testbench": "~3.8.0",
-    "phpunit/phpunit": "^7.0"
+    "orchestra/testbench": "^4.0",
+    "phpunit/phpunit": "^8.0"
   },
   "autoload": {
     "psr-4": {

src/Contracts/Parser.php

@@ -23,6 +23,19 @@ protected function getUriParser($request)
         return self::$uriParser;
     }
 
+    /**
+     * Method to add extra request parameters to the request instance.
+     *
+     * @param mixed $request
+     * @param array $extraParams
+     */
+    protected function addCustomParams($request, array $extraParams = []): void
+    {
+        $all = $request->all();
+        $new = array_merge_recursive($all, $extraParams);
+        $request->replace($new);
+    }
+
     /**
      * Parses our include joins.
      */

src/Contracts/Validation.php

@@ -59,6 +59,8 @@ protected function rulesForUpdate(/* @scrutinizer ignore-unused */$id): array
      *
      * @param mixed $role role name or array of role names
      *
+     * @deprecated -- should be rather used in policies / gates
+     *
      * @return bool
      */
     protected function hasRole($role): bool
@@ -73,6 +75,8 @@ protected function hasRole($role): bool
      *
      * @param array $roles
      *
+     * @deprecated -- should be rather used in policies / gates
+     *
      * @return bool
      */
     protected function hasAllRoles(array $roles): bool

src/Generator/stubs/controller.stub

@@ -96,9 +96,10 @@ class {{controller.name}} extends Controller
    /**
     * Store a newly created resource in storage.
     * POST /api/{resource}.
-	  *
-	  * @param Request $request
+	*
+	* @param Request $request
     *
+    * @see self::handleStoreOrUpdateAction to do magic insert / update
     * @return Response
     */
     public function store(Request $request)

src/Helpers.php

@@ -114,10 +114,18 @@ public static function filterFieldsFromRequest($request, ?array $defaultFields,
      *
      * @return array
      */
-    public static function excludeArrayValues(array $array, array $excludes, ?array $optionals = []): array
+    public static function excludeArrayValues(array $array, array $excludes, ?array $acceptable = []): array
     {
-        return Arr::where($array, function ($value) use ($excludes, $optionals) {
-            return ! in_array($value, $excludes) || in_array($value, $optionals);
+        return Arr::where($array, function ($value) use ($excludes, $acceptable) {
+            if (in_array($value, $excludes)) {
+                return false;
+            }
+
+            if (! empty($acceptable)) {
+                return in_array($value, $acceptable);
+            }
+
+            return true;
         });
     }
 }

src/Http/Controllers/Api/Controller.php

@@ -105,8 +105,9 @@ public function __construct()
      *
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleIndexAction($request)
+    public function handleIndexAction($request, array $extraParams = [])
     {
+        $this->addCustomParams($request, $extraParams);
         $this->validateRequestType($request);
         $this->authoriseUserAction('viewAny');
         $this->getUriParser($request);
@@ -124,14 +125,23 @@ public function handleIndexAction($request)
         return $this->respondWithMany($items);
     }
 
+    public function handleStoreOrUpdateAction($request, array $extraParams = [])
+    {
+        $key = self::$model->getKeyName();
+        $id = $request->input($key, null) ?? data_get($extraParams, $key, null);
+
+        return $id ? $this->handleUpdateAction($id, $request, $extraParams) : $this->handleStoreAction($request, $extraParams);
+    }
+
     /**
      * Store a newly created resource in storage.
      * POST /api/{resource}.
      *
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleStoreAction($request)
+    public function handleStoreAction($request, array $extraParams = [])
     {
+        $this->addCustomParams($request, $extraParams);
         $this->validateRequestType($request);
         $this->authoriseUserAction('create');
 
@@ -168,7 +178,7 @@ public function handleStoreAction($request)
         } catch (\Illuminate\Database\QueryException $exception) {
             $message = config('app.debug') ? $exception->getMessage() : 'Failed to create Record';
 
-            throw new ApiException($message);
+            throw new ApiException($message, $exception->getCode(), $exception);
         } catch (\Exception $exception) {
             DB::rollback();
 
@@ -183,8 +193,9 @@ public function handleStoreAction($request)
      * @param int $id
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleShowAction($id, $request)
+    public function handleShowAction($id, $request, array $extraParams = [])
     {
+        $this->addCustomParams($request, $extraParams);
         $this->validateRequestType($request);
 
         $this->authoriseUserAction('view', self::$model::find($id));
@@ -212,8 +223,9 @@ public function handleShowAction($id, $request)
      * @param int $id
      * @param \Illuminate\Http\Request|\Illuminate\Foundation\Http\FormRequest $request
      */
-    public function handleUpdateAction($id, $request)
+    public function handleUpdateAction($id, $request, array $extraParams = [])
     {
+        $this->addCustomParams($request, $extraParams);
         $this->validateRequestType($request);
 
         $this->authoriseUserAction('update', self::$model::find($id));
@@ -260,7 +272,7 @@ public function handleUpdateAction($id, $request)
         } catch (\Illuminate\Database\QueryException $exception) {
             $message = config('app.debug') ? $exception->getMessage() : 'Failed to update Record';
 
-            throw new ApiException($message);
+            throw new ApiException($message, $exception->getCode(), $exception);
         } catch (\Exception $exception) {
             DB::rollback();
 

tests/LaravelApiHelpersTest.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Phpsa\LaravelApiController\Tests;
+
+use Orchestra\Testbench\TestCase;
+use Phpsa\LaravelApiController\Facades\LaravelApiController;
+use Phpsa\LaravelApiController\Helpers;
+use Phpsa\LaravelApiController\ServiceProvider;
+
+class LaravelApiHelpersTest extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [ServiceProvider::class];
+    }
+
+    protected function getPackageAliases($app)
+    {
+        return [
+            'laravel-api-controller' => LaravelApiController::class,
+        ];
+    }
+
+    public function testSnakeCasing()
+    {
+        $array = [
+            'test_one' => 'test_one',
+            'testTwo' => 'test_two',
+        ];
+
+        $transposed = Helpers::snakeCaseArrayKeys($array);
+
+        $this->assertSame(array_keys($transposed), array_values($array));
+    }
+
+    public function testCamelCasing()
+    {
+        $array = [
+            'test_one' => 'testOne',
+            'testTwo' => 'testTwo',
+        ];
+
+        $transposed = Helpers::camelCaseArrayKeys($array);
+
+        $this->assertSame(array_keys($transposed), array_values($array));
+    }
+
+    public function testArrayExcludes()
+    {
+        $allowedFields = [
+            'field1',
+            'field2',
+            'field3',
+            'field4',
+            'field5',
+        ];
+
+        $excludeFields = [
+            'field2',
+        ];
+
+        $inputData = [
+            'field1',
+            'field2',
+            'field3',
+            'field4',
+            'field5',
+            'field6',
+        ];
+
+        $remaining = Helpers::excludeArrayValues($inputData, $excludeFields, $allowedFields);
+
+        $this->assertSame([
+            'field1',
+            'field3',
+            'field4',
+            'field5',
+        ], array_values($remaining));
+
+        $remaining = Helpers::excludeArrayValues($inputData, [], $allowedFields);
+
+        $this->assertSame([
+            'field1',
+            'field2',
+            'field3',
+            'field4',
+            'field5',
+        ], array_values($remaining));
+    }
+}