Added basic config builder as per #69

configbuilder.py

@@ -0,0 +1,154 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Recent changes Gamepedia compatible Discord webhook is a project for using a webhook as recent changes page from MediaWiki.
+# Copyright (C) 2018 Frisk
+
+# 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/>.
+
+import json, time, sys, re
+
+try:
+	import requests
+except ModuleNotFoundError:
+	print("The requests module couldn't be found. Please install requests library.")
+	sys.exit(0)
+
+if "--help" in sys.argv:
+	print("""Usage: python configbuilder.py [OPTIONS]
+	
+	Options:
+	--basic - Prepares only the most basic settings necessary to run the script, leaves a lot of customization options on default
+	--advanced - Prepares advanced settings with great range of customization
+	--annoying - Asks for every single value available""")
+	sys.exit(0)
+
+def default_or_custom(answer, default):
+	if answer == "":
+		return default
+	else:
+		return answer
+
+def yes_no(answer):
+	if answer.lower() == "y":
+		return True
+	if answer.lower() == "n":
+		return False
+
+print("Welcome in RcGcDw config builder! You can accept the default value if provided in the question by using Enter key without providing any other input.\nWARNING! Your current settings.json will be overwritten if you continue!")
+
+try:  # load settings
+	with open("settings.json.example") as sfile:
+		settings = json.load(sfile)
+except FileNotFoundError:
+	if yes_no(default_or_custom(input("Template config (settings.json.example) could not be found. Download the most recent stable one from master branch? (https://gitlab.com/piotrex43/RcGcDw/raw/master/settings.json.example)? (Y/n)"), "y")):
+		settings = requests.get("https://gitlab.com/piotrex43/RcGcDw/raw/master/settings.json.example").json()
+
+def basic():
+	while True:
+		if set_cooldown():
+			break
+	while True:
+		if set_wiki():
+			break
+	while True:
+		if set_lang():
+			break
+	while True:
+		if set_webhook():
+			break
+	while True:
+		if set_wikiname():
+			break
+	while True:
+		if set_displaymode():
+			break
+	with open("settings.json", "w") as settings_file:
+		settings_file.write(json.dumps(settings, indent=4))
+	print("Responses has been saved! Your settings.json should be now valid and bot ready to run.")
+
+def set_cooldown():
+	option = default_or_custom(input("Interval for fetching recent changes in seconds (min. 10, default 30).\n"), 30)
+	try:
+		option = int(option)
+		if option < 10:
+			print("Please give a value higher than 9!")
+			return False
+		else:
+			settings["cooldown"] = option
+			return True
+	except ValueError:
+		print("Please give a valid number.")
+		return False
+
+def set_wiki():
+	option = input("Please give the wiki you want to be monitored. (for example 'minecraft' or 'terraria-pl' are valid options)\n")
+	if option.startswith("http"):
+		regex = re.search(r"http(?:s|):\/\/(.*?)\.gamepedia.com", option)
+		if regex.group(1):
+			option = regex.group(1)
+	wiki_request = requests.get("https://{}.gamepedia.com".format(option), timeout=10, allow_redirects=False)
+	if wiki_request.status_code == 404 or wiki_request.status_code == 302:
+		print("Wiki at https://{}.gamepedia.com does not exist, are you sure you have entered the wiki correctly?".format(option))
+		return False
+	else:
+		settings["wiki"] = option
+		return True
+
+def set_lang():
+	option = default_or_custom(input(
+		"Please provide a language code for translation of the script. Translations available: en, de, ru, pt-br, fr. (default en)\n"), "en")
+	if option in ["en", "de", "ru", "pt-br", "fr"]:
+		settings["lang"] = option
+		return True
+	return False
+
+def set_webhook():
+	option = input(
+		"Webhook URL is required. You can get it on Discord by following instructions on this page: https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks\n")
+	if option.startswith("https://discordapp.com/api/webhooks/"):
+		test_webhook = requests.get(option)
+		if test_webhook.status_code != 200:
+			print("The webhook URL does not seem right. Reason: {}".format(test_webhook.json()["message"]))
+			return False
+		else:
+			settings["webhookURL"] = option
+			return True
+	else:
+		print("The webhook URL should start with https://discordapp.com/api/webhooks/, are you sure it's the right URL?")
+		return False
+
+def set_wikiname():
+	option = input("Please provide any wiki name for the wiki (can be whatever, but should be a full name of the wiki, for example \"Minecraft Wiki\")\n") # TODO Fetch the wiki yourself using api by default
+	settings["wikiname"] = option
+	return True
+
+def set_displaymode():
+	option = default_or_custom(input(
+		"Please choose the display mode for the feed. More on how they look like on https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation. Valid values: compact or embed. Default: embed\n"), "embed").lower()
+	if option in ["embed", "compact"]:
+		settings["appearance"]["mode"] = option
+		return True
+	print("Invalid mode selected!")
+	return False
+
+
+try:
+	basic()
+except KeyboardInterrupt:
+	if not yes_no(default_or_custom(input("\nSave the config before exiting? (y/N)"),"n")):
+		sys.exit(0)
+	else:
+		with open("settings.json", "w") as settings_file:
+			settings_file.write(json.dumps(settings, indent=4))