Meteor-Community-Packages/meteor-roles

Add isInRole to JS API as well

Open

#56 ouverte le 19 sept. 2014

Voir sur GitHub
 (17 commentaires) (0 réactions) (0 assignés)JavaScript (919 stars) (161 forks)batch import
enhancementgood first issuehelp wanted

Description

Something you frequently do in the application, is check if the current user is allowed to access something. As there currently is no shorthand for this in the Javascript API, you have to do something like:

if ( Roles.userIsInRole( Meteor.userId(), 'permission' ) )
    // ...

I noticed the UI helper offers a beautiful shortand syntax for this, using the currently logged in user. I think it would make a lot of sense to add this to the API as well, so that one can simply do:

if ( Roles.isInRole( 'permission' ) )
    // ...

or even better:

if ( Roles.has( 'permission' ) )
    // ...

Guide contributeur

Stack technique
javascript
Domaine
authenticationauthorization
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
understanding of Meteor roles APIbasic JavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
The issue requests a shorthand method `Roles.isInRole('permission')` or `Roles.has('permission')` in the JS API, similar to the existing UI helper. To implement, look at the UI helper code in roles client.js (lines 28-35) and the current Roles.userIsInRole function. Add a new method that calls Roles.userIsInRole with the current user ID obtained from Meteor.userId(). Ensure the method is exported and documented.