VPlanServer

About

VPlanServer is the server for a customly built substitution plan system. It runs an express webserver, which is used to serve the JSON data of today's and tomorrow's substitution plan, aswell as to listen to incoming substitution plans from authorized sources (see VPlanClient) For emergency cases it backs up the most recent substitution plans into /plans. It's saving all the http request logs to /logs/access/XX_XX_XX.log and all other internal logs to logs/console/YEAR_MONTH_DAY.log.

Installation

Node.js 6.0.0 or newer is required to be installed on your machine.

git clone https://github.com/mpggu/VPlanServer to clone the source to your server,

npm i to install all the required dependencies.

Then create a config.json in your root directory to configure the behaviour of the program.

Config

{
  "auth": "secret_xxx",                    // Authentication for allowing to POST substitution plans
  "wpURL": "wp.myschool.edu",              // The URL of the WordPress Installation
  "wpUsername": "robot",                   // The username of the WordPress user
  "wpPassword": "hunter2",                 // The password of the WordPress user
  "wpPageID": "123",                       // The WordPress Page-ID of the substitution plan.
  "scheduledUploads": 15,                  // When to upload tomorrow's substitution plan. Accepts 0-23. 15 will upload at 15pm
  "port": 6767,                            // On what port to run the webserver on
  "sentryDNS": "https://***@sentry.io/XXX" // Your sentry DNS (sentry.io)
}

Running

I recommend a process manager for production (pm2, forever, nodemon) or simply run node index

Endpoints

URL	Method	Description	Data Params	Headers
/api/v1/vplan	POST	Uploads new substitution plans	The raw data of the untis generated HTML file (UTF-8)	Authorization that matches the configs secret
/api/v1/vplan/today	GET	Returns today's full substitution plan as JSON
/api/v1/vplan/today/:course	GET	Returns today's full substitution plan with a search query applied (e.g. 9A)
/api/v1/vplan/tomorrow	GET	Returns tomorrow's full substitution plan as JSON
/api/v1/vplan/tomorrow/:course	GET	Returns tomorrows's full substitution plan with a search query applied (e.g. 9A)

Help

If you experience any problems or bugs, or just have a question in general, feel free to contact us (German or English). Manuel Kraus, [email protected]

In-depth

After receiving a POST request to server.ip:6767/api/v1/vplan, it parses the raw html data to JSON using VPlanParser, which is then used to satisfy GET request. It's afterwards being passed down to the Updater which either instantly uploads today's substitution plan up to a certain threshold (see config), or puts it in the queue of being uploaded to WordPress at a later point in time.