Formalize API and document

[jordan-heemskerk]

[jordan-heemskerk]

I can help with this as well

[gregnr]

We decided to use Socket.IO for our client-server communication. Socket.IO was chosen for the following reasons:

• Analyzing a repo takes a long time (> 30 seconds). Most AJAX requests will timeout before our data can be returned
• Two way socket communication will allow the server to asynchronously send back the response when it finishes
• Socket.IO is cross browser and supports many underlying protocols. It picks the best protocol based on what the client supports (ie. if client doesn't support websockets, switches to long polling)
• Socket connections will allow us to show progress (ie. on progress bar) in the future

The event we will use to send an analyze request is "AnalyzeRepoRequest". Username, password, repo URL, and test directory will be passed as data for this event:

{
    user: "",
    pass: "",
    repo: "",
    testDir: ""
}

The response from the server will use the event "AnalyzeRepoResponse". It will return the Plotly graph ID in an object:

{
    plotlyGraphId: ##
}