Skip to content

Commit

Permalink
Add manager for the Client Grants endpoint (updated) (#142)
Browse files Browse the repository at this point in the history
* Add a manager for the Client Grants endpoint.

Issue #128

* Add tests for the ClientGrantsManager.

Issue #128

* Fix URL in ClientGrantsManager.

Issue #128

* Update tests for the management SDK.

Issue #128

* Added missing client grants manager methods to management client.
  • Loading branch information
ognus authored and glena committed Nov 9, 2016
1 parent 96b2a12 commit eafeb76
Show file tree
Hide file tree
Showing 4 changed files with 633 additions and 0 deletions.
149 changes: 149 additions & 0 deletions src/management/ClientGrantsManager.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
var RestClient = require('rest-facade').Client;
var ArgumentError = require('../exceptions').ArgumentError;
var utils = require('../utils');


/**
* @class ClientGrantsManager
* Auth0 Client Grants Manager.
*
* See {@link https://auth0.com/docs/api/v2#!/Client_Grants Client Grants}
*
* @constructor
* @memberOf module:management
*
* @param {Object} options The client options.
* @param {String} options.baseUrl The URL of the API.
* @param {Object} [options.headers] Headers to be included in all requests.
*/
var ClientGrantsManager = function (options) {
if (options === null || typeof options !== 'object') {
throw new ArgumentError('Must provide client options');
}

if (options.baseUrl === null || options.baseUrl === undefined) {
throw new ArgumentError('Must provide a base URL for the API');
}

if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
throw new ArgumentError('The provided base URL is invalid');
}

/**
* Options object for the Rest Client instance.
*
* @type {Object}
*/
var clientOptions = {
headers: options.headers,
query: { repeatParams: false }
};

/**
* Provides an abstraction layer for consuming the
* {@link https://auth0.com/docs/api/v2#!/Client_Grants Auth0 Client Grantss endpoint}.
*
* @type {external:RestClient}
*/
this.resource = new RestClient(options.baseUrl + '/client-grants/:id', clientOptions);
};


/**
* Create an Auth0 client grant.
*
* @method create
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
* if (err) {
* // Handle error.
* }
*
* // Client grant created.
* });
*
* @param {Object} data The client data object.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ClientGrantsManager, 'create', 'resource.create');


/**
* Get all Auth0 Client Grants.
*
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.getAll(function (err, grants) {
* console.log(grants.length);
* });
*
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ClientGrantsManager, 'getAll', 'resource.getAll');


/**
* Update an Auth0 client grant.
*
* @method update
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* var data = {
* client_id: CLIENT_ID,
* audience: AUDIENCE,
* scope: []
* };
* var params = { id: CLIENT_GRANT_ID };
*
* management.clientGrants.update(params, data, function (err, grant) {
* if (err) {
* // Handle error.
* }
*
* console.log(grant.id);
* });
*
* @param {Object} params Client parameters.
* @param {String} params.id Client grant ID.
* @param {Object} data Updated client data.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ClientGrantsManager, 'update', 'resource.patch');


/**
* Delete an Auth0 client grant.
*
* @method delete
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
* if (err) {
* // Handle error.
* }
*
* // Grant deleted.
* });
*
* @param {Object} params Client parameters.
* @param {String} params.id Client grant ID.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ClientGrantsManager, 'delete', 'resource.delete');


module.exports = ClientGrantsManager;
106 changes: 106 additions & 0 deletions src/management/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ var ArgumentError = require('../exceptions').ArgumentError;

// Managers.
var ClientsManager = require('./ClientsManager');
var ClientGrantsManager = require('./ClientGrantsManager');
var UsersManager = require('./UsersManager');
var ConnectionsManager = require('./ConnectionsManager');
var BlacklistedTokensManager = require('./BlacklistedTokensManager');
Expand Down Expand Up @@ -86,6 +87,14 @@ var ManagementClient = function (options) {
*/
this.clients = new ClientsManager(managerOptions);

/**
* Simple abstraction for performing CRUD operations on the client grants
* endpoint.
*
* @type {ClientGrantsManager}
*/
this.clientGrants = new ClientGrantsManager(managerOptions);

/**
* Simple abstraction for performing CRUD operations on the
* users endpoint.
Expand Down Expand Up @@ -438,6 +447,103 @@ utils.wrapPropertyMethod(ManagementClient, 'updateClient', 'clients.update');
utils.wrapPropertyMethod(ManagementClient, 'deleteClient', 'clients.delete');


/**
* Get all Auth0 Client Grants.
*
* @method getAll
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.getAll(function (err, grants) {
* console.log(grants.length);
* });
*
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'getClientGrants', 'clientGrants.getAll');


/**
* Create an Auth0 client grant.
*
* @method create
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.create(data, function (err) {
* if (err) {
* // Handle error.
* }
*
* // Client grant created.
* });
*
* @param {Object} data The client data object.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'createClientGrant', 'clientGrants.create');


/**
* Update an Auth0 client grant.
*
* @method update
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* var data = {
* client_id: CLIENT_ID,
* audience: AUDIENCE,
* scope: []
* };
* var params = { id: CLIENT_GRANT_ID };
*
* management.clientGrants.update(params, data, function (err, grant) {
* if (err) {
* // Handle error.
* }
*
* console.log(grant.id);
* });
*
* @param {Object} params Client parameters.
* @param {String} params.id Client grant ID.
* @param {Object} data Updated client data.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'updateClientGrant', 'clientGrants.patch');


/**
* Delete an Auth0 client grant.
*
* @method delete
* @memberOf module:management.ClientGrantsManager.prototype
*
* @example
* management.clientGrants.delete({ id: GRANT_ID }, function (err) {
* if (err) {
* // Handle error.
* }
*
* // Grant deleted.
* });
*
* @param {Object} params Client parameters.
* @param {String} params.id Client grant ID.
* @param {Function} [cb] Callback function.
*
* @return {Promise|undefined}
*/
utils.wrapPropertyMethod(ManagementClient, 'deleteClientGrant', 'clientGrants.delete');


/**
* Create an Auth0 credential.
*
Expand Down
Loading

0 comments on commit eafeb76

Please sign in to comment.