fwsp-umf-message - npm Package Compare versions

Comparing version 0.0.13 to 0.1.0

index.js

@@ -72,2 +72,42 @@ 'use strict';
   /**
+  * @name messageToShort
+  * @summary convert a long message to a short one
+  * @param {object} message - message to be converted
+  * @return {object} converted message
+  */
+  messageToShort(message) {
+    let convertedMessage = {};
+    (message.to) && (convertedMessage.to = message.to);
+    (message.from) && (convertedMessage.frm = message.from);
+    (message.mid) && (convertedMessage.mid = message.mid);
+    (message.rmid) && (convertedMessage.rmid = message.rmid);
+    (message.timestamp) && (convertedMessage.ts = message.timestamp);
+    (message.version) && (convertedMessage.ver = message.version);
+    (message.via) && (convertedMessage.via = message.via);
+    (message['for']) && (convertedMessage['for'] = message['for']);
+    (message.body) && (convertedMessage.bdy = message.body);
+    return convertedMessage;
+  }
+
+  /**
+  * @name messageToLong
+  * @summary convert a short message to a long one
+  * @param {object} message - message to be converted
+  * @return {object} converted message
+  */
+  messageToLong(message) {
+    let convertedMessage = {};
+    (message.to) && (convertedMessage.to = message.to);
+    (message.frm) && (convertedMessage.from = message.frm);
+    (message.mid) && (convertedMessage.mid = message.mid);
+    (message.rmid) && (convertedMessage.rmid = message.rmid);
+    (message.ts) && (convertedMessage.timestamp = message.ts);
+    (message.ver) && (convertedMessage.version = message.ver);
+    (message.via) && (convertedMessage.via = message.via);
+    (message['for']) && (convertedMessage['for'] = message['for']);
+    (message.bdy) && (convertedMessage.body = message.bdy);
+    return convertedMessage;
+  }
+
+  /**
   * @name validateMessage
@@ -124,3 +164,2 @@ * @summary Validates that a UMF message has required fields
     }
-
     let segments = urlRoute.split(':');
@@ -127,0 +166,0 @@ if (segments.length < 1) {

package.json

 {
   "name": "fwsp-umf-message",
-  "version": "0.0.13",
+  "version": "0.1.0",
   "description": "umf-message: a tool for creating and working with UMF style messages",
@@ -5,0 +5,0 @@ "author": "Carlos Justiniano",

README.md

@@ -72,2 +72,26 @@ # UMF Message
 
+### messageToShort - convert a long message to a short one
+
+```javascript
+/**
+* @name messageToShort
+* @summary convert a long message to a short one
+* @param {object} message - message to be converted
+* @return {object} converted message
+*/
+messageToShort(message)
+```
+
+### messageToLong - convert a short message to a long one
+
+```javascript
+/**
+* @name messageToLong
+* @summary convert a short message to a long one
+* @param {object} message - message to be converted
+* @return {object} converted message
+*/
+messageToLong(message)
+```
+
 ### validateMessage - Validates that a UMF message has required fields
@@ -111,2 +135,1 @@
 ```
-

specs/tests.js

@@ -7,5 +7,2 @@ 'use strict';
 
-/**
-* Test createMessage
-*/
 describe('createMessage', () => {
@@ -32,2 +29,29 @@ it('should return an object when given an empty message', () => {
 
+describe('message conversion to and from short form', () => {
+  it('should convert a short form message to a long form message', () => {
+    let msg = UMFMessage.createMessage({
+      to: 'someservice:/',
+      frm: 'tester',
+      bdy: {
+        val: 'some value'
+      }
+    }, true);
+    let longFormMessage = UMFMessage.messageToLong(msg);
+    expect(longFormMessage).to.have.property('from');
+    expect(longFormMessage).to.have.property('body');
+  });
+  it('should convert a long form message to a short form message', () => {
+    let msg = UMFMessage.createMessage({
+      to: 'someservice:/',
+      from: 'tester',
+      body: {
+        val: 'some value'
+      }
+    });
+    let shortFormMessage = UMFMessage.messageToShort(msg);
+    expect(shortFormMessage).to.have.property('frm');
+    expect(shortFormMessage).to.have.property('bdy');
+  });
+});
+
 describe('validateMessage', () => {
@@ -65,3 +89,3 @@ it('should return false if missing from field', () => {
 describe('parseRoute', () => {
-  let instanceID = 'fa1ae8d5-86fc-44af-aad8-cd2740aef041';
+  let instanceID = 'fa1ae8d586fc44afaad8cd2740aef041';
   let msg = UMFMessage.createMessage({
@@ -68,0 +92,0 @@ to: `${instanceID}@test-service:[GET]/v1/somedata`,

No alert changes

Improved metrics

Total package byte prevSize

17053

increased by21.5%

Lines of code

296

increased by25.96%

Number of lines in readme file

134

increased by20.72%

No dependency changes