masonite-permission 0.1.3

File management solution for Masonite

Masonite Permission

Introduction

Associate users with roles and permissions

Installation

pip install masonite-permission

Configuration

Add PermissionProvider to your project in config/providers.py:

# config/providers.py
# ...
from masonite_permission import PermissionProvider

# ...
PROVIDERS = [
    # ...
    # Third Party Providers
    PermissionProvider,
    # ...
]

Then you can publish the package resources (if needed) by doing:

python craft package:publish masonite-permission

Finally, extend User model class with HasRoles.

from masoniteorm.models import Model
from masoniteorm.scopes import SoftDeletesMixin
from masonite.authentication import Authenticates
from masonite_permission.models.has_roles import HasRoles

class User(Model, SoftDeletesMixin, Authenticates, HasRoles):
    """User Model."""

    __fillable__ = ["name", "email", "password"]
    __hidden__ = ["password"]
    __auth__ = "email"

Usage

Role

Methods that can be used in role model object:

""" Creating Role """
role = Role.create({
  "name": "Admin",
  "slug": "admin" # must be unique
})

""" collection can be synced """
permission_collection = Permission.all()

role.sync_permissions(permission_collection)

""" id will also work """
permission_ids = [1,2,3,4,5]
role.sync_permissions(permission_ids)

""" clear related data """
role.sync_permissions([])


""" Attach/Detatch Permission """
permission = Permission.first()
role.attach_permission(permission) # add permission to role, ignores if permission already exists
role.detach_permission(permission) # remove permission from role, ignores if permission doesn't exist

""" this can also be done """
role.attach_permission(1) # passing permission id instead of object, ignores if permission already exists
role.detatch_permission(1) # passing permission id instead of object, ignores if permission doesn't exist

Permission

Methods that can be used in permission model object:

""" Creating Permission """
permission = Permission.create({
  "name": "Create Post",
  "slug": "create-post" # must be unique
})

""" collection can be synced """
roles_collection = Role.all()

permission.sync_roles(role_collection)

""" id will also work """
role_ids = [1,2,3,4,5]
permission.sync_roles(role_ids)

""" clear related data """
permissioin.sync_roles([])


""" Attach/Detatch Role """
role = Role.first()
permission.attach_role(role) # add role to permission, ignores if role already exists
permission.detach_role(role) # remove role from permission, ignores if role doesn't exist

""" this can also be done """
permission.attach_role(1) # passing role id instead of object, ignores if role already exists
permission.detatch_role(1) # passing role id instead of object, ignores if role doesn't exist

User

Methods that can be used in user model object:

user = User.first()

# Add/Remove single role
role = Role.first()

user.assign_role(role) # or you can pass role id
user.remove_role(role) # or you can pass role id

# if you want to add multiple roles
roles = Role.all()

user.sync_roles(roles) # or you can also pass list of ids...

# remove all roles from user at once
user.sync_roles([])

# check if user has role
user.has_role("role-1") # returns boolean

# check if user has any of the roles
user.has_any_role(["role-1", "role-2"]) # returns boolean

# check if user has all of the roles
user.has_all_roles(["role-1", "role-2"]) # returns boolean

# check if user has permission
user.has_permission("permission-1") # returns boolean

# check if user has any of the permissions
user.has_any_permission(["permission-1", "permission-2"]) # returns boolean

# check if user has all of the permissions
user.has_all_permissions(["permission-1", "permission-2"]) # returns boolean

Using in Template

In case of Roles Checking if user has role.

{% if user.is_("admin") %}
    <p>You are an admin</p>
{% endif %}

Checking if user has any of the roles

{% if user.is_("admin|editor|truck-driver") %}
    <p>You can be either admin, editor, truck driver or all of those</p>
{% endif %}

Checking if user has all of the roles

{% if user.is_("admin,editor,truck-driver") %}
    <p>You are an admin, editor and also truck-driver</p>
{% endif %}

In case of Permissions Checking if user can do {permission}.

{% if user.can_("edit-post") %}
    <p>You can edit post</p>
{% endif %}

Checking if user can do any one or more of the {permissions}

{% if user.can_("edit-post|delete-post") %}
    <p>You can either edit-post, delete-post or both.</p>
{% endif %}

Checking if user can do all of the {permissions}

{% if user.can_("edit-post,delete-post") %}
    <p>You can edit post and also delete post.</p>
{% endif %}

Contributing

Please read the Contributing Documentation here.

Maintainers

• Yubaraj Shrestha

License

Masonite Permission is open-sourced software licensed under the MIT license.