204 Create a script for the workshop leader

Author: btimbermont

puma/apps/android/teleguard/teleguard.py

@@ -1,8 +1,11 @@
+from typing import List
+
+from appium.webdriver import WebElement
 from appium.webdriver.common.appiumby import AppiumBy
 
 from puma.apps.android.teleguard.xpaths import *
 from puma.state_graph.action import action
-from puma.state_graph.puma_driver import PumaDriver, supported_version
+from puma.state_graph.puma_driver import PumaDriver, supported_version, PumaClickException
 from puma.state_graph.state import ContextualState, SimpleState, compose_clicks
 from puma.state_graph.state_graph import StateGraph
 
@@ -111,14 +114,61 @@ def add_contact(self, teleguard_id: str):
         self.driver.click(CONVERSATION_STATE_INVITE)
 
     @action(conversations_state)
-    def accept_invite(self):
+    def invite_received(self, scroll: bool = False, max_swipes: int = 10) -> bool:
+        """
+        Checks whether an invite has been received. By default this method does not scroll to look for an invite.
         """
-        Accepts an invite from another user.
+        if scroll:
+            try:
+                self.driver.swipe_to_find_element(CONVERSATION_STATE_YOU_HAVE_BEEN_INVITED, max_swipes=max_swipes)
+                return True
+            except PumaClickException:
+                return False
+        return self.driver.is_present(CONVERSATION_STATE_YOU_HAVE_BEEN_INVITED)
+
+    @action(conversations_state)
+    def accept_invite(self) -> str:
+        """
+        Accepts an invite from another user and returns the name of the accepted invite.
 
         If there are multiple invites, only the topmost invite in the UI will be accepted.
+
+        This method returns the name of the user that sent an invite. If no invite was sent, an exception is raised.
         """
         self.driver.swipe_to_click_element(CONVERSATION_STATE_YOU_HAVE_BEEN_INVITED)
-        self.driver.click(CONVERSATION_STATE_ACCEPT_INVITE)
+        name = self.driver.get_element(CONVERSATION_STATE_INVITATION_NAME).get_attribute('content-desc')
+        self.driver.click(CONVERSATION_STATE_INVITATION_ACCEPT)
+        return name
+
+    def _extract_name(self, conversation_row: WebElement) -> str:
+        """
+        Given a conversation row, extracts the name of the conversation.
+        For users with an avatar, the first line of the content description is the conversation name.
+        For users without an avatar, there is an extra first line with just the first letter of the name.
+        We try to detect this pattern and return the first or second line based on this.
+        """
+        content_description = conversation_row.get_attribute('content-desc')
+        lines = content_description.split('\n')[:2]
+        if len(lines[0])>1:
+            return lines[0]
+        elif lines[1][0] == lines[0]:
+            return lines[1]
+        else:
+            return lines[0]
+
+    @action(conversations_state)
+    def conversations_with_unread_messages(self) -> List[str]:
+        """
+        Returns a list of names of conversations that have unread messages.
+        """
+        try:
+            elements = self.driver.get_elements(CONVERSATION_STATE_UNREAD_MESSAGES)
+            names = [self._extract_name(e) for e in elements]
+            return names
+        except PumaClickException:
+            return []
+
+
 
     @action(chat_state)
     def send_message(self, message: str, conversation: str = None):

puma/apps/android/teleguard/xpaths.py

@@ -7,13 +7,16 @@
 CONVERSATION_STATE_EDIT_TEXT = '//android.widget.EditText'
 CONVERSATION_STATE_INVITE = '//android.widget.Button[@content-desc="INVITE"]'
 CONVERSATION_STATE_YOU_HAVE_BEEN_INVITED = '//android.view.View[contains(@content-desc, "You have been invited")]'
-CONVERSATION_STATE_ACCEPT_INVITE = '//android.widget.Button[@content-desc="ACCEPT INVITE"]'
+CONVERSATION_STATE_INVITATION_ID = '//android.view.View[starts-with(lower-case(@content-desc), "teleguard id:")]'
+CONVERSATION_STATE_INVITATION_NAME = '//android.view.View[starts-with(lower-case(@content-desc), "teleguard id:")]/preceding-sibling::*[last()]'
+CONVERSATION_STATE_INVITATION_ACCEPT = '//android.widget.Button[@content-desc="ACCEPT INVITE"]'
+CONVERSATION_STATE_UNREAD_MESSAGES = '//*[@content-desc and matches(@content-desc, "\\n\\d$")]'
 
 CHAT_STATE_CONVERSATION_NAME = ('//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.view.View[1]/android.view.View[2]/android.widget.ImageView[2][@content-desc]|'
                                 '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.view.View[1]/android.view.View[2]/android.view.View[1][@content-desc]')
 CHAT_STATE_TEXT_FIELD = '//android.widget.EditText[@hint="Send a message"]'
 CHAT_STATE_SEND_MEDIA_BUTTON = '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.widget.ImageView[2]'
-CHAT_STATE_SEND_BUTTON = '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.widget.ImageView[3]'
+CHAT_STATE_SEND_BUTTON = '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.widget.ImageView[last()]'
 CHAT_STATE_MICROPHONE_BUTTON = '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.widget.ImageView[4]'
 CHAT_STATE_THREE_DOTS = '//android.widget.FrameLayout[@resource-id="android:id/content"]/android.widget.FrameLayout/android.widget.FrameLayout/android.view.View/android.view.View/android.view.View/android.view.View/android.view.View[1]/android.view.View[2]/android.widget.ImageView[last()]'
 

tutorial/2026/workshop_leader/__init__.py

@@ -0,0 +1,30 @@
+Thank you for your message! I've received it loud and clear.
+I appreciate your message! Just to let you know, I'm not a chatbot, but I've noted your input.
+Message received! Thank you for reaching out. Just a reminder, I'm not capable of continuing the conversation like a person.
+Thanks for the note! I understand your message, but please remember that I'm a server, not a chatbot.
+Your message has been received! Thanks for sharing. I'm here for processing, not chatting.
+Thanks for your input! Just so you know, I'm not a conversational AI, but I acknowledge your message.
+Message confirmed! Thank you for sending it. I'm programmed for service, not conversation.
+I've received your message. Thank you! Bear in mind, I don't have the capability for back-and-forth chatting.
+Thanks! Your message has been noted. I'm here to assist, not to converse like a human.
+Message received! Thank you for contacting me. I can only process requests, not engage in dialogue.
+Your message has reached me! I appreciate it. However, remember I'm not designed for real conversation.
+Thank you! I've registered your message. Please note that I operate as a server, not a chatbot.
+Acknowledged! Your message is received. Just a heads-up, I don't engage in conversations.
+Thanks for your message! I've received it and will process accordingly. Not a chatbot here!
+Confirmation received! I appreciate your input, but I'm not equipped for conversation.
+I've got your message! Thanks! Just a reminder that I'm here to serve, not to chat.
+Message noted! Thank you for reaching out. I don't have conversational capabilities.
+I appreciate your input! Your message is received, but I'm not a conversational AI.
+Thank you! Your message has been acknowledged. I can't continue a dialogue like a chatbot.
+Message received with thanks! Just so you know, I'm not designed for conversational exchange.
+Thanks for your message! It has been logged. I'm more of a server than a conversationalist.
+I've successfully received your message! Thank you. I'm not capable of chatting, though.
+Acknowledged! Your message is received. Keep in mind I don't engage in back-and-forth.
+Thank you for your message! I recognize it, but I'm not a chatbot.
+Message received! Thanks! Just a reminder, I'm not programmed for larger conversations.
+I've received your note! Thank you for sharing. Remember, I'm a service, not a chatbot.
+Thank you! Your message has been noted. I can't follow up like a conversational AI.
+I appreciate your message! It's been acknowledged. I'm not capable of having real conversations.
+Thanks for your input! Your message was received. I'm not equipped for chat interactions.
+Message confirmed! I appreciate you reaching out. However, I'm not a chatbot with dialogue skills.

tutorial/2026/workshop_leader/chat_responses.txt

@@ -0,0 +1,31 @@
+Hello there, thanks for inviting me!
+Greetings! It's a pleasure to join the conversation.
+Hi! Thanks for the invite; how can I assist you today?
+Hello! I'm excited to chat with you.
+Hey there! Glad to be here. What's on your mind?
+Salutations! I'm ready to engage in some dialogue.
+Hi there! Your invitation is warmly accepted!
+Hello! I'm thrilled to connect. What would you like to discuss?
+Greetings! Thank you for the warm welcome!
+Hi! Happy to chat with you. What do you want to talk about?
+Hello! Thank you for inviting me; I'm here to help!
+Hey! It's great to be here. What's the topic of conversation?
+Hi there! Ready to jump into the discussion.
+Hello! Thanks for including me. How can I contribute?
+Greetings! Looking forward to a fruitful chat.
+Hi! Delighted to join you. What's up?
+Hello there! Excited to dive into this conversation.
+Hey! I appreciate the invitation. Let's chat!
+Hi! I'm here, ready to respond. What's on your agenda?
+Greetings! It's wonderful to connect. What shall we discuss?
+Hello! Thank you for the invite. Let's get started!
+Hey there! I'm looking forward to our chat.
+Hi! Thank you for involving me in this conversation.
+Hello! I'm at your service. What's the first topic?
+Greetings! Ready to engage in a lively discussion!
+Hi! Glad to be part of this. What's on your mind?
+Hello! Excited to hear from you. What can I do for you?
+Hey! Thanks for having me; I'm ready for some dialogue.
+Hi there! Looking forward to chatting with you.
+Greetings! Let's make this chat interesting!
+Hello! I appreciate your invitation. Let's discuss!

tutorial/2026/workshop_leader/hello_messages.txt

@@ -0,0 +1,27 @@
+import random
+from time import sleep
+
+from puma.apps.android.teleguard.teleguard import TeleGuard
+
+BLACK_PIXEL = ''
+
+if __name__ == '__main__':
+    teleguard = TeleGuard(BLACK_PIXEL)
+
+    with open('hello_messages.txt', 'r') as f:
+        hello_messages = f.read().splitlines()
+    with open('chat_responses.txt', 'r') as f:
+        responses = f.read().splitlines()
+
+    while True:
+        # check for invites
+        if teleguard.invite_received():
+            name = teleguard.accept_invite()
+            teleguard.send_message(random.choice(hello_messages), conversation=name)
+        # check for unread messages
+        conversations_with_unread_messages = teleguard.conversations_with_unread_messages()
+        for conversation in conversations_with_unread_messages:
+            teleguard.send_message(random.choice(responses), conversation=conversation)
+        teleguard.go_to_state(teleguard.conversations_state)
+        print('nothing to do, sleeping...')
+        sleep(5)