Code clean up, added README.md, consistency for chat_id arguments

Author: ALCC01

LICENSE

@@ -0,0 +1,46 @@
+# Nodeogram
+Nodeogram is a simple yet complete Node.JS module for Telegram bots.
+
+## Features
+* **Not a wrapper**. Nodeogram takes the Telegram API to the next level and allows you to create your bots while handling all the boring stuff for you
+* **Complete**. Nodeogram features all of the most recent API updates and it's designed to not block you from using right away the not yet implemented ones
+* **Promises**. The entire library is promise-based
+* **Event based**. Nodeogram provides an event-based handling of updates, allowing you to interact more easily with message, commands, callback and line queries.
+
+## Getting started
+
+First, you'll need to install the module
+
+```bash
+npm i --save nodeogram
+```
+
+Once the packages is installed, you can start working on you bot.
+
+```javascript
+const nodeogram = require('nodeogram'),
+bot = new nodeogram.Bot('your-token-goes-here');
+
+bot.init();
+bot.on('message', message => message.reply("Hello World!"));
+```
+
+And you are done.
+
+## License
+
+    Nodeogram - A Node.JS Telegram bots API library
+    Copyright (C) 2016 Alberto Coscia <[email protected]>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

README.md

@@ -25,7 +25,8 @@ function Bot(token) {
     this.emitter = new events.EventEmitter();
 
     this.handleAPIError = (err) => {
-        console.log(`An error occurred while querying the Telegram API - ${JSON.parse(err.response.text).error_code} ${JSON.parse(err.response.text).description}`)
+        if (err.response) { console.log(`An error occurred while querying the Telegram API - ${err.response.text ? JSON.parse(err.response.text).error_code : ""} ${err.response.text ? JSON.parse(err.response.text).description : ""}`)}
+        else console.log(err)
     };
 
     this.get = (path, query) => {
@@ -93,14 +94,15 @@ function Bot(token) {
                             });
                         }
                         if (result.inline_query) this.emitter.emit('inline_query', new InlineQuery(result.inline_query, this));
-                        if (result.callback_query) this.emitter.emit('callback_query', new CallbackQuery(result.callback_query, this))
-                        if (result.edited_message) this.emitter.emit('edited_message', new Message(result.edited_message, this))
+                        if (result.callback_query) this.emitter.emit('callback_query', new CallbackQuery(result.callback_query, this));
+                        if (result.edited_message) this.emitter.emit('edited_message', new Message(result.edited_message, this));
+                        if (result.chosen_inline_result) this.emitter.emit('chosen_inline_result', new ChosenInlineResult(result.chosen_inline_result, this))
                     });
                 }
                 this.getUpdates();
             })
             .catch((err) => {
-                console.log(err)
+                this.handleAPIError(err);
                 // Wait before retrying in order not to flood Telegram's servers
                 setTimeout(() => {
                     this.getUpdates();
@@ -113,19 +115,21 @@ function Bot(token) {
         this.commands.push({command: command, description: description, callback: callback});
     };
 
-    this.getChat = (id) => {
-        return this.call('getChat', {chat_id: id}).then((res) => {
+    this.getChat = (chat_id) => {
+        return this.call('getChat', {chat_id: chat_id}).then((res) => {
             return new Chat(res.body.result, this)
         })
     };
 
-    this.leaveChat = (id) => {
-        return this.call('leaveChat', {chat_id: id}).then((res) => {
+    this.leaveChat = (chat_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
+        return this.call('leaveChat', {chat_id: chat_id}).then((res) => {
             return res.body.result;
         })
     };
 
     this.sendMessage = (chat_id, text, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         options.text = text;
@@ -135,6 +139,7 @@ function Bot(token) {
     };
 
     this.sendLocation = (chat_id, longitude, latitude, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         options.longitude = longitude;
@@ -145,6 +150,7 @@ function Bot(token) {
     };
 
     this.sendVenue = (chat_id, longitude, latitude, title, address, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         options.longitude = longitude;
@@ -157,6 +163,7 @@ function Bot(token) {
     };
 
     this.sendContact = (chat_id, phone_number, first_name, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         options.phone_number = phone_number;
@@ -168,6 +175,7 @@ function Bot(token) {
 
 
     this.forwardMessage = (chat_id, from_chat_id, message_id, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         options.from_chat_id = from_chat_id;
@@ -181,9 +189,10 @@ function Bot(token) {
         return this.call('answerCallbackQuery', {callback_query_id: id, text: text, alert: alert});
     };
 
-    this.getUserProfilePhotos = (id, options) => {
+    this.getUserProfilePhotos = (user_id, options) => {
+        if (user_id instanceof User) user_id = user_id.id;
         options = options || {};
-        options.user_id = id;
+        options.user_id = user_id;
         return this.call('getUserProfilePhotos', options).then((res) => {
             return new UserProfilePhotos(res.body.result, this);
         });
@@ -196,6 +205,7 @@ function Bot(token) {
     };
 
     this.sendFile = (chat_id, type, path, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         options = options || {};
         options.chat_id = chat_id;
         var method;
@@ -310,6 +320,7 @@ function Bot(token) {
     };
 
     this.getChatAdministrators = (chat_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         return this.call('getChatAdministrators', {chat_id: chat_id}).then((res) => {
             var administrators = res.body.result;
             var processed = [];
@@ -321,32 +332,37 @@ function Bot(token) {
     };
 
     this.getChatMember = (chat_id, user_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         if (user_id instanceof User) user_id = user_id.id;
         return this.call('getChatMember', {chat_id: chat_id, user_id: user_id}).then((res) => {
             return new User(res.body.result, this);
         })
     };
 
     this.kickChatMember = (chat_id, user_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         if (user_id instanceof User) user_id = user_id.id;
         return this.call('kickChatMember', {chat_id: chat_id, user_id: user_id}).then((res) => {
             return res.body.result;
         })
     };
     this.unbanChatMember = (chat_id, user_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         if (user_id instanceof User) user_id = user_id.id;
         return this.call('unbanChatMember', {chat_id: chat_id, user_id: user_id}).then((res) => {
             return res.body.result;
         })
     };
 
     this.getChatMembersCount = (chat_id) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         return this.call('getChatMembersCount', {chat_id: chat_id}).then((res) => {
             return res.body.result;
         })
     };
 
     this.sendChatAction = (chat_id, action) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
         return this.call('sendChatAction', {chat_id: chat_id, action: action}).then((res) => {
             return res.body.result;
         })
@@ -364,11 +380,23 @@ function Bot(token) {
     };
 
     this.handleMessage = (message) => {
+        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);
+        if (message.new_chat_photo) this.emitter.emit('new_chat_photo', message.new_chat_photo, message);
+        if (message.delete_chat_photo) this.emitter.emit('delete_chat_photo	', message.delete_chat_photo, message);
+        if (message.group_chat_created) this.emitter.emit('group_chat_created', message.group_chat_created, message);
+        if (message.supergroup_chat_created) this.emitter.emit('supergroup_chat_created', message.supergroup_chat_created, message);
+        if (message.channel_chat_created) this.emitter.emit('channel_chat_created', message.channel_chat_created, message);
+        if (message.migrate_to_chat_id) this.emitter.emit('migrate_to_chat_id', message.migrate_to_chat_id, message);
+        if (message.migrate_from_chat_id) this.emitter.emit('migrate_from_chat_id', message.migrate_from_chat_id, message);
+        if (message.pinned_message) this.emitter.emit('pinned_message', message.pinned_message, message);
+
         this.emitter.emit('message', message);
     };
 
     this.init = () => {
-        if (!this.token) throw "Unvalid token!";
+        if (!this.token) throw "Invalid token!";
         this.messageHandlers = [
             this.handleCommands,
             this.handleMessage
@@ -384,8 +412,9 @@ function Bot(token) {
     };
 
     this.call('getMe', {}).then((res) => {
-        this.me = res.body.result;
-    });
+        if (res) this.me = res.body.result;
+        else throw "Unable to retrieve informations about the bot!"
+    }).catch(err => this.handleAPIError(err));
 
     // For more complex event handling use this.emitter
     this.on = (event, listener) => {

lib/Bot.js

@@ -1,6 +1,5 @@
 'use strict';
 const User = require('./User.js'),
-    Chat = require('./Chat.js'),
     Message = require('./Message.js'),
     extend = require('util')._extend;
 

lib/CallbackQuery.js

@@ -8,3 +8,5 @@ function ChosenInlineResult(object, bot) {
     this.bot = bot;
     this.user = new User(this.user, this.bot);
 }
+
+module.exports = ChosenInlineResult;

lib/ChosenInlineResult.js

@@ -11,6 +11,7 @@ function Message(object, bot) {
     this.from = new User(this.from, bot);
     this.chat = new Chat(this.chat, bot);
     this.forward_from = new User(this.forward_from, bot);
+    this.forward_from_chat = new Chat(this.forward_from_chat, bot);
     this.reply_to_this = module.exports(this.reply_to_this);
     this.new_chat_member = new User(this.new_chat_member, bot);
     this.left_chat_member = new User(this.left_chat_member, bot);
@@ -54,35 +55,39 @@ function Message(object, bot) {
                     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)})
+                    this.text_mentions.push({text: text, user: new User(entity.user, this.bot)});
                     break;
             }
         })
     }
 
     if (this.photo) {
-        var sizes = [];
+        let sizes = [];
         this.photo.forEach((size) => {
             sizes.push(new PhotoSize(size, this.bot))
         });
         this.photo = sizes;
     }
 
+    if (this.new_chat_photo) {
+        let sizes = [];
+        this.new_chat_photo.forEach((size) => {
+            sizes.push(new PhotoSize(size, this.bot))
+        });
+        this.new_chat_photo = sizes;
+    }
+
     this.reply = (text, options) => {
         options = options || {};
         options.reply_to_message_id = this.message_id;
         return this.chat.sendMessage(text, options)
     };
 
-    this.forward = (chat, options) => {
-        // A chat id was passed
-        if (typeof chat == "number" || typeof chat == "string") {
-            return this.bot.forwardMessage(chat, this.chat.id, this.message_id, options)
-        }
-        // A Chat object was passed
-        if (typeof chat == "object") {
-            return chat.forwardMessage(this.chat.id, this.message_id, options)
-        }
+    this.forward = (chat_id, options) => {
+        if (chat_id instanceof Chat) chat_id = chat_id.id;
+        if (chat_id instanceof User) chat_id = chat_id.id;
+
+        return this.bot.forwardMessage(chat_id, this.chat.id, this.message_id, options)
     };
 
     this.editText = (text, inline, options) => {

lib/Message.js

@@ -10,6 +10,13 @@
     "telegram",
     "bot"
   ],
+  "repository" : {
+    "type": "git",
+    "url": "https://github.com/ALCC01/nodeogram.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ALCC01/nodeogram/issues"
+  },
   "author": "Alberto Coscia",
   "license": "GPL-3.0",
   "dependencies": {