models: move User LDL def into `user.json`

common/models/user.js

@@ -2,107 +2,18 @@
  * Module Dependencies.
  */
 
-var PersistedModel = require('../../lib/loopback').PersistedModel
+var loopback = require('../../lib/loopback')
-  , loopback = require('../../lib/loopback')
   , path = require('path')
   , SALT_WORK_FACTOR = 10
   , crypto = require('crypto')
   , bcrypt = require('bcryptjs')
-  , BaseAccessToken = require('./access-token')
   , DEFAULT_TTL = 1209600 // 2 weeks in seconds
   , DEFAULT_RESET_PW_TTL = 15 * 60 // 15 mins in seconds
   , DEFAULT_MAX_TTL = 31556926 // 1 year in seconds
-  , Role = require('./role').Role
-  , ACL = require('./acl').ACL
   , assert = require('assert');
 
 var debug = require('debug')('loopback:user');
 
-/*!
- * Default User properties.
- */
-
-var properties = {
-    realm: {type: String},
-    username: {type: String},
-    password: {type: String, required: true},
-    credentials: Object, // deprecated, to be removed in 2.x
-    challenges: Object, // deprecated, to be removed in 2.x
-    email: {type: String, required: true},
-    emailVerified: Boolean,
-    verificationToken: String,
-    status: String,
-    created: Date,
-    lastUpdated: Date
-};
-
-var options = {
-  hidden: ['password'],
-  acls: [
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.DENY
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.ALLOW,
-      property: 'create'
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.OWNER,
-      permission: ACL.ALLOW,
-      property: 'deleteById'
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.ALLOW,
-      property: "login"
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.ALLOW,
-      property: "logout"
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.OWNER,
-      permission: ACL.ALLOW,
-      property: "findById"
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.OWNER,
-      permission: ACL.ALLOW,
-      property: "updateAttributes"
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.ALLOW,
-      property: "confirm"
-    },
-    {
-      principalType: ACL.ROLE,
-      principalId: Role.EVERYONE,
-      permission: ACL.ALLOW,
-      property: "resetPassword",
-      accessType: ACL.EXECUTE
-    }
-  ],
-  relations: {
-    accessTokens: {
-      type: 'hasMany',
-      model: 'AccessToken',
-      foreignKey: 'userId'
-    }
-  }
-};
-
 /**
  * Extends from the built in `loopback.Model` type.
  *
@@ -122,11 +33,11 @@ var options = {
  * @property {Boolean} emailVerified Set when a user's email has been verified via `confirm()`
  * @property {String} verificationToken Set when `verify()` is called
  *
- * @class
+ * @class User
- * @inherits {Model}
+ * @inherits {PersistedModel}
  */
 
-var User = module.exports = PersistedModel.extend('User', properties, options);
+module.exports = function(User) {
 
 /**
  * Create access token for the logged in user. This method can be overridden to
@@ -177,7 +88,6 @@ User.login = function (credentials, include, fn) {
   }
 
 
-
   var query = {};
   if (credentials.email) {
     query.email = credentials.email;
@@ -464,7 +374,7 @@ User.resetPassword = function(options, cb) {
 
 User.setup = function() {
   // We need to call the base class's setup method
-  PersistedModel.setup.call(this);
+  User.base.setup.call(this);
   var UserModel = this;
 
   // max ttl
@@ -491,13 +401,11 @@ User.setup = function () {
       description: 'Login a user with username/email and password',
       accepts: [
         {arg: 'credentials', type: 'object', required: true, http: {source: 'body'}},
-        {arg: 'include', type: 'string', http: {source: 'query' }, description:
+        {arg: 'include', type: 'string', http: {source: 'query' }, description: 'Related objects to include in the response. ' +
-          'Related objects to include in the response. ' +
           'See the description of return value for more details.'}
       ],
       returns: {
-        arg: 'accessToken', type: 'object', root: true, description:
+        arg: 'accessToken', type: 'object', root: true, description: 'The response body contains properties of the AccessToken created on login.\n' +
-          'The response body contains properties of the AccessToken created on login.\n' +
           'Depending on the value of `include` parameter, the body may contain ' +
           'additional properties:\n\n' +
           '  - `user` - `{User}` - Data of the currently logged in user. (`include=user`)\n\n'
@@ -517,8 +425,7 @@ User.setup = function () {
           var tokenID = accessToken && accessToken.id;
 
           return tokenID;
-        }, description:
+        }, description: 'Do not supply this argument, it is automatically extracted ' +
-          'Do not supply this argument, it is automatically extracted ' +
           'from request headers.'
         }
       ],
@@ -561,8 +468,11 @@ User.setup = function () {
   });
 
   // default models
-  UserModel.email = require('./email');
+  assert(loopback.Email, 'Email model must be defined before User model');
-  UserModel.accessToken = require('./access-token');
+  UserModel.email = loopback.Email;
+
+  assert(loopback.AccessToken, 'AccessToken model must be defined before User model');
+  UserModel.accessToken = loopback.AccessToken;
 
   // email validation regex
   var re = /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
@@ -579,3 +489,5 @@ User.setup = function () {
  */
 
 User.setup();
+
+};

common/models/user.json

@@ -0,0 +1,96 @@
+{
+  "name": "User",
+  "properties": {
+    "realm": {
+      "type": "string"
+    },
+    "username": {
+      "type": "string"
+    },
+    "password": {
+      "type": "string",
+      "required": true
+    },
+    "credentials": {
+      "type": "object",
+      "deprecated": true
+    },
+    "challenges": {
+      "type": "object",
+      "deprecated": true
+    },
+    "email": {
+      "type": "string",
+      "required": true
+    },
+    "emailVerified": "boolean",
+    "verificationToken": "string",
+    "status": "string",
+    "created": "date",
+    "lastUpdated": "date"
+  },
+  "hidden": ["password"],
+  "acls": [
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "DENY"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "ALLOW",
+      "property": "create"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$owner",
+      "permission": "ALLOW",
+      "property": "deleteById"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "ALLOW",
+      "property": "login"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "ALLOW",
+      "property": "logout"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$owner",
+      "permission": "ALLOW",
+      "property": "findById"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$owner",
+      "permission": "ALLOW",
+      "property": "updateAttributes"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "ACL.ALLOW",
+      "property": "confirm"
+    },
+    {
+      "principalType": "ROLE",
+      "principalId": "$everyone",
+      "permission": "ALLOW",
+      "property": "resetPassword",
+      "accessType": "EXECUTE"
+    }
+  ],
+  "relations": {
+    "accessTokens": {
+      "type": "hasMany",
+      "model": "AccessToken",
+      "foreignKey": "userId"
+    }
+  }
+}

lib/builtin-models.js

@@ -1,12 +1,19 @@
 module.exports = function(loopback) {
+  // NOTE(bajtos) we must use static require() due to browserify limitations
+
   loopback.Email = require('../common/models/email');
-  loopback.User = require('../common/models/user');
+
   loopback.Application = require('../common/models/application');
   loopback.AccessToken = require('../common/models/access-token');
   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.User = createModel(
+    require('../common/models/user.json'),
+    require('../common/models/user.js'));
+
   loopback.Change = require('../common/models/change');
   loopback.Checkpoint = require('../common/models/checkpoint');
 
@@ -28,4 +35,10 @@ module.exports = function(loopback) {
   loopback.ACL.autoAttach = dataSourceTypes.DB;
   loopback.Scope.autoAttach = dataSourceTypes.DB;
   loopback.Application.autoAttach = dataSourceTypes.DB;
+
+  function createModel(definitionJson, customizeFn) {
+    var Model = loopback.createModel(definitionJson);
+    customizeFn(Model);
+    return Model;
+  }
 };