Ticket watcher (#45)

- Ticket and Status created
- bot now has ticket commands (`add_ticket`, `remove_ticket` and `list_tickets`)
- TicketWatcher created

Author: rodrigondec

Makefile

@@ -61,10 +61,15 @@ docker.bot.stop:
 
 docker.bot.restart: docker.bot.stop docker.up
 
-docker.worker.stop:
-	sudo docker stop bot-worker
+docker.session_watcher.stop:
+	sudo docker stop session-watcher
 
-docker.worker.restart: docker.worker.stop docker.up
+docker.session_watcher.restart: docker.session_watcher.stop docker.up
+
+docker.ticket_watcher.stop:
+	sudo docker stop ticket-watcher
+
+docker.ticket_watcher.restart: docker.ticket_watcher.stop docker.up
 
 docker.volumes.remove: docker.down
 	sudo docker volume rm $(current_dir)_mongo_volume

bot/commands/__init__.py

@@ -3,11 +3,13 @@
 from bot.commands.callback import config_handlers as callback_handlers
 from bot.commands.exchange import config_handlers as exchange_handlers
 from bot.commands.subject import config_handlers as subject_handlers
+from bot.commands.ticket import config_handlers as ticket_handlers
 
 handlers = [
     base_handlers,
     subscription_handlers,
     callback_handlers,
     exchange_handlers,
-    subject_handlers
+    subject_handlers,
+    ticket_handlers
 ]

bot/commands/subject.py

@@ -5,7 +5,7 @@
 from mongoengine.errors import DoesNotExist, MultipleObjectsReturned
 
 from bot.core import BotTelegramCore
-from bot.messages import NOW_GROUP_RESTRICTED
+from bot.messages import GROUP_RESTRICTED, CALL_NOW
 from db.subject import Subject
 from db.observer import UserObserver
 from db.update_message import UpdateMessage
@@ -25,7 +25,8 @@ def now(update: Update, context: CallbackContext):
     if not chat.type == "private":
         available_vsps = "\n".join([subject.header for
                                     subject in Subject.objects.all()])
-        message.reply_text(NOW_GROUP_RESTRICTED, parse_mode='MARKDOWN')
+        message.reply_text(f"{GROUP_RESTRICTED} {CALL_NOW}",
+                           parse_mode='MARKDOWN')
         message.reply_text(f"<b>Available VSP's are:</b>\n\n{available_vsps}",
                            parse_mode='HTML')
         return

bot/commands/ticket.py

@@ -0,0 +1,117 @@
+import logging
+
+from mongoengine.errors import DoesNotExist
+from telegram import Update
+from telegram.ext import CommandHandler, CallbackContext
+
+from bot.core import BotTelegramCore
+from bot.messages import GROUP_RESTRICTED, TX_ID_ERROR
+from db.observer import UserObserver
+from db.ticket import Ticket
+
+
+logging.basicConfig(
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    level=logging.INFO)
+
+logger = logging.getLogger(__name__)
+
+
+def add_ticket(update: Update, context: CallbackContext):
+    chat = update.effective_chat
+    message = update.effective_message
+
+    if chat.type != "private":
+        message.reply_text(GROUP_RESTRICTED)
+        return
+
+    try:
+        observer = UserObserver.objects.get(chat_id=f"{chat.id}")
+    except DoesNotExist:
+        observer = UserObserver(f"{chat.username}",
+                                f"{chat.id}").save()
+
+    try:
+        tx_id = context.args[0]
+    except IndexError:
+        message.reply_text(TX_ID_ERROR)
+        return
+
+    try:
+        Ticket.objects.get(observer=observer, tx_id=tx_id)
+        message.reply_text(f"Ticket with transaction id {tx_id}"
+                           f" is already registered!", parse_mode='HTML')
+        return
+    except DoesNotExist:
+        ticket = Ticket(observer, tx_id)
+
+    if ticket.fetch():
+        message.reply_text(f"Ticket has been saved!"
+                           f"\n\n{ticket.html}", parse_mode='HTML')
+
+
+def remove_ticket(update: Update, context: CallbackContext):
+    chat = update.effective_chat
+    message = update.effective_message
+
+    if chat.type != "private":
+        message.reply_text(GROUP_RESTRICTED)
+        return
+
+    try:
+        observer = UserObserver.objects.get(chat_id=f"{chat.id}")
+    except DoesNotExist:
+        observer = UserObserver(f"{chat.username}",
+                                f"{chat.id}").save()
+
+    try:
+        tx_id = context.args[0]
+    except IndexError:
+        message.reply_text(TX_ID_ERROR)
+        return
+
+    try:
+        ticket = Ticket.objects.get(observer=observer, tx_id=tx_id)
+    except DoesNotExist:
+        message.reply_text(f"Ticket with transaction id {tx_id} doesn't exist!")
+        return
+
+    ticket.delete()
+    message.reply_text(f"Ticket {tx_id} has been removed!")
+
+
+def list_tickets(update: Update, context: CallbackContext):
+    chat = update.effective_chat
+    message = update.effective_message
+
+    if chat.type != "private":
+        message.reply_text(GROUP_RESTRICTED)
+        return
+
+    try:
+        observer = UserObserver.objects.get(chat_id=f"{chat.id}")
+    except DoesNotExist:
+        observer = UserObserver(f"{chat.username}",
+                                f"{chat.id}").save()
+
+    tickets = Ticket.objects(observer=observer)
+
+    if not tickets:
+        message.reply_text("<b>There are no watched tickets!"
+                           "</b>", parse_mode='HTML')
+        return
+
+    text = "<b>Watched tickets</b>\n\n"
+    for index, ticket in enumerate(tickets):
+        text += ticket.html
+        text += '\n' if index != len(tickets) else ''
+
+    message.reply_text(text, parse_mode='HTML')
+
+
+def config_handlers(instance: BotTelegramCore):
+    logger.info("Setting ticket commands...")
+
+    instance.add_handler(CommandHandler("add_ticket", add_ticket))
+    instance.add_handler(CommandHandler("remove_ticket", remove_ticket))
+    instance.add_handler(CommandHandler("list_tickets", list_tickets))

bot/messages.py

@@ -6,4 +6,8 @@
 
 ADMIN_RESTRICTED = "This command is restricted to admins only!"
 
-NOW_GROUP_RESTRICTED = "The command `/now` without args is restricted on groups! Please call `/now` with args"
+GROUP_RESTRICTED = "This command is restricted on groups!"
+
+CALL_NOW = "Please call `/now` with args"
+
+TX_ID_ERROR = "Please pass a valid transaction id!"

db/observer.py

@@ -54,9 +54,12 @@ def notify(self, update_message):
         self._remove_last_message_from_subject(update_message.subject)
         self._send_update_message(update_message)
 
+    def send_message(self, message):
+        return BotTelegramCore.send_message(
+            f'{message}', chat_id=self.chat_id)
+
     def _send_update_message(self, update_message):
-        telegram_message = BotTelegramCore.send_message(
-            f'{update_message}', chat_id=self.chat_id)
+        telegram_message = self.send_message(update_message)
         self._create_message(telegram_message.message_id,
                              update_message.subject)
 

db/ticket.py

@@ -3,10 +3,12 @@
 
 import pendulum
 from mongoengine import (
-    Document,
-    FloatField, DateTimeField)
+    Document, ReferenceField,
+    FloatField, DateTimeField, StringField)
 
+from db.observer import Observer
 from utils.dcrdata import request_dcr_data
+from utils.exceptions import DcrDataAPIError
 
 
 logging.basicConfig(
@@ -65,3 +67,100 @@ def get_last(cls):
                 cls.lock.release()
 
         return last_ticket_price
+
+
+class Status(Document):
+    name = StringField(max_length=8, unique=True)
+
+    def __eq__(self, other):
+        name = None
+
+        if isinstance(other, Status):
+            name = other.name
+        elif isinstance(other, str):
+            name = other
+        return self.name == name
+
+    def __str__(self):
+        return self.name
+
+    @classmethod
+    def immature(cls):
+        return cls.objects.get(name='immature')
+
+    @classmethod
+    def live(cls):
+        return cls.objects.get(name='live')
+
+    @classmethod
+    def voted(cls):
+        return cls.objects.get(name='voted')
+
+
+class Ticket(Document):
+    observer = ReferenceField(Observer, unique_with='tx_id')
+    tx_id = StringField(max_length=64, required=True)
+    _status = ReferenceField(Status)
+    vote_id = StringField(max_length=64)
+
+    def __str__(self):
+        message = f"tx {self.tx_id}\n" \
+                  f"status: {self.status}"
+        if self.vote_id:
+            message += f"\nvote: {self.vote_id}"
+        return message
+
+    @property
+    def html(self):
+        message = f"<b>tx</b>: {self.tx_link}\n" \
+                  f"<b>status</b>: {self.status}"
+        if self.vote_id:
+            message += f"\n<b>vote</b>: {self.vote_link}"
+        return message
+
+    def is_same_status(self, new_status_name):
+        return self.status == new_status_name
+
+    @property
+    def status(self):
+        return self._status
+
+    @status.setter
+    def status(self, new_status_name):
+        self._status = Status.objects.get(name=new_status_name)
+
+    @property
+    def tx_link(self):
+        return f"<a href='https://dcrdata.decred.org/tx/" \
+               f"{self.tx_id}'>{self.tx_id}</a>"
+
+    @property
+    def vote_link(self):
+        return f"<a href='https://dcrdata.decred.org/tx/" \
+               f"{self.vote_id}'>{self.vote_id}</a>"
+
+    def notify(self):
+        self.observer.send_message(self.html)
+
+    def fetch(self):
+        logger.debug(f"fetching ticket {self}")
+        try:
+            data = request_dcr_data(f"tx/{self.tx_id}/tinfo")
+        except DcrDataAPIError as e:
+            self.delete()
+            self.observer.send_message(e)
+            self.observer.send_message(f"Your ticket was removed!")
+            return False
+
+        status = data.get('status')
+
+        if self.is_same_status(status):
+            return True
+
+        self.status = status
+        if self.status == Status.voted():
+            self.vote_id = data.get('vote')
+
+        self.save()
+        self.notify()
+        return True

docker-compose.arm.yml

@@ -23,12 +23,12 @@ services:
             - mongo
         env_file: .env
 
-    bot-worker:
+    session-watcher:
         build:
             context: .
             dockerfile: Dockerfile.arm
-        container_name: bot-worker
-        command: python -m sws.client
+        container_name: session-watcher
+        command: python -m watchers.session
         depends_on:
             - mongo
         env_file: .env

docker-compose.prod.yml

@@ -21,10 +21,10 @@ services:
             - mongo
         env_file: .env
 
-    bot-worker:
+    session-watcher:
         image: dcrguys/jack_bot
-        container_name: bot-worker
-        command: python -m sws.client
+        container_name: session-watcher
+        command: python -m watchers.session
         depends_on:
             - mongo
         env_file: .env

docker-compose.yml

@@ -25,12 +25,24 @@ services:
             - .:/bot
         env_file: .env
 
-    bot-worker:
+    session-watcher:
         build:
             context: .
             dockerfile: Dockerfile
-        container_name: bot-worker
-        command: python -m sws.client
+        container_name: session-watcher
+        command: python -m watchers.session
+        depends_on:
+            - mongo
+        volumes:
+            - .:/bot
+        env_file: .env
+
+    ticket-watcher:
+        build:
+            context: .
+            dockerfile: Dockerfile
+        container_name: ticket-watcher
+        command: python -m watchers.ticket
         depends_on:
             - mongo
         volumes: