Added basic (and unstable) support for the new Telegram gaming platform

ALCC01 · ALCC01 · commit 03efed1311f2 · 2016-10-03T18:53:39.000+02:00
diff --git a/index.js b/index.js
@@ -11,6 +11,8 @@ var Bot = module.exports.Bot = require('./lib/Bot.js'),
     Keyboard = module.exports.Keyboard = require('./lib/Keyboard.js'),
     ChatMember = module.exports.ChatMember = require('./lib/ChatMember.js'),
     UserProfilePhotos = module.exports.UserProfilePhotos = require ('./lib/UserProfilePhotos.js'),
+    Animation = module.exports.Animation = require('./lib/Animation.js'),
+    GameHighScore = module.exports.GameHighScore = require('./lib/GameHighScore.js'),
     InlineQueryResultArticle = module.exports.InlineQueryResultArticle = require('./lib/InlineQueryResultArticle.js'),
     InlineQueryResultLocation = module.exports.InlineQueryResultLocation = require('./lib/InlineQueryResultLocation.js'),
     InlineQueryResultPhoto = module.exports.InlineQueryResultPhoto = require('./lib/InlineQueryResultPhoto.js'),
@@ -21,4 +23,5 @@ var Bot = module.exports.Bot = require('./lib/Bot.js'),
     InlineQueryResultVoice = module.exports.InlineQueryResultVoice = require('./lib/InlineQueryResultVoice.js'),
     InlineQueryResultDocument = module.exports.InlineQueryResultDocument = require('./lib/InlineQueryResultDocument.js'),
     InlineQueryResultVenue = module.exports.InlineQueryResultVenue = require('./lib/InlineQueryResultVenue.js'),
-    InlineQueryResultContact = module.exports.InlineQueryResultContact = require('./lib/InlineQueryResultContact.js');
+    InlineQueryResultContact = module.exports.InlineQueryResultContact = require('./lib/InlineQueryResultContact.js'),
+    InlineQueryResultGame = module.exports.InlineQueryResultGame = require('./lib/InlineQueryResultGame.js');
diff --git a/lib/Animation.js b/lib/Animation.js
@@ -0,0 +1,17 @@
+'use strict';
+const extend = require('util')._extend;
+
+function Animation(object, bot) {
+    this.bot = bot;
+    extend(this, object);
+
+    if (this.photo) {
+        let sizes = [];
+        this.photo.forEach((size) => {
+            sizes.push(new PhotoSize(size, this.bot))
+        });
+        this.photo = sizes;
+    }
+}
+
+module.exports = Animation;
diff --git a/lib/Bot.js b/lib/Bot.js
@@ -10,6 +10,7 @@ const request = require('superagent-promise')(require('superagent'), Promise),
     CallbackQuery = require('./CallbackQuery.js'),
     ChatMember = require('./ChatMember.js'),
     UserProfilePhotos = require('./UserProfilePhotos.js'),
+    GameHighScore = require('./GameHighScore.js'),
     fs = require('fs'),
     events = require('events'),
     endpoint = 'https://api.telegram.org';
@@ -28,6 +29,7 @@ function Bot(token, options) {
     this.saveChats = true;
     this.enableHelp = true;
     this.forms = {}; // user_id: {form, answers}
+    this.debug = process.env.NODEOGRAM_DEBUG || false;
     this.webhookRoute = '/';
     this.webhookPort = 8080;
     this.autoFetch = true;
@@ -86,14 +88,15 @@ function Bot(token, options) {
     };
 
     this.handleUpdates = (updates) => {
-        console.log(JSON.stringify(updates));
+        if (this.debug) console.log(JSON.stringify(updates));
         if (updates.length > 0) {
             this.lastUpdate = updates[updates.length - 1].update_id + 1;
             var now = Date.now() / 1000;
             updates.forEach((result) => {
                 if (result.message) {
+                    if (this.debug) console.log(`New message #${result.message.message_id}`);
                     if (result.message.date < now - 2000) {
-                        console.log(`Skipping backlog update ${result.update_id}`);
+                        if (this.debug) console.log(`Skipping backlog update #${result.update_id}`);
                         return;
                     }
                     var message = new Message(result.message, this);
@@ -102,6 +105,8 @@ function Bot(token, options) {
                         if (handleNext) {
                             var res = handler(message);
                             handleNext = res === undefined ? true : res;
+                        } else {
+                            if (this.debug) console.log(`Not executing any other message handler for message #${message.message_id}`);
                         }
                     });
                 }
@@ -222,6 +227,17 @@ function Bot(token, options) {
         });
     };
 
+    this.sendGame = (chat_id, game_short_name, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
+        if (chat_id instanceof User) chat_id = chat_id.id;
+        options = options || {};
+        options.chat_id = chat_id;
+        options.game_short_name = game_short_name;
+        return this.call('sendGame', options).then((res) => {
+            return new Message(res.body.result, this);
+        });
+    }
+
 
     this.forwardMessage = (chat_id, from_chat_id, message_id, options) => {
         if (chat_id instanceof Chat) chat_id = chat_id.id;
@@ -235,8 +251,18 @@ function Bot(token, options) {
         });
     };
 
-    this.answerCallbackQuery = (id, text, alert) => {
-        return this.call('answerCallbackQuery', {callback_query_id: id, text: text, alert: alert}).then((res) => {
+    this.answerCallbackQuery = (id, options, alert) => {
+        // TODO Drop support for the old method signature
+        if (typeof options === 'string') {
+            options = {
+                text: options,
+                alert: alert
+            }
+        }
+        options = options || {};
+        options.callback_query_id = id;
+
+        return this.call('answerCallbackQuery', options).then((res) => {
             return res.body.result;
         });
     };
@@ -372,12 +398,71 @@ function Bot(token, options) {
         } else {
             options.chat_id = chat_id;
             options.message_id = id;
-            return this.call('editMessageReplyMarkupn', options).then((res) => {
+            return this.call('editMessageReplyMarkup', options).then((res) => {
                 return new Message(res.body.result)
             })
         }
     };
 
+    this.setGameScore = (id, user_id, score, inline, options, chat_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
+        if (chat_id instanceof User) chat_id = chat_id.id;
+        if (user_id instanceof Chat) user_id = user_id.id;
+        if (user_id instanceof User) user_id = user_id.id;
+
+        options = options || {};
+        options.user_id = user_id;
+        options.score = score;
+
+        if (inline) {
+            options.inline_message_id = id;
+            return this.call('setGameScore', options).then((res) => {
+                return res.body.result;
+            })
+        } else {
+            options.chat_id = chat_id;
+            options.message_id = id;
+            return this.call('setGameScore', options).then((res) => {
+                return new Message(res.body.result)
+            })
+        }
+    };
+
+    this.getGameHighScores = (id, user_id, inline, chat_id) => {
+        console.log(id);
+        console.log(user_id);
+        console.log(inline);
+        console.log(chat_id)
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
+        if (chat_id instanceof User) chat_id = chat_id.id;
+        if (user_id instanceof Chat) user_id = user_id.id;
+        if (user_id instanceof User) user_id = user_id.id;
+
+        options = {};
+        options.user_id = user_id;
+
+        if (inline) {
+            options.inline_message_id = id;
+            return this.call('getGameHighScores', options).then((res) => {
+                var scores = [];
+                res.body.result.forEach(score => {
+                    scores.push(new GameHighScore(score, this))
+                });
+                return scores;
+            })
+        } else {
+            options.chat_id = chat_id;
+            options.message_id = id;
+            return this.call('getGameHighScores', options).then((res) => {
+                var scores = [];
+                res.body.result.forEach(score => {
+                    scores.push(new GameHighScore(score, this))
+                });
+                return scores;
+            })
+        }
+    };
+
     this.getChatAdministrators = (chat_id) => {
         if (chat_id instanceof Chat) chat_id = chat_id.id;
         return this.call('getChatAdministrators', {chat_id: chat_id}).then((res) => {
@@ -445,6 +530,7 @@ function Bot(token, options) {
     };
 
     this.handleMessage = (message) => {
+        if (this.debug) console.log(`Executing message handler handleMessage for message #${message.message_id}`);
         if (message.new_chat_member) this.emitter.emit('new_chat_member', message.new_chat_member, message);
         if (message.left_chat_member) this.emitter.emit('left_chat_member', message.left_chat_member, message);
         if (message.new_chat_title) this.emitter.emit('new_chat_title', message.new_chat_title, message);
@@ -461,6 +547,7 @@ function Bot(token, options) {
     };
 
     this.handleProfiles = (message) => {
+        if (this.debug) console.log(`Executing message handler handleProfiles for message #${message.message_id}`);
         var edited = false;
         if (!profiles.users[message.from.id] && this.saveUsers) {
             profiles.users[message.from.id] = message.from;
@@ -478,6 +565,7 @@ function Bot(token, options) {
     };
 
     this.handleForms = (message) => {
+        if (this.debug) console.log(`Executing message handler handleForms for message #${message.message_id}`);
         var id = message.from.id;
         if (this.forms[id] && message.chat.type == 'private') {
             var next = false;
@@ -567,7 +655,6 @@ function Bot(token, options) {
                 }
                 if (!this.webhookFunction) {
                     this.express_app.post(this.webhookRoute, (req, res) => {
-                        console.log(req.body);
                         this.handleUpdates([req.body]);
                         res.send({})
                     })
diff --git a/lib/CallbackQuery.js b/lib/CallbackQuery.js
@@ -1,6 +1,7 @@
 'use strict';
 const User = require('./User.js'),
     Message = require('./Message.js'),
+    Chat = require('./Chat.js'),
     extend = require('util')._extend;
 
 function CallbackQuery(object, bot) {
@@ -11,8 +12,15 @@ function CallbackQuery(object, bot) {
     this.from = new User(this.from, bot);
     if (this.message) this.message = new Message(this.message, bot);
 
-    this.answer = (text, alert) => {
-        this.bot.answerCallbackQuery(this.id, text, alert)
+    this.answer = (options, alert) => {
+        // TODO Drop support for the old method signature
+        if (typeof options === 'string') {
+            options = {
+                text: options,
+                alert: alert
+            }
+        }
+        this.bot.answerCallbackQuery(this.id, options || options)
     }
 }
 
diff --git a/lib/Chat.js b/lib/Chat.js
@@ -34,6 +34,10 @@ function Chat(object, bot) {
         return this.bot.sendContact(this.id, phone_number, first_name, options)
     };
 
+    this.sendGame = (game_short_name, options) => {
+        return this.bot.sendGame(this.id, game_short_name, options)
+    }
+
     this.kickMember = (user_id) => {
         if (user_id instanceof User) user_id = user_id.id;
         return this.bot.kickChatMember(this.id, user_id)
diff --git a/lib/Game.js b/lib/Game.js
@@ -0,0 +1,74 @@
+'use strict';
+const User = require('./User.js'),
+    Chat = require('./Chat.js'),
+    PhotoSize = require('./PhotoSize.js'),
+    Animation = require('./Animation.js'),
+    extend = require('util')._extend;
+
+function Game(object, bot) {
+    if (object == undefined) return;
+    extend(this, object);
+
+    this.commands = [];
+    this.mentions = [];
+    this.text_mentions = [];
+    this.hashtags = [];
+    this.links = [];
+    this.command = undefined;
+    this.bot = bot;
+
+    if (this.text_entities) {
+        this.text_entities.forEach((entity) => {
+            var offset = entity.offset,
+                length = entity.length,
+                text = this.text.substr(offset, offset + length);
+            switch (entity.type) {
+                case 'bot_command':
+                    var command,
+                        rawCommand = command = text,
+                        args = this.text.substr(offset + length +1).split(" "),
+                        index = rawCommand.indexOf('@'),
+                        recipient;
+
+                    if (index !== -1) {
+                        recipient = rawCommand.substr(index);
+                        command = rawCommand.substr(0, index);
+                    }
+                    this.commands.push({command: command, recipient: recipient, args: args});
+                    if (offset === 0) {
+                        this.command = {command: command, recipient: recipient, args: args}
+                    }
+                    break;
+                case 'mention':
+                    this.mentions.push(text);
+                    break;
+                case 'hashtag':
+                    this.hashtags.push(text);
+                    break;
+                case 'url':
+                    this.links.push({type: 'url', url: text, text: text});
+                    break;
+                case 'text_link':
+                    this.links.push({type: 'link', url: entity.url, text: text});
+                    break;
+                case 'text_mention':
+                    this.text_mentions.push({text: text, user: new User(entity.user, this.bot)});
+                    break;
+            }
+        })
+    }
+
+    if (this.photo) {
+        let sizes = [];
+        this.photo.forEach((size) => {
+            sizes.push(new PhotoSize(size, this.bot))
+        });
+        this.photo = sizes;
+    }
+
+    if (this.animation) {
+        this.animation = new Animation(this.animation, this.bot);
+    }
+}
+
+module.exports = Game;
diff --git a/lib/GameHighScore.js b/lib/GameHighScore.js
@@ -0,0 +1,13 @@
+'use strict';
+const User = require('./User.js'),
+    extend = require('util')._extend;
+
+function GameHighScore(object, bot) {
+    extend(this, object);
+    this.bot = bot;
+
+    this.user = new User(this.user, bot);
+
+}
+
+module.exports = GameHighScore;
diff --git a/lib/InlineQueryResultGame.js b/lib/InlineQueryResultGame.js
@@ -0,0 +1,11 @@
+'use strict';
+const extend = require('util')._extend;
+
+function InlineQueryResultGame(id, game_short_name, options) {
+    extend(this, options);
+    this.type = 'article';
+    this.id = id;
+    this.game_short_name = game_short_name;
+}
+
+module.exports = InlineQueryResultGame;
diff --git a/lib/Message.js b/lib/Message.js
@@ -2,6 +2,7 @@
 const User = require('./User.js'),
     Chat = require('./Chat.js'),
     PhotoSize = require('./PhotoSize.js'),
+    Game = require('./Game'),
     extend = require('util')._extend;
 
 function Message(object, bot) {
@@ -81,6 +82,10 @@ function Message(object, bot) {
         this.new_chat_photo = sizes;
     }
 
+    if (this.game) {
+        this.game = new Game(this.game, this.bot);
+    }
+
     this.reply = (text, options) => {
         options = options || {};
         options.reply_to_message_id = this.message_id;
@@ -105,6 +110,14 @@ function Message(object, bot) {
     this.editReplyMarkup = (markup, inline, options) => {
         return bot.editMessageReplyMarkup(this.message_id, markup, inline, options, this.chat.id)
     };
+
+    this.setGameScore = (user_id, score, inline, options) => {
+        return bot.setGameScore(this.message_id, user_id, score, inline, options, this.chat.id)
+    }
+
+    this.getGameHighScores = (user_id, inline) => {
+        return bot.getGameHighScores(this.message_id, user_id, inline, this.chat.id)
+    }
 }
 
 module.exports = Message;
diff --git a/lib/User.js b/lib/User.js
