Refactored existing user API work

- Updated routes to use new format.
- Changed how hidden fields are exposed to be more flexible to different
  use-cases.
- Updated properties available on read/list results.
- Started adding testing coverage.
- Removed old unused UserRepo 'getAllUsers' function.

Related to #2701, Progression of #2734

app/Auth/Role.php

@@ -28,6 +28,8 @@ class Role extends Model implements Loggable
 
     protected $fillable = ['display_name', 'description', 'external_auth_id'];
 
+    protected $hidden = ['pivot'];
+
     /**
      * The roles that belong to the role.
      */

app/Auth/User.php

@@ -72,7 +72,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
      */
     protected $hidden = [
         'password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',
-        'created_at', 'updated_at', 'image_id',
+        'created_at', 'updated_at', 'image_id', 'roles', 'avatar',
     ];
 
     /**

app/Auth/UserRepo.php

@@ -52,23 +52,14 @@ class UserRepo
         return User::query()->where('slug', '=', $slug)->firstOrFail();
     }
 
-    /**
-     * Get all the users with their permissions.
-     */
-    public function getAllUsers(): Collection
-    {
-        return User::query()->with('roles', 'avatar')->orderBy('name', 'asc')->get();
-    }
-
     /**
      * Get all users as Builder for API
      */
-    public function getUsersBuilder(int $id = null ) : Builder
+    public function getApiUsersBuilder() : Builder
     {
-        $query = User::query()->select(['*'])
-            ->withLastActivityAt()
-            ->with(['roles', 'avatar']);
-        return $query;
+        return User::query()->select(['*'])
+            ->scopes('withLastActivityAt')
+            ->with(['avatar']);
     }
     /**
      * Get all the users with their permissions in a paginated format.