Updated spatie permission to version 5 and added teams support

Author: andrewdrake

README.md

@@ -48,16 +48,26 @@ https://laravel.com/docs/6.x#installation
 
 https://laravel.com/docs/6.x/authentication
 
-#### Step 3. Install spatie roles & permissions package
+#### Step 3. Require the current package using composer:
+
+```bash
+composer require venturedrake/laravel-crm:^0.7
+```
+
+#### Step 4. Install spatie roles & permissions package
 
 https://spatie.be/docs/laravel-permission/v4/installation-laravel
 
-#### Step 4. Require the current package using composer:
+Adjust the settings in app/config/permission.php to the following:
 
-```bash
-composer require venturedrake/laravel-crm:^0.7
+```php
+'permission' => VentureDrake\LaravelCrm\Models\Permission::class
+'role' => VentureDrake\LaravelCrm\Models\Role::class,
 ```
 
+If you are using the teams feature, follow this additional step:  
+https://spatie.be/docs/laravel-permission/v5/basic-usage/teams-permissions
+
 #### Step 5. Publish the migrations, config & assets
 
 ```bash
@@ -190,12 +200,10 @@ Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recen
 
 ## Roadmap
 
- - Products
  - Notes
  - Tasks
  - Files / Documents
  - Calendar (Calls, Meetings, Reminders)
- - Dashboard
  - Custom Fields
  - Activity Feed / Timelines
  - CSV Import / Export

config/laravel-crm.php

@@ -33,16 +33,12 @@
     |
     | For Jetstream see https://jetstream.laravel.com/2.x/features/teams.html
     |
-    | For Spark see https://spark-classic.laravel.com/docs/11.0/teams
+    | For Spark Classic see https://spark-classic.laravel.com/docs/11.0/teams
     |
-    | IMPORTANT! This package uses the Spatie Permissions package to manage
-    | user roles and permissions, which by default are system wide. Howwever
-    | there is support added for roles & permissions at team level. To enable
-    | you will need to adjust the settings in app/config/permission.php to
-    | the following:
-    |
-    | 'permission' => VentureDrake\LaravelCrm\Models\Permission::class
-    | 'role' => VentureDrake\LaravelCrm\Models\Role::class,
+    | IMPORTANT! This package uses the Spatie Permissions package which as of
+    | version 5 supports teams. PLease check you have version 5 or higher
+    | installed and follow this additional step when installing the package:
+    | https://spatie.be/docs/laravel-permission/v5/basic-usage/teams-permissions
     |
     */
 

database/migrations/add_fields_to_roles_permissions_tables.php.stub

@@ -35,7 +35,6 @@ class AddFieldsToRolesPermissionsTables extends Migration
         if (! Schema::hasColumn('permissions', 'crm_permission'))
         {
             Schema::table('permissions', function (Blueprint $table) {
-        
                 $table->boolean('crm_permission')->after('description')->default(0);
             });
         } 

database/migrations/add_team_id_to_roles_permissions_tables.php.stub

@@ -209,13 +209,13 @@ public function run()
         Permission::firstOrCreate(['name' => 'edit crm fields', 'crm_permission' => 1]);
         Permission::firstOrCreate(['name' => 'delete crm fields', 'crm_permission' => 1]);
 
-        $role = Role::firstOrCreate(['name' => 'Owner', 'crm_role' => 1])
+        $role = Role::firstOrCreate(['name' => 'Owner', 'crm_role' => 1, 'team_id' => null])
             ->givePermissionTo(Permission::all());
 
-        $role = Role::firstOrCreate(['name' => 'Admin', 'crm_role' => 1])
+        $role = Role::firstOrCreate(['name' => 'Admin', 'crm_role' => 1, 'team_id' => null])
             ->givePermissionTo(Permission::all());
 
-        $role = Role::firstOrCreate(['name' => 'Manager', 'crm_role' => 1])
+        $role = Role::firstOrCreate(['name' => 'Manager', 'crm_role' => 1, 'team_id' => null])
             ->givePermissionTo([
                 'create crm leads',
                 'view crm leads',
@@ -239,7 +239,7 @@ public function run()
                 'delete crm contacts',
             ]);
 
-        $role = Role::firstOrCreate(['name' => 'Employee', 'crm_role' => 1])
+        $role = Role::firstOrCreate(['name' => 'Employee', 'crm_role' => 1, 'team_id' => null])
             ->givePermissionTo([
                 'create crm leads',
                 'view crm leads',

database/seeders/LaravelCrmTablesSeeder.php

@@ -0,0 +1,27 @@
+<?php
+namespace VentureDrake\LaravelCrm\Http\Middleware;
+
+use Closure;
+
+class TeamsPermission
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        if (auth()->guest()) {
+            return $next($request);
+        }
+        
+        if (config('laravel-crm.teams')) {
+            app(\Spatie\Permission\PermissionRegistrar::class)->setPermissionsTeamId(auth()->user()->currentTeam->id);
+        }
+
+        return $next($request);
+    }
+}

src/Http/Middleware/TeamsPermission.php

@@ -22,6 +22,7 @@
 use VentureDrake\LaravelCrm\Http\Middleware\LastOnlineAt;
 use VentureDrake\LaravelCrm\Http\Middleware\Settings;
 use VentureDrake\LaravelCrm\Http\Middleware\SystemCheck;
+use VentureDrake\LaravelCrm\Http\Middleware\TeamsPermission;
 use VentureDrake\LaravelCrm\Models\Email;
 use VentureDrake\LaravelCrm\Models\Lead;
 use VentureDrake\LaravelCrm\Models\Organisation;
@@ -82,6 +83,8 @@ class_alias('App\Models\Team', 'App\Team');
 
         // Middleware
         $router->aliasMiddleware('auth.laravel-crm', Authenticate::class);
+        $router->pushMiddlewareToGroup('crm', TeamsPermission::class);
+        $router->pushMiddlewareToGroup('api', TeamsPermission::class);
         $router->pushMiddlewareToGroup('crm', Settings::class);
         $router->pushMiddlewareToGroup('api', Settings::class);
         $router->pushMiddlewareToGroup('crm', HasCrmAccess::class);
@@ -164,14 +167,13 @@ function ($perPage = 30, $page = null, $options = []) {
                 __DIR__ . '/../database/migrations/create_laravel_crm_deal_products_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_deal_products_table.php', 10),
                 __DIR__ . '/../database/migrations/add_global_to_laravel_crm_settings_table.php.stub' => $this->getMigrationFileName($filesystem, 'add_global_to_laravel_crm_settings_table.php', 11),
                 __DIR__ . '/../database/migrations/alter_fields_for_encryption_on_laravel_crm_tables.php.stub' => $this->getMigrationFileName($filesystem, 'alter_fields_for_encryption_on_laravel_crm_tables.php', 12),
-                __DIR__ . '/../database/migrations/add_team_id_to_roles_permissions_tables.php.stub' => $this->getMigrationFileName($filesystem, 'add_team_id_to_roles_permissions_tables.php', 13),
-                __DIR__ . '/../database/migrations/create_laravel_crm_address_types_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_address_types_table.php', 14),
-                __DIR__ . '/../database/migrations/alter_type_on_laravel_crm_phones_table.php.stub' => $this->getMigrationFileName($filesystem, 'alter_type_on_laravel_crm_phones_table.php', 15),
-                __DIR__ . '/../database/migrations/add_description_to_laravel_crm_labels_table.php.stub' => $this->getMigrationFileName($filesystem, 'add_description_to_laravel_crm_labels_table.php', 16),
-                __DIR__ . '/../database/migrations/add_name_to_laravel_crm_addresses_table.php.stub' => $this->getMigrationFileName($filesystem, 'add_name_to_laravel_crm_addresses_table.php', 17),
-                __DIR__ . '/../database/migrations/create_laravel_crm_contacts_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contacts_table.php', 18),
-                __DIR__ . '/../database/migrations/create_laravel_crm_contact_types_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contact_types_table.php', 19),
-                __DIR__ . '/../database/migrations/create_laravel_crm_contact_contact_type_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contact_contact_type_table.php', 20),
+                __DIR__ . '/../database/migrations/create_laravel_crm_address_types_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_address_types_table.php', 13),
+                __DIR__ . '/../database/migrations/alter_type_on_laravel_crm_phones_table.php.stub' => $this->getMigrationFileName($filesystem, 'alter_type_on_laravel_crm_phones_table.php', 14),
+                __DIR__ . '/../database/migrations/add_description_to_laravel_crm_labels_table.php.stub' => $this->getMigrationFileName($filesystem, 'add_description_to_laravel_crm_labels_table.php', 15),
+                __DIR__ . '/../database/migrations/add_name_to_laravel_crm_addresses_table.php.stub' => $this->getMigrationFileName($filesystem, 'add_name_to_laravel_crm_addresses_table.php', 16),
+                __DIR__ . '/../database/migrations/create_laravel_crm_contacts_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contacts_table.php', 17),
+                __DIR__ . '/../database/migrations/create_laravel_crm_contact_types_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contact_types_table.php', 18),
+                __DIR__ . '/../database/migrations/create_laravel_crm_contact_contact_type_table.php.stub' => $this->getMigrationFileName($filesystem, 'create_laravel_crm_contact_contact_type_table.php', 19),
             ], 'migrations');
 
             // Publishing the seeders

src/LaravelCrmServiceProvider.php

@@ -3,20 +3,11 @@
 namespace VentureDrake\LaravelCrm\Models;
 
 use Spatie\Permission\Models\Permission as SpatiePermission;
-use VentureDrake\LaravelCrm\Scopes\BelongsToTeamsScope;
-use VentureDrake\LaravelCrm\Traits\BelongsToTeams;
 
 class Permission extends SpatiePermission
 {
-    use BelongsToTeams;
-    
     public function scopeCrm($query)
     {
         return $query->where('crm_permission', 1);
     }
-
-    public function scopeAllTeams($query)
-    {
-        return $query->withoutGlobalScope(BelongsToTeamsScope::class);
-    }
 }

src/Models/Permission.php

@@ -3,13 +3,9 @@
 namespace VentureDrake\LaravelCrm\Models;
 
 use Spatie\Permission\Models\Role as SpatieRole;
-use VentureDrake\LaravelCrm\Scopes\BelongsToTeamsScope;
-use VentureDrake\LaravelCrm\Traits\BelongsToTeams;
 
 class Role extends SpatieRole
 {
-    use BelongsToTeams;
-    
     public function scopeCrm($query)
     {
         return $query->where('crm_role', 1);
@@ -19,9 +15,4 @@ public function scopeCrmNotOwner($query)
     {
         return $query->where('crm_role', 1)->where('name', '<>', 'Owner');
     }
-
-    public function scopeAllTeams($query)
-    {
-        return $query->withoutGlobalScope(BelongsToTeamsScope::class);
-    }
 }