@feup-infolab/node-b2drop
v1.1.0
Published
A B2Drop client for NodeJS
Downloads
2
Readme
node-b2drop
NodeJS client for B2Drop, based on OwnCloud
Table of Contents
Installation
$ npm i @feup-infolab/node-b2drop
Module Details
Introduction
The module is divides in two main classes B2drop and B2ropShare, the main reason for that is to give the maximum flexibility using this cloud storage service.
B2Drop
B2Drop is responsible for all operations related to user private area. This operations can be divided in two groups: WebDav and the functions to extend the previous group capabilities using requests.
The WebDav functions group send the user and password on every request via https.
The extended features uses request and requesttoken to validate the request.
WebDav
Extended Features
Methods
B2Drop(username, password)
- ConstructorchangeFolderSetting (folderUri, folderID, setting, callback)
- Change folder setting (only change 1 setting for each call)checkIfFolderExits (folderPath, callbakc)
- Check if a folder exits in provided pathcreateFolder (folderUri, callback)
- Create folder in folderUridelete(fileUri, callback)
- Delete file at fileUrideleteFolder (folderUri, callback)
- Delete folder in folderUriget(fileUri, outputStream, callback)
- Get file from fileUrigetAuthToken (callback)
- get Authentication Token form B2drop websitegetDirectoryContents (folderPath, callback)
- List folder contentgetQuota (callback)
- Get available and used space in the cloudgetShareLink (folderUri, password, callback)
- Create and get share link and set folder to editable and folder passwordput(fileUri, inputStream, callback)
- Upload file to fileUritestConnection (callback)
- Simple test to check if username and password are valid
B2DropShare
B2DropShare is responsible for all operations related to users shared area, only uses WebDav.
WebDav
Methods
B2DropShare ( sharelink, password)
- ConstructorcreateFolder(folderUri, callback)
- Create folder in folderUricheckIfFolderExits ( folderPath, callback)
- Check if folder exists in provided pathdelete(fileUri, callback)
- Delete file at fileUrideleteFolder(folderUri, callback)
- Delete folder in folderUriput(fileUri, inputStream, callback)
- Upload file to fileUriget(fileUri, outputStream, callback)
- Get file from fileUrigetDirectoryContents(folderPath, callback)
- List folder content
Examples
Create Share Link
const b2drop = require('node-b2drop').B2Drop;
var account = new b2drop(b2dropAccount.username, b2dropAccount.password);
account.getShareLink(testPathFolder1, passwordFolder, function (err, response, shareLink)
{
console.log(shareLink);
};
});
Upload File
const b2drop = require('node-b2drop').B2Drop;
var fileUri;
var inputStream = fs.createReadStream(testFile.location);
inputStream.on("open", function ()
{
var account = new b2drop(b2dropAccount.username, b2dropAccount.password);
account.put(fileUri, inputStream, function (err)
{
console.log(err);
});
}
});
Test
$ npm test