fwsp-umf-message
Advanced tools
Comparing version 0.3.1 to 0.4.0
29
index.js
'use strict'; | ||
const moment = require('moment'); | ||
const uuid = require('uuid'); | ||
const Utils = require('fwsp-jsutils'); | ||
@@ -17,11 +15,2 @@ const UMF_VERSION = 'UMF/1.4.3'; | ||
/** | ||
* @name getMessage | ||
* @summary Returns a plain-old JavaScript object | ||
* @return {object} obj - a Plain old JavaScript Object. | ||
*/ | ||
getMessage() { | ||
return Object.assign({}, this.message); | ||
} | ||
/** | ||
* @name getTimeStamp | ||
@@ -32,3 +21,3 @@ * @summary retrieve an ISO 8601 timestamp | ||
getTimeStamp() { | ||
return moment().toISOString(); | ||
return new Date().toISOString(); | ||
} | ||
@@ -48,6 +37,7 @@ | ||
* @summary Returns a short form UUID for use with messages | ||
* @return {string} uuid - UUID | ||
@see https://en.wikipedia.org/wiki/Base36 | ||
* @return {string} short identifer | ||
*/ | ||
createShortMessageID() { | ||
return Utils.shortID(); | ||
return (Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)).toString(36); | ||
} | ||
@@ -58,7 +48,6 @@ | ||
* @name toJSON | ||
* @param {object} message - message to be converted | ||
* @return {string} JSON version of message | ||
* @return {object} A JSON stringifiable version of message | ||
*/ | ||
toJSON(message) { | ||
return Utils.safeJSONStringify(this.message); | ||
toJSON() { | ||
return this.message; | ||
} | ||
@@ -104,7 +93,7 @@ | ||
/** | ||
* @name validateMessage | ||
* @name validate | ||
* @summary Validates that a UMF message has required fields | ||
* @return {boolean} response - returns true is valid otherwise false | ||
*/ | ||
validateMessage() { | ||
validate() { | ||
if (!this.message.from || !this.message.to || !this.message.body) { | ||
@@ -111,0 +100,0 @@ return false; |
{ | ||
"name": "fwsp-umf-message", | ||
"version": "0.3.1", | ||
"version": "0.4.0", | ||
"description": "umf-message: a tool for creating and working with UMF style messages", | ||
@@ -15,4 +15,2 @@ "author": "Carlos Justiniano", | ||
"dependencies": { | ||
"fwsp-jsutils": "1.0.8", | ||
"moment": "2.14.1", | ||
"uuid": "2.0.2" | ||
@@ -19,0 +17,0 @@ }, |
@@ -32,14 +32,8 @@ # UMF Message [![Build Status](https://travis-ci.org/flywheelsports/fwsp-umf-message.svg?branch=master)](https://travis-ci.org/flywheelsports/fwsp-umf-message) | ||
To retrieve an entire message object using: | ||
To retrieve an entire message object use: | ||
```javascript | ||
console.log(msg.getMessage()); | ||
console.log(msg.toJSON()); | ||
``` | ||
And you get get a JSON string using: | ||
```javascript | ||
console.log(msg.toJSON()) | ||
``` | ||
## Tests | ||
@@ -46,0 +40,0 @@ |
@@ -57,6 +57,6 @@ 'use strict'; | ||
describe('validateMessage', () => { | ||
describe('validate', () => { | ||
it('should return false if missing from field', () => { | ||
let msg = UMFMessage.createMessage({}); | ||
let ret = msg.validateMessage(); | ||
let ret = msg.validate(); | ||
expect(ret).to.be.false; | ||
@@ -67,3 +67,3 @@ expect(msg['from']).to.be.undefined; | ||
let msg = UMFMessage.createMessage({}); | ||
let ret = msg.validateMessage(); | ||
let ret = msg.validate(); | ||
expect(ret).to.be.false; | ||
@@ -74,3 +74,3 @@ expect(msg['to']).to.be.undefined; | ||
let msg = UMFMessage.createMessage({}); | ||
let ret = msg.validateMessage(); | ||
let ret = msg.validate(); | ||
expect(ret).to.be.false; | ||
@@ -86,3 +86,3 @@ expect(msg['body']).to.be.undefined; | ||
}); | ||
let ret = msg.validateMessage(); | ||
let ret = msg.validate(); | ||
expect(ret).to.be.true; | ||
@@ -133,6 +133,5 @@ }); | ||
}); | ||
let json = msg.toJSON(msg); | ||
let parsed = Utils.safeJSONParse(json); | ||
expect(parsed).to.have.property('from'); | ||
let json = msg.toJSON(); | ||
expect(json).to.have.property('from'); | ||
}); | ||
}); |
1
18288
317
45
- Removedfwsp-jsutils@1.0.8
- Removedmoment@2.14.1
- Removedfwsp-jsutils@1.0.8(transitive)
- Removedmoment@2.14.1(transitive)