This code provides a REST API for updating the text on the LED sign above the bathrooms.

This readme is not complete and the code is still considered to be beta so at any given time this may be outdated or inacurate.

The code will not run unless it has a valid serial device to output to. For testing purposes, you can create a fake serial device with socat like this: socat -d -d pty,raw,echo=0 pty,raw,echo=0

###Client Methods The table below shows methods the server will respond to from any client.

The server will respond with a 404 error if a target does not exist.

###Admin Methods This table shows methods the server will respond to if the request orginates from localhost(127.0.0.1) only.

The server will respond with a 401 if a client that isn't localhost uses either method on "/message/all".

The server accepts JSON formatted data for POST and PUT requests and will return JSON formatted data on all requests that return data.

###Client Attributes

The attributes in the table below are set by the client in POST or PUT requests.

Default values for attributes will be applied if they are not specifed by the client.

###Server Response Attributes

The server will respond to valid requests with all of the client specified attributes and with two additional attributes.

Here are some examples of interacting with the sign using curl. The examples are using the "-v" switch to show HTTP headers.

####Write a new message to the sign:

curl -vd '{"message":"This message is orange.","color":"orange","transition":"none","timer":"2h15m"}' localhost:8080/message/new

Server response(HTTP header + JSON data):

< HTTP/1.1 201 Created

< Content-Type: application/json;charset=utf-8

< Location: http://localhost:8080/message/032653f7-5a58-47f9-a0af-5cb715d19054

< Content-Length: 150

< X-Content-Type-Options: nosniff

< Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-11-22)

< Date: Wed, 29 Apr 2015 01:57:05 GMT

< Connection: Keep-Alive

{"message":"This message is orange.","color":"orange","transition":"none","timer":"2h15m","status":"on","uuid":"032653f7-5a58-47f9-a0af-5cb715d19054"}

####Update the message we just wrote with new text:

curl -X PUT -vd '{"message":"This is an updated message"}' localhost:8080/message/032653f7-5a58-47f9-a0af-5cb715d19054'

Server response(HTTP header + JSON data):

< HTTP/1.1 200 OK

< Content-Type: application/json;charset=utf-8

< Content-Length: 153

< X-Content-Type-Options: nosniff

< Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-11-22)

< Date: Wed, 29 Apr 2015 01:59:58 GMT

< Connection: Keep-Alive

{"message":"This is an updated message","color":"orange","transition":"none","timer":"2h15m","status":"on","uuid":"032653f7-5a58-47f9-a0af-5cb715d19054"}

####Getting the message from the server:

curl -v localhost:8080/message/032653f7-5a58-47f9-a0af-5cb715d19054

Server response(HTTP header + JSON data):

< HTTP/1.1 200 OK

< Content-Type: application/json;charset=utf-8

< Content-Length: 93

< X-Content-Type-Options: nosniff

< Server: WEBrick/1.3.1 (Ruby/1.9.3/2013-11-22)

< Date: Wed, 29 Apr 2015 02:02:29 GMT

< Connection: Keep-Alive

{"message":"This is an updated message","color":"orange","transition":"none","timer":"2h15m"}

####Deleting a message from the server:

curl -vX DELETE localhost:8080/message/032653f7-5a58-47f9-a0af-5cb715d19054

Server response(HTTP header + JSON data):

< HTTP/1.1 1

< Content-Type: application/json

< Content-Length: 0

< X-Content-Type-Options: nosniff

< Connection: keep-alive

< Server: thin 1.3.1 codename Triple Espresso

Server response codes are not completly RESTfull yet. In the future responses that return no data will set 204 instead of 200. There is no error checking built into the codebase yet so it is entirely possible that a malicious request could break things. If you find a bug please report it as an issue on the github page.

Hack the planet.