larvit/smpp-js
3
0
Fork 0
Code Issues Pull Requests Actions Activity

Bumped upstream versions, minor adjustments to docs and a log message

Browse Source
This commit is contained in:
Lilleman auf Larv
2016-05-16 11:22:30 +02:00
parent f4a7c51b85
commit 5da55e0f52
4 changed files with 110 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.eslintrc
+12 -12
View File
@@ -4,20 +4,20 @@
"mocha": true "mocha": true
}, },
"rules": { "rules": {
"global-strict": [2, "always"], "strict": [2, "safe"],
"no-mixed-requires": false, "no-mixed-requires": 0,
"no-multi-spaces": false, "no-multi-spaces": 0,
"space-infix-ops": true, "space-infix-ops": 2,
"quotes": [1, "single"], "quotes": [1, "single"],
"vars-on-top": [1, true], "vars-on-top": 1,
"one-var": [1, true], "one-var": 1,
"no-shadow": false, "no-shadow": 0,
"eol-last": false, "eol-last": 0,
"key-spacing": false, "key-spacing": 0,
"no-mixed-spaces-and-tabs": [2, "smart-tabs"], "no-mixed-spaces-and-tabs": [2, "smart-tabs"],
"space-unary-ops": [1, { "words": true, "nonwords": true }], "space-unary-ops": [1, { "words": true, "nonwords": true }],
"no-underscore-dangle": false, "no-underscore-dangle": 0,
"camelcase": false, "camelcase": 0,
"no-process-exit": false "no-process-exit": 0
} }
} }
README.md
+93 -85
View File
@@ -11,59 +11,63 @@ This is a simplified implementation of the SMPP protocol.
This will setup a client that connects to localhost, port 2775 without username or password and send a message. This will setup a client that connects to localhost, port 2775 without username or password and send a message.
var larvitsmpp = require('larvitsmpp'); ```javascript
var larvitsmpp = require('larvitsmpp');
larvitsmpp.client(function(err, clientSession) { larvitsmpp.client(function(err, clientSession) {
clientSession.sendSms({ clientSession.sendSms({
'from': '46701113311', 'from': '46701113311',
'to': '46709771337', 'to': '46709771337',
'message': 'Hello world' 'message': 'Hello world'
}); });
// Gracefully close connection // Gracefully close connection
clientSession.unbind(); clientSession.unbind();
}); });
```
### Some connection parameters and DLR ### Some connection parameters and DLR
This will setup a client that connects to given host, port with username and password, send a password and retrieve a DLR. This will setup a client that connects to given host, port with username and password, send a password and retrieve a DLR.
larvitsmpp.client({ ```javascript
'host': 'smpp.somewhere.com', larvitsmpp.client({
'port': 2775, 'host': 'smpp.somewhere.com',
'username': 'foo', 'port': 2775,
'password': 'bar' 'username': 'foo',
}, function(err, clientSession) { 'password': 'bar'
if (err) { }, function(err, clientSession) {
throw err; if (err) {
} throw err;
}
clientSession.sendSms({ clientSession.sendSms({
'from': '46701113311', 'from': '46701113311',
'to': '46709771337', 'to': '46709771337',
'message': '«baff»', 'message': '«baff»',
'dlr': true 'dlr': true
}, function(err, smsId, retPduObj) { }, function(err, smsId, retPduObj) {
if (err) { if (err) {
throw err; throw err;
} }
console.log('SMS sent, smsId(s): ' + smsId.join(', ')); console.log('SMS sent, smsId(s): ' + smsId.join(', '));
console.log('Return PDU object:'); console.log('Return PDU object:');
console.log(retPduObj); console.log(retPduObj);
}); });
clientSession.on('dlr', function(dlr, dlrPduObj) { clientSession.on('dlr', function(dlr, dlrPduObj) {
console.log('DLR received:'); console.log('DLR received:');
console.log(dlr); console.log(dlr);
console.log('DLR PDU object:'); console.log('DLR PDU object:');
console.log(dlrPduObj); console.log(dlrPduObj);
// Gracefully close connection // Gracefully close connection
clientSession.unbind(); clientSession.unbind();
}); });
}); });
```
## Server ## Server
@@ -71,64 +75,68 @@ This will setup a client that connects to given host, port with username and pas
This will setup a password less server on localhost, port 2775 and console.log() incomming commands. This will setup a password less server on localhost, port 2775 and console.log() incomming commands.
var larvitsmpp = require('larvitsmpp'); ```javascript
var larvitsmpp = require('larvitsmpp');
larvitsmpp.server(function(err, serverSession) { larvitsmpp.server(function(err, serverSession) {
if (err) { if (err) {
throw err; throw err;
} }
serverSession.on('data', function(data) { serverSession.on('data', function(data) {
console.log('command: ' + data.command); console.log('command: ' + data.command);
}); });
}); });
```
### With auth, returning smsId and DLR ### With auth, returning smsId and DLR
Example code below: Example code below:
// This should of course be replaced with your preferred auth system ```javascript
function checkuserpass(username, password, callback) { // This should of course be replaced with your preferred auth system
if (username === 'foo' && password === 'bar') { function checkuserpass(username, password, callback) {
// The last parameter is just user meta data that will be attached to the session as "userData" and is optional if (username === 'foo' && password === 'bar') {
callback(null, true, {'username': 'foo', 'userId': 123}); // The last parameter is just user meta data that will be attached to the session as "userData" and is optional
} else { callback(null, true, {'username': 'foo', 'userId': 123});
callback(null, false); } else {
} callback(null, false);
} }
}
larvitsmpp.server({ larvitsmpp.server({
'checkuserpass': checkuserpass 'checkuserpass': checkuserpass
}, function(err, serverSession) { }, function(err, serverSession) {
if (err) { if (err) {
throw err; throw err;
} }
// Incoming SMS! // Incoming SMS!
serverSession.on('sms', function(sms) { serverSession.on('sms', function(sms) {
// It is important to run the sms.resp() since this is a part of the protocol // It is important to run the sms.resp() since this is a part of the protocol
sms.resp({ sms.resp({
// Decimal value status code // Decimal value status code
// Default is 0 == no error // Default is 0 == no error
// See SMPP spec for all available status codes // See SMPP spec for all available status codes
// For example: 11 == 0000000B == ESME_RINVDSTADR == "Invalid destination address". // For example: 11 == 0000000B == ESME_RINVDSTADR == "Invalid destination address".
'status': 0, 'status': 0,
// Set SMS id, this is important if DLR is to be connected with the right SMS but is not mandatory // Set SMS id, this is important if DLR is to be connected with the right SMS but is not mandatory
'smsId': 450 'smsId': 450
}); });
// Oh, the sms sender wants a dlr (delivery report), send it! // Oh, the sms sender wants a dlr (delivery report), send it!
if (sms.dlr === true) { if (sms.dlr === true) {
serverSession.sendDlr(sms); serverSession.sendDlr(sms);
// To send a negative delivery report do: // To send a negative delivery report do:
//serverSession.sendDlr(sms, false); //serverSession.sendDlr(sms, false);
} }
}); });
}); });
```
## Session Events ## Session Events
lib/session.js
+1 -1
View File
@@ -198,7 +198,7 @@ function send(pdu, closeAfterSend, callback) {
} }
} else { } else {
err = new Error('Event triggered but incoming PDU is not a response or seqNr does not match. isResp: ' + incPduObj.isResp().toString() + ' incSeqNr: ' + incPduObj.seqNr + ' expected seqNr: ' + pduObj.seqNr); err = new Error('Event triggered but incoming PDU is not a response or seqNr does not match. isResp: ' + incPduObj.isResp().toString() + ' incSeqNr: ' + incPduObj.seqNr + ' expected seqNr: ' + pduObj.seqNr);
log.warn(err.message); log.warn('larvitsmpp: lib/session.js: send() - this.on(incomingPduObj) - ' + err.message);
callback(err); callback(err);
} }
}); });
package.json
+4 -4
View File
@@ -9,16 +9,16 @@
"dependencies": { "dependencies": {
"async": "^1.5.2", "async": "^1.5.2",
"iconv-lite": "^0.4.13", "iconv-lite": "^0.4.13",
"moment": "^2.11.2", "moment": "^2.13.0",
"utils-merge": "^1.0.0", "utils-merge": "^1.0.0",
"winston": "^2.1.1" "winston": "^2.2.0"
}, },
"description": "Simplified SMPP implementation", "description": "Simplified SMPP implementation",
"devDependencies": { "devDependencies": {
"coveralls": "^2.11.9", "coveralls": "^2.11.9",
"istanbul": "^0.4.3", "istanbul": "^0.4.3",
"mocha": "^2.4.5", "mocha": "^2.4.5",
"portfinder": "^0.4.0" "portfinder": "^1.0.3"
}, },
"keywords": [ "keywords": [
"smpp", "smpp",
@@ -31,7 +31,7 @@
"url": "https://github.com/larvit/larvitsmpp", "url": "https://github.com/larvit/larvitsmpp",
"type": "git" "type": "git"
}, },
"version": "0.1.18", "version": "0.1.19",
"readmeFilename": "README.md", "readmeFilename": "README.md",
"bugs": { "bugs": {
"url": "https://github.com/larvit/larvitsmpp/issues" "url": "https://github.com/larvit/larvitsmpp/issues"