dabbu-knowledge-platform / files-api-server

An implementation of the Dabbu Files API that enables you to access your files, folders and emails stored with multiple providers as simple files and folders, all in one place!

Dabbu Files API Server

With the Dabbu Knowledge Platform, we aim to rethink the way we organize and traverse large amounts of knowledge, no matter where it is stored.

Dabbu allows you to access any of your personal information (Gmail, Google Drive, OneDrive, your hard drive, ...) as simple files and folders from Dabbu CLI.

It not only allows you to seamlessly search/traverse your information across these sources (as simple as cd, list), but also move information around between drives (copy) - yes even your Gmail messages in a thread get copied to your hard drive as .md files in a zip if you do a c:/$ cp m:/INBOX/* ./"My Emails".

You can also go into the special knowledge drive where you can pivot information by topics/people/places e.g. k:/$ cd austin (will return you all your information from Gmail, Google Drive, OneDrive that has a reference to the place Austin). You can further narrow your search by doing k:/austin$ cd [email protected] (yes it even extracts people and allows you to pivot information by them). This would show you all emails and files that are related to Austin and from/to [email protected].

All of this has been implemented by abstracting access to providers (you can add more providers as modules) and exposing a unified API for information (no matter where and what form it takes).

The only way to use Dabbu (at the moment) is through a command-line interface (CLI). A desktop app is in the works.

This is an implementation of the Dabbu Files API. This repository does not house the code for the CLI. Information on the CLI, including installation process and setup, can be found here.

Using the Files API Server

The Files API Server can be used in any application to access the user's files and folders. Some providers require the user to authorize the app using OAuth 2.0. To get started on using the Files API Server in your app, look at the getting started guide (Work in progress, though API documentation is complete).

Providers supported

• Google drive
• Gmail
• One Drive

To request a new provider, file an issue here.

Issues and pull requests

You can contribute to Dabbu by reporting bugs, fixing bugs, adding features, and spreading the word! If you want to report a bug, create an issue by clicking here. While creating an issue, try to follow the Bug report or Feature request template.

Please read contributing.md for a detailed guide to setting up your environment and making changes to the code.

Also, if you need any help on the code, please do ask on this Github discussion. We will only be glad to help :)

Legal stuff

License - GNU GPL v3

All projects of the Dabbu Knowledge Platform are copyrighted (C) 2021 Dabbu Knowledge Platform [email protected] and licensed under the GNU GPLv3 license. See license.md for a copy of the license file.

files-api-server's Issues

[BUG]: Files with a '/' in their name don't get copied

Describe the bug
When downloading/copying a file with a / in its name, the operation fails with a 404 error, stating the file (here only the part after the / in the name is given) does not exist. E.g.: If the file is named Download File/Copy File Test, the CLI assumes Download File to be a folder and only Copy File Test to be the file name.

To Reproduce
Steps to reproduce the behavior:

1. Rename a file to contain a / in its name (Google Drive/Gmail thread)
2. Try downloading the file using the read command or copying it using the copy command
3. See error (404)

Expected behavior
The file gets downloaded or copied

Screenshots
If applicable, add screenshots to help explain your problem.

Versions (please complete the following information):

• Dabbu CLI Version: Affects all up to v3.2.0
• OS Version: Affects Windows/MacOS/Linux

Additional context
Seems to be a problem with the CLI trying to parse a filename out of the full path, and ends up taking the part after the '/' in the file name as the entire file name.

[CODE]: Migrate to Typescript

Describe the issue
The code currently has no typing. It should be strongly typed, especially since this is an API implementation and shoud return results in a specific format.

How could it be made better?
Migrating existing code to Typescript. Also, creating separate models for resources like files would help in consistency with the API.

Screenshots
If applicable, add screenshots to help explain the benefits of your changes.

Additional context
Add any other context about the problem here.

[NPROV]: Add Dropbox provider

Name of provider

Dropbox

Any ideas on how it should be implemented

API is detailed here.

Additional information
Add any other thoughts here

[CODE]: Add Tests

Describe the issue
There are currently no tests written to check API behaviour when changes are made.

How could it be made better?
Adding tests using a test runner like Ava and create a Google/Microsoft/etc account to simply test the API.

Screenshots
If applicable, add screenshots to help explain the benefits of your changes.

Additional context
Add any other context about the problem here.