From a72a42e4368ca0c71bb9d94ea616b515a1cdd16f Mon Sep 17 00:00:00 2001
From: Raymond Feng <raymond@strongloop.com>
Date: Fri, 22 Nov 2013 09:08:44 -0800
Subject: [PATCH] Add Role.findByName and more comments

---
 lib/models/acl.js  | 16 ++++++++--------
 lib/models/role.js |  6 ++++++
 2 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/lib/models/acl.js b/lib/models/acl.js
index 918fcfbe..6b0562d8 100644
--- a/lib/models/acl.js
+++ b/lib/models/acl.js
@@ -96,15 +96,15 @@ var ACL = loopback.createModel('ACL', ACLSchema);
 
 ACL.ALL = '*';
 
-ACL.DEFAULT = 'DEFAULT';
-ACL.ALLOW = 'ALLOW';
-ACL.ALARM = 'ALARM';
-ACL.AUDIT = 'AUDIT';
-ACL.DENY = 'DENY';
+ACL.DEFAULT = 'DEFAULT'; // Not specified
+ACL.ALLOW = 'ALLOW'; // Allow
+ACL.ALARM = 'ALARM'; // Warn - send an alarm
+ACL.AUDIT = 'AUDIT'; // Audit - record the access
+ACL.DENY = 'DENY'; // Deny
 
-ACL.READ = 'READ';
-ACL.WRITE = 'WRITE';
-ACL.EXECUTE = 'EXECUTE';
+ACL.READ = 'READ'; // Read operation
+ACL.WRITE = 'WRITE'; // Write operation
+ACL.EXECUTE = 'EXECUTE'; // Execute operation
 
 ACL.USER = 'USER';
 ACL.APP = ACL.APPLICATION = 'APP';
diff --git a/lib/models/role.js b/lib/models/role.js
index 56284e43..bfa7430c 100644
--- a/lib/models/role.js
+++ b/lib/models/role.js
@@ -1,4 +1,5 @@
 var loopback = require('../loopback');
+var assert = require('assert');
 
 // Role model
 var RoleSchema = {
@@ -91,6 +92,11 @@ var Role = loopback.createModel('Role', RoleSchema, {
   }
 });
 
+Role.findByName = function(name, callback) {
+  assert(name, 'Name is required');
+  Role.findOne({where: {name: name}}, callback);
+};
+
 // Set up the connection to users/applications/roles once the model
 Role.once('dataSourceAttached', function () {
   Role.prototype.users = function (callback) {