models: move Scope def into its own files

common/models/acl.js

@@ -468,47 +468,4 @@ ACL.checkAccessForToken = function (token, model, modelId, method, callback) {
   });
 };
 
-/*!
- * Schema for Scope which represents the permissions that are granted to client
- * applications by the resource owner
- */
-var ScopeSchema = {
-  name: {type: String, required: true},
-  description: String
-};
-
-/**
- * Resource owner grants/delegates permissions to client applications
- *
- * For a protected resource, does the client application have the authorization
- * from the resource owner (user or system)?
- *
- * Scope has many resource access entries
- * @class
- */
-var Scope = loopback.createModel('Scope', ScopeSchema);
-
-
-/**
- * Check if the given scope is allowed to access the model/property
- * @param {String} scope The scope name
- * @param {String} model The model name
- * @param {String} property The property/method/relation name
- * @param {String} accessType The access type
- * @callback {Function} callback
- * @param {String|Error} err The error object
- * @param {AccessRequest} result The access permission
- */
-Scope.checkPermission = function (scope, model, property, accessType, callback) {
-  this.findOne({where: {name: scope}}, function (err, scope) {
-    if (err) {
-      callback && callback(err);
-    } else {
-      var aclModel = loopback.getModelByType(ACL);
-      aclModel.checkPermission(ACL.SCOPE, scope.id, model, property, accessType, callback);
-    }
-  });
-};
-
 module.exports.ACL = ACL;
-module.exports.Scope = Scope;

common/models/scope.js

@@ -0,0 +1,39 @@
+var assert = require('assert');
+
+/**
+ * Resource owner grants/delegates permissions to client applications
+ *
+ * For a protected resource, does the client application have the authorization
+ * from the resource owner (user or system)?
+ *
+ * Scope has many resource access entries
+ *
+ * @class Scope
+ */
+
+module.exports = function(Scope) {
+  /**
+   * Check if the given scope is allowed to access the model/property
+   * @param {String} scope The scope name
+   * @param {String} model The model name
+   * @param {String} property The property/method/relation name
+   * @param {String} accessType The access type
+   * @callback {Function} callback
+   * @param {String|Error} err The error object
+   * @param {AccessRequest} result The access permission
+   */
+  Scope.checkPermission = function (scope, model, property, accessType, callback) {
+    var ACL = loopback.ACL;
+    assert(ACL,
+      'ACL model must be defined before Scope.checkPermission is called');
+
+    this.findOne({where: {name: scope}}, function (err, scope) {
+      if (err) {
+        callback && callback(err);
+      } else {
+        var aclModel = loopback.getModelByType(ACL);
+        aclModel.checkPermission(ACL.SCOPE, scope.id, model, property, accessType, callback);
+      }
+    });
+  };
+};

common/models/scope.json

@@ -0,0 +1,14 @@
+{
+  "name": "Scope",
+  "description": [
+    "Schema for Scope which represents the permissions that are granted",
+    "to client applications by the resource owner"
+  ],
+  "properties": {
+    "name": {
+      "type": "string",
+      "required": true
+    },
+    "description": "string"
+  }
+}

docs.json

@@ -16,6 +16,7 @@
 { "title": "Built-in models", "depth": 2 },
     "common/models/access-token.js",
     "common/models/acl.js",
+    "common/models/scope.js",
     "common/models/application.js",
     "common/models/email.js",
     "common/models/role.js",

lib/builtin-models.js

@@ -16,7 +16,10 @@ module.exports = function(loopback) {
   loopback.Role = require('../common/models/role').Role;
   loopback.RoleMapping = require('../common/models/role').RoleMapping;
   loopback.ACL = require('../common/models/acl').ACL;
-  loopback.Scope = require('../common/models/acl').Scope;
+
+  loopback.Scope = createModel(
+    require('../common/models/scope.json'),
+    require('../common/models/scope.js'));
 
   loopback.User = createModel(
     require('../common/models/user.json'),