Roles and permissions endpoint, sync roles and user, sync permissions and role.

Author: joselfonseca

app/Entities/Role.php

@@ -3,6 +3,7 @@
 namespace App\Entities;
 
 use App\Support\UuidScopeTrait;
+use App\Support\HasPermissionsUuid;
 
 /**
  * Class Role
@@ -11,10 +12,11 @@
 class Role extends \Spatie\Permission\Models\Role
 {
 
-    use UuidScopeTrait;
+    use UuidScopeTrait, HasPermissionsUuid;
 
     /**
      * @var array
      */
     protected $fillable = ['name', 'uuid'];
+
 }

app/Entities/User.php

@@ -2,6 +2,7 @@
 
 namespace App\Entities;
 
+use App\Support\HasRolesUuid;
 use App\Support\UuidScopeTrait;
 use Laravel\Passport\HasApiTokens;
 use Spatie\Permission\Traits\HasRoles;
@@ -15,7 +16,9 @@
  */
 class User extends Authenticatable
 {
-    use Notifiable, UuidScopeTrait, HasApiTokens, HasRoles, SoftDeletes;
+    use Notifiable, UuidScopeTrait, HasApiTokens, HasRoles, SoftDeletes, HasRolesUuid {
+        HasRolesUuid::getStoredRole insteadof HasRoles;
+    }
 
     /**
      * The attributes that are mass assignable.

app/Http/Controllers/Api/Users/PermissionsController.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Http\Controllers\Api\Users;
+
+use App\Entities\Permission;
+use Illuminate\Http\Request;
+use Dingo\Api\Routing\Helpers;
+use App\Http\Controllers\Controller;
+use App\Transformers\Users\PermissionTransformer;
+
+/**
+ * Class PermissionsController
+ * @package App\Http\Controllers\Api\Users
+ */
+class PermissionsController extends Controller
+{
+
+    use Helpers;
+
+    /**
+     * @var
+     */
+    protected $model;
+
+
+    /**
+     * PermissionsController constructor.
+     * @param Permission $model
+     */
+    public function __construct(Permission $model)
+    {
+        $this->model = $model;
+        $this->middleware('permission:List permissions')->only('index');
+    }
+
+
+    /**
+     * @param Request $request
+     * @return \Dingo\Api\Http\Response
+     */
+    public function index(Request $request)
+    {
+        return $this->response->paginator($this->model->paginate($request->get('limit', config('app.pagination_limit'))), new PermissionTransformer());
+    }
+
+}

app/Http/Controllers/Api/Users/RolesController.php

@@ -8,6 +8,10 @@
 use App\Http\Controllers\Controller;
 use App\Transformers\Users\RoleTransformer;
 
+/**
+ * Class RolesController
+ * @package App\Http\Controllers\Api\Users
+ */
 class RolesController extends Controller
 {
     use Helpers;
@@ -17,8 +21,9 @@ class RolesController extends Controller
      */
     protected $model;
 
+
     /**
-     * UsersController constructor.
+     * RolesController constructor.
      * @param Role $model
      */
     public function __construct(Role $model)
@@ -65,6 +70,9 @@ public function store(Request $request)
             'name' => 'required'
         ]);
         $role = $this->model->create($request->all());
+        if($request->has('permissions')) {
+            $role->syncPermissions($request['permissions']);
+        }
         return $this->response->created(url('api/roles/'.$role->uuid));
     }
 
@@ -77,11 +85,13 @@ public function store(Request $request)
     public function update(Request $request, $uuid)
     {
         $role = $this->model->byUuid($uuid)->firstOrFail();
-        $rules = [
+        $this->validate($request, [
             'name' => 'required'
-        ];
-        $this->validate($request, $rules);
+        ]);
         $role->update($request->except('_token'));
+        if($request->has('permissions')) {
+            $role->syncPermissions($request['permissions']);
+        }
         return $this->response->item($role->fresh(), new RoleTransformer());
     }
 

app/Http/Controllers/Api/Users/UsersController.php

@@ -74,6 +74,9 @@ public function store(Request $request)
             'password' => 'required|min:8|confirmed'
         ]);
         $user = $this->model->create($request->all());
+        if($request->has('roles')) {
+            $user->syncRoles($request['roles']);
+        }
         return $this->response->created(url('api/users/'.$user->uuid));
     }
 
@@ -98,6 +101,9 @@ public function update(Request $request, $uuid)
         }
         $this->validate($request, $rules);
         $user->update($request->except('_token'));
+        if($request->has('roles')) {
+            $user->syncRoles($request['roles']);
+        }
         return $this->response->item($user->fresh(), new UserTransformer());
     }
 

app/Http/Controllers/Auth/RegisterController.php

@@ -2,7 +2,7 @@
 
 namespace App\Http\Controllers\Auth;
 
-use App\User;
+use App\Entities\User;
 use App\Http\Controllers\Controller;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Foundation\Auth\RegistersUsers;

app/Services/Installation/InstallAppHandler.php

@@ -38,16 +38,7 @@ class InstallAppHandler
             ['name' => 'Update roles'],
         ],
         'permissions' => [
-            ['name' => 'List permissions'],
-            ['name' => 'Create permissions'],
-            ['name' => 'Delete permissions'],
-            ['name' => 'Update permissions'],
-        ],
-        'users.roles' => [
-            ['name' => 'Associate users with roles']
-        ],
-        'roles.permissions' => [
-            ['name' => 'Associate roles with permissions']
+            ['name' => 'List permissions']
         ]
     ];
 

app/Support/HasPermissionsUuid.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Support;
+
+use App\Entities\Permission;
+
+/**
+ * Class HasPermissionsUuid
+ * @package App\Support
+ */
+trait HasPermissionsUuid
+{
+
+    /**
+     * Added support to use a UUID to find the Permission
+     *
+     * @param string|array|Permission|\Illuminate\Support\Collection $permissions
+     *
+     * @return Permission
+     */
+    protected function getStoredPermission($permissions)
+    {
+        if (is_string($permissions)) {
+            return app(Permission::class)->where('name', $permissions)->orWhere('uuid', $permissions)->first();
+        }
+
+        if (is_array($permissions)) {
+            return app(Permission::class)->whereIn('name', $permissions)->orWhereIn('uuid', $permissions)->get();
+        }
+
+        return $permissions;
+    }
+
+}

app/Support/HasRolesUuid.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Support;
+
+use App\Entities\Role;
+
+trait HasRolesUuid
+{
+
+    /**
+     * @param $role
+     *
+     * @return Role
+     */
+    protected function getStoredRole($role)
+    {
+        if (is_string($role)) {
+            return app(Role::class)->where('name', $role)->orWhere('uuid', $role)->first();
+        }
+
+        return $role;
+    }
+
+}

database/factories/ModelFactory.php

@@ -29,4 +29,11 @@
         'name' => $faker->name,
         'uuid' => $faker->uuid
     ];
+});
+
+$factory->define(App\Entities\Permission::class, function (Faker\Generator $faker) {
+    return [
+        'name' => $faker->name,
+        'uuid' => $faker->uuid
+    ];
 });