automattic / mydb-expose Goto Github PK

View Code? Open in Web Editor NEW

8.0 110.0 4.0 138 KB

mydb connect middleware

Makefile 0.38% JavaScript 99.62%

mydb-expose's Introduction

This repository is no longer maintained

mydb-expose

Connect middleware to expose documents through MyDB.

Example

// dependencies
var mydb = require('mydb-expose');
var express = require('express');
var app = express();
var db = require('monk')():

// middleware
app.use(express.cookieParser());
app.use(mydb({ mongo: '127.0.0.1:27017', url: '127.0.0.1:3000' }));

// example session route
app.post('/login', function(req, res){
  req.session.set('user_id', '123');
  res.send(200);
});

// example document expose
app.get('/some/doc', function(req, res){
  res.send(db.get('collection').findOne({ some: 'query' }));
});

API

Middleware

Options:

url
- a string like cloudup.mydb.io or a reference to the mydb server object in case it's in the same process
redis
- a redis client instance or
- a string like localhost:6379
mongo
- a monk instance
- a string like localhost:27017/test
sessionExpose
- fields to expose from the session document (defaults to '-sid')

ServerResponse#send

The express method is overridden to detect monk-style Promise objects.

If the request contains the header X-Requested-With: MyDB.

ServerRequest#session

Points to the

MySession

Operations executed on the session object defer the response sent to the client automatically, unless a callback is passed to one of the functions below.

Errors are nextd automatically.

The object is populated with the latest snapshot from the database.

reload(fn)

Reloads the session from database.

set(key, val, fn)

Calls $set with the given key and val.

unset(key, fn)

Calls $unset with the given key.

pop(key, fn)

Calls $pop with the given key.

shift(key, fn)

Calls $pop with the given key and -1, producing a shift.

push(key, val, fn)

Calls $push to the given key with val.

pushAll(key, vals, fn)

Calls $push to the given key with vals.

pull(key, val, fn)

Calls $pull with the given key and val.

pullAll(key, vals, fn)

Calls $pullAll with the given key and vals.

rename(key, newKey, fn)

Calls $rename with the given key and newKey.

get(key, fn)

Gets the given key asynchronously. Normally you just want to access req.session[key].

mydb-expose's People

Contributors

Stargazers

Watchers

Forkers

thebyrd mnmly coreh isabella232

mydb-expose's Issues

Allow tweaking session fields exposure

Expose `res.subscribe`

res.subscribe(promise, fn)
res.subscribe(oid|string, fn)

Functioning example

Hello,

I am trying to setup a demo example but no luck so far :(

My server looks like this:
// dependencies
var mydb = require('mydb-expose');
var path = require('path');
var express = require('express');
var app = express();
var db = require('monk')('127.0.0.1:27017/mydb-test');

//db
var users = db.get('users');
users.insert({ name: 'Tobi' });

// middleware
app.use(express.static(path.join(__dirname, '/public')));
app.use(express.cookieParser());
app.use(mydb({ mongo: '127.0.0.1:27017/mydb-test', url: '127.0.0.1:3000' }));

// example session route
app.post('/login', function(req, res){
  req.session.set('user_id', '123');
  res.send(200);
});

//serve main file
app.get('/', function(req, res){
  res.sendfile('index.html');
});

// example document expose
app.get('/user', function(req, res){
  res.send(db.get('user').findOne({ name: 'Tobi' }));
});

app.listen(3000, '127.0.0.1');
console.log('Listening on port 3000');

my index.html looks like this:

<!DOCTYPE html>
<html>
<head>
  <title>mydb-test</title>

</head>
<body>
  <script src="build/build.js"></script>
  <script>
  var db = require('mydb')('127.0.0.1:3000');
  var user = db.get('/user', function(){
    console.log(user.name)
  });
  //subscribe to name changes
  user.on('name', function(name){
    console.log('name changed to:' + name)
  })
  </script>
</body>
</html>

When I start the express server and connect with a browser to http://127.0.0.1 , I get the following error in the console:

GET http://127.0.0.1:3000/engine.io/?EIO=2&transport=polling 404 (Not Found)

Any advice?
Thanx

req.mydb.subscribe(promise)

Hash the sid with the `_id` to produce the subscription id

Do not use 304, browser special cases it. Use `X-MyDb-Not-Modified: 1`

Expose collection name

Required to get the initial payload

"ETag" support

Fix tests

They still assume redis

Make /session endpoint optional

Subscribe with redis PUB

Default to no /session endpoint in the absence of connect session middleware.

And warn with debug

Full ns support

Not just relay collection, but also database name.