meteor-smartfile

Dead simple file uploads for Meteor backed by SmartFile file hosting platform

Installation

meteor-smartfile can be installed with Meteorite. From inside a Meteorite-managed app:

$ mrt add smartfile

Example

https://github.com/sylvaingi/meteor-smartfile-example

API

Configuration

Before using this package, you must have a free SmartFile Developers account (signup here).

Server configuration

Configuration is achieved through the configure method:

var sfInstance = new SmartFile();

sfInstance.configure({
    key: "SmartFile API key",
    password: "SmartFile API password",
    basePath: "uploads",
    publicRootUrl: "https://file.ac/XXXXXXX/"
});

basePath is optional and defines the root directory on SmartFile the package will use for read and write operations. If not specified, the root directory on SmartFile will be used.

publicRootUrl is optional, it must be a https://file.ac/XXXXXXX/ URL of a SmartFile link pointing to your basePath. Links are useful for public access (i.e. the browser fetching uploaded files on SmartFile), they can be created through the UI or via the REST API.

Client configuration

Client side configuration is identical to the server, but only the publicRootUrl field is processed.

Client API

sfInstance.upload(file, {
    fileName: "myupload.jpg", //optional, overrides file.name
    path: "uploads" //optional, path of storage of the upload relative to basePath
}, function (err, res){
    if (err) {
        console.log("upload failed", err);
        return;
    }

    // Log the public URL of the upload
    console.log("Upload public URL:" + sfInstance.resolvePublic(res));
});

Server API

Callbacks

// Used to validate upload, options is the 2nd argument of the `upload()` client call
// If it returns false, the upload will be halted and a Meteor.Error with status 403 will be thrown
sfInstance.allow = function (options) {
    return options.path === "uploads";
};

// Callbacks for upload success or failure
// result contains statusCode returned by SmartFile API and path corresponding to the upload
sfInstance.onUpload = function (result, options) {
    console.log("File uploaded to " + result.path);
};

sfInstance.onUploadFail = function (error, options) {
    console.log("SmartFile returned error", error.statusCode, error.detail);
};

Utilities

// Creates the uploads/images directory if it does not exist, throws an error otherwise
sfInstance.mkdir("uploads/images");

// Lists the files within the uploads directory
sfInstance.ls("uploads");

// Remove a remote file...
sfInstance.rm("uploads/secret.txt");

Advanced

Internally, meteor-smartfile defines a Meteor method invoking sfInstance.onIncomingFile(data, options) whenever a client calls upload() and the server allow() callback returns true.

The default implementation performs the following operation:

sfInstance.onIncomingFile = function (data, options) {
    // upload the Buffer data to SmartFile
    sfInstance.save(data, options);
}

It can be overriden in order to tweak the upload contents, as the data parameter is a Node.js Buffer instance. A real-world usage would be resizing a received image in 3 sizes and upload them to SmartFile via 3 calls to sfInstance.save().

License

MIT