bde-esiee / api-calendar

🎓📆🔌API for ESIEE Paris's Calendar (Classes, Room availability...)

ESIEE API

An exhaustive API for ESIEE's calendar

Reference

The base URI for the API is /api/calendar/

Querying upcoming activities

An activity is composed of:

• The name of the activity (mainly the subject name).
• A description containing most of the time the groups concerned, the name of the subject, the name of the teacher and the export date.
• The starting time of the avtivity.
• The ending time of the activity.
• The rooms where the avtivity take place.

This result in the following JSON template:

{
	"name"       : "String",
	"description": "String",
	"start"      : "Date",
	"end"        : "Date",
	"rooms"      : [
		"String"
	]
}

URI	Description
/api/calendar/activities	Query all upcoming activities.
/api/calendar/activities/n	Query n upcoming activities.
/api/calendar/activities/n/s	Query n upcoming activities and skip the s first ones.

Querying upcoming tests

A test is an activity and therefore has the same template.

URI	Description
/api/calendar/tests	Query all upcoming tests.
/api/calendar/tests/promotion	Query all upcoming tests for this promotion. (Currently support only tests with a name of type AAA-0000:CTRL)

Querying free rooms

A room is only a String, which means that the result will be like:

[
	"Room1",
	"Room2",
	"Room3",
	"…"
]

URI	Description
/api/calendar/rooms	Query all rooms that are currently free.
/api/calendar/rooms/time	Query all rooms that are free at time.

api-calendar's Issues

Put mongodb url in environment variable

Make a common config file

Remove mongodb internal data from API responses

They are inconsistent across cache refreshes, and useless

Memory Leak

I suspect the server is keeping the whole calendar in memory, generating ~150mb of data constantly in memory

Switch the API to jsonp

Basically switch all the res.json to res.jsonp in order to allow cross-domain requests (required for a cordova app i believe)

Switch to npm module "debug" for logging

We should switch to npm module "debug" for logging, instead of manual console.log-ing. (Especially in the "cache" part)

Move the clubs API

Please move the clubs API to https://github.com/BDE-ESIEE/API-clubs.
This repo will be renamed "API-calendar" tonight

Put hardcoded values in a config file

You can use something like

var config = require("./config.json")

Limit the number of activities sent by /activities

In order to avoid wasting resources, we should add query params that allows to specify a number of activities to request, limit it, and add an offset query param.

We could use something like

db.collection.find().skip(20).limit(10)

Decouple express api and "roomFinder" module

IMHO res.findRoom* should take a callback param and the response thing should be managed by the root index.js

Free rooms API adjustments

Do you think we should adjust the api in /app/roomfinder/index.js to give a more "human interpretable" output, eg don't include rooms that will be unavailable in 5 minutes

Add the ability to test with a static ical file instead of an API call

To put in config file

Report errors to client

Such as here : http://is.gd/Y70kVs