Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
protein
Advanced tools
Readme
Protein is http middleware for Node with support for prototype methods, getters and setters. It's compatible with Connect.
It's available through npm:
npm install protein
var protein = require('protein');
var url = require('url');
var fn = protein()
// Adds a query property to the request. Use request.query to access the parsed query
.getter('request.query', function() {
return this._query || (this._query = url.parse(request.url, true).query);
})
// Adds an echo method to the response. Use response.echo() to return the query
.fn('response.echo', function() {
this.end(JSON.stringify(this.request.query));
})
.use(function(request, response) {
response.echo();
});
require('http').createServer(fn).listen(8080);
If we rewrite the above example using Connect it would look like.
var connect = require('connect');
var url = require('url');
var fn = connect()
.use(function(request, response, next) {
request.query = url.parse(request.url, true).query;
next();
})
.use(function(request, response, next) {
response.echo = function() {
response.end(JSON.stringify(request.query));
};
next();
})
.use(function(request, response) {
// Explained below
response.end('hello world');
});
require('http').createServer(fn).listen(8080);
But if we look closer at the above example we are actually parsing the query on every request even though we never use it.
Wouldn't it be nicer to just parse when we access it?
Using Protein we can just define a getter on the middleware prototype:
var fn = protein()
.getter('request.query', function() {
return this._query || (this._query = url.parse(request.url, true).query);
})
.use( ... )
Now when we access request.query the first time the query will be parsed and in all other cases no parsing happens.
Notice Protein is actually defining the getter on the middleware prototype for us so the is actually only defined once - NOT every request.
Similary we could just define echo
on the middleware prototype instead of defining it on every request:
var fn = protein()
.getter('request.query', function() {
return this._query || (this._query = url.parse(request.url, true).query);
})
.fn('response.echo', function() {
this.end(JSON.stringify(request.query));
})
.use( ... )
Note that we are only expanding the middleware prototype and not the prototype from the http
module so their should be zero side effects.
The final program just looks like this:
var protein = require('protein');
var url = require('url');
var fn = protein()
.getter('request.query', function() {
return this._query || (this._query = url.parse(request.url, true).query);
})
.fn('response.echo', function() {
this.end(JSON.stringify(request.query));
})
.use(function(request, response) {
// this method is the only one which is run on every request
response.end('hello world');
});
require('http').createServer(fn).listen(8080);
If you want to create middleware that can be reused in other places and which expands the middleware prototype you can use the following format:
var random = function(request, response, next) {
request.random = Math.random();
next();
};
random.response = {}; // the collection of middleware response prototype methods
random.response.random = function() {
this.end(''+this.request.random); // we can access the request from the response using this.request
};
protein().use(random).use(function(request, response) {
response.random(); // should return a random number
});
If we dont want to run a function on every request but instead want to just expand the prototypes we can just declare a map:
var random = {request: {}, response: {}};
random.request.__defineGetter__('random', function() {
return Math.random();
});
random.response.random = function() {
this.end(''+this.request.random);
};
protein().use(random).use(function(request, response) {
response.random(); // should return a random number
});
For more examples on how to create your own reusable middleware see the examples.
All Connect modules should be compatible with Protein. To make a Protein module compatible with Connect you need to wrap it:
var connectable = protein().use(myProteinMiddleware);
connect.use(connectable);
(The MIT License)
Copyright (c) 2012 Mathias Buus Madsen mathiasbuus@gmail.com
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.
FAQs
Protein is http prototype mixins for Node.js
We found that protein demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).