rest-sessions

REST Sessions

A REST interface to handle and share sessions between different app server platforms. Based on redis-sessions.

Installation

npm install rest-sessions

Run npm install to install the dependencies.

For the test make sure Redis runs locally and run npm test

Methods

POST /:app/create/:id

Create a session for :app and user :id

Parameters:

• ip The IP of the user
• ttl optional (default: 7200) The timeout for the session in seconds

Example:

POST /mywebapp/create/user123?ip=192.168.99.22&ttl=86400

Response:

{"token": "KrxwdpUjoTQcYmMISjQE2C4drmXMhn5w2gX0388UySdPYoEJkPa74nhZhg3iaj7w"}

Note: You should save this token in a cookie and use it in subsequent requests to identify the user via GET /:app/get/:token

GET /:app/get/:token

Get a session for :app and :token

Example:

GET /mywebapp/get/KrxwdpUjoTQcYmMISjQE2C4drmXMhn5w2gX0388UySdPYoEJkPa74nhZhg3iaj7w

Response:

{
    "id": "user123",
    "r": 1,  // The read counter for this session
    "w": 1,  // The write counter for this session
    "ttl": 86400,
    "idle": 273,  // The idle time since the previous request
    "ip": "192.168.99.22"
}

POST /:app/set/:token

Set some additional parameters for this session via a simple JSON object supplied via the POST body.

Example 1:

POST /mywebapp/set/KrxwdpUjoTQcYmMISjQE2C4drmXMhn5w2gX0388UySdPYoEJkPa74nhZhg3iaj7w
Content-Type: application/json

{
	"name": "Peter Smith",
	"unread_msgs": 12
}

Response:

{
    "id": "user123",
    "r": 1,
    "w": 2,
    "ttl": 86400,
    "idle": 211,
    "ip": "192.168.99.22",
    "d": {
        "name": "Peter Smith",
        "unread_msgs": 12,
        "age": 46
    }
}

Example 2:

• To remove a key set it to null
• If you omit a key it will stay untouched

POST /mywebapp/set/KrxwdpUjoTQcYmMISjQE2C4drmXMhn5w2gX0388UySdPYoEJkPa74nhZhg3iaj7w
Content-Type: application/json

{
	"name": "Bruce Dickinson",
	"unread_msgs": null,
	"job": "making gold records"
}

Response:

Note that the unread_msgs field was removed and age was not touched.

{
    "id": "user123",
    "r": 1,
    "w": 3,
    "ttl": 86400,
    "idle": 17,
    "ip": "192.168.99.22",
    "d": {
        "name": "Bruce Dickinson",
        "age": 46,
        "job": "making gold records"
    }
}

GET /:app/activity

Get the number of active unique users (not sessions!) within the last n seconds

Parameters:

• dt Delta time. Amount of seconds to check (e.g. 600 for the last 10 min.)

Get a session for :app and :token

Example:

GET /mywebapp/activity?dt=600

Response:

{"activity": 1}

DELETE /:app/kill/:token

Kill a single session of an app.

Example:

DELETE /mywebapp/kill/KrxwdpUjoTQcYmMISjQE2C4drmXMhn5w2gX0388UySdPYoEJkPa74nhZhg3iaj7w

Response:

{"kill": 1}

DELETE /:app/killsoid/:id

A single unique user id might have multiple sessions on different devices and/or browsers. This methods kills all sessions of an id.

Example:

DELETE /mywebapp/killsoid/user123

Response:

{"kill": 3}

DELETE /:app/killall

Kills all sessions of an app.

Example:

DELETE /mywebapp/killall

Response:

{"kill": 42}