var factory = require('./factory'); var handler = require('./storage-handler'); var storage = require('pkgcloud').storage; module.exports = StorageService; /** * Storage service constructor. Properties of options object depend on the storage service provider. * * @options {Object} options Options to create a provider; see below. * @prop {String} provider Storage service provider. Must be one of: * * * 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) { if (!(this instanceof StorageService)) { return new StorageService(options); } this.provider = options.provider; this.client = factory.createClient(options); } function map(obj) { return obj; } /** * List all storage service 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) { cb(err, containers); } else { cb(err, containers.map(function (c) { return map(c); })); } }); }; /** * 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) { options = options || {}; if ('object' === typeof options && !(options instanceof storage.Container)) { var Container = factory.getProvider(this.provider).Container; options = new Container(this.client, options); } return this.client.createContainer(options, function (err, container) { return cb(err, map(container)); }); }; /** * Destroy an existing storage service container. * @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 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) { return cb(err, map(container)); }); }; /** * Get the stream for uploading * @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') { cb = options; options = {}; } options = options || {}; if (container) { options.container = container; } if (file) { options.remote = file; } return this.client.upload(options, cb); }; /** * Get the stream for downloading. * @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') { cb = options; options = {}; } options = options || {}; if (container) { options.container = container; } if (file) { options.remote = file; } return this.client.download(options, cb); }; /** * List all files within the given container. * @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, options, cb) { return this.client.getFiles(container, options, function (err, files) { if (err) { cb(err, files); } else { cb(err, files.map(function (f) { return map(f); })); } }); }; /** * 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 * @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 * @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); }; StorageService.modelName = 'storage'; StorageService.prototype.getContainers.shared = true; StorageService.prototype.getContainers.accepts = []; StorageService.prototype.getContainers.returns = {arg: 'containers', type: 'array', root: true}; StorageService.prototype.getContainers.http = {verb: 'get', path: '/'}; StorageService.prototype.getContainer.shared = true; StorageService.prototype.getContainer.accepts = [ {arg: 'container', type: 'string'} ]; StorageService.prototype.getContainer.returns = {arg: 'container', type: 'object', root: true}; StorageService.prototype.getContainer.http = {verb: 'get', path: '/:container'}; StorageService.prototype.createContainer.shared = true; StorageService.prototype.createContainer.accepts = [ {arg: 'options', type: 'object', http: {source: 'body'}} ]; StorageService.prototype.createContainer.returns = {arg: 'container', type: 'object', root: true}; StorageService.prototype.createContainer.http = {verb: 'post', path: '/'}; StorageService.prototype.destroyContainer.shared = true; StorageService.prototype.destroyContainer.accepts = [ {arg: 'container', type: 'string'} ]; StorageService.prototype.destroyContainer.returns = {}; StorageService.prototype.destroyContainer.http = {verb: 'delete', path: '/:container'}; StorageService.prototype.getFiles.shared = true; StorageService.prototype.getFiles.accepts = [ {arg: 'container', type: 'string'} ]; StorageService.prototype.getFiles.returns = {arg: 'files', type: 'array', root: true}; StorageService.prototype.getFiles.http = {verb: 'get', path: '/:container/files'}; StorageService.prototype.getFile.shared = true; StorageService.prototype.getFile.accepts = [ {arg: 'container', type: 'string'}, {arg: 'file', type: 'string'} ]; StorageService.prototype.getFile.returns = {arg: 'file', type: 'object', root: true}; StorageService.prototype.getFile.http = {verb: 'get', path: '/:container/files/:file'}; StorageService.prototype.removeFile.shared = true; StorageService.prototype.removeFile.accepts = [ {arg: 'container', type: 'string'}, {arg: 'file', type: 'string'} ]; StorageService.prototype.removeFile.returns = {}; StorageService.prototype.removeFile.http = {verb: 'delete', path: '/:container/files/:file'}; StorageService.prototype.upload.shared = true; StorageService.prototype.upload.accepts = [ {arg: 'req', type: 'object', 'http': {source: 'req'}}, {arg: 'res', type: 'object', 'http': {source: 'res'}} ]; StorageService.prototype.upload.returns = {arg: 'result', type: 'object'}; StorageService.prototype.upload.http = {verb: 'post', path: '/:container/upload'}; StorageService.prototype.download.shared = true; StorageService.prototype.download.accepts = [ {arg: 'container', type: 'string', 'http': {source: 'path'}}, {arg: 'file', type: 'string', 'http': {source: 'path'}}, {arg: 'res', type: 'object', 'http': {source: 'res'}} ]; StorageService.prototype.download.http = {verb: 'get', path: '/:container/download/:file'};