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

Merge branch 'release/1.0.2' into production

This commit is contained in:
Miroslav Bajtoš 2014-05-30 18:39:21 +02:00
parent 50cd49dd9a 660ddd8c78
commit 66a19d870b
6 changed files with 97 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs.json
View File

@ -1,8 +1,7 @@
{
"content": [
{ "title": "LoopBack Storage Service", "depth": 2 },
"lib/storage-service.js",
{ "title": "Storage Handler API", "depth": 3 },
"lib/storage-service.js",
"lib/storage-handler.js"
]
}

8
lib/providers/filesystem/index.js
View File

@ -190,10 +190,10 @@ FileSystemProvider.prototype.download = function (options, cb) {
}
};
FileSystemProvider.prototype.getFiles = function (container, download, cb) {
if (typeof download === 'function' && !(download instanceof RegExp)) {
cb = download;
download = false;
FileSystemProvider.prototype.getFiles = function (container, options, cb) {
if (typeof options === 'function' && !(options instanceof RegExp)) {
cb = options;
options = false;
}
var self = this;
if (!validateName(container, cb)) return;

8
lib/storage-connector.js
View File

@ -1,8 +1,10 @@
var StorageService = require('./storage-service');
/**
* Export the initialize method to Loopback data
* @param dataSource
* @param callback
* Initialize the storage service as a connector for LoopBack data sources
* @param {DataSource} dataSource DataSource instance
* @prop {Object} settings Connector settings
* @callback {Function} callback Callback function
* @param {String|Object} err Error string or object
*/
exports.initialize = function (dataSource, callback) {
var settings = dataSource.settings || {};

12
lib/storage-handler.js
View File

@ -3,11 +3,12 @@ var StringDecoder = require('string_decoder').StringDecoder;
/**
* Handle multipart/form-data upload to the storage service
* @param provider The storage service provider
* @param {Object} provider The storage service provider
* @param {Request} req The HTTP request
* @param {Response} res The HTTP response
* @param {String} container The container name
* @param {Function} cb The callback
* @callback {Function} cb Callback function
* @header storageService.upload(provider, req, res, container, cb)
*/
exports.upload = function (provider, req, res, container, cb) {
var form = new IncomingForm(this.options);
@ -103,13 +104,14 @@ exports.upload = function (provider, req, res, container, cb) {
}
/**
* Handle download from a container/file
* @param provider The storage service provider
* Handle download from a container/file.
* @param {Object} provider The storage service provider
* @param {Request} req The HTTP request
* @param {Response} res The HTTP response
* @param {String} container The container name
* @param {String} file The file name
* @param {Function} cb The callback
* @callback {Function} cb Callback function.
* @header storageService.download(provider, req, res, container, file, cb)
*/
exports.download = function (provider, req, res, container, file, cb) {
var reader = provider.download({

128
lib/storage-service.js
View File

@ -8,11 +8,17 @@ module.exports = StorageService;
/**
* Storage service constructor. Properties of options object depend on the storage service provider.
*
*
* @options {Object} options The options to create a provider; see below;
* @prop {Object} connector <!-- What is this? -->
* @prop {String} provider Use 'filesystem' for local file system. Other supported values are: 'amazon', 'rackspace', 'azure', and 'openstack'.
* @prop {String} root With 'filesystem' provider, the path to the root of storage directory.
* @options {Object} options Options to create a provider; see below.
* @prop {String} provider Storage service provider. Must be one of:
* <ul><li>'filesystem' - local file system.</li>
* <li>'amazon'</li>
* <li>'rackspace'</li>
* <li>'azure'</li>
* <li>'openstack'</li>
* </ul>
*
* Other supported values depend on the provider.
* See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information.
* @class
*/
function StorageService(options) {
@ -25,30 +31,14 @@ function StorageService(options) {
function map(obj) {
return obj;
/*
if (!obj || typeof obj !== 'object') {
return obj;
}
var data = {};
for (var i in obj) {
if (obj.hasOwnProperty(i) && typeof obj[i] !== 'function'
&& typeof obj[i] !== 'object') {
if (i === 'newListener' || i === 'delimiter' || i === 'wildcard') {
// Skip properties from the base class
continue;
}
data[i] = obj[i];
}
}
return data;
*/
}
/**
* List all storage service containers.
* @param {Function} callback Callback function; parameters: err - error message, containers - object holding all containers.
* @callback {Function} callback Callback function
* @param {Object|String} err Error string or object
* @param {Object[]} containers An array of container metadata objects
*/
StorageService.prototype.getContainers = function (cb) {
this.client.getContainers(function (err, containers) {
if (err) {
@ -62,14 +52,13 @@ StorageService.prototype.getContainers = function (cb) {
};
/**
* Create a new storage service container. Other option properties depend on the provider.
*
* @options {Object} options The options to create a provider; see below;
* @prop {Object} connector <!-- WHAT IS THIS? -->
* @prop {String} provider Storage service provider. Use 'filesystem' for local file system. Other supported values are: 'amazon', 'rackspace', 'azure', and 'openstack'.
* @prop {String} root With 'filesystem' provider, the path to the root of storage directory.
* @prop {String}
* @param {Function} callback Callback function.
* Create a new storage service container.
*
* @options {Object} options Options to create a container. Option properties depend on the provider.
* @prop {String} name Container name
* @callback {Function} cb Callback function
* @param {Object|String} err Error string or object
* @param {Object} container Container metadata object
*/
StorageService.prototype.createContainer = function (options, cb) {
@ -85,17 +74,20 @@ StorageService.prototype.createContainer = function (options, cb) {
/**
* Destroy an existing storage service container.
* @param {Object} container Container object.
* @param {Function} callback Callback function.
* @param {String} container Container name.
* @callback {Function} callback Callback function.
* @param {Object|String} err Error string or object
*/
StorageService.prototype.destroyContainer = function (container, cb) {
return this.client.destroyContainer(container, cb);
};
/**
* Look up a container by name.
* @param {Object} container Container object.
* @param {Function} callback Callback function.
* Look up a container metadata object by name.
* @param {String} container Container name.
* @callback {Function} callback Callback function.
* @param {Object|String} err Error string or object
* @param {Object} container Container metadata object
*/
StorageService.prototype.getContainer = function (container, cb) {
return this.client.getContainer(container, function (err, container) {
@ -105,10 +97,12 @@ StorageService.prototype.getContainer = function (container, cb) {
/**
* Get the stream for uploading
* @param {Object} container Container object.
* @param {String} file IS THIS A FILE?
* @options options See below.
* @param callback Callback function
* @param {String} container Container name
* @param {String} file File name
* @options {Object} [options] Options for uploading
* @callback callback Callback function
* @param {String|Object} err Error string or object
* @returns {Stream} Stream for uploading
*/
StorageService.prototype.uploadStream = function (container, file, options, cb) {
if (!cb && typeof options === 'function') {
@ -128,10 +122,12 @@ StorageService.prototype.uploadStream = function (container, file, options, cb)
/**
* Get the stream for downloading.
* @param {Object} container Container object.
* @param {String} file Path to file.
* @options {Object} options See below. <!-- What are the options -->
* @param {Function} callback Callback function
* @param {String} container Container name.
* @param {String} file File name.
* @options {Object} options Options for downloading
* @callback {Function} callback Callback function
* @param {String|Object} err Error string or object
* @returns {Stream} Stream for downloading
*/
StorageService.prototype.downloadStream = function (container, file, options, cb) {
if (!cb && typeof options === 'function') {
@ -151,12 +147,14 @@ StorageService.prototype.downloadStream = function (container, file, options, cb
/**
* List all files within the given container.
* @param {Object} container Container object.
* @param {Function} download
* @param {Function} callback Callback function
* @param {String} container Container name.
* @param {Object} [options] Options for download
* @callback {Function} cb Callback function
* @param {Object|String} err Error string or object
* @param {Object[]} files An array of file metadata objects
*/
StorageService.prototype.getFiles = function (container, download, cb) {
return this.client.getFiles(container, download, function (err, files) {
StorageService.prototype.getFiles = function (container, options, cb) {
return this.client.getFiles(container, options, function (err, files) {
if (err) {
cb(err, files);
} else {
@ -167,20 +165,48 @@ StorageService.prototype.getFiles = function (container, download, cb) {
});
};
/**
* Look up the metadata object for a file by name
* @param {String} container Container name
* @param {String} file File name
* @callback {Function} cb Callback function
* @param {Object|String} err Error string or object
* @param {Object} file File metadata object
*/
StorageService.prototype.getFile = function (container, file, cb) {
return this.client.getFile(container, file, function (err, f) {
return cb(err, map(f));
});
};
/**
* Remove an existing file
* @param {String} container Container name
* @param {String} file File name
* @callback {Function} cb Callback function
* @param {Object|String} err Error string or object
*/
StorageService.prototype.removeFile = function (container, file, cb) {
return this.client.removeFile(container, file, cb);
};
/**
* Upload middleware for the HTTP request/response <!-- Should this be documented? -->
* @param {Request} req Request object
* @param {Response} res Response object
* @param {Function} cb Callback function
*/
StorageService.prototype.upload = function (req, res, cb) {
return handler.upload(this.client, req, res, req.params.container, cb);
};
/**
* Download middleware <!-- Should this be documented? -->
* @param {String} container Container name
* @param {String} file File name
* @param {Response} res HTTP response
* @param {Function} cb Callback function
*/
StorageService.prototype.download = function (container, file, res, cb) {
return handler.download(this.client, null, res, container, file, cb);
};
@ -259,4 +285,4 @@ StorageService.prototype.download.accepts = [
{arg: 'res', type: 'object', 'http': {source: 'res'}}
];
StorageService.prototype.download.http =
{verb: 'get', path: '/:container/download/:file'};
{verb: 'get', path: '/:container/download/:file'};

6
package.json
View File

@ -1,19 +1,19 @@
{
"name": "loopback-storage-service",
"description": "Loopback Storage Service",
"version": "1.0.0",
"version": "1.0.2",
"main": "index.js",
"scripts": {
"test": "./node_modules/.bin/mocha --timeout 30000 test/*test.js"
},
"dependencies": {
"pkgcloud": "~0.9.4",
"async": "~0.2.10"
"async": "~0.2.10",
"formidable": "~1.0.14"
},
"devDependencies": {
"express": "~3.4.0",
"loopback": "1.x.x",
"formidable": "~1.0.14",
"mocha": "~1.18.2",
"supertest": "~0.10.0",
"mkdirp": "~0.3.5"