rest-sessions

    2.0.1 • Public • Published

    REST-Sessions

    Build Status Dependency Status

    REST-Sessions

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

    Installation

    • npm i -g rest-sessions

    via Docker

    https://hub.docker.com/r/smrchy/docker-rest-sessions/

    Configuration

    Use the following environment variables to set the listening port and Redis host and port:

    • RS_PORT
    • RS_REDISHOST
    • RS_REDISPORT
    • RS_NAMESPACE (Redis namespace prefix: defaults to drs)
    • RS_LOGLEVEL (a morgan loglevel or none to disable logging)

    Methods

    PUT /: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:

    PUT /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 If might use the put request to add additional paramenters to the session. Just supply them in the body (see the POST request) and set the Content-Type to application/json.

    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.)

    Example:

    GET /mywebapp/activity?dt=600
    

    Response:

    {"activity": 1}
    

    GET /:app/soapp

    Get all sessions of an app that were active within the last n seconds

    Parameters:

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

    Example:

    GET /mywebapp/soapp?dt=600
    

    Response:

    {"sessions":
        [
            {
                "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"
                }
            },
            {
                "id": "user456",
                "r": 4,
                "w": 3,
                "ttl": 86400,
                "idle": 217,
                "ip": "192.168.99.25"
            }
        ]
    }
    

    GET /:app/soid/:id

    Get all sessions of a single id within an app.

    Example:

    GET /mywebapp/soid/user456
    

    Response:

    {"sessions":
        [
            {
                "id": "user456",
                "r": 4,
                "w": 3,
                "ttl": 86400,
                "idle": 217,
                "ip": "192.168.99.25"
            },
            {
                "id": "user456",
                "r": 42,
                "w": 31,
                "ttl": 86400,
                "idle": 23107,
                "ip": "10.0.2.45"
            }
        ]
    }
    

    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}
    

    GET /ping

    Pings the redis server and returns

    PONG
    

    License

    (The MIT License)

    Copyright (c) 2010-2016 TCS <dev (at) tcs.de>

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i rest-sessions

    DownloadsWeekly Downloads

    16

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    28.5 kB

    Total Files

    14

    Last publish

    Collaborators

    • smrchy