Merge branch 'master' of https://github.com/peterbartels/send

Author: a.habannakeh

README.md

@@ -76,7 +76,7 @@ the 4th byte in the stream.
 
 ##### etag
 
-Enable or disable etag generation, defaults to true.
+Enable or disable etag generation, defaults to `true` unless the transform options is set.
 
 ##### extensions
 
@@ -101,9 +101,11 @@ in preferred order.
 
 ##### lastModified
 
-Enable or disable `Last-Modified` header, defaults to true. Uses the file
+Enable or disable `Last-Modified` header, defaults to `true`. Uses the file
 system's last modified value.
 
+If the `transform` option is set then the default is `false`.
+
 ##### maxAge
 
 Provide a max-age in milliseconds for http caching, defaults to 0.
@@ -120,6 +122,28 @@ Byte offset at which the stream starts, defaults to 0. The start is inclusive,
 meaning `start: 2` will include the 3rd byte in the stream.
 
 #### Events
+=======
+##### Transform
+
+A function that consumes the file stream and produces a new (transformed) stream:
+```javascript
+function(stream) {return stream.pipe(replaceStream('tobi', 'peter'))}
+```
+ 
+Multiple transformations are possible: 
+```javascript
+function(stream) {
+  return stream
+  .pipe(replaceStream('tobi', 'peter'))
+  .pipe(replaceStream('peter', 'hans'))
+  .pipe(...)
+}
+```
+
+With transform the last-modified and etag defaults to `false` but can be overridden when
+a transform on the file's stream is expected to always generate the same result. 
+
+### Events
 
 The `SendStream` is an event emitter and will emit the following events:
 

index.js

@@ -96,19 +96,14 @@ function send (req, path, options) {
 function SendStream (req, path, options) {
   Stream.call(this)
 
-  var opts = options || {}
 
-  this.options = opts
-  this.path = path
-  this.req = req
+  this._transform = typeof options.transform === 'function'
+      ? options.transform
+      : undefined
 
-  this._acceptRanges = opts.acceptRanges !== undefined
-    ? Boolean(opts.acceptRanges)
-    : true
-
-  this._cacheControl = opts.cacheControl !== undefined
-    ? Boolean(opts.cacheControl)
-    : true
+  this._etag = options.etag !== undefined
+    ? Boolean(options.etag)
+    : (this._transform !== undefined ? false : true)
 
   this._etag = opts.etag !== undefined
     ? Boolean(opts.etag)
@@ -145,9 +140,15 @@ function SendStream (req, path, options) {
     ? normalizeList(opts.index, 'index option')
     : ['index.html']
 
+<<<<<<< HEAD
   this._lastModified = opts.lastModified !== undefined
     ? Boolean(opts.lastModified)
     : true
+=======
+  this._lastModified = options.lastModified !== undefined
+    ? Boolean(options.lastModified)
+    : (this._transform !== undefined ? false : true)
+>>>>>>> f8fd84f270e1e1afb969e75d63e57a63f9d17141
 
   this._maxage = opts.maxAge || opts.maxage
   this._maxage = typeof this._maxage === 'string'
@@ -696,7 +697,16 @@ SendStream.prototype.send = function send (path, stat) {
   opts.end = Math.max(offset, offset + len - 1)
 
   // content-length
+<<<<<<< HEAD
   res.setHeader('Content-Length', len)
+=======
+  if(this._transform === undefined){
+	res.setHeader('Content-Length', len);
+  }else{
+    //we don't know the content-length of the transformed data beforehand
+    res.setHeader('Transfer-Encoding', 'chunked');
+  }
+>>>>>>> f8fd84f270e1e1afb969e75d63e57a63f9d17141
 
   // HEAD support
   if (req.method === 'HEAD') {
@@ -793,10 +803,23 @@ SendStream.prototype.stream = function stream (path, options) {
   var res = this.res
 
   // pipe
+<<<<<<< HEAD
   var stream = fs.createReadStream(path, options)
   this.emit('stream', stream)
   stream.pipe(res)
 
+=======
+  var stream = fs.createReadStream(path, options);
+  
+  this.emit('stream', stream);
+  
+  if(this._transform !== undefined){
+    stream = this._transform(stream);
+  }
+  
+  stream.pipe(res);
+  
+>>>>>>> f8fd84f270e1e1afb969e75d63e57a63f9d17141
   // response finished, done with the fd
   onFinished(res, function onfinished () {
     finished = true

test/send.js

@@ -8,6 +8,7 @@ var http = require('http')
 var path = require('path')
 var request = require('supertest')
 var send = require('..')
+var replaceStream = require('replacestream')
 
 // test server
 
@@ -1317,12 +1318,61 @@ describe('send(file, options)', function () {
     })
   })
 
-  describe('root', function () {
-    describe('when given', function () {
-      it('should join root', function (done) {
-        request(createServer({ root: fixtures }))
-          .get('/pets/../name.txt')
-          .expect(200, 'tobi', done)
+  describe('transform', function(){
+    it('should transform the file contents', function(done){
+      var app = http.createServer(function(req, res){
+        send(req, 'test/fixtures/name.txt', {transform: function(stream) {return stream.pipe(replaceStream('tobi', 'peter'))}})
+        .pipe(res)
+      });
+
+      request(app)
+      .get('/name.txt')
+      .expect(shouldNotHaveHeader('Last-Modified'))
+      .expect(shouldNotHaveHeader('ETag'))
+      .expect(200, "peter", done)
+    })
+
+    it('should be possible to do mulitple transformations', function(done){
+      var transformFunc = function(stream) {
+        return stream
+        .pipe(replaceStream('tobi', 'peter'))
+        .pipe(replaceStream('peter', 'hans'))
+      }
+	  
+      var app = http.createServer(function(req, res){
+        send(req, 'test/fixtures/name.txt', {transform: transformFunc})
+        .pipe(res)
+      });
+	  
+      request(app)
+      .get('/name.txt')
+      .expect(200, "hans", done)
+    })
+
+    it('should be able to override last modified', function(done){
+      var app = http.createServer(function(req, res){
+        send(req, 'test/fixtures/name.txt', {lastModified: true, transform: function(stream) {return stream.pipe(replaceStream('tobi', 'peter'))}})
+        .pipe(res)
+      });
+
+      request(app)
+      .get('/name.txt')
+      .expect('last-modified', dateRegExp)
+      .expect(200, "peter", done)
+    })
+  })
+
+  describe('root', function(){
+    describe('when given', function(){
+      it('should join root', function(done){
+        var app = http.createServer(function(req, res){
+          send(req, req.url, {root: __dirname + '/fixtures'})
+          .pipe(res);
+        });
+
+        request(app)
+        .get('/pets/../name.txt')
+        .expect(200, 'tobi', done)
       })
 
       it('should work with trailing slash', function (done) {