node-red-contrib-line-messaging-api 0.1.4 → 0.1.9

package/README.md

@@ -6,10 +6,11 @@ LINE Messagin APIを利用できるNode-REDのノードです。
 
 以下のAPIを利用できます。
 
-* LINE Messaging API
-    * Reply Message
-    * Push Message
-* LINE Notify
+- LINE Messaging API
+    - Webhook & Reply Message
+    - Push Message
+    - BloadCast Message
+- LINE Notify
 
 ## インストール
 
@@ -23,13 +24,13 @@ AdminタブからInstall
 
 ## 利用イメージ
 
-### Reply Message
+### Webhook & Reply Message
 
-* HTTP inノードで受け取る
-* Functionノードでハンドリング
-* Reply Messageノードでリプライ
-
-![](https://i.gyazo.com/d3df3a28e010b008043ed80ae6a672ea.gif)
+1. Webhookノードを配置し、ダブルクリックで設定を開き、指定した `/path` と自身のホスト名の組み合わせ（Webhook URL）を、LINE Developersであらかじめ作成したMessaging APIに登録します。
+2. ReplyMessageノードを配置し、チャネルのシークレットとアクセストークンを設定します。
+3. WebhookノードとReplyMessageノードを接続してLINEにメッセージを送るとオウム返しBotができます。  
+  [![Image from Gyazo](https://i.gyazo.com/7da2dbecfc69515edf852cf7a26d9196.gif)](https://gyazo.com/7da2dbecfc69515edf852cf7a26d9196)
+4. WebhookノードとReplyMessageノードの中間で `msg.payload` をうまく作成すると様々なメッセージが送れます。文字列を指定すると通常のテキストメッセージに、[LINEで定義されているメッセージオブジェクト](https://developers.line.biz/ja/reference/messaging-api/#message-objects)を指定すればそのメッセージを返信することができます。
 
 ### Push Message
 
@@ -53,6 +54,7 @@ AdminタブからInstall
 
 ## release
 
-* 2020/12/17: Bloadcast Messageに対応、Reply MessageがFlex Messageに対応（thanks [@gaomar](https://github.com/gaomar)）
-* 2019/2/13: PUSH MessageとLINE Notify対応
-* 2018/10/11: 現状は簡単なリプライのみ実装されています。
+- 2021/8/1: Reply Messageが画像に対応（thanks [@ukkz](https://github.com/ukkz)）
+- 2020/12/17: Bloadcast Messageに対応、Reply MessageがFlex Messageに対応（thanks [@gaomar](https://github.com/gaomar)）
+- 2019/2/13: PUSH MessageとLINE Notify対応
+- 2018/10/11: 現状は簡単なリプライのみ実装されています。

package/nodes/bloadcast/bloadcast.html

@@ -4,20 +4,26 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
-            channelSecret:{value:"", required:true},
-            channelAccessToken:{value:"", required:true}
         },
-        inputs:1,
-        outputs:1,
+
+        credentials: {
+            channelSecret:{value:"", type: "password", required:true},
+            channelAccessToken:{value:"", type: "password", required:true}
+        },
+
+        inputs: 1,
+        outputs: 1,
         icon: "comment.png",
         align: "right",
-        label: function() {
-            return this.name||"BloadcastMessage";
+        paletteLabel: 'Bloadcast',
+        label: function () {
+            return this.name || 'BloadcastMessage';
         }
     });
 </script>
 
 <script type="text/x-red" data-template-name="BloadcastMessage">
+    
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">

package/nodes/bloadcast/bloadcast.js

@@ -11,7 +11,7 @@ module.exports = (RED) => {
         try {
             lineconfig = require('../../env');
         } catch (error) {
-            lineconfig = { channelSecret: config.channelSecret, channelAccessToken: config.channelAccessToken};
+            lineconfig = { channelSecret: node.credentials.channelSecret, channelAccessToken: node.credentials.channelAccessToken};
         }
 
         if(lineconfig.channelSecret === '' || lineconfig.channelAccessToken === '') {
@@ -42,5 +42,10 @@ module.exports = (RED) => {
         });
     }
 
-    RED.nodes.registerType("BloadcastMessage", main);
+    RED.nodes.registerType("BloadcastMessage", main, {
+        credentials: {
+            channelSecret: {type:"password"},
+            channelAccessToken: {type:"password"},
+        },
+    });
 }

package/nodes/limit/limit.html

@@ -0,0 +1,38 @@
+<script>
+    RED.nodes.registerType('Limit',{
+        category: 'LINE',
+        color: '#01B301',
+        defaults: {
+            name: {value:""},
+        },
+        credentials: {
+            AccessToken: { type: "password", required: true }
+        },
+        inputs:1,
+        outputs:1,
+        icon: "comment.png",
+        align: "right",
+        label: function() {
+            return this.name||"Limit";
+        }
+    });
+</script>
+
+<script type="text/x-red" data-template-name="Limit">
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-AccessToken">
+            <i class="icon-tag"></i>
+            LINE Limit AccessToken
+        </label>
+        <input type="password" id="node-input-AccessToken" placeholder="LINE Limit AccessToken">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="Limit">
+    <p>当月の送信メッセージのリミットを教えてくれます。</p>
+</script>

package/nodes/limit/limit.js

@@ -0,0 +1,45 @@
+module.exports = (RED) => {
+    'use strict';
+    
+    const axiosBase = require('axios');
+
+    const main = function(config){
+        const node = this;
+        RED.nodes.createNode(node, config);
+        const LINE_TOKEN = node.credentials.AccessToken;
+        const axios = axiosBase.create({
+            baseURL: `https://api.line.me/v2/bot/message/quota`,
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+                'Authorization': `Bearer ${LINE_TOKEN}`
+            }
+        });
+
+        node.on('input', async (msg) => {
+            const mes = msg.payload;
+            try {
+                const resLimit = await axios.get(`/`);
+                const resCurrent = await axios.get(`/consumption`);
+
+                const output = {
+                    type: resLimit.data.type,
+                    limit: resLimit.data.value,
+                    totalUsage: resCurrent.data.totalUsage,
+                    usagePercentage: resCurrent.data.totalUsage / resLimit.data.value
+                }
+
+                msg.payload = output;
+                node.send(msg);
+            } catch (error) {
+                console.log(error);
+            }
+
+        });
+    }
+
+    RED.nodes.registerType("Limit", main, {
+        credentials: {
+            AccessToken: {type:"password"}
+        }
+    });
+}

package/nodes/notify/notify.html

@@ -4,7 +4,9 @@
         color: '#1ad823',
         defaults: {
             name: {value:""},
-            AccessToken:{value:"", required:true}
+        },
+        credentials: {
+            AccessToken: { type: "password", required: true }
         },
         inputs:1,
         outputs:0,

package/nodes/notify/notify.js

@@ -6,7 +6,7 @@ module.exports = (RED) => {
     const main = function(config){
         const node = this;
         RED.nodes.createNode(node, config);
-        const LINE_TOKEN = config.AccessToken;
+        const LINE_TOKEN = node.credentials.AccessToken;
         const axios = axiosBase.create({
             baseURL: `https://notify-api.line.me`,
             headers: {
@@ -28,5 +28,9 @@ module.exports = (RED) => {
         });
     }
 
-    RED.nodes.registerType("Notify", main);
+    RED.nodes.registerType("Notify", main, {
+        credentials: {
+            AccessToken: {type:"password"}
+        }
+    });
 }

package/nodes/push/push.html

@@ -4,16 +4,19 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
-            channelSecret:{value:"", required:true},
-            channelAccessToken:{value:"", required:true},
-            targetId:{value:"", required:true},
         },
-        inputs:1,
-        outputs:0,
+        credentials: {
+            channelSecret: {type:"password", required:true},
+            channelAccessToken: {type:"password", required:true},
+            targetId:{type:"password", required:true},
+        },
+        inputs: 1,
+        outputs: 0,
         icon: "comment.png",
         align: "right",
+        paletteLabel: 'Push',
         label: function() {
-            return this.name||"PushMessage";
+            return this.name || 'PushMessage';
         }
     });
 </script>

package/nodes/push/push.js

@@ -10,7 +10,7 @@ module.exports = (RED) => {
         try {
             lineconfig = require('../../env');
         } catch (error) {
-            lineconfig = { channelSecret: config.channelSecret, channelAccessToken: config.channelAccessToken};
+            lineconfig = { channelSecret: node.credentials.channelSecret, channelAccessToken: node.credentials.channelAccessToken};
         }
 
         if(lineconfig.channelSecret === '' || lineconfig.channelAccessToken === '') {
@@ -20,7 +20,7 @@ module.exports = (RED) => {
         const client = new line.Client(lineconfig);
 
         node.on('input', async (msg) => {
-            const userId = config.targetId;
+            const userId = node.credentials.targetId;
             try {
                 const res = await client.pushMessage(userId, {
                     type: 'text',
@@ -36,5 +36,11 @@ module.exports = (RED) => {
         });
     }
 
-    RED.nodes.registerType("PushMessage", main);
+    RED.nodes.registerType("PushMessage", main, {
+        credentials: {
+            channelSecret: {type:"password"},
+            channelAccessToken: {type:"password"},
+            targetId: {type:"password"},
+        },
+    });
 }

package/nodes/reply/reply.html

@@ -4,16 +4,19 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
-            channelSecret:{value:"", required:true},
-            channelAccessToken:{value:"", required:true},
             replyMessage:{value:""}
         },
+        credentials: {
+            channelSecret: {type:"password", required:true},
+            channelAccessToken: {type:"password", required:true},
+        },
         inputs:1,
         outputs:0,
         icon: "comment.png",
         align: "right",
-        label: function() {
-            return this.name||"ReplyMessage";
+        paletteLabel: 'Reply',
+        label: function () {
+            return this.name || 'ReplyMessage';
         }
     });
 </script>
@@ -36,7 +39,7 @@
 
     <div class="form-row">
         <label for="node-input-replyMessage"><i class="icon-tag"></i> ReplyMessage</label>
-        <input type="text" id="node-input-replyMessage" placeholder="空の場合はおうむ返しします">
+        <input type="text" id="node-input-replyMessage" placeholder="static text message here">
     </div>
 </script>
 

package/nodes/reply/reply.js

@@ -11,18 +11,18 @@ module.exports = (RED) => {
             lineconfig = require('../../env');
         } catch (error) {
             lineconfig = {
-                channelSecret: config.channelSecret,
-                channelAccessToken: config.channelAccessToken
+                channelSecret: node.credentials.channelSecret,
+                channelAccessToken: node.credentials.channelAccessToken
             };
         }
 
-        if(lineconfig.channelSecret === '' || lineconfig.channelAccessToken === '') {
-            this.error(RED._("token not found"));
+        if (lineconfig.channelSecret === '' || lineconfig.channelAccessToken === '') {
+            this.error(RED._('token not found'));
         }
 
         const client = new line.Client(lineconfig);
 
-        //メインの処理
+        // 旧仕様
         const handleEvent = (event) => {
             if (event.type !== 'message') {
                 return Promise.resolve(null);
@@ -31,37 +31,80 @@ module.exports = (RED) => {
             if (event.message.type === 'text') {
                 return client.replyMessage(event.replyToken, {
                     type: 'text',
-                    text: config.replyMessage || event.message.text //実際に返信の言葉を入れる箇所
-                  });
+                    text: config.replyMessage || event.message.text // 実際に返信の言葉を入れる箇所
+                });
             } else if (event.message.type === 'flex') {
                 const message_text = event.message.altText;
 
                 return client.replyMessage(event.replyToken, {
-                    type: "flex",
+                    type: 'flex',
                     altText: message_text,
                     contents: event.message.text
                 });
+            } else if (event.message.type === 'image') {
+                return client.replyMessage(event.replyToken, {
+                    type: 'image',
+                    originalContentUrl: event.message.originalContentUrl,
+                    previewImageUrl: event.message.previewImageUrl || event.message.originalContentUrl
+                });
             } else {
                 return Promise.resolve(null);
             }
         }
 
-        node.on('input', (msg) => {
-            Promise
-                .all(msg.payload.events.map(handleEvent))
-                .then(result => {
-                    // [{}]が返ってきてる
-                    if (result.length === 1 && 0 === Object.keys(result[0]).length) {
-                        result = {status: 200, message: 'Success'}
-                    }
-                    msg.payload = result;
-                    node.send(msg)
-                }).catch(err => {
-                    console.log(err);
-                    node.error(err);
+        // 新仕様
+        const reply = (msg) => {
+            if (!msg.line || !msg.line.event || !msg.line.event.type) {
+                throw 'no valid LINE event found within msg';
+            } else if (!msg.line.event.replyToken) {
+                throw 'no replyable LINE event received';
+            } else if (!msg.payload) {
+                throw 'reply content (msg.payload) is empty';
+            } else if (typeof msg.payload === 'object' && msg.payload.type) {
+                // payloadがオブジェクトの場合はメッセージオブジェクト扱いで送信される
+                return client.replyMessage(msg.line.event.replyToken, msg.payload);
+            } else {
+                // payloadがそれ以外なら強制的に文字列に変換しテキストメッセージ扱いで送信する
+                return client.replyMessage(msg.line.event.replyToken, {
+                    type: 'text',
+                    text: config.replyMessage || String(msg.payload)
                 });
+            }
+        }
+
+        node.on('input', async (msg) => {
+            if (msg.line && msg.line.event) {
+                // 新仕様
+                try {
+                    const result = await reply(msg);
+                    console.info(result);
+                } catch (err) {
+                    console.warn(err);
+                    node.error(err);
+                }
+            } else if (msg.payload.events) {
+                // 旧仕様
+                Promise
+                    .all(msg.payload.events.map(handleEvent))
+                    .then(result => {
+                        // [{}]が返ってきてる
+                        if (result.length === 1 && 0 === Object.keys(result[0]).length) {
+                            result = { status: 200, message: 'Success' }
+                        }
+                        msg.payload = result;
+                        node.send(msg)
+                    }).catch(err => {
+                        console.log(err);
+                        node.error(err);
+                    });
+            }
         });
     }
 
-    RED.nodes.registerType("ReplyMessage", main);
+    RED.nodes.registerType('ReplyMessage', main, {
+        credentials: {
+            channelSecret: { type:'password' },
+            channelAccessToken: { type:'password' },
+        }
+    });
 }

package/nodes/webhook/webhook.html

@@ -0,0 +1,59 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Webhook', {
+        category: 'LINE',
+        color: '#01B301',
+        defaults: {
+            name: { value: '' },
+            url: { value: '', required: true }
+        },
+        inputs: 0,
+        outputs: 1,
+        icon: 'inject.svg',
+        paletteLabel: 'Webhook',
+        label: function () {
+            if (this.name) {
+                return this.name;
+            } else if (this.url) {
+                let root = RED.settings.httpNodeRoot;
+                if (root.slice(-1) != '/') {
+                    root = root + '/';
+                }
+                if (this.url.charAt(0) == '/') {
+                    root += this.url.slice(1);
+                } else {
+                    root += this.url;
+                }
+                return root;
+            } else {
+                return 'Webhook';
+            }
+        },
+        oneditprepare: function () {
+            let root = RED.settings.httpNodeRoot;
+            if (root.slice(-1) == '/') {
+                root = root.slice(0, -1);
+            }
+            if (root == '') {
+                $('#node-input-tip').hide();
+            } else {
+                $('#node-input-path').html(root);
+                $('#node-input-tip').show();
+            }
+        }
+    });
+</script>
+
+<script type="text/x-red" data-template-name="Webhook">
+    <div class="form-row">
+        <label for="node-input-url"><i class="fa fa-globe"></i> Path</label>
+        <input id="node-input-url" type="text" placeholder="/webhook">
+    </div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input id="node-input-name" type="text" placeholder="Name">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="Webhook">
+    <p>A webhook endpoint node that receives from LINE platform when fire any events occurred.</p>
+</script>

package/nodes/webhook/webhook.js

@@ -0,0 +1,191 @@
+/**
+ * 公式ノード http in ベース
+ * @see https://raw.githubusercontent.com/node-red/node-red/master/packages/node_modules/@node-red/nodes/core/network/21-httpin.js
+ */
+
+module.exports = function (RED) {
+    'use strict';
+
+    const bodyParser = require('body-parser');
+    const cors = require('cors');
+
+    function createResponseWrapper(node, res) {
+        const wrapper = {
+            _res: res
+        };
+        const toWrap = [
+            'append',
+            'attachment',
+            'cookie',
+            'clearCookie',
+            'download',
+            'end',
+            'format',
+            'get',
+            'json',
+            'jsonp',
+            'links',
+            'location',
+            'redirect',
+            'render',
+            'send',
+            'sendfile',
+            'sendFile',
+            'sendStatus',
+            'set',
+            'status',
+            'type',
+            'vary'
+        ];
+        toWrap.forEach(function (f) {
+            wrapper[f] = function () {
+                node.warn(RED._('webhook.errors.deprecated-call', { method: 'msg.res.' + f }));
+                const result = res[f].apply(res, arguments);
+                if (result === res) {
+                    return wrapper;
+                } else {
+                    return result;
+                }
+            }
+        });
+        return wrapper;
+    }
+
+    let corsHandler = function (req, res, next) { next(); }
+
+    if (RED.settings.httpNodeCors) {
+        corsHandler = cors(RED.settings.httpNodeCors);
+        RED.httpNode.options('*', corsHandler);
+    }
+
+    // LINEイベント種別から適切な文字列を返す
+    function eventToString(event) {
+        if (event.type === 'message') {
+            // メッセージ系イベント
+            switch (event.message.type) {
+                case 'text':
+                    return event.message.text;
+                case 'image':
+                case 'video':
+                case 'audio':
+                case 'file':
+                    // 実装予定
+                    return '(media)';
+                case 'location':
+                    return event.message.address;
+                case 'sticker':
+                    return '(sticker)';
+                default:
+                    return '(unknown message event)';
+            }
+        } else {
+            // メッセージじゃない
+            switch (event.type) {
+                case 'unsend':
+                    return '(unsend)';
+                case 'follow':
+                    return '(follow)';
+                case 'unfollow':
+                    return '(unfollow)';
+                case 'join':
+                    return '(join)';
+                case 'leave':
+                    return '(leave)';
+                case 'memberJoined':
+                    return '(memberJoined)';
+                case 'memberLeft':
+                    return '(memberLeft)';
+                case 'postback':
+                    if (event.postback.params.datetime) return event.postback.params.datetime;
+                    else if (event.postback.params.newRichMenuAliasId) return event.postback.params.newRichMenuAliasId;
+                    else '(postback)';
+                case 'videoPlayComplete':
+                    return 'videoPlayComplete';
+                case 'beacon':
+                    return (event.beacon.dm) ? event.beacon.dm : event.beacon.hwid;
+                case 'accountLink':
+                    return '(accountLink)';
+                case 'things': // typeによって連携・連携解除・シナリオ実行の3種がある
+                    return event.things.deviceId;
+                default:
+                    return '(unknown event)';
+            }
+        }
+    }
+
+    function Webhook(config) {
+        RED.nodes.createNode(this, config);
+        if (RED.settings.httpNodeRoot !== false) {
+
+            if (!config.url) {
+                this.warn(RED._('webhook.errors.missing-path'));
+                return;
+            }
+            this.url = config.url;
+            if (this.url[0] !== '/') {
+                this.url = '/' + this.url;
+            }
+
+            const node = this;
+
+            // エラー時
+            this.errorHandler = function (err, req, res, next) {
+                node.warn(err);
+                res.sendStatus(500);
+            };
+
+            // 受信してmsgを送り出すところ
+            this.callback = function (req, res) {
+                const msgid = RED.util.generateId();
+                res._msgid = msgid;
+                // Webhook共通
+                if (req.body.destination && req.body.events) {
+                    // イベントと同数のmsgを送信
+                    req.body.events.forEach(event => {
+                        node.send({
+                            _msgid: msgid,
+                            req: req,
+                            res: createResponseWrapper(node, res),
+                            line: {
+                                destination: req.body.destination,
+                                event: event, // 個別のイベント
+                                events: req.body.events, // 生イベント配列
+                            },
+                            payload: eventToString(event)
+                        });
+                    });
+                }
+                // 空データをLINEプラットフォームへ返す (200 OK)
+                const wrapper = createResponseWrapper(node, res);
+                wrapper._res.set('content-length', 0);
+                wrapper._res.status(200).send('');
+            };
+
+            const httpMiddleware = function (req, res, next) { next(); }
+
+            if (RED.settings.httpNodeMiddleware) {
+                if (typeof RED.settings.httpNodeMiddleware === 'function' || Array.isArray(RED.settings.httpNodeMiddleware)) {
+                    httpMiddleware = RED.settings.httpNodeMiddleware;
+                }
+            }
+
+            const maxApiRequestSize = RED.settings.apiMaxLength || '5mb';
+            const jsonParser = bodyParser.json({ limit: maxApiRequestSize });
+
+            // 必ずPOSTで受ける
+            RED.httpNode.post(this.url, httpMiddleware, corsHandler, jsonParser, this.callback, this.errorHandler);
+
+            this.on('close', function () {
+                const node = this;
+                RED.httpNode._router.stack.forEach(function (route, i, routes) {
+                    if (route.route && route.route.path === node.url && route.route.methods['post']) {
+                        routes.splice(i, 1);
+                    }
+                });
+            });
+        } else {
+            this.warn(RED._('webhook.errors.not-created'));
+        }
+    }
+    RED.nodes.registerType('Webhook', Webhook);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-line-messaging-api",
-  "version": "0.1.4",
+  "version": "0.1.9",
   "description": "LINE Messaging APIです",
   "main": "line.js",
   "repository": {
@@ -13,9 +13,11 @@
   },
   "node-red": {
     "nodes": {
+      "Webhook": "./nodes/webhook/webhook.js",
       "ReplyMessage": "./nodes/reply/reply.js",
       "PushMessage": "./nodes/push/push.js",
       "BloadcastMessage": "./nodes/bloadcast/bloadcast.js",
+      "Limit": "./nodes/limit/limit.js",
       "Notify": "./nodes/notify/notify.js"
     }
   },
@@ -27,6 +29,8 @@
   "license": "Apache 2.0",
   "dependencies": {
     "@line/bot-sdk": "^7.2.0",
+    "body-parser": "^1.19.1",
+    "cors": "^2.8.5",
     "express": "^4.17.1"
   }
 }