drive-config

drive-config

A npm module for maintaining user config files (in json) on Google Drive.

npm install drive-config

About

We can take advantage of Google Drive's appdata folder to store a users config data for our application. The user cannot see these files, but can delete config data and revoke our app's access on their Drive by clicking the gear icon in the top right -> Settings -> Manage Apps -> Options Dropdown.

Usage

This module is currently written with ES6 for Node 6+

Setup

var googleAuth = require('google-auth-library');
let driveConfig = require('drive-config');

// get your user's oauth2Client 
// more info about setting this up at https://github.com/google/google-api-nodejs-client
let auth = new googleAuth();
let oauth2Client = new auth.OAuth2(clientId, clientSecret, redirectUrl);
oauth2Client.credentials = user.creds;

let driveConfigClient = new driveConfig(oauth2Client);

List

Gets all files in a user's google drive for your application

driveConfigClient.list().then(files => {
    // do something with files
}).catch(err => {
    // handle errors
});

Create

Makes a new files in the user's google drive

driveConfigClient.create(fileName, data).then(file => {
    // do something with the file
}).catch(err => {
    // handle errors
});

Get

Gets a file from a user's google drive with a fileId

driveConfigClient.get(fileId).then(file => {
    // do something with the file
}).catch(err => {
    // handle errors
});

Get by name

Gets a list of files that have a specific name

driveConfigClient.getByName(fileName).then(files => {
    // do something with the list of files
}).catch(err => {
    // handle errors
});

Update

Updates a file on a user's google drive

driveConfigClient.update(fileId, data).then(file => {
    // do something with the file
}).catch(err => {
    // handle errors
});

Destroy

Completely delete's a file from a user's google drive

driveConfigClient.destory(fileId).then(() => {
    // do something next
}).catch(err => {
    // handle errors
});

File Object

// Example of what is returned from most methods
{
    id: String,
    name: String,
    data: Object,
    createdTime: Date,
    modifiedTime: Date,
}