Meteor-Community-Packages/meteor-roles

Add isInRole to JS API as well

Open

#56 geöffnet am 19. Sept. 2014

Auf GitHub ansehen
 (17 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (919 Stars) (161 Forks)batch import
enhancementgood first issuehelp wanted

Beschreibung

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' ) )
    // ...

Contributor Guide

Tech Stack
javascript
Domain
authenticationauthorization
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
understanding of Meteor roles APIbasic JavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.