Updated docs. Added postback serialization. Improved tests.

Author: alexindigo

README.md

@@ -6,7 +6,7 @@ module.exports = postback;
  *
  * @this  Fbbot#
  * @param {object} payload - messaging envelop object
- * @param {function} callback - invoked after type casting is done
+ * @param {function} callback - invoked after parsing is done
  */
 function postback(payload, callback)
 {

incoming/postback.js

@@ -174,7 +174,9 @@ function generateMessage(type, data)
       break;
 
     case types.TEXT:
-      message = {text: data};
+      // `text` must be UTF-8 and has a 320 character limit
+      // https://developers.facebook.com/docs/messenger-platform/send-api-reference/text-message
+      message = {text: data.substr(0, 320)};
       break;
 
     case types.AUDIO:
@@ -187,7 +189,7 @@ function generateMessage(type, data)
     case types.QUICK_REPLIES:
       // `quick_replies` is limited to 10
       // https://developers.facebook.com/docs/messenger-platform/send-api-reference/quick-replies
-      message = {text: data.text, quick_replies: (data.quick_replies || data.elements).slice(0, 10)};
+      message = {text: data.text, quick_replies: data.quick_replies.slice(0, 10)};
       break;
 
     case types.GENERIC:

lib/send.js

@@ -0,0 +1,18 @@
+module.exports = buttonPostback;
+
+/**
+ * Stringifies provided button.postback payload
+ *
+ * @this  Fbbot#
+ * @param {object} payload - button.postback object
+ * @param {function} callback - invoked after stringification is done
+ */
+function buttonPostback(payload, callback)
+{
+  if (typeof payload.payload != 'string')
+  {
+    payload.payload = JSON.stringify(payload.payload);
+  }
+
+  callback(null, payload);
+}

outgoing/button_postback.js

@@ -1,6 +1,15 @@
 var attach = require('../lib/attach.js');
 
 var filters = {
+
+  'send.button.postback': [
+    require('./button_postback.js')
+  ],
+
+  'send.quick_reply': [
+    require('./quick_reply.js')
+  ]
+
 };
 
 module.exports = attach.bind(null, filters);

outgoing/index.js

@@ -0,0 +1,18 @@
+module.exports = quickReply;
+
+/**
+ * Stringifies provided quick reply payload
+ *
+ * @this  Fbbot#
+ * @param {object} payload - quick_reply object
+ * @param {function} callback - invoked after stringification is done
+ */
+function quickReply(payload, callback)
+{
+  if (typeof payload.payload != 'string')
+  {
+    payload.payload = JSON.stringify(payload.payload);
+  }
+
+  callback(null, payload);
+}

outgoing/quick_reply.js

@@ -12,7 +12,10 @@
         }, {
           "type": "postback",
           "title": "Start Chatting",
-          "payload": "USER_DEFINED_PAYLOAD"
+          "payload": {
+            "custom": "payload",
+            "provides_as": "object"
+          }
         }]
       }
     },
@@ -34,7 +37,7 @@
             }, {
               "type": "postback",
               "title": "Start Chatting",
-              "payload": "USER_DEFINED_PAYLOAD"
+              "payload": "{\"custom\":\"payload\",\"provides_as\":\"object\"}"
             }]
           }
         }

test/fixtures/outgoing/button.json

@@ -319,7 +319,9 @@
         }, {
           "content_type": "text",
           "title": "Green",
-          "payload": "DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_GREEN"
+          "payload": {
+            "developer": ["defined", "payload", "for", "picking", "green"]
+          }
         }]
       }
     },
@@ -337,7 +339,7 @@
         }, {
           "content_type": "text",
           "title": "Green",
-          "payload": "DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_GREEN"
+          "payload": "{\"developer\":[\"defined\",\"payload\",\"for\",\"picking\",\"green\"]}"
         }]
       }
     },

test/fixtures/outgoing/message.json

@@ -1,7 +1,7 @@
 [
   {
     "count": {
-      "expected": 2,
+      "expected": 3,
       "hook": "send.quick_reply"
     },
     "arguments": {
@@ -16,7 +16,12 @@
         }, {
           "content_type": "text",
           "title": "Green",
-          "payload": "DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_GREEN"
+          "payload": {
+            "custom": "payload",
+            "for": "quick_reply"
+          }
+        }, {
+          "content_type": "location"
         }]
       }
     },
@@ -34,7 +39,9 @@
         }, {
           "content_type": "text",
           "title": "Green",
-          "payload": "DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_GREEN"
+          "payload": "{\"custom\":\"payload\",\"for\":\"quick_reply\"}"
+        }, {
+          "content_type": "location"
         }]
       }
     },

test/fixtures/outgoing/quick_replies.json

@@ -19,5 +19,30 @@
       "recipient_id": "10157033896470555",
       "message_id": "mid.1456970487948:c34767dfe57ee6e339"
     }
+  },
+
+  {
+    "meta": {
+      "description": "Truncates extra characters from the provided string"
+    },
+    "arguments": {
+      "user": "10157033896470556",
+      "type": "TEXT",
+      "data": "In 1988, Joseph D. Becker published the first Unicode draft proposal. At the basis of his design was the naive assumption that 16 bits per character would suffice. In 1991, the first version of the Unicode standard was published, with code points limited to 16 bits. In the following years many systems have added support for Unicode and switched to the UCS-2 encoding. It was especially attractive for new technologies, such as the Qt framework (1992), Windows NT 3.1 (1993) and Java (1995)."
+    },
+
+    "expected": {
+      "recipient": {
+        "id": "10157033896470556"
+      },
+      "message": {
+        "text": "In 1988, Joseph D. Becker published the first Unicode draft proposal. At the basis of his design was the naive assumption that 16 bits per character would suffice. In 1991, the first version of the Unicode standard was published, with code points limited to 16 bits. In the following years many systems have added suppor"
+      }
+    },
+
+    "response": {
+      "recipient_id": "10157033896470556",
+      "message_id": "mid.1456970487948:c44767dfe57ee6e339"
+    }
   }
 ]