https://github.com/btd/connect-session

Connect.js session managment for Rest Api applications
https://github.com/btd/connect-session

Last synced: 9 days ago
JSON representation

Connect.js session managment for Rest Api applications

• Host: GitHub
• URL: https://github.com/btd/connect-session
• Owner: btd
• Created: 2012-12-24T13:17:13.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2012-12-24T17:15:37.000Z (almost 12 years ago)
• Last Synced: 2024-10-08T01:47:11.739Z (about 1 month ago)
• Language: JavaScript
• Size: 105 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# connect-session

It is a small project which help organize optional sessions in REST applications that uses connect/express. By default

 connect has only cookie session, that is not applicable and very unconvinient for API projects.

## Usage

Generally it based on connect session.js code, so configuration and options almost the same.

For example you have a route that handle session management:

First i expect you will made some configuration and create middleware function:

```javascript

//you config-session.js file

var connectSession = require('connect-session'),

    session = connectSession.session,

    header = connectSession.header;

var util = require('../lib/utils');

//you should replace this one with other store (but this used by default)

var MemoryStore = require('../lib/session/memory');

var loaders = [

    header({

        header: 'X-User-Session' //this used by default, so you can skip this

    })

];

var options = {

    store: new MemoryStore

}

module.exports.sessionCreate = session(loaders, options);

module.exports.sessionLoad = session(loaders, util.merge(options, {

    generateOnMissingSID: false

}));

```

```javascript

var sessionCreate = require('./config-session').sessionCreate;

app.get('/sessions/new', sessionCreate, function(req, res) {

    res.json({ sid: req.sessionID});

})

```

This route will return newly created session and initialize session. You should understand that session will be available

only in this route. What happen there:

First request will be processed by session middleware (by default it uses `MemoryStore` to store sessions) it will use

header loader to try to find session id in default header `'X-User-Session'` (to change this pass in header options { header: 'My-header'}).

If session id will not be founded new session will be created and its sid will be returned.

Of course you expect that session will be loaded every time it can be loaded, to make this need to add in app general middleware:

```javascript

var sessionLoad = require('./config-session').sessionLoad;

//do not forget add all needed middleware before!!!

app.use(sessionLoad);

```

## License 

(The MIT License)

Copyright (c) 2012 Bardadym Denis <[email protected]>

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.