======================= multi-user-file-manager Version 1.0.0 12/14/2014

Description

A simple API that will allow you to upload and retrieve files from a specified location. It uses media type Collection+JSON in order to send the appropriate information back through the HTTP response. It supports, uploading, retrieveing and deleting of files along with retreiving the entire list of files. Server is written in node and data is stored in a sqlite database. Server will write to a log file information about all requests that are made to that address.

======================= Command line arguments

run server: node NodeServer.js

======================= File List

fileCollection NodeServer.js package.json logFile.json

======================= Requests/Url's

-fileid is a space for the id of the file you are wanting to interact with-

GET

• /
  • The initial GET request, sends back a collection+JSON list of all the files
• /file/fileid/html
  • sends back an html page with two links, one to download the file and the other to delete it.
• /file/fileid/json
  • sends back a json document with information fields on the file
• /file/fileid/download
  • will create the file on the hard drive and redirect the browser to its location for download

POST

• /file
  • Is expecting a form with some attached file in the HTTP POST
• /file/fileid/delete
  • will remove the file from the database

HEAD

• / *sends back a simple HTTP response with no content

======================= Response Outlines

-These are example responses for a GET request to the specified url-

• '/': [initialGET.txt] (/initialGET.txt)
• '/file/fileid/html': [filePage.txt] (/filePage.txt)
• '/file/fileid/json': [singleFile.txt] (/singleFile.txt)

======================= Database 'fileCollection'

• written in sqlite
• contains single table 'collection'
  • Fields:
    • 'filename': TEXT
      • example entry: somefile
    • 'fileid': TEXT NOT NULL
      • example entry: 02d5c910-36ea-431c-8ee8-b3eb1c6c22ad
    • 'date': INTEGER
      • example entry: 12/10/2014
    • 'filetype': TEXT
      • example entry: txt
    • 'size': INTEGER
      • example entry (in bytes): 217
    • 'filedata': BLOB
      • example entry: this is some text
    • 'link': TEXT
      • example entry: /file/02d5c910-36ea-431c-8ee8-b3eb1c6c22ad/json

State Diagram

----------------                ----------------------
|   **file**   |                |    **File List**   |
|    (type)    |      Item      |       (names)      | <------------
|    (size)    | <------------- |     (total size)   |
|    (date)    |                |       (number)     |
|    (name)    |                ----------------------
----------------                           ^
        |                                  |
        ------------------------------------
                    Collection