Improved Scopes Mapping (#71)

* moved scope parsing to the resources trait where it belongs

* Update Controller.php

* Update Parser.php

* Update laravel-api-controller.php

* Apply fixes from StyleCI (#72)

Co-authored-by: Craig Smith <[email protected]>

Co-authored-by: Craig Smith <[email protected]>

Author: phpsa

config/laravel-api-controller.php

@@ -2,15 +2,15 @@
 
 return [
     // Relative path from the app directory to api controllers directory.
-    'controllers_dir' => 'Http/Controllers/Api',
+    'controllers_dir' => env('PHPSA_API_CONTROLLER_DIR', 'Http/Controllers/Api'),
     // Relative path from the app directory to the api routes file.
     'routes_file' => '../routes/api.php',
     // Relative path from the app directory to the models directory. Typically it's either 'Models' or ''.
     'models_base_dir' => 'Models',
     // Relative path from the base directory to the api controller stub.
-    'controller_stub' => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/controller.stub',
+    'controller_stub' => env('PHPSA_API_CONTROLLER_STUB', 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/controller.stub'),
     // Relative path from the base directory to the route stub.
-    'route_stub' => 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/route.stub',
+    'route_stub' => env('PHPSA_API_ROUTE_STUB', 'vendor/phpsa/laravel-api-controller/src/Generator/stubs/route.stub'),
 
     'parameters' => [
         'include' => 'include', // which hasOnes / HasMany etc to include in the response

src/Contracts/Parser.php

@@ -193,21 +193,6 @@ protected function parseFilterParams(): void
         }
     }
 
-    /**
-     * parses out custom method filters etc.
-     *
-     * @param mixed $request
-     */
-    protected function parseMethodParams($request): void
-    {
-        foreach ($this->/** @scrutinizer ignore-call */ getAllowedScopes() as $scope) {
-            if ($request->has(Helpers::snake($scope)) || $request->has(Helpers::camel($scope))) {
-                $value = $request->has(Helpers::snake($scope)) ? $request->get(Helpers::snake($scope)) : $request->get(Helpers::camel($scope));
-                call_user_func([$this->repository, Helpers::camel($scope)], $value);
-            }
-        }
-    }
-
     protected function setWhereHasClause(array $where): void
     {
         [$with, $key] = explode('.', $where['key']);

src/Http/Api/Contracts/HasResources.php

@@ -2,6 +2,7 @@
 
 namespace Phpsa\LaravelApiController\Http\Api\Contracts;
 
+use Phpsa\LaravelApiController\Helpers;
 use Phpsa\LaravelApiController\Http\Resources\ApiCollection;
 use Phpsa\LaravelApiController\Http\Resources\ApiResource;
 
@@ -62,6 +63,28 @@ protected function getAllowedScopes(): array
     {
         $resource = $this->getResourceSingle();
 
-        return (method_exists($resource, 'getAllowedScopes')) ? ($resource)::getAllowedScopes() : [];
+        $scopes = collect((method_exists($resource, 'getAllowedScopes')) ? ($resource)::getAllowedScopes() : []);
+
+        return $scopes->map(function ($scope) {
+            return strpos($scope, 'scope') === 0 ? substr($scope, 5) : $scope;
+        })->toArray();
+    }
+
+    /**
+     * parses out custom method filters etc.
+     *
+     * @param mixed $request
+     */
+    protected function parseAllowedScopes($request): void
+    {
+        foreach ($this->getAllowedScopes() as $scope) {
+            $snake = Helpers::snake($scope);
+            $camel = Helpers::camel($scope);
+
+            if ($request->has($snake) || $request->has($camel)) {
+                $value = $request->has($snake) ? $request->get($snake) : $request->get($camel);
+                call_user_func([$this->repository, $camel], $value);
+            }
+        }
     }
 }

src/Http/Api/Controller.php

@@ -110,7 +110,7 @@ protected function handleIndexActionCommon($request, array $extraParams = [])
         $this->parseIncludeParams();
         $this->parseSortParams();
         $this->parseFilterParams();
-        $this->parseMethodParams($request);
+        $this->parseAllowedScopes($request);
         $this->qualifyCollectionQuery();
     }