Merge pull request miki2826#2 from Askrround/support_notification_type

support for notification type
maher-samir · May 13, 2016 · 7d4b038 · 7d4b038
2 parents 59d217f + e8b5ae9
commit 7d4b038
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@ botly
 [![Dependency Status](https://david-dm.org/Askrround/botly.svg?theme=shields.io)](https://david-dm.org/Askrround/botly)
 [![devDependency Status](https://david-dm.org/Askrround/botly/dev-status.svg?theme=shields.io)](https://david-dm.org/Askrround/botly#info=devDependencies)
 [![npm downloads](https://img.shields.io/npm/dm/botly.svg)](https://img.shields.io/npm/dm/botly.svg)
+[![license](https://img.shields.io/npm/l/botly.svg)](LICENSE)
 [![NPM](https://nodei.co/npm/botly.png)](https://nodei.co/npm/botly/)
 
 > Simple Facebook Messenger Platform Bot API
@@ -60,7 +61,7 @@ You can also clone the repository and run a complete bot example from the `examp
 
 ### API
 
-#### send (recipientId, message[, callback])
+#### send (recipientId, message[, notificationType][, callback])
 ```javascript
 botly.send(userId, {
     text: "Hi There!"
@@ -69,14 +70,14 @@ botly.send(userId, {
 });
 ```
 
-#### sendText (recipientId, text[, callback])
+#### sendText (recipientId, text[, notificationType][, callback])
 ```javascript
 botly.sendText(userId, "Hi There!", function (err, data) {
         //log it
 });
 ```
 
-#### sendAttachment (recipientId, type, payload[, callback])
+#### sendAttachment (recipientId, type, payload[, notificationType][, callback])
 ```javascript
 botly.sendAttachment(userId, Botly.CONST.ATTACHMENT_TYPE.IMAGE,
     {
@@ -86,14 +87,14 @@ botly.sendAttachment(userId, Botly.CONST.ATTACHMENT_TYPE.IMAGE,
 });
 ```
 
-#### sendImage (recipientId, imageURL[, callback])
+#### sendImage (recipientId, imageURL[, notificationType][, callback])
 ```javascript
 botly.sendImage(userId, "http://example.com/image.png", function (err, data) {
         //log it
 });
 ```
 
-#### sendButtons (recipientId, text, buttons[, callback])
+#### sendButtons (recipientId, text, buttons[, notificationType][, callback])
 ```javascript
 let buttons = [];
 buttons.push(botly.createWebURLButton("Go to Askrround", "http://askrround.com"));
@@ -104,7 +105,7 @@ botly.sendButtons(userId, "What do you want to do next?", buttons
 });
 ```
 
-#### sendGeneric (recipientId, elements[, callback])
+#### sendGeneric (recipientId, elements[, notificationType][, callback])
 ```javascript
 let buttons = [];
 buttons.push(botly.createWebURLButton("Go to Askrround", "http://askrround.com"));
@@ -118,7 +119,7 @@ botly.sendGeneric(sender, element, function (err, data) {
 });
 ```
 
-#### sendReceipt (recipientId, payload[, callback])
+#### sendReceipt (recipientId, payload[, notificationType][, callback])
 ```javascript
 let payload = {
     "recipient_name": "Stephane Crozatier",

diff --git a/lib/Botly.js b/lib/Botly.js
@@ -116,7 +116,12 @@ Botly.prototype.setWelcomeScreen = function (pageId, message, callback) {
         });
 };
 
-Botly.prototype.send = function (recipientId, message, callback) {
+Botly.prototype.send = function (recipientId, message, notificationType, callback) {
+    notificationType = notificationType || this.notificationType;
+    if (typeof notificationType === "function") {
+        callback = notificationType;
+        notificationType = this.notificationType;
+    }
     request.post(
         {
             url: FB_MESSENGER_URL,
@@ -127,7 +132,7 @@ Botly.prototype.send = function (recipientId, message, callback) {
             body: {
                 recipient: {id: recipientId},
                 message: message,
-                notification_type: this.notificationType
+                notification_type: notificationType
             }
 
         }, (err, res, body) => {
@@ -137,40 +142,40 @@ Botly.prototype.send = function (recipientId, message, callback) {
         });
 };
 
-Botly.prototype.sendAttachment = function (recipientId, type, payload, callback) {
+Botly.prototype.sendAttachment = function (recipientId, type, payload, notificationType, callback) {
     this.send(recipientId, {
         attachment: {
             type: type,
             payload: payload
         }
-    }, callback);
+    }, notificationType, callback);
 };
 
-Botly.prototype.sendImage = function (recipientId, imageURL, callback) {
+Botly.prototype.sendImage = function (recipientId, imageURL, notificationType, callback) {
     this.sendAttachment(recipientId, ATTACHMENT_TYPE.IMAGE, {
         url: imageURL
-    }, callback);
+    }, notificationType, callback);
 };
 
-Botly.prototype.sendText = function (recipientId, text, callback) {
+Botly.prototype.sendText = function (recipientId, text, notificationType, callback) {
     this.send(recipientId, {
         text: text
-    }, callback);
+    }, notificationType, callback);
 };
 
-Botly.prototype.sendButtons = function (recipientId, text, buttons, callback) {
+Botly.prototype.sendButtons = function (recipientId, text, buttons, notificationType, callback) {
     this.sendAttachment(recipientId, ATTACHMENT_TYPE.TEMPLATE,
-        this.createButtonTemplate(text, buttons), callback);
+        this.createButtonTemplate(text, buttons), notificationType, callback);
 };
 
-Botly.prototype.sendGeneric = function (recipientId, elements, callback) {
+Botly.prototype.sendGeneric = function (recipientId, elements, notificationType, callback) {
     this.sendAttachment(recipientId, ATTACHMENT_TYPE.TEMPLATE,
-        this.createGenericTemplate(elements), callback);
+        this.createGenericTemplate(elements), notificationType, callback);
 };
 
-Botly.prototype.sendReceipt = function (recipientId, payload, callback) {
+Botly.prototype.sendReceipt = function (recipientId, payload, notificationType, callback) {
     payload.template_type = TEMPLATE_TYPE.RECEIPT;
-    this.sendAttachment(recipientId, ATTACHMENT_TYPE.TEMPLATE, payload, callback);
+    this.sendAttachment(recipientId, ATTACHMENT_TYPE.TEMPLATE, payload, notificationType, callback);
 };
 
 Botly.prototype.createWebURLButton = function (title, url) {

diff --git a/test/botly_test.js b/test/botly_test.js
@@ -155,6 +155,35 @@ describe("Botly Tests", function () {
 
     });
 
+    it("should emit error when there is one", done => {
+
+        var botly = new Botly({
+            accessToken: "myToken",
+            verifyToken: "myVerifyToken",
+            webHookPath: "/webhook",
+            notificationType: Botly.CONST.NOTIFICATION_TYPE.NO_PUSH
+        });
+        var router = botly.router();
+
+        botly.on("error", (err) => {
+            expect(err).to.be.defined;
+            done();
+        });
+
+        var response = http.createResponse();
+        var request = http.createRequest({
+            method: "POST",
+            url: "/webhook",
+            body: {
+                "object": "page",
+                "entry": "blabla"
+            }
+        });
+
+        router.handle(request, response);
+
+    });
+
     it("should handle delivery messages", done => {
         var mids = [
             "mid.1458668856218:ed81099e15d3f4f233"
@@ -378,7 +407,8 @@ describe("Botly Tests", function () {
             notificationType: Botly.CONST.NOTIFICATION_TYPE.NO_PUSH
         });
 
-        botly.sendText(USER_ID, "hi", ()=>{});
+        botly.sendText(USER_ID, "hi", ()=> {
+        });
 
         expect(request.post.calledOnce).to.be.true;
         expect(request.post.args[0][0].body).to.eql({
@@ -429,10 +459,7 @@ describe("Botly Tests", function () {
             notificationType: Botly.CONST.NOTIFICATION_TYPE.NO_PUSH
         });
 
-        var buttons = [];
-        buttons.push(botly.createWebURLButton("Go to Askrround", "http://askrround.com"));
-        buttons.push(botly.createPostbackButton("Continue", "continue"));
-        botly.sendButtons(USER_ID, "What do you want to do next?", buttons, function (err, data) {
+        botly.sendButtons(USER_ID, "What do you want to do next?", botly.createPostbackButton("Continue", "continue"), function (err, data) {
         });
 
         expect(request.post.calledOnce).to.be.true;
@@ -442,11 +469,6 @@ describe("Botly Tests", function () {
                     "payload": {
 
                         "buttons": [
-                            {
-                                "title": "Go to Askrround",
-                                "type": "web_url",
-                                "url": "http://askrround.com"
-                            },
                             {
                                 "payload": "continue",
                                 "title": "Continue",
@@ -475,13 +497,10 @@ describe("Botly Tests", function () {
             notificationType: Botly.CONST.NOTIFICATION_TYPE.NO_PUSH
         });
 
-        var buttons = [];
-        buttons.push(botly.createWebURLButton("Go to Askrround", "http://askrround.com"));
-        buttons.push(botly.createPostbackButton("Continue", "continue"));
         var element = botly.createElement("What do you want to do next?",
             "https://upload.wikimedia.org/wikipedia/en/9/93/Tanooki_Mario.jpg",
             "https://upload.wikimedia.org/wikipedia/en/9/93/Tanooki_Mario.jpg",
-            "Choose now!", buttons);
+            "Choose now!", botly.createWebURLButton("Go to Askrround", "http://askrround.com"));
         botly.sendGeneric(USER_ID, element);
 
         expect(request.post.calledOnce).to.be.true;
@@ -496,11 +515,6 @@ describe("Botly Tests", function () {
                                         "title": "Go to Askrround",
                                         "type": "web_url",
                                         "url": "http://askrround.com"
-                                    },
-                                    {
-                                        "payload": "continue",
-                                        "title": "Continue",
-                                        "type": "postback"
                                     }
                                 ],
                                 "image_url": "https://upload.wikimedia.org/wikipedia/en/9/93/Tanooki_Mario.jpg",
@@ -580,7 +594,7 @@ describe("Botly Tests", function () {
                 }
             ]
         };
-        botly.sendReceipt(USER_ID, payload);
+        botly.sendReceipt(USER_ID, payload, Botly.CONST.NOTIFICATION_TYPE.REGULAR);
 
         expect(request.post.calledOnce).to.be.true;
         expect(request.post.args[0][0].body).to.eql({
@@ -640,7 +654,7 @@ describe("Botly Tests", function () {
                     "type": "template"
                 }
             },
-            "notification_type": "NO_PUSH",
+            "notification_type": "REGULAR",
             "recipient": {
                 "id": "333"
             }
@@ -680,7 +694,8 @@ describe("Botly Tests", function () {
             notificationType: Botly.CONST.NOTIFICATION_TYPE.NO_PUSH
         });
 
-        botly.setWelcomeScreen(PAGE_ID, {text:"hi"}, ()=>{});
+        botly.setWelcomeScreen(PAGE_ID, {text: "hi"}, ()=> {
+        });
 
         expect(request.post.calledOnce).to.be.true;
         expect(request.post.args[0][0].body).to.eql({