version 0.0.6

Merge branch 'development'

.travis.yml

@@ -1,4 +1,6 @@
 language: node_js
 node_js:
   - "0.10"
-  - "0.8"
+  - "0.8"
+before_install:
+  - '[ "${TRAVIS_NODE_VERSION}" != "0.8" ] || npm install -g npm@~1.4.6'

README.md

@@ -61,6 +61,23 @@ Run Tests
   npm test
 ```
 
+Troubleshooting
+====================
+
+* **I get an error when installing node packages *"ERR! Error: No compatible version found: assertion-error@'^1.0.1'"***
+
+  If you are running a version of NodeJS less than or equal to 0.8, upgrading NPM to a version greater than or equal to 1.4.6 should solve this issue.
+
+  ```
+  npm install -g npm@~1.4.6
+  ```
+
+  Another way around is to simply avoid installing the development dependencies:
+
+  ```
+  npm install --production
+  ```
+
 ====================
 
 #### Author: [Craig Thayer](https://github.com/sazze)

lib/winston-logstash-udp.js

@@ -29,6 +29,8 @@ var LogstashUDP = exports.LogstashUDP = function(options) {
     this.port = options.port || 9999;
     this.application = options.appName || process.title;
     this.pid = options.pid || process.pid;
+    this.trailingLineFeed = options.trailingLineFeed === true;
+    this.trailingLineFeedChar = options.trailingLineFeedChar || os.EOL;
 
     this.client = null;
 
@@ -79,9 +81,14 @@ LogstashUDP.prototype.log = function(level, msg, meta, callback) {
 
 LogstashUDP.prototype.sendLog = function(message, callback) {
     var self = this;
+
+    if (this.trailingLineFeed === true) {
+        message = message.replace(/\s+$/, '') + this.trailingLineFeedChar;
+    }
+
     var buf = new Buffer(message);
 
     callback = (callback || function() {});
 
     self.client.send(buf, 0, buf.length, self.port, self.host, callback);
-};
+};

package.json

@@ -1,14 +1,15 @@
 {
     "name": "winston-logstash-udp",
-    "version": "0.0.5",
+    "version": "0.0.6",
     "description": "A Logstash UDP transport for winston",
     "main": "./lib/winston-logstash-udp",
     "homepage": "https://github.com/sazze/winston-logstash-udp",
     "scripts": {
         "test": "mocha test/*_test.js"
     },
     "engines": {
-        "node": ">=0.8.x"
+        "node": ">=0.8.x",
+        "npm" : ">=1.4.6"
     },
     "repository": {
         "type": "git",
@@ -21,7 +22,8 @@
         "winston": ">=0.7.2",
         "mocha": ">=1.8.2",
         "chai": ">=1.5.0",
-        "timekeeper": ">=0.0.3"
+        "timekeeper": ">=0.0.3",
+        "sinon-chai": "~2.8.0"
     },
     "keywords": [
         "logging",
@@ -47,6 +49,10 @@
         {
             "name": "devAsterisk",
             "email": "[email protected]"
+        },
+        {
+            "name": "Anis Safine",
+            "email": "[email protected]"
         }
     ],
     "maintainers": [
@@ -55,4 +61,4 @@
             "email": "[email protected]"
         }
     ]
-}
+}

test/winston-logstash-udp_test.js

@@ -1,13 +1,19 @@
 process.env.NODE_ENV = 'test';
 
 var chai = require('chai'),
+    sinon = require('sinon'),
+    sinonChai = require('sinon-chai'),
     expect = chai.expect,
     dgram = require('dgram'),
     winston = require('winston'),
     timekeeper = require('timekeeper'),
+    os = require('os'),
+    common = require('winston/lib/winston/common'),
     freezed_time = new Date(1330688329321);
 
 chai.Assertion.includeStack = true;
+chai.should();
+chai.use(sinonChai);
 
 require('../lib/winston-logstash-udp');
 
@@ -35,15 +41,25 @@ describe('winston-logstash-udp transport', function () {
         return server;
     }
 
-    function createLogger(port) {
+    function createLogger(port, options) {
+        var defaultOptions = {
+            port: port,
+            appName: 'test',
+            localhost: 'localhost',
+            pid: 12345
+        },
+        options = options || {},
+        field;
+
+        for (field in defaultOptions) {
+            if (defaultOptions.hasOwnProperty(field) && !options.hasOwnProperty(field)) {
+                options[field] = defaultOptions[field];
+            }
+        }
+
         return new (winston.Logger)({
             transports: [
-                new (winston.transports.LogstashUDP)({
-                    port: port,
-                    appName: 'test',
-                    localhost: 'localhost',
-                    pid: 12345
-                })
+                new (winston.transports.LogstashUDP)(options)
             ]
         });
     }
@@ -70,6 +86,45 @@ describe('winston-logstash-udp transport', function () {
             logger.log('info', 'hello world', {stream: 'sample'});
         });
 
+        describe('with the option \'trailing line-feed\' on', function () {
+            it('remove all trailing blank characters and replace them with the operating system\'s EOL character', function (done) {
+                var logger = createLogger(
+                    port,
+                    {
+                        trailingLineFeed: true
+                    }
+                );
+
+                common.log = sinon.stub().returns('{"what":"ever"}' + "\r\n\t ");
+
+                test_server = createTestServer(port, function (data) {
+                    expect(data.toString()).to.be.eql('{"what":"ever"}' + os.EOL);
+                    done();
+                });
+
+                logger.log('info', 'hello world', {stream: 'sample'});
+            });
+
+            it('if set in the options, remove all trailing blank characters and replace them with a custom character', function (done) {
+                var logger = createLogger(
+                    port,
+                    {
+                        trailingLineFeed: true,
+                        trailingLineFeedChar: os.EOL + "\n"
+                    }
+                );
+
+                common.log = sinon.stub().returns('{"what":"ever"}' + "\r\n\t ");
+
+                test_server = createTestServer(port, function (data) {
+                    expect(data.toString()).to.be.eql('{"what":"ever"}' + os.EOL + "\n");
+                    done();
+                });
+
+                logger.log('info', 'hello world', {stream: 'sample'});
+            });
+        });
+
         // Teardown
         afterEach(function () {
             if (test_server) {
@@ -82,4 +137,4 @@ describe('winston-logstash-udp transport', function () {
 
     });
 
-});
+});