Example Python Bot

#!/home/signal-gateway/venv/bin/python3

import os
import yaml
import re
import sys
import bot_handler
from rq import Queue
from rq.job import Job
from bot_worker import conn
q = Queue(connection=conn)

script_path = os.path.dirname(os.path.abspath( __file__ ))
regex_uuid = '[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}'

help_message = """/cat : get random cat
/wanip : get current WAN IP"""

def bot_help(*args, **kwargs):
    job = q.enqueue(bot_handler.send_message, help_message, kwargs['sender'])

def cat(*args, **kwargs):
    job = q.enqueue(bot_handler.cat, kwargs['sender'])

def wanip(*args, **kwargs):
    job = q.enqueue(bot_handler.wanip, kwargs['sender'])

# regex match to get the function to run for a message
regex_handlers = [
    (r'/help', bot_help),
    (r'/cat', cat),
    (r'/wanip', wanip),
    ]

def message_handler(message, sender):
    """
    try to find a function (in regex_handlers) to run for the message
    """
    for regex, function in regex_handlers:
        if re.search(regex, message, re.IGNORECASE):
            function(message=message, sender=sender)
            break

def get_contacts():
    """
    load known contacts from file
    """
    with open(script_path + '/.config/contacts.yml', 'r') as ymlfile:
        return yaml.safe_load(ymlfile)

def is_known_contact(contact):
    """
    check if the sender is a known contact
    """
    contacts = get_contacts()
    name = list(filter(lambda person: person['name'] == contact, contacts['contacts']))
    tel = list(filter(lambda person: person['tel'] == contact, contacts['contacts']))
    if name or tel:
        if name:
            recipient = name[0]['tel']
        elif tel:
            recipient = contact
        return (True, recipient)
    else:
        return (False, None)

if __name__ == "__main__":
    line = sys.argv[1].split()
    is_group = re.search(r".+(\[)(.+)(\]).*", line[2])
    if is_group:
        sender = is_group.group(2)
    else:
        sender = line[2]
    message = ' '.join(line[3:])
    friend = is_known_contact(sender)
    if friend[1]:
        sender = friend[1]
    if is_group or friend[0]:
        message_handler(message, sender)

import re
import uuid
import requests
import os
import redis
from rq import Queue
from rq.job import Job
from bot_worker import conn
q = Queue(connection=conn)

redis_host = 'localhost'
cwd = os.getcwd()

def requests_get(url, data=None, user=None, password=None, filename=None, stream=False):
    result = requests.get(url, auth=(user, password), data=data, stream=stream, verify=True)
    if filename is not None:
        if result.status_code == 200:
                with open(filename, 'wb') as f:
                    f.write(result.content)
                    return True
    else:
        return result

def requests_post(url, data=None, user=None, password=None, files=None, stream=False):
    result = requests.post(url, auth=(user, password), data=data, files=files, stream=stream)
    print(result)
    if result.status_code == 200:
        return result
    return False

def cleanup_attachments(filename):
    return os.remove(filename)

def get_group_id(recipient):
    """
    try to find the groupid for a recipient
    """
    for filename in os.listdir(cwd + '/.storage/groups'):
        textfile = open(cwd + '/.storage/groups/' + filename, 'r')
        filetext = textfile.read()
        textfile.close()
        matches = re.search('name: (' + re.escape(recipient) + ')', filetext)
        if matches:
            return filename
            break
        else:
            return recipient

def send_message(message, recipient, filename=None):
    """
    send a message using the signal gateway
    """
    multipart_form_data = {
        'message': ('', message),
        'to': ('', get_group_id(recipient))
    }
    if filename:
        multipart_form_data.update({ 'file': (open(filename, 'rb')) })
    result = requests_post('http://localhost:5000/', files=multipart_form_data)
    if filename:
        job = q.enqueue(cleanup_attachments, filename)
    return result

def cat(sender):
    """
    fetch a random cat from thecatapi.com and send back
    """
    filename = str(uuid.uuid4())
    result = requests_get('http://thecatapi.com/api/images/get?format=src&type=gif', None, None, None, filename, True)
    if result:
        send_message("Here's your random " + "\U0001F63B", sender, filename)

def wanip(sender):
    """
    get current WAN ip address and send back
    """
    result = requests.get('http://whatismyip.akamai.com')
    if result:
        send_message("current WAN ip address is " + str(result.text), sender)

#!/home/signal-gateway/venv/bin/python3

import os
import re
import redis
from rq import Worker, Queue, Connection

listen = ['default']

redis_url = os.getenv('REDIS', 'redis://localhost:6379')

conn = redis.from_url(redis_url)

if __name__ == '__main__':
    with Connection(conn):
        worker = Worker(list(map(Queue, listen)))
        worker.work()

systemctl enable signal-bot-worker
systemctl start signal-bot-worker