From 8ba6ad5b22b4b3d78c88342609dd3b0e03373b0f Mon Sep 17 00:00:00 2001
From: Javinator9889 <javialonso007@hotmail.es>
Date: Wed, 4 Jul 2018 14:19:39 +0200
Subject: [PATCH] Completed "Help" handler

---
 youtube_md_bot/.idea/workspace.xml     | 48 ++++++++++++---------
 youtube_md_bot/handlers/HelpHandler.py | 60 ++++++++++++++++++++++++--
 youtube_md_bot/messages/messages.json  | 18 +++++---
 3 files changed, 95 insertions(+), 31 deletions(-)

diff --git a/youtube_md_bot/.idea/workspace.xml b/youtube_md_bot/.idea/workspace.xml
index 1cdd8f4..f245ff3 100644
--- a/youtube_md_bot/.idea/workspace.xml
+++ b/youtube_md_bot/.idea/workspace.xml
@@ -2,12 +2,10 @@
 <project version="4">
   <component name="ChangeListManager">
     <list default="true" id="ecb85847-acff-4336-b3d7-4f5563aac01d" name="Default" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/modules.xml" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/sqlDataSources.xml" beforeDir="false" />
       <change beforePath="$PROJECT_DIR$/../youtube_md_bot/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/../youtube_md_bot/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/__init__.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/../youtube_md_bot/database/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/database/__init__.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/../youtube_md_bot/handlers/StartHandler.py" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/handlers/StartHandler.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/../youtube_md_bot/handlers/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/handlers/__init__.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/../youtube_md_bot/messages/messages.json" beforeDir="false" afterPath="$PROJECT_DIR$/../youtube_md_bot/messages/messages.json" afterDir="false" />
     </list>
     <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
@@ -100,8 +98,8 @@
       <file leaf-file-name="messages.json" pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/../youtube_md_bot/messages/messages.json">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="238">
-              <caret line="14" column="23" lean-forward="true" selection-start-line="14" selection-start-column="10" selection-end-line="14" selection-end-column="23" />
+            <state relative-caret-position="357">
+              <caret line="21" column="10" selection-start-line="21" selection-start-column="10" selection-end-line="21" selection-end-column="26" />
             </state>
           </provider>
         </entry>
@@ -151,8 +149,8 @@
       <file leaf-file-name="HelpHandler.py" pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="221">
-              <caret line="13" column="66" lean-forward="true" selection-start-line="13" selection-start-column="66" selection-end-line="13" selection-end-column="66" />
+            <state relative-caret-position="1088">
+              <caret line="64" column="91" lean-forward="true" selection-start-line="64" selection-start-column="91" selection-end-line="64" selection-end-column="91" />
               <folding>
                 <element signature="e#0#87#0" expanded="true" />
               </folding>
@@ -248,11 +246,11 @@
         <option value="$PROJECT_DIR$/application.py" />
         <option value="$PROJECT_DIR$/../youtube_md_bot/utils/__init__.py" />
         <option value="$PROJECT_DIR$/../youtube_md_bot/__init__.py" />
-        <option value="$PROJECT_DIR$/../youtube_md_bot/messages/messages.json" />
         <option value="$PROJECT_DIR$/../youtube_md_bot/handlers/__init__.py" />
-        <option value="$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py" />
         <option value="$PROJECT_DIR$/../youtube_md_bot/database/__init__.py" />
         <option value="$PROJECT_DIR$/../youtube_md_bot/handlers/StartHandler.py" />
+        <option value="$PROJECT_DIR$/../youtube_md_bot/messages/messages.json" />
+        <option value="$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py" />
       </list>
     </option>
   </component>
@@ -471,7 +469,14 @@
       <option name="project" value="LOCAL" />
       <updated>1530471396812</updated>
     </task>
-    <option name="localTasksCounter" value="14" />
+    <task id="LOCAL-00014" summary="Updated handlers, messages and database for async working">
+      <created>1530474313444</created>
+      <option name="number" value="00014" />
+      <option name="presentableId" value="LOCAL-00014" />
+      <option name="project" value="LOCAL" />
+      <updated>1530474313444</updated>
+    </task>
+    <option name="localTasksCounter" value="15" />
     <servers />
   </component>
   <component name="ToolWindowManager">
@@ -521,7 +526,8 @@
     <MESSAGE value="Created logging manager" />
     <MESSAGE value="Renamed project - changed directory name" />
     <MESSAGE value="Updated &quot;main&quot;" />
-    <option name="LAST_COMMIT_MESSAGE" value="Updated &quot;main&quot;" />
+    <MESSAGE value="Updated handlers, messages and database for async working" />
+    <option name="LAST_COMMIT_MESSAGE" value="Updated handlers, messages and database for async working" />
   </component>
   <component name="XDebuggerManager">
     <breakpoint-manager>
@@ -885,13 +891,6 @@
         </state>
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/../youtube_md_bot/messages/messages.json">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="238">
-          <caret line="14" column="23" lean-forward="true" selection-start-line="14" selection-start-column="10" selection-end-line="14" selection-end-column="23" />
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/../youtube_md_bot/handlers/__init__.py">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="136">
@@ -919,10 +918,17 @@
         </state>
       </provider>
     </entry>
+    <entry file="file://$PROJECT_DIR$/../youtube_md_bot/messages/messages.json">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="357">
+          <caret line="21" column="10" selection-start-line="21" selection-start-column="10" selection-end-line="21" selection-end-column="26" />
+        </state>
+      </provider>
+    </entry>
     <entry file="file://$PROJECT_DIR$/../youtube_md_bot/handlers/HelpHandler.py">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="221">
-          <caret line="13" column="66" lean-forward="true" selection-start-line="13" selection-start-column="66" selection-end-line="13" selection-end-column="66" />
+        <state relative-caret-position="1088">
+          <caret line="64" column="91" lean-forward="true" selection-start-line="64" selection-start-column="91" selection-end-line="64" selection-end-column="91" />
           <folding>
             <element signature="e#0#87#0" expanded="true" />
           </folding>
diff --git a/youtube_md_bot/handlers/HelpHandler.py b/youtube_md_bot/handlers/HelpHandler.py
index b9dfee9..1936603 100644
--- a/youtube_md_bot/handlers/HelpHandler.py
+++ b/youtube_md_bot/handlers/HelpHandler.py
@@ -15,20 +15,74 @@ def help(self, bot: Bot, update: Update, args: list):
 
         if len(args) == 0:
             self.show_help_keyboard(bot=bot, user_id=user_id, lang=lang)
+        else:
+            help_attribute = args[0]
+            if help_attribute == "ta":
+                self.show_help_title_artist(bot, user_id, lang)
+            elif help_attribute == "url":
+                self.show_help_url(bot, user_id, lang)
+            elif help_attribute == 'h':
+                self.show_help_history(bot, user_id, lang)
+            elif help_attribute == "meta":
+                self.show_help_metadata(bot, user_id, lang)
+            else:
+                self.__show_reply_unrecognized_attribute(bot, user_id, lang)
 
-    def show_help_keyboard(self, bot: Bot, user_id: int, lang: str, message_id: int=None):
+    def show_help_keyboard(self, bot: Bot, user_id: int, lang: str, message_id: int = None):
         help_message = self.__messages[lang][0]["help"]["msg"]
         tt_at_button = self.__messages[lang][0]["help"]["d_via_tt-at-but"]
         url_button = self.__messages[lang][0]["help"]["d_via_url-but"]
         history_button = self.__messages[lang][0]["help"]["d_via_history-but"]
+        metadata_button = self.__messages[lang][0]["help"]["m_set_metadata-but"]
         support_button = self.__messages[lang][0]["help"]["support_but"]
 
         help_keyboard = InlineKeyboardMarkup([[InlineKeyboardButton(tt_at_button, callback_data="tt_at_button"),
                                                InlineKeyboardButton(url_button, callback_data="url_button")],
                                               [InlineKeyboardButton(history_button, callback_data="history_button"),
-                                               InlineKeyboardButton(support_button, callback_data="support_button")]])
+                                               InlineKeyboardButton(metadata_button, callback_data="metadata_button")],
+                                              [InlineKeyboardButton(support_button, callback_data="support_button")]])
         if not message_id:
             bot.sendMessage(chat_id=user_id, text=help_message, reply_markup=help_keyboard,
                             parse_mode=ParseMode.MARKDOWN)
         else:
-            bot.editMessageText(help_message, chat_id=user_id, message_id=message_id, parse_mode=ParseMode.MARKDOWN)
+            bot.editMessageText(text=help_message, chat_id=user_id, message_id=message_id,
+                                parse_mode=ParseMode.MARKDOWN)
+
+    def show_help_title_artist(self, bot: Bot, user_id: int, lang: str, message_id: int = None):
+        help_message = self.__messages[lang][0]["help"]["d_via_tt-at"]
+        if not message_id:
+            bot.sendMessage(chat_id=user_id, text=help_message, parse_mode=ParseMode.MARKDOWN)
+        else:
+            self.__show_keyboard_back_button(bot, user_id, lang, message_id, help_message)
+
+    def show_help_url(self, bot: Bot, user_id: int, lang: str, message_id: int = None):
+        help_message = self.__messages[lang][0]["help"]["d_via_url"]
+        if not message_id:
+            bot.sendMessage(chat_id=user_id, text=help_message, parse_mode=ParseMode.MARKDOWN)
+        else:
+            self.__show_keyboard_back_button(bot, user_id, lang, message_id, help_message)
+
+    def show_help_history(self, bot: Bot, user_id: int, lang: str, message_id: int = None):
+        help_message = self.__messages[lang][0]["help"]["d_via_history"]
+        if not message_id:
+            bot.sendMessage(chat_id=user_id, text=help_message, parse_mode=ParseMode.MARKDOWN)
+        else:
+            self.__show_keyboard_back_button(bot, user_id, lang, message_id, help_message)
+
+    def show_help_metadata(self, bot: Bot, user_id: int, lang: str, message_id: int = None):
+        help_message = self.__messages[lang][0]["help"]["m_set_metadata"]
+        if not message_id:
+            bot.sendMessage(chat_id=user_id, text=help_message, parse_mode=ParseMode.MARKDOWN)
+        else:
+            self.__show_keyboard_back_button(bot, user_id, lang, message_id, help_message)
+
+    def __show_keyboard_back_button(self, bot: Bot, user_id: int, lang: str, message_id: int, text: str):
+        back_button = self.__messages[lang][0]["help"]["back_button"]
+
+        back_keyboard = InlineKeyboardMarkup([[InlineKeyboardButton(back_button, callback_data="help_back")]])
+        bot.editMessageText(text=text, chat_id=user_id, message_id=message_id,
+                            parse_mode=ParseMode.MARKDOWN, reply_markup=back_keyboard)
+
+    def __show_reply_unrecognized_attribute(self, bot: Bot, user_id: int, lang: str):
+        unrecognized_text = self.__messages[lang][0]["help"]["h_unrecognized"]
+        bot.sendMessage(chat_id=user_id, text=unrecognized_text, parse_mode=ParseMode.MARKDOWN)
diff --git a/youtube_md_bot/messages/messages.json b/youtube_md_bot/messages/messages.json
index f7f657d..bbaabc6 100644
--- a/youtube_md_bot/messages/messages.json
+++ b/youtube_md_bot/messages/messages.json
@@ -9,13 +9,17 @@
       "help": [
         {
           "msg": "Para descargar una canción puedes:\n  ■  *Buscar* 🔎 la canción por _título y artista_, enviándoselo directamente al bot\n  ■  *Enviar* directamente la _URL_ 🔗 del vídeo\n  ■  Seleccionar una *canción ya descargada* desde el historial 🕒\n\nPara más ayuda, navega con los botones que aparecen debajo",
-          "d_via_tt-at-but": "Título y artista",
-          "d_via_url-but": "URL",
-          "d_via_history-but": "Historial",
-          "support_but": "Soporte",
-          "d_via_tt-at": "*Descarga*[ ]({})canciones enviando directamente el _título_ 🎤 y _artista_ 🗣 de la canción al bot",
-          "d_via_url": "Comienza[ ]({})directamente *con la descarga* enviando la URL del vídeo de YouTube\n\nPuedes usar un bot _inline_ como @vid para agilizar este proceso",
-          "d_via_history": "Accede[ ]({})a tu *historial* mediante el comando /history, desde donde podrás _seleccionar directamente_ la canción que quieras descargar"
+          "d_via_tt-at-but": "Título y artista 🗣🎤",
+          "d_via_url-but": "URL 🔗",
+          "d_via_history-but": "Historial 🕒",
+          "m_set_metadata-but": "Metadatos 🏷",
+          "support_but": "Soporte 🛠",
+          "back_button": "◀ Atrás",
+          "d_via_tt-at": "*Descarga*[ ]({})canciones enviando directamente el _título_ 🎤 y _artista_ 🗣 de la canción al bot.\n\n_Puedes obtener esta información escribiendo:_ `/help ta` (*t*itle, *a*rtist)",
+          "d_via_url": "Comienza[ ]({})directamente *con la descarga* enviando la URL del vídeo de YouTube\n\nPuedes usar un bot _inline_ como @vid para agilizar este proceso.\n\n_Puedes obtener esta información escribiendo:_ `/help url`",
+          "d_via_history": "Accede[ ]({})a tu *historial* mediante el comando /history, desde donde podrás _seleccionar directamente_ la canción que quieras descargar.\n\n_Puedes obtener esta información escribiendo:_ `/help h` (*h*istory)",
+          "m_set_metadata": "Cambia los metadatos de una canción al descargarla:\n\n  ■  Cambia *las preferencias* ⚙ usando /config\n  ■  Cuando _descargues un vídeo_, se te preguntará por las preferencias. Indica el título usando /t:\n         `/t titulo`\n     Indica el artista usando /a:\n         `/a artista`\n  ■  Se te *preguntará* si quieres usar la _miniatura de YouTube_ como carátula de tu canción.\n\n_Puedes obtener esta información escribiendo:_ `/help meta` (*meta*data)",
+          "h_unrecognized": "No se reconoce el atributo. La lista de opciones disponibles es:\n\n  ■  `/help ta`, para título y artista 🗣🎤\n  ■  `/help url`, para URL 🔗\n  ■  `/help h`, para historial 🕒\n  ■  `/help meta`, para metadatos 🏷"
         }
       ]
     }