Various changes for usability and easier setup

1. The bot now uses a configuration file instead of
   parsing command line arguments.

2. The bot has a wizard to auto-create the
   configuration if it doesn't exist.

3. Instead of saying "Bot ready" to the owner,
   the message is printed on the console.

Author: mildsunrise

.gitignore

@@ -1,2 +1,3 @@
+/config.json
 node_modules/
 npm-debug.log

README.md

@@ -39,7 +39,11 @@ To start the bot:
 node server
 ~~~
 
-If you receive a `Bot ready.` message, it's up and running.
+The first time you run it, it will ask you some questions and create
+the configuration file automatically: `config.json`. You can also
+write it manually, see `config.example.json`.
+
+When started it will print a `Bot ready.` message when it's up and running.
 For convenience, you might want to talk to the BotFather and set the
 command list to the contents of `commands.txt`.
 

config.example.json

@@ -0,0 +1,4 @@
+{
+    "authToken": "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11",
+    "owner": 34509246,
+}

lib/wizard.js

@@ -0,0 +1,123 @@
+var readline = require("readline");
+var botgram = require("botgram");
+var fs = require("fs");
+var util = require("util");
+
+// Wizard functions
+
+function stepAuthToken(rl, config) {
+    return question(rl, "First, enter your bot API token: ")
+    .then(function (token) {
+        token = token.trim();
+        //if (!/^\d{5,}:[a-zA-Z0-9_+/-]{20,}$/.test(token))
+        //    throw new Error();
+        config.authToken = token;
+        return createBot(token);
+    }).catch(function (err) {
+        console.error("Invalid token was entered, please try again.\n%s\n", err);
+        return stepAuthToken(rl, config);
+    });
+}
+
+function stepOwner(rl, config, getNextMessage) {
+    console.log("Waiting for a message...");
+    return getNextMessage().then(function (msg) {
+        var prompt = util.format("Should %s «%s» (%s) be the bot's owner? [y/n]: ", msg.chat.type, msg.chat.name, msg.chat.id);
+        return question(rl, prompt)
+        .then(function (answer) {
+            console.log();
+            answer = answer.trim().toLowerCase();
+            if (answer === "y" || answer === "yes")
+                config.owner = msg.chat.id;
+            else
+                return stepOwner(rl, config, getNextMessage);
+        });
+    });
+}
+
+function configWizard(options) {
+    var rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    var config = {};
+    var bot = null;
+
+    return Promise.resolve()
+    .then(function () {
+        return stepAuthToken(rl, config);
+    })
+    .then(function (bot_) {
+        bot = bot_;
+        console.log("\nNow, talk to me so I can discover your Telegram user:\n%s\n", bot.link());
+    })
+    .then(function () {
+        var getNextMessage = getPromiseFactory(bot);
+        return stepOwner(rl, config, getNextMessage);
+    })
+    .then(function () {
+        console.log("All done, writing the configuration...");
+        var contents = JSON.stringify(config, null, 4) + "\n";
+        return writeFile(options.configFile, contents);
+    })
+
+    .catch(function (err) {
+        console.error("Error, wizard crashed:\n%s", err.stack);
+        process.exit(1);
+    })
+    .then(function () {
+        rl.close();
+        if (bot) bot.stop();
+        process.exit(0);
+    });
+}
+
+// Promise utilities
+
+function question(interface, query) {
+    return new Promise(function (resolve, reject) {
+        interface.question(query, resolve);
+    });
+}
+
+function writeFile(file, contents) {
+    return new Promise(function (resolve, reject) {
+        fs.writeFile(file, contents, "utf-8", function (err) {
+            if (err) reject(err);
+            else resolve();
+        });
+    });
+}
+
+function createBot(token) {
+    return new Promise(function (resolve, reject) {
+        var bot = botgram(token);
+        bot.on("error", function (err) {
+            bot.stop();
+            reject(err);
+        });
+        bot.on("ready", resolve.bind(this, bot));
+    });
+}
+
+function getPromiseFactory(bot) {
+    var resolveCbs = [];
+    bot.message(function (msg, reply, next) {
+        if (!msg.queued) {
+            resolveCbs.forEach(function (resolve) {
+                resolve(msg);
+            });
+            resolveCbs = [];
+        }
+        next();
+    });
+    return function () {
+        return new Promise(function (resolve, reject) {
+            resolveCbs.push(resolve);
+        });
+    };
+}
+
+
+
+exports.configWizard = configWizard;

server.js

@@ -12,13 +12,17 @@ var utils = require("./lib/utils");
 var Command = require("./lib/command").Command;
 var Editor = require("./lib/editor").Editor;
 
-if (process.argv.length !== 4) {
-  console.error("Usage: " + process.argv.slice(0,2).join(" ") + " <auth token> <ID>");
-  process.exit(1);
+var CONFIG_FILE = path.join(__dirname, "config.json");
+try {
+    var config = require(CONFIG_FILE);
+} catch (e) {
+    console.error("Couldn't load the configuration file, starting the wizard.\n");
+    require("./lib/wizard").configWizard({ configFile: CONFIG_FILE });
+    return;
 }
 
-var bot = botgram(process.argv[2]);
-var owner = parseInt(process.argv[3]);
+var bot = botgram(config.authToken);
+var owner = config.owner;
 var tokens = {};
 var granted = {};
 var contexts = {};
@@ -30,8 +34,8 @@ bot.on("updateError", function (err) {
   console.error("Error when updating:", err);
 });
 
-bot.on("ready", function () {
-  bot.reply(owner).silent().text("Bot ready.");
+bot.on("synced", function () {
+  console.log("Bot ready.");
 });