query-orchestration/vendor/github.com/permitio/permit-golang/pkg/api/roles.go

package api

import (
	"context"
	"github.com/google/uuid"
	"github.com/permitio/permit-golang/pkg/config"
	"github.com/permitio/permit-golang/pkg/errors"
	"github.com/permitio/permit-golang/pkg/models"
	"github.com/permitio/permit-golang/pkg/openapi"
	"go.uber.org/zap"
)

type Roles struct {
	permitBaseApi
}

func NewRolesApi(client *openapi.APIClient, config *config.PermitConfig) *Roles {
	return &Roles{
		permitBaseApi{
			client: client,
			config: config,
			logger: config.Logger,
		},
	}
}

type RoleRead struct {
	models.RoleRead
}

// List all roles in the current environment.
// Usage Example:
// `roles, err := PermitClient.Api.Roles.List(ctx,1, 10)`
func (r *Roles) List(ctx context.Context, page int, perPage int) ([]models.RoleRead, error) {
	perPageLimit := int32(DefaultPerPageLimit)
	if !isPaginationInLimit(int32(page), int32(perPage), perPageLimit) {
		err := errors.NewPermitPaginationError()
		r.logger.Error("error listing roles - max per page: "+string(perPageLimit), zap.Error(err))
		return nil, err
	}
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}
	roles, httpRes, err := r.client.RolesApi.ListRoles(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment()).Page(int32(page)).PerPage(int32(perPage)).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error listing roles", zap.Error(err))
		return nil, err
	}
	return roles, nil
}

// List all roles in the current environment by attributes filter
// Usage Example:
// `roles, err := PermitClient.Api.Roles.List(ctx,1, 10, map[string]string{"attribute": "xyz"})`
func (r *Roles) ListByAttributes(ctx context.Context, page int, perPage int, attributesFilter map[string]interface{}) ([]models.RoleRead, error) {
	perPageLimit := int32(DefaultPerPageLimit)
	if !isPaginationInLimit(int32(page), int32(perPage), perPageLimit) {
		err := errors.NewPermitPaginationError()
		r.logger.Error("error listing roles - max per page: "+string(perPageLimit), zap.Error(err))
		return nil, err
	}
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}
	roles, httpRes, err := r.client.RolesApi.ListRoles(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment()).Page(int32(page)).PerPage(int32(perPage)).AttributesFilter(attributesFilter).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error listing roles", zap.Error(err))
		return nil, err
	}
	return roles, nil
}

// Get a role by key.
// Usage Example:
// `role, err := PermitClient.Api.Roles.Get(ctx, "role-key")`
func (r *Roles) Get(ctx context.Context, roleKey string) (*models.RoleRead, error) {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}
	role, httpRes, err := r.client.RolesApi.GetRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error getting role: "+roleKey, zap.Error(err))
		return nil, err
	}

	return role, nil
}

// GetByKey get a role by key.
// Usage Example:
// `role, err := PermitClient.Api.Roles.GetByKey(ctx, "role-key")`
func (r *Roles) GetByKey(ctx context.Context, roleKey string) (*models.RoleRead, error) {
	return r.Get(ctx, roleKey)
}

// GetById get a role by id.
// Usage Example:
// `role, err := PermitClient.Api.Roles.GetById(ctx, uuid.New())`
func (r *Roles) GetById(ctx context.Context, roleKey uuid.UUID) (*models.RoleRead, error) {
	return r.Get(ctx, roleKey.String())
}

// Create a new role.
// Usage Example:
// ```
// roleCreate := models.NewRoleCreate("role-key", "role-name")
// role, err := PermitClient.Api.Roles.Create(ctx, roleCreate)
// ```
func (r *Roles) Create(ctx context.Context, roleCreate models.RoleCreate) (*models.RoleRead, error) {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}
	role, httpRes, err := r.client.RolesApi.CreateRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment()).RoleCreate(roleCreate).Execute()
	err = errors.HttpErrorHandle(err, httpRes)

	if err != nil {
		r.logger.Error("error creating role: "+roleCreate.GetKey(), zap.Error(err))
		return nil, err
	}

	r.logger.Debug("role created",
		zap.String("type", "role"),
		zap.String("key", role.GetKey()),
		zap.String("id", role.Id),
	)

	return role, nil
}

// Update a role.
// Usage Example:
// ```
// roleUpdate := models.NewRoleUpdate()
// roleUpdate.SetName("new-role-name")
// role, err := PermitClient.Api.Roles.Update(ctx, "role-key", roleUpdate)
// ```
func (r *Roles) Update(ctx context.Context, roleKey string, roleUpdate models.RoleUpdate) (*models.RoleRead, error) {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}
	role, httpRes, err := r.client.RolesApi.UpdateRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey).RoleUpdate(roleUpdate).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error updating role: "+roleKey, zap.Error(err))
		return nil, err
	}
	return role, nil
}

// Delete a role.
// Usage Example:
// `err := PermitClient.Api.Roles.Delete(ctx, "role-key")`
func (r *Roles) Delete(ctx context.Context, roleKey string) error {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return err
	}
	httpRes, err := r.client.RolesApi.DeleteRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error deleting role: "+roleKey, zap.Error(err))
		return err
	}
	return nil
}

// AssignPermissions assign permissions to a role, by role key and list of permission keys.
// If a permission is already granted to the role it is skipped.
// Each permission can be either a resource-action key, or {resource_key}:{action_key}, i.e: the "document:read".
// Usage Example:
// `err := PermitClient.Api.Roles.AssignPermissions(ctx, "role-key", []string{"document:read", "document:write"})`
func (r *Roles) AssignPermissions(ctx context.Context, roleKey string, permissions []string) error {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return err
	}
	addRolePermissions := *models.NewAddRolePermissions(permissions)
	_, httpRes, err := r.client.RolesApi.AssignPermissionsToRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey).AddRolePermissions(addRolePermissions).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error assigning these permissions: '"+listToString(permissions)+"' to role: "+roleKey, zap.Error(err))
		return err
	}
	return nil
}

// RemovePermissions remove permissions from a role, by role key and list of permission keys.
// If a permission is not found it is skipped.
// Each permission can be either a resource-action key, or {resource_key}:{action_key}, i.e: the "document:read".
// Usage Example:
// `err := PermitClient.Api.Roles.RemovePermissions(ctx, "role-key", []string{"document:read", "document:write"})`
func (r *Roles) RemovePermissions(ctx context.Context, roleKey string, permissions []string) error {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return err
	}
	removeRolePermissions := *models.NewRemoveRolePermissions(permissions)
	_, httpRes, err := r.client.RolesApi.RemovePermissionsFromRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey).RemoveRolePermissions(removeRolePermissions).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error removing these permissions: '"+listToString(permissions)+"' from role: "+roleKey, zap.Error(err))
		return err
	}
	return nil
}

func (r *Roles) BulkAssignRole(ctx context.Context, assignments []models.RoleAssignmentCreate) (*models.BulkRoleAssignmentReport, error) {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}

	req := r.client.RoleAssignmentsApi.BulkAssignRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment()).RoleAssignmentCreate(assignments)
	report, resp, err := req.Execute()

	err = errors.HttpErrorHandle(err, resp)

	if err != nil {
		r.logger.Error("failed assigning roles in bulk", zap.Error(err), zap.Int("count", len(assignments)))
		return nil, err
	}

	return report, nil
}

func (r *Roles) BulkUnAssignRole(ctx context.Context, unassignments []models.RoleAssignmentRemove) (*models.BulkRoleUnAssignmentReport, error) {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return nil, err
	}

	req := r.client.RoleAssignmentsApi.BulkUnassignRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment()).RoleAssignmentRemove(unassignments)
	report, resp, err := req.Execute()

	err = errors.HttpErrorHandle(err, resp)

	if err != nil {
		r.logger.Error("failed assigning roles in bulk", zap.Error(err), zap.Int("count", len(unassignments)))
		return nil, err
	}

	return report, nil
}

// AddParentRole add a parent role to a role, by role key and parent role key.
// Makes a role extend the parent role.
// In other words, a role will automatically be assigned any permissions that are granted to the parent role.
// We can say the role extends the parent role or inherits from the parent role.
// Usage Example:
// `err := PermitClient.Api.Roles.AddParentRole(ctx, "role-key", "parent-role-key")`
func (r *Roles) AddParentRole(ctx context.Context, roleKey string, parentRoleKey string) error {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return err
	}
	_, httpRes, err := r.client.RolesApi.AddParentRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey, parentRoleKey).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error adding parent role: '"+parentRoleKey+"' to role: "+roleKey, zap.Error(err))
		return err
	}
	return nil
}

// RemoveParentRole remove a parent role from a role, by role key and parent role key.
// Usage Example:
// `err := PermitClient.Api.Roles.RemoveParentRole(ctx, "role-key", "parent-role-key")`
func (r *Roles) RemoveParentRole(ctx context.Context, roleKey string, parentRoleKey string) error {
	err := r.lazyLoadPermitContext(ctx)
	if err != nil {
		r.logger.Error("", zap.Error(err))
		return err
	}
	_, httpRes, err := r.client.RolesApi.RemoveParentRole(ctx, r.config.Context.GetProject(), r.config.Context.GetEnvironment(), roleKey, parentRoleKey).Execute()
	err = errors.HttpErrorHandle(err, httpRes)
	if err != nil {
		r.logger.Error("error removing parent role: '"+parentRoleKey+"' from role: "+roleKey, zap.Error(err))
		return err
	}
	return nil
}