klacabane / cubbyhole_dev

REST API for the storage service.

cubbyhole_dev

Install

1. Download & install Python 2.7.6 (NOT THE 3.3!) http://www.python.org/getit/

2. Open a bash:

   npm install -g node-gyp

3. For Windows: Download & install OpenSSL for Windows (NOT THE LIGHT VERSION!) (Ex: Win64 OpenSSL v1.0.1f) http://slproweb.com/products/Win32OpenSSL.html

4. Install MongoDB. For CentOS (http://docs.mongodb.org/manual/tutorial/install-mongodb-on-red-hat-centos-or-fedora-linux/) :

Create a /etc/yum.repos.d/mongodb.repo file to hold the following configuration information for the MongoDB repository:

[mongodb]
name=MongoDB Repository
baseurl=http://downloads-distro.mongodb.org/repo/redhat/os/x86_64/
gpgcheck=0
enabled=1

Install mongodb:

sudo yum install mongodb-org

sudo chkconfig mongod on

sudo service mongod restart

5. Install NodeJS. For CentOS:

   yum install nodejs

6. Git bash on the projet folder

   npm install

Getting started

Open the mongod console and let it open and running

Git bash on the projet folder

node app.js

Adding Fixtures

Open app.js and uncomment lines 47 to 52:

/** Uncomment to populate db with new Plans & Bws */
	/*
Utils.insertPlanAndBw(function (err) {
	if (err) throw err;
});
*/

Launch the API (see Getting Started above)

Stop the API.

Re-open app.js and comment lines 47 to 52

Re-launch the API. Fixtures are added.

Changing IP Addresses

Open config.js & replace line 3, 16, 19

address: "mongodb://localhost/Cubbyhole"

api: {
    	address: "http://localhost:3000"
	}

webclient: {
    	address: "http://localhost:8000"
	}

with

address: "mongodb://localhost/Cubbyhole"

api: {
    	address: "http://10.0.0.25:3000"
	}

webclient: {
    	address: "http://10.0.0.20:8000"
	}

cubbyhole_dev's Issues

Add request for API Documentation

Handle user.currentPlan.usage.bandwidth (upload & download)

Add route to stop sharing a folder

When user accepts a shared folder, it doesn't appear on files view

Add route to get all notifications

Add Rename Item route

PUT
name

Add Delete Plan route

Add email verification for sign up

Add route to change permission

R-O or R-W

Add route to access public item (shared link)

Add route to invite people to join a shared folder

Add size property for folders

Add route to create link

Add route to leave a shared folder

Maybe the same as #14 & #15

Enable downloading empty folders

Update GET /user/:id route

We need:

• the user's 'currentPlan' filled (not just its id)
• the quantity of storage used by the user
• the shared Quota used by the user
• the bandwidth consumed by the user

On the user's profile page, we will display progress bars for storage, shared quota and bandwidth to enable the user to quickly see where he is in his consumption.

Add Sign Up route

REQUEST:

type: 'POST',
url: '/auth/signup',
data: {
   email: email, // string
   pass: pass, // string
   plan: plan // number
}

RESPONSE:

data: {
   sessionKey
   profile: {
     email
     plan
   }
}
OR
error: {
   msg // Possible msg: email already exists
   status (?)
}

API Documentation

Add route to delete permission

Maybe the same as #14

Handle user.currentPlan.usage.storage

Add prop to plan to say it can be deleted or not (free) & price can't be changed

Add route to accept joining shared folder

By email

Add get user by email route

GET /:email ?

Add Sign In route

REQUEST:

type: 'POST',
url: '/auth/signin',
data: {
   email: email, // string
   pass: pass // string
}

RESPONSE:

data: {
   sessionKey
   profile: {
      email
      plan
   }
}
OR
error: {
   msg
   status (?)
}

Send Plan info with user profile on login

Fill bandwidth in response to POST & PUT plan

Add Get all users route

Add route to get all shared folders

 [{
   _id,
    name,
   type // not very necessary
   size // if possible
   lastModified,
   path: 'My Cubbyhole,folder1',
   owner: {
       _id
       email
   },
   members: [{
       _id,
       email,
       status (joined or still waiting)
       permission: 0 (r-o) or 1 (r-w)
   }]
 }];

Add "forgot password feature"

Add Logout route

/auth DELETE

sessionKey will be in the X-Cub-AuthToken header

Add all files route

/files GET

API should return all the files that belong to the connected user (check X-Cub-AuthToken to know the user) like the example below.

/!\ All the user's files should be wrapped in a parent node named 'My Cubbyhole', with an id equal to -1 and 'folder' as type.

ALSO, EACH NODE (file or folder) SHOULD HAVE AN UNIQUE ID! In the example below, ids are missing.

Example:
var json_from_api = [
{
id: -1,
type: 'folder',
name: 'My Cubbyhole',
children: [
{
type: 'folder',
name: 'America',
children: [
{
type: 'folder',
name: 'United States of America',
children: [
{
type: 'file',
name: 'California'
},
{
type: 'folder',
name: 'Washington',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [
{
type: 'folder',
name: 'Orange County',
children: [
{
type: 'folder',
name: 'Kirkland',
children: [

                                                                                                                                                    ]
                                                                                                                                                }
                                                                                                                                            ]
                                                                                                                                        }
                                                                                                                                    ]
                                                                                                                                }
                                                                                                                            ]
                                                                                                                        }
                                                                                                                    ]
                                                                                                                }
                                                                                                            ]
                                                                                                        }
                                                                                                    ]
                                                                                                }
                                                                                            ]
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            ]
                                                                        }
                                                                    ]
                                                                }
                                                            ]
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            type: 'folder',
                            name: 'Canada'
                        }
                    ]
                },
                {
                    type: 'folder',
                    name: 'Europe',
                    children: [
                        {
                            type: 'folder',
                            name: 'France',
                            children: [
                                {
                                    type: 'folder',
                                    name: 'Midi-Pyrénéessssssssssssssssssssssssssssssssssssssssss',
                                    children: [
                                        {
                                            type: 'folder',
                                            name: 'Haute-Garonne',
                                            children: [
                                                {
                                                    type: 'file',
                                                    name: 'Toulouse'
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            type: 'folder',
                            name: 'Portugal'
                        },
                        {
                            type: 'folder',
                            name: 'Spain'
                        }
                    ]
                },
                {
                    type: 'folder',
                    name: 'Oceania',
                    children: [
                        {
                            type: 'folder',
                            name: 'Australia'
                        },
                        {
                            type: 'file',
                            name: 'Tasmania'
                        }
                    ]
                },
                {
                    type: 'folder',
                    name: 'Asia'
                }
            ]
        }
    ];

GET /users: do not send removed users

Make a DB schema

[SyncClient] path separator Windows

Handle user.currentPlan.usage.share (sharedQuota)

When Plan is deleted, user is updated to Free. But what if he exceeds the Free plan usage metrics?

Add move route

PUT /item/:id with param 'parent'

add New Plan route

POST

param: plan

Add new file(s) route

/files POST

Add route to delete link

Add Edit Plan route

PUT

param: plan

Write & format emails from API

• account verification email
• invitation to join shared folder

Add route to remove our user account

Add new folder route

/folders POST

Return size:0 for empty folders (Unix)

Already working for Windows

Add resend verification feature

Add route to get all Plans

Add route to get all links