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' of https://github.com/strongloop/asteroid

This commit is contained in:
Ritchie Martori 2013-06-21 14:59:44 -07:00
parent 68e4464c59 17015eef9b
commit 3ba2b0512b
5 changed files with 133 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

192
README.md
View File

@ -145,7 +145,7 @@ Validate the model instance.
Attach a model to a [DataSource](#data-source). Attaching a [DataSource](#data-source) updates the model with additional methods and behaviors.
var oracle = asteroid.createDataSource({
connector: require('asteroid-oracle'),
connector: require('asteroid-connector-oracle'),
host: '111.22.333.44',
database: 'MYDB',
username: 'username',
@ -210,11 +210,11 @@ Find instance by id.
console.info(user.id); // 23
});
##### Model.findOne(filter, callback)
##### Model.findOne(where, callback)
Find a single instance that matches the given filter.
Find a single instance that matches the given where expression.
User.find(23, function(err, user) {
User.findOne({id: 23}, function(err, user) {
console.info(user.id); // 23
});
@ -226,6 +226,8 @@ Update when record with id=data.id found, insert otherwise. **Note:** no setters
Define a static model method.
User.login = function (username, password, fn) {
var passwordHash = hashPassword(password);
this.findOne({username: username}, function (err, user) {
@ -245,7 +247,7 @@ Define a static model method.
});
}
Setup the static model method to be exposed to clients as a [remote method](#remote-method).
Setup the static model method to be exposed to clients as a [remote method](#remote-method).
asteroid.remoteMethod(
User.login,
@ -305,7 +307,7 @@ Define a remote model instance method.
#### Remote Methods
Both instance and static methods can be exposed to clients. A remote method must accept a callback with the conventional `fn(err, result, ...)` signature.
Both instance and static methods can be exposed to clients. A remote method must accept a callback with the conventional `fn(err, result, ...)` signature.
##### asteroid.remoteMethod(fn, [options]);
@ -441,25 +443,29 @@ Define a "one to many" relationship.
Query and create the related models.
Book.create(function(err, book) {
// using 'chapters' scope for build:
var c = book.chapters.build({name: 'Chapter 1'});
// create a chapter instance
// ready to be saved in the data source
var chapter = book.chapters.build({name: 'Chapter 1'});
// same as:
c = new Chapter({name: 'Chapter 1', bookId: book.id});
// save the new chapter
chapter.save();
// using 'chapters' scope for create:
book.chapters.create();
// same as:
Chapter.create({bookId: book.id});
// you can also call the Chapter.create method with
// the `chapters` property which will build a chapter
// instance and save the it in the data source
book.chapters.create({name: 'Chapter 2'}, function(err, savedChapter) {
// this callback is optional
});
// using scope for querying:
// query chapters for the book using the
book.chapters(function(err, chapters) {
/* all chapters with bookId = book.id */
// all chapters with bookId = book.id
console.log(chapters);
});
book.chapters({where: {name: 'test'}, function(err, chapters) {
// all chapters with bookId = book.id and name = 'test'
console.log(chapters);
});
});
@ -470,7 +476,6 @@ TODO: implement / document
#### Shared Methods
Any static or instance method can be decorated as `shared`. These methods are exposed over the provided transport (eg. [asteroid.rest](#rest)).
### Data Source
@ -492,54 +497,115 @@ Define a model and attach it to a `DataSource`.
var Color = oracle.createModel('color', {name: String});
#### dataSource.discoverAndBuildModels(owner, tableOrView, options, fn)
#### dataSource.discoverModelDefinitions([username], fn)
Discover a set of models based on tables or collections in a data source.
oracle.discoverAndBuildModels('MYORG', function(err, models) {
var ProductModel = models.Product;
Discover a set of model definitions (table or collection names) based on tables or collections in a data source.
oracle.discoverModelDefinitions(function (err, models) {
models.forEach(function (def) {
// def.name ~ the model name
oracle.discoverSchema(null, def.name, function (err, schema) {
console.log(schema);
});
});
});
**Note:** The `models` will contain all properties and options discovered from the data source. It will also automatically discover and create relationships.
#### dataSource.discoverAndBuildModelsSync(owner, tableOrView, options)
#### dataSource.discoverSchema([owner], name, fn)
Synchronously Discover a set of models based on tables or collections in a data source.
Discover the schema of a specific table or collection.
var models = oracle.discoverAndBuildModelsSync('MYORG');
var ProductModel = models.Product;
**Example schema from oracle connector:**
#### dataSource.defineOperation(name, options, fn)
Define a new operation available to all model's attached to the data source.
var maps = asteroid.createDataSource({
connector: require('asteroid-rest'),
url: 'http://api.googleapis.com/maps/api'
});
rest.defineOperation('geocode', {
url: '/geocode/json',
verb: 'get',
accepts: [
{arg: 'address', type: 'string'},
{arg: 'sensor', default: 'true'}
],
returns: {arg: 'location', type: asteroid.GeoPoint, transform: transform},
json: true,
enableRemote: true
});
function transform(res) {
var geo = res.body.results[0].geometry;
return new asteroid.GeoPoint({lat: geo.lat, long: geo.lng});
{
"name": "Product",
"options": {
"idInjection": false,
"oracle": {
"schema": "BLACKPOOL",
"table": "PRODUCT"
}
},
"properties": {
"id": {
"type": "String",
"required": true,
"length": 20,
"id": 1,
"oracle": {
"columnName": "ID",
"dataType": "VARCHAR2",
"dataLength": 20,
"nullable": "N"
}
},
"name": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "NAME",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
},
"audibleRange": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "AUDIBLE_RANGE",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"effectiveRange": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "EFFECTIVE_RANGE",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"rounds": {
"type": "Number",
"required": false,
"length": 22,
"oracle": {
"columnName": "ROUNDS",
"dataType": "NUMBER",
"dataLength": 22,
"nullable": "Y"
}
},
"extras": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "EXTRAS",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
},
"fireModes": {
"type": "String",
"required": false,
"length": 64,
"oracle": {
"columnName": "FIRE_MODES",
"dataType": "VARCHAR2",
"dataLength": 64,
"nullable": "Y"
}
}
}
}
var GeoCoder = rest.createModel('geocoder');
GeoCoder.geocode('123 fake street', function(err, point) {
console.log(point.lat, point.long); // 24.224424 44.444445
});
#### dataSource.enableRemote(operation)
@ -553,7 +619,7 @@ Disable remote access to a data source operation. Each [connector](#connector) h
// all rest data source operations are
// disabled by default
var oracle = asteroid.createDataSource({
connector: require('asteroid-oracle'),
connector: require('asteroid-connector-oracle'),
host: '...',
...
});
@ -619,11 +685,11 @@ Include the connector in your package.json dependencies and run `npm install`.
{
"dependencies": {
"asteroid-oracle": "latest"
"asteroid-connector-oracle": "latest"
}
}
### GeoPoint
### GeoPoint TODO
Embed a latitude / longitude point in a [Model](#model).
@ -681,7 +747,7 @@ Various APIs in Asteroid accept type descriptions (eg. [remote methods](#remote-
- `Array` - JSON array
- `Date` - a JavaScript date object
- `Buffer` - a node.js Buffer object
- [GeoPoint](#geopoint) - an asteroid GeoPoint object.
- [GeoPoint](#geopoint) - an asteroid GeoPoint object. TODO
### REST Router

4
example/simple-data-source/app-oracle.js
View File

@ -5,7 +5,7 @@ app.use(asteroid.rest());
var dataSource = app.dataSource('db',
{ adapter: 'oracle',
{ adapter: require('asteroid-connector-oracle'),
host: '166.78.158.45',
database: 'XE',
username: 'strongloop',
@ -29,4 +29,4 @@ dataSource.autoupdate(function (err, data) {
app.listen(3000);
console.log('a list of colors is available at http://localhost:300/colors');
console.log('a list of colors is available at http://localhost:300/colors');

1
lib/application.js
View File

@ -61,6 +61,7 @@ app._models = [];
app.model = function (Model) {
this._models.push(Model);
Model.shared = true;
Model.app = this;
if(Model._remoteHooks) {
Model._remoteHooks.emit('attached', app);

2
package.json
View File

@ -19,6 +19,6 @@
"supertest": "latest"
},
"optionalDependencies": {
"jugglingdb-oracle": "git+ssh://git@github.com:strongloop/jugglingdb-oracle.git"
"asteroid-connector-oracle": "git+ssh://git@github.com:strongloop/asteroid-connector-oracle.git"
}
}

47
test/data-source.test.js
View File

@ -34,53 +34,6 @@ describe('DataSource', function() {
});
});
// describe('dataSource.discover(options, fn)', function() {
// it("Discover an object containing properties and settings for an existing data source.", function(done) {
// /* example -
// oracle.discover({owner: 'MYORG'}, function(err, tables) {
// var productSchema = tables.PRODUCTS;
// var ProductModel = oracle.createModel('product', productSchema.properties, productSchema.settings);
// });
//
// */
// done(new Error('test not implemented'));
// });
// });
//
// describe('dataSource.discoverSync(options)', function() {
// it("Synchronously discover an object containing properties and settings for an existing data source tables or collections.", function(done) {
// /* example -
// var tables = oracle.discover({owner: 'MYORG'});
// var productSchema = tables.PRODUCTS;
// var ProductModel = oracle.createModel('product', productSchema.properties, productSchema.settings);
//
// */
// done(new Error('test not implemented'));
// });
// });
// describe('dataSource.discoverModels(options, fn) ', function() {
// it("Discover a set of models based on tables or collections in a data source.", function(done) {
// /* example -
// oracle.discoverModels({owner: 'MYORG'}, function(err, models) {
// var ProductModel = models.Product;
// });
//
// */
// done(new Error('test not implemented'));
// });
// });
//
// describe('dataSource.discoverModelsSync(options)', function() {
// it("Synchronously Discover a set of models based on tables or collections in a data source.", function(done) {
// /* example -
// var models = oracle.discoverModels({owner: 'MYORG'});
// var ProductModel = models.Product;
// */
// done(new Error('test not implemented'));
// });
// });
describe('dataSource.operations()', function() {
it("List the enabled and disabled operations.", function() {
// assert the defaults