verdnatura-mirror
/
loopback
mirror of https://github.com/strongloop/loopback.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into feature/remoting-connector

This commit is contained in:
Ritchie Martori 2014-04-14 11:01:20 -07:00
parent b4da270a49 5ffc0e8979
commit 5298834c68
13 changed files with 307 additions and 174 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,5 +1,7 @@
# LoopBack
For a quick introduction and overview, see http://loopback.io/.
## Documentation
[See the full documentation](http://docs.strongloop.com/display/DOC/LoopBack).

2
docs/api-model.md
View File

@ -49,7 +49,7 @@ var oracle = loopback.createDataSource({
User.attachTo(oracle);
```
**Note:** until a model is attached to a data source it will **not** have any **attached methods**.
NOTE: until a model is attached to a data source it will not have any attached methods.
### Properties

96
lib/application.js
View File

@ -48,8 +48,7 @@ var app = exports = module.exports = {};
/**
* Lazily load a set of [remote objects](http://apidocs.strongloop.com/strong-remoting/#remoteobjectsoptions).
*
* **NOTE:** Calling `app.remotes()` multiple times will only ever return a
* single set of remote objects.
* **NOTE:** Calling `app.remotes()` more than once returns only a single set of remote objects.
* @returns {RemoteObjects}
*/
@ -88,11 +87,13 @@ app.disuse = function (route) {
* });
* ```
*
* @param {String} modelName The name of the model to define
* @options {Object} config The model's configuration
* @property {String} dataSource The `DataSource` to attach the model to
* @property {Object} [options] an object containing `Model` options
* @property {Object} [properties] object defining the `Model` properties in [LoopBack Definition Language](http://docs.strongloop.com/loopback-datasource-juggler/#loopback-definition-language)
* @param {String} modelName The name of the model to define.
* @options {Object} config The model's configuration.
* @property {String|DataSource} dataSource The `DataSource` to which to attach the model.
* @property {Object} [options] an object containing `Model` options.
* @property {ACL[]} [options.acls] an array of `ACL` definitions.
* @property {String[]} [options.hidden] **experimental** an array of properties to hide when accessed remotely.
* @property {Object} [properties] object defining the `Model` properties in [LoopBack Definition Language](http://docs.strongloop.com/loopback-datasource-juggler/#loopback-definition-language).
* @end
* @returns {ModelConstructor} the model class
*/
@ -127,14 +128,11 @@ app.model = function (Model, config) {
}
/**
* Get the models exported by the app. Only models defined using `app.model()`
* will show up in this list.
* Get the models exported by the app. Returns only models defined using `app.model()`
*
* There are two ways how to access models.
* There are two ways to access models:
*
* **1. A list of all models**
*
* Call `app.models()` to get a list of all models.
* 1. Call `app.models()` to get a list of all models.
*
* ```js
* var models = app.models();
@ -144,12 +142,11 @@ app.model = function (Model, config) {
* });
* ```
*
* **2. By model name**
*
* **2. Use `app.model` to access a model by name.
* `app.model` has properties for all defined models.
*
* In the following example the `Product` and `CustomerReceipt` models are
* accessed using the `models` object.
* The following example illustrates accessing the `Product` and `CustomerReceipt` models
* using the `models` object.
*
* ```js
* var loopback = require('loopback');
@ -176,7 +173,7 @@ app.model = function (Model, config) {
* var customerReceipt = app.models.customerReceipt;
* ```
*
* @returns {Array} a list of model classes
* @returns {Array} Array of model classes.
*/
app.models = function () {
@ -198,6 +195,7 @@ app.dataSource = function (name, config) {
/**
* Get all remote objects.
* @returns {Object} [Remote objects](http://apidocs.strongloop.com/strong-remoting/#remoteobjectsoptions).
*/
app.remoteObjects = function () {
@ -218,8 +216,7 @@ app.remoteObjects = function () {
/**
* Enable swagger REST API documentation.
*
* > Note: This method is deprecated, use the extension
* [loopback-explorer](http://npmjs.org/package/loopback-explorer) instead.
* **Note**: This method is deprecated. Use [loopback-explorer](http://npmjs.org/package/loopback-explorer) instead.
*
* **Options**
*
@ -312,29 +309,30 @@ app.enableAuth = function() {
/**
* Initialize an application from an options object or a set of JSON and JavaScript files.
*
* **What happens during an app _boot_?**
* This function takes an optional argument that is either a string or an object.
*
* 1. **DataSources** are created from an `options.dataSources` object or `datasources.json` in the current directory
* 2. **Models** are created from an `options.models` object or `models.json` in the current directory
* 3. Any JavaScript files in the `./models` directory are loaded with `require()`.
* 4. Any JavaScript files in the `./boot` directory are loaded with `require()`.
* If the argument is a string, then it sets the application root directory based on the string value. Then it:
* 1. Creates DataSources from the `datasources.json` file in the application root directory.
* 2. Creates Models from the `models.json` file in the application root directory.
*
* **Options**
* If the argument is an object, then it looks for `model`, `dataSources`, and `appRootDir` properties of the object.
* If the object has no `appRootDir` property then it sets the current working directory as the application root directory.
* Then it:
* 1. Creates DataSources from the `options.dataSources` object.
* 2. Creates Models from the `options.models` object.
*
* - `appRootDir` - _optional_ - the directory to use when loading JSON and JavaScript files
* - `models` - _optional_ - an object containing `Model` definitions
* - `dataSources` - _optional_ - an object containing `DataSource` definitions
* In both cases, the function loads JavaScript files in the `/models` and `/boot` subdirectories of the application root directory with `require()`.
*
* > **NOTE:** mixing `app.boot()` and `app.model(name, config)` in multiple
* > files may result
* > in models being **undefined** due to race conditions. To avoid this when
* > using `app.boot()`
* > make sure all models are passed as part of the `models` definition.
* **NOTE:** mixing `app.boot()` and `app.model(name, config)` in multiple
* files may result in models being **undefined** due to race conditions.
* To avoid this when using `app.boot()` make sure all models are passed as part of the `models` definition.
*
* Throws an error if the config object is not valid or if boot fails.
*
* <a name="model-definition"></a>
* **Model Definitions**
*
* The following is an example of an object containing two `Model` definitions: "location" and "inventory".
* The following is example JSON for two `Model` definitions: "dealership" and "location".
*
* ```js
* {
@ -379,20 +377,13 @@ app.enableAuth = function() {
* }
* }
* ```
*
* **Model definition properties**
*
* - `dataSource` - **required** - a string containing the name of the data source definition to attach the `Model` to
* - `options` - _optional_ - an object containing `Model` options
* - `properties` _optional_ - an object defining the `Model` properties in [LoopBack Definition Language](http://docs.strongloop.com/loopback-datasource-juggler/#loopback-definition-language)
*
* **DataSource definition properties**
*
* - `connector` - **required** - the name of the [connector](#working-with-data-sources-and-connectors)
* @options {String|Object} options Boot options; If String, this is the application root directory; if object, has below properties.
* @property {String} appRootDir Directory to use when loading JSON and JavaScript files (optional). Defaults to the current directory (`process.cwd()`).
* @property {Object} models Object containing `Model` definitions (optional).
* @property {Object} dataSources Object containing `DataSource` definitions (optional).
* @end
*
* @header app.boot([options])
* @throws {Error} If config is not valid
* @throws {Error} If boot fails
*/
app.boot = function(options) {
@ -545,7 +536,11 @@ function dataSourcesFromConfig(config) {
function modelFromConfig(name, config, app) {
var ModelCtor = require('./loopback').createModel(name, config.properties, config.options);
var dataSource = app.dataSources[config.dataSource];
var dataSource = config.dataSource;
if(typeof dataSource === 'string') {
dataSource = app.dataSources[dataSource];
}
assert(isDataSource(dataSource), name + ' is referencing a dataSource that does not exist: "'+ config.dataSource +'"');
@ -644,7 +639,8 @@ function clearHandlerCache(app) {
app._handlers = undefined;
}
/**
/*!
* This function is now deprecated.
* Install all express middleware required by LoopBack.
*
* It is possible to inject your own middleware by listening on one of the
@ -793,7 +789,7 @@ app.installMiddleware = function() {
* This way the port param contains always the real port number, even when
* listen was called with port number 0.
*
* @param {Function=} cb If specified, the callback will be added as a listener
* @param {Function} cb If specified, the callback is added as a listener
* for the server's "listening" event.
* @returns {http.Server} A node `http.Server` with this application configured
* as the request handler.

29
lib/loopback.js
View File

@ -15,27 +15,29 @@ var express = require('express')
, assert = require('assert');
/**
* `loopback` is the main entry for LoopBack core module. It provides static
* Main entry for LoopBack core module. It provides static properties and
* methods to create models and data sources. The module itself is a function
* that creates loopback `app`. For example,
*
*
* ```js
* var loopback = require('loopback');
* var app = loopback();
* ```
*
* @class loopback
* @header loopback
*/
var loopback = exports = module.exports = createApplication;
/**
* Is this a browser environment?
* True if running in a browser environment; false otherwise.
*/
loopback.isBrowser = typeof window !== 'undefined';
/**
* Is this a server environment?
* True if running in a server environment; false otherwise.
*/
loopback.isServer = !loopback.isBrowser;
@ -116,11 +118,10 @@ loopback.errorHandler.title = 'Loopback';
/**
* Create a data source with passing the provided options to the connector.
*
* @param {String} name (optional)
* @param {Object} options
*
* - connector - an loopback connector
* - other values - see the specified `connector` docs
* @param {String} name Optional name.
* @options {Object} Data Source options
* @property {Object} connector LoopBack connector.
* @property {*} Other&nbsp;properties See the relevant connector documentation.
*/
loopback.createDataSource = function (name, options) {
@ -141,7 +142,7 @@ loopback.createDataSource = function (name, options) {
/**
* Create a named vanilla JavaScript class constructor with an attached set of properties and options.
*
* @param {String} name - must be unique
* @param {String} name Unique name.
* @param {Object} properties
* @param {Object} options (optional)
*/
@ -223,7 +224,7 @@ loopback.memory = function (name) {
/**
* Look up a model class by name from all models created by loopback.createModel()
* @param {String} modelName The model name
* @return {Model} The model class
* @returns {Model} The model class
*/
loopback.getModel = function(modelName) {
return loopback.Model.modelBuilder.models[modelName];
@ -233,7 +234,7 @@ loopback.getModel = function(modelName) {
* Look up a model class by the base model class. The method can be used by LoopBack
* to find configured models in models.json over the base model.
* @param {Model} The base model class
* @return {Model} The subclass if found or the base class
* @returns {Model} The subclass if found or the base class
*/
loopback.getModelByType = function(modelType) {
assert(typeof modelType === 'function', 'The model type must be a constructor');
@ -250,7 +251,7 @@ loopback.getModelByType = function(modelType) {
* Set the default `dataSource` for a given `type`.
* @param {String} type The datasource type
* @param {Object|DataSource} dataSource The data source settings or instance
* @return {DataSource} The data source instance
* @returns {DataSource} The data source instance
*/
loopback.setDefaultDataSourceForType = function(type, dataSource) {
@ -267,7 +268,7 @@ loopback.setDefaultDataSourceForType = function(type, dataSource) {
/**
* Get the default `dataSource` for a given `type`.
* @param {String} type The datasource type
* @return {DataSource} The data source instance
* @returns {DataSource} The data source instance
*/
loopback.getDefaultDataSourceForType = function(type) {

3
lib/models/model.js
View File

@ -100,8 +100,9 @@ Model.setup = function () {
};
// Map the prototype method to /:id with data in the body
var idDesc = ModelCtor.modelName + ' id';
ModelCtor.sharedCtor.accepts = [
{arg: 'id', type: 'any', http: {source: 'path'}}
{arg: 'id', type: 'any', http: {source: 'path'}, description: idDesc}
// {arg: 'instance', type: 'object', http: {source: 'body'}}
];

17
lib/models/user.js
View File

@ -49,6 +49,7 @@ var properties = {
};
var options = {
hidden: ['password'],
acls: [
{
principalType: ACL.ROLE,
@ -90,6 +91,12 @@ var options = {
principalId: Role.OWNER,
permission: ACL.ALLOW,
property: "updateAttributes"
},
{
principalType: ACL.ROLE,
principalId: Role.EVERYONE,
permission: ACL.ALLOW,
property: "confirm"
}
],
relations: {
@ -273,8 +280,11 @@ User.prototype.verify = function (options, fn) {
+ '://'
+ options.host
+ User.http.path
+ User.confirm.http.path;
+ User.confirm.http.path
+ '?uid='
+ options.user.id
+ '&redirect='
+ options.redirect;
// Email model
@ -297,7 +307,7 @@ User.prototype.verify = function (options, fn) {
// TODO - support more verification types
function sendEmail(user) {
options.verifyHref += '?token=' + user.verificationToken;
options.verifyHref += '&token=' + user.verificationToken;
options.text = options.text || 'Please verify your email by opening this link in a web browser:\n\t{href}';
@ -306,6 +316,7 @@ User.prototype.verify = function (options, fn) {
var template = loopback.template(options.template);
Email.send({
to: options.to || user.email,
from: options.from,
subject: options.subject || 'Thanks for Registering',
text: options.text,
html: template(options)

6
package.json
View File

@ -9,7 +9,7 @@
"Platform",
"mBaaS"
],
"version": "1.7.2",
"version": "1.7.6",
"scripts": {
"test": "mocha -R spec"
},
@ -29,10 +29,10 @@
"async": "~0.2.10"
},
"peerDependencies": {
"loopback-datasource-juggler": "~1.3.3"
"loopback-datasource-juggler": "~1.3.11"
},
"devDependencies": {
"loopback-datasource-juggler": "~1.3.3",
"loopback-datasource-juggler": "~1.3.11",
"mocha": "~1.17.1",
"strong-task-emitter": "0.0.x",
"supertest": "~0.9.0",

6
test/access-control.integration.js
View File

@ -55,6 +55,7 @@ describe('access control - integration', function () {
return '/api/accessTokens/' + this.randomToken.id;
}
});
*/
describe('/users', function () {
@ -94,6 +95,10 @@ describe('access control - integration', function () {
});
lt.describe.whenCalledRemotely('GET', '/api/users/:id', function() {
lt.it.shouldBeAllowed();
it('should not include a password', function() {
var user = this.res.body;
assert.equal(user.password, undefined);
});
});
lt.describe.whenCalledRemotely('PUT', '/api/users/:id', function() {
lt.it.shouldBeAllowed();
@ -136,7 +141,6 @@ describe('access control - integration', function () {
return '/api/banks/' + this.bank.id;
}
});
*/
describe('/accounts', function () {
lt.beforeEach.givenModel('account');

10
test/fixtures/simple-integration-app/models.json vendored
View File

@ -30,7 +30,15 @@
"widget": {
"properties": {},
"public": true,
"dataSource": "db"
"dataSource": "db",
"options": {
"relations": {
"store": {
"model": "store",
"type": "belongsTo"
}
}
}
},
"store": {
"properties": {},

59
test/hidden-properties.test.js Normal file
View File

@ -0,0 +1,59 @@
var loopback = require('../');
describe('hidden properties', function () {
beforeEach(function (done) {
var app = this.app = loopback();
var Product = this.Product = app.model('product', {
options: {hidden: ['secret']},
dataSource: loopback.memory()
});
var Category = this.Category = this.app.model('category', {
dataSource: loopback.memory()
});
Category.hasMany(Product);
app.use(loopback.rest());
Category.create({
name: 'my category'
}, function(err, category) {
category.products.create({
name: 'pencil',
secret: 'a secret'
}, done);
});
});
afterEach(function(done) {
var Product = this.Product;
this.Category.destroyAll(function() {
Product.destroyAll(done);
});
})
it('should hide a property remotely', function (done) {
request(this.app)
.get('/products')
.expect('Content-Type', /json/)
.expect(200)
.end(function(err, res){
if(err) return done(err);
var product = res.body[0];
assert.equal(product.secret, undefined);
done();
});
});
it('should hide a property of nested models', function (done) {
var app = this.app;
request(app)
.get('/categories?filter[include]=products')
.expect('Content-Type', /json/)
.expect(200)
.end(function(err, res){
if(err) return done(err);
var category = res.body[0];
var product = category.products[0];
assert.equal(product.secret, undefined);
done();
});
});
});

77
test/model.test.js
View File

@ -624,81 +624,4 @@ describe('Model', function() {
assert.equal(model, acl);
});
});
// describe('Model.hasAndBelongsToMany()', function() {
// it("TODO: implement / document", function(done) {
// /* example -
//
// */
// done(new Error('test not implemented'));
// });
// });
// describe('Model.remoteMethods()', function() {
// it("Return a list of enabled remote methods", function() {
// app.model(User);
// User.remoteMethods(); // ['save', ...]
// });
// });
// describe('Model.availableMethods()', function() {
// it("Returns the currently available api of a model as well as descriptions of any modified behavior or methods from attached data sources", function(done) {
// /* example -
// User.attachTo(oracle);
// console.log(User.availableMethods());
//
// {
// 'User.all': {
// accepts: [{arg: 'filter', type: 'object', description: '...'}],
// returns: [{arg: 'users', type: ['User']}]
// },
// 'User.find': {
// accepts: [{arg: 'id', type: 'any'}],
// returns: [{arg: 'items', type: 'User'}]
// },
// ...
// }
// var oracle = loopback.createDataSource({
// connector: 'oracle',
// host: '111.22.333.44',
// database: 'MYDB',
// username: 'username',
// password: 'password'
// });
//
// */
// done(new Error('test not implemented'));
// });
// });
// describe('Model.before(name, fn)', function(){
// it('Run a function before a method is called', function() {
// // User.before('save', function(user, next) {
// // console.log('about to save', user);
// //
// // next();
// // });
// //
// // User.before('delete', function(user, next) {
// // // prevent all delete calls
// // next(new Error('deleting is disabled'));
// // });
// // User.beforeRemote('save', function(ctx, user, next) {
// // if(ctx.user.id === user.id) {
// // next();
// // } else {
// // next(new Error('must be logged in to update'))
// // }
// // });
//
// throw new Error('not implemented');
// });
// });
//
// describe('Model.after(name, fn)', function(){
// it('Run a function after a method is called', function() {
//
// throw new Error('not implemented');
// });
// });
});

129
test/relations.integration.js
View File

@ -4,6 +4,7 @@ var path = require('path');
var SIMPLE_APP = path.join(__dirname, 'fixtures', 'simple-integration-app');
var app = require(path.join(SIMPLE_APP, 'app.js'));
var assert = require('assert');
var expect = require('chai').expect;
describe('relations - integration', function () {
@ -95,4 +96,132 @@ describe('relations - integration', function () {
});
});
describe('/widgets/:id/store', function () {
beforeEach(function (done) {
var self = this;
this.store.widgets.create({
name: this.widgetName
}, function(err, widget) {
self.widget = widget;
self.url = '/api/widgets/' + self.widget.id + '/store';
done();
});
});
lt.describe.whenCalledRemotely('GET', '/api/widgets/:id/store', function () {
it('should succeed with statusCode 200', function () {
assert.equal(this.res.statusCode, 200);
assert.equal(this.res.body.id, this.store.id);
});
});
});
describe('hasAndBelongsToMany', function() {
beforeEach(function defineProductAndCategoryModels() {
var product = app.model(
'product',
{ properties: { id: 'string', name: 'string' }, dataSource: 'db' }
);
var category = app.model(
'category',
{ properties: { id: 'string', name: 'string' }, dataSource: 'db' }
);
product.hasAndBelongsToMany(category);
category.hasAndBelongsToMany(product);
});
lt.beforeEach.givenModel('category');
beforeEach(function createProductsInCategory(done) {
var test = this;
this.category.products.create({
name: 'a-product'
}, function(err, product) {
if (err) return done(err);
test.product = product;
done();
});
});
beforeEach(function createAnotherCategoryAndProduct(done) {
app.models.category.create({ name: 'another-category' },
function(err, cat) {
if (err) return done(err);
cat.products.create({ name: 'another-product' }, done);
});
});
afterEach(function(done) {
this.app.models.product.destroyAll(done);
});
it.skip('allows to find related objects via where filter', function(done) {
//TODO https://github.com/strongloop/loopback-datasource-juggler/issues/94
var expectedProduct = this.product;
// Note: the URL format is not final
this.get('/api/products?filter[where][categoryId]=' + this.category.id)
.expect(200, function(err, res) {
if (err) return done(err);
expect(res.body).to.eql([
{
id: expectedProduct.id,
name: expectedProduct.name
}
]);
done();
});
});
it('allows to find related object via URL scope', function(done) {
var expectedProduct = this.product;
this.get('/api/categories/' + this.category.id + '/products')
.expect(200, function(err, res) {
if (err) return done(err);
expect(res.body).to.eql([
{
id: expectedProduct.id,
name: expectedProduct.name
}
]);
done();
});
});
it('includes requested related models in `find`', function(done) {
var expectedProduct = this.product;
var url = '/api/categories/findOne?filter[where][id]=' +
this.category.id + '&filter[include]=products';
this.get(url)
.expect(200, function(err, res) {
expect(res.body).to.have.property('products');
expect(res.body.products).to.eql([
{
id: expectedProduct.id,
name: expectedProduct.name
}
]);
done();
});
});
it.skip('includes requested related models in `findById`', function(done) {
//TODO https://github.com/strongloop/loopback-datasource-juggler/issues/93
var expectedProduct = this.product;
// Note: the URL format is not final
var url = '/api/categories/' + this.category.id + '?include=products';
this.get(url)
.expect(200, function(err, res) {
expect(res.body).to.have.property('products');
expect(res.body.products).to.eql([
{
id: expectedProduct.id,
name: expectedProduct.name
}
]);
done();
});
});
});
});

3
test/remoting.integration.js
View File

@ -66,5 +66,4 @@ describe('remoting - integration', function () {
});
});
})
;
});