Add wheel requirements for dev

.github/workflows/release-chart.yaml

@@ -0,0 +1,32 @@
+name: Release Helm Chart
+
+"on":
+  push:
+    branches:
+      - main
+    paths:
+      - "charts/**/Chart.yaml"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+      - name: Install Helm
+        uses: azure/setup-helm@v1
+        with:
+          version: v3.6.3
+
+      - name: Run chart-releaser
+        uses: helm/chart-releaser-action@v1.2.1
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          CR_RELEASE_NAME_TEMPLATE: "smsbot-helm-chart-{{ .Version }}"

README.md

@@ -9,3 +9,16 @@ Forked from [FiveBoroughs/Twilio2Telegram](https://github.com/FiveBoroughs/Twili
 This simple tool acts as a webhook receiver for the Twilio API, taking messages sent over and posting them on Telegram to a target chat or channel. This is useful for forwarding on 2FA messages, notification text messages for services that don't support international numbers (*cough* Disney, of all people).
 
 The bot is designed to run within a Kubernetes environment, but can be operated as a individual container, or as a hand ran service.
+
+## Configuration
+
+All configuration is provided via environment variables
+
+| Variable                   | Required? | Description                                                                 |
+| -------------------------- | --------- | --------------------------------------------------------------------------- |
+| SMSBOT_DEFAULT_SUBSCRIBERS | No        | A list of IDs, seperated by commas, to add to the subscribers list on start |
+| SMSBOT_LISTEN_HOST         | No        | The host for the webhooks to listen on, defaults to `0.0.0.0`               |
+| SMSBOT_LISTEN_PORT         | No        | The port to listen to, defaults to `80`                                     |
+| SMSBOT_OWNER_ID            | No        | ID of the owner of this bot                                                 |
+| SMSBOT_TELEGRAM_BOT_TOKEN  | Yes       | Your Bot Token for Telegram                                                 |
+| SMSBOT_TWILIO_AUTH_TOKEN   | No        | Twilio auth token, used to validate any incoming webhook calls              |

charts/smsbot/Chart.yaml

@@ -0,0 +1,18 @@
+apiVersion: v2
+appVersion: 0.0.3
+description: A simple Telegram bot to receive SMS messages.
+name: smsbot
+version: 0.0.3
+kubeVersion: ">=1.19.0-0"
+keywords:
+- smsbot
+home: https://github.com/nikdoof/smsbot/tree/main/charts/smsbot
+sources:
+- https://github.com/nikdoof/smsbot
+maintainers:
+- name: nikdoof
+  email: nikdoof@users.noreply.github.com
+dependencies:
+- name: common
+  repository: https://library-charts.k8s-at-home.com
+  version: 4.3.0

charts/smsbot/ci/ct-values.yaml

@@ -0,0 +1,10 @@
+env:
+  SMSBOT_TELEGRAM_BOT_TOKEN: xxxx
+ingress:
+  main:
+    enabled: true
+    hosts:
+      - host: smsbot.domain.tld
+        paths:
+          - path: /
+            pathType: Prefix

charts/smsbot/templates/NOTES.txt

@@ -0,0 +1 @@
+{{ include "common.notes.defaultNotes" . }}

charts/smsbot/templates/common.yaml

@@ -0,0 +1 @@
+{{ include "common.all" . }}

charts/smsbot/values.yaml

@@ -0,0 +1,35 @@
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from the k8s@home library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
+#
+
+image:
+  # -- image repository
+  repository: ghcr.io/nikdoof/smsbot
+  # -- image pull policy
+  pullPolicy: IfNotPresent
+  # -- image tag
+  tag: 0.0.3
+
+# -- environment variables.
+# @default -- See below
+env:
+  # -- Set the container timezone
+  TZ: UTC
+  # SMSBOT_TELEGRAM_BOT_TOKEN: 
+
+# -- Configures service settings for the chart.
+# @default -- See values.yaml
+service:
+  main:
+    ports:
+      http:
+        port: 80
+
+ingress:
+  # -- Enable and configure ingress settings for the chart under this key.
+  # @default -- See values.yaml
+  main:
+    enabled: false

requirements-dev.txt

@@ -0,0 +1 @@
+wheel

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = smsbot
-version = 0.0.1
+version = 0.0.3
 description = A simple Telegram bot to receive SMS messages.
 long_description = file: README.md, LICENSE
 license = MIT
@@ -23,13 +23,13 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-        smsbot = smsbot:main
+        smsbot = smsbot.cli:main
 
 [flake8]
 format = wemake
-ignore = E501,D,WPS226,WPS110, WPS210,WPS231,WPS202
+ignore = D,E501,WPS432,WPS323,WPS2,S104,WPS412,WPS100
 max-line-length = 120
-exclude = setup.py
+exclude = setup.py,env,build
 
 [darglint]
 docstring_style=sphinx

smsbot/__init__.py

@@ -1,168 +0,0 @@
-import logging
-import os
-import sys
-from functools import wraps
-
-from flask import Flask, abort, current_app, request
-from telegram.ext import CommandHandler, Updater
-from twilio.request_validator import RequestValidator
-from waitress import serve
-import pkg_resources
-
-pkg_version = pkg_resources.require("smsbot")[0].version
-
-
-class TelegramSmsBot(object):
-
-    owner_id = None
-    subscriber_ids = []
-
-    def __init__(self, token):
-        self.logger = logging.getLogger(self.__class__.__name__)
-        self.bot_token = token
-
-    def start(self):
-        self.logger.info('Starting bot...')
-        self.updater = Updater(self.bot_token, use_context=True)
-        self.updater.dispatcher.add_handler(CommandHandler('help', self.help_handler))
-        self.updater.dispatcher.add_handler(CommandHandler('start', self.help_handler))
-        self.updater.dispatcher.add_handler(CommandHandler('subscribe', self.subscribe_handler))
-        self.updater.dispatcher.add_handler(CommandHandler('unsubscribe', self.unsubscribe_handler))
-        self.updater.dispatcher.add_error_handler(self.error_handler)
-
-        self.updater.start_polling()
-        self.bot = self.updater.bot
-        self.logger.info('Bot Ready')
-
-    def stop(self):
-        self.updater.stop()
-
-    def help_handler(self, update, context):
-        """Send a message when the command /help is issued."""
-        self.logger.info('/help command received in chat: %s', update.message.chat)
-        update.message.reply_markdown('Smsbot v{0}\n\n/help\n/subscribe\n/unsubscribe'.format(pkg_version))
-
-    def subscribe_handler(self, update, context):
-        self.logger.info('/subscribe command received')
-        if not update.message.chat['id'] in self.subscriber_ids:
-            self.logger.info('{0} subscribed'.format(update.message.chat['username']))
-            self.subscriber_ids.append(update.message.chat['id'])
-            update.message.reply_markdown('You have been subscribed to SMS notifications')
-        else:
-            update.message.reply_markdown('You are already subscribed to SMS notifications')
-
-    def unsubscribe_handler(self, update, context):
-        self.logger.info('/unsubscribe command received')
-        if update.message.chat['id'] in self.subscriber_ids:
-            self.logger.info('{0} unsubscribed'.format(update.message.chat['username']))
-            self.subscriber_ids.remove(update.message.chat['id'])
-            update.message.reply_markdown('You have been unsubscribed to SMS notifications')
-        else:
-            update.message.reply_markdown('You are not subscribed to SMS notifications')
-
-    def error_handler(self, update, context):
-        """Log Errors caused by Updates."""
-        self.logger.warning('Update "%s" caused error "%s"', update, context.error)
-
-    def send_message(self, message, chat_id):
-        self.bot.sendMessage(text=message, chat_id=chat_id)
-
-    def send_owner(self, message):
-        if self.owner_id:
-            self.send_message(message, self.owner_id)
-
-    def send_subscribers(self, message):
-        for chat_id in self.subscriber_ids:
-            self.send_message(message, chat_id)
-
-    def set_owner(self, chat_id):
-        self.owner_id = chat_id
-
-    def add_subscriber(self, chat_id):
-        self.subscriber_ids.append(chat_id)
-
-
-def validate_twilio_request(f):
-    """Validates that incoming requests genuinely originated from Twilio"""
-    @wraps(f)
-    def decorated_function(*args, **kwargs):
-        # Create an instance of the RequestValidator class
-        twilio_token = os.environ.get('SMSBOT_TWILIO_AUTH_TOKEN')
-
-        if not twilio_token:
-            current_app.logger.warning('Twilio request validation skipped due to SMSBOT_TWILIO_AUTH_TOKEN missing')
-            return f(*args, **kwargs)
-
-        validator = RequestValidator(twilio_token)
-
-        # Validate the request using its URL, POST data,
-        # and X-TWILIO-SIGNATURE header
-        request_valid = validator.validate(
-            request.url,
-            request.form,
-            request.headers.get('X-TWILIO-SIGNATURE', ''))
-
-        # Continue processing the request if it's valid, return a 403 error if
-        # it's not
-        if request_valid or current_app.debug:
-            return f(*args, **kwargs)
-        else:
-            return abort(403)
-    return decorated_function
-
-
-class TwilioWebhookHandler(object):
-
-    def __init__(self):
-        self.app = Flask(self.__class__.__name__)
-        self.app.add_url_rule('/', 'index', self.index, methods=['GET'])
-        self.app.add_url_rule('/message', 'message', self.message, methods=['POST'])
-        self.app.add_url_rule('/call', 'call', self.call, methods=['POST'])
-
-    def set_bot(self, bot):
-        self.bot = bot
-
-    def index(self):
-        return 'Smsbot v{0} - {1}'.format(pkg_version, request.values.to_dict())
-
-    @validate_twilio_request
-    def message(self):
-
-        message = "From: {From}\n\n{Body}".format(**request.values.to_dict())
-
-        current_app.logger.info('Received SMS from {From}: {Body}'.format(**request.values.to_dict()))
-        self.bot.send_subscribers(message)
-
-        return '<response></response>'
-
-    @validate_twilio_request
-    def call(self):
-        current_app.logger.info('Received Call from {From}'.format(**request.values.to_dict()))
-        self.bot.send_subscribers('Received Call from {From}, rejecting.'.format(**request.values.to_dict()))
-        # Always reject calls
-        return '<Response><Reject/></Response>'
-
-    def serve(self, host='0.0.0.0', port=80, debug=False):
-        serve(self.app, host=host, port=port)
-
-
-def main():
-    logging.basicConfig(level=logging.INFO)
-    logging.info('smsbot v%s', pkg_version)
-
-    listen_host = os.environ.get('SMSBOT_LISTEN_HOST') or '0.0.0.0'
-    listen_port = int(os.environ.get('SMSBOT_LISTEN_PORT') or '80')
-
-    token = os.environ.get('SMSBOT_TELEGRAM_BOT_TOKEN')
-    if not token:
-        logging.error('Telegram Bot token missing')
-        sys.exit(1)
-
-    # Start bot
-    telegram_bot = TelegramSmsBot(token)
-    telegram_bot.start()
-
-    # Start webhooks
-    webhooks = TwilioWebhookHandler()
-    webhooks.set_bot(telegram_bot)
-    webhooks.serve(host=listen_host, port=listen_port)

smsbot/__main__.py

@@ -1,4 +1,4 @@
-from . import main
+from smsbot.cli import main
 
 if __name__ == '__main__':
     main()

smsbot/cli.py

@@ -0,0 +1,42 @@
+import logging
+import os
+import sys
+
+import pkg_resources
+
+from smsbot.telegram import TelegramSmsBot
+from smsbot.webhook_handler import TwilioWebhookHandler
+
+pkg_version = pkg_resources.require('smsbot')[0].version
+
+
+def main():
+    logging.basicConfig(level=logging.INFO)
+    logging.info('smsbot v%s', pkg_version)
+
+    listen_host = os.environ.get('SMSBOT_LISTEN_HOST') or '0.0.0.0'
+    listen_port = int(os.environ.get('SMSBOT_LISTEN_PORT') or '80')
+
+    token = os.environ.get('SMSBOT_TELEGRAM_BOT_TOKEN')
+    if not token:
+        logging.error('Telegram Bot token missing')
+        sys.exit(1)
+
+    # Start bot
+    telegram_bot = TelegramSmsBot(token)
+
+    # Set the owner ID if configured
+    if 'SMSBOT_OWNER_ID' in os.environ:
+        telegram_bot.set_owner(os.environ.get('SMSBOT_OWNER_ID'))
+
+    # Add default subscribers
+    if 'SMSBOT_DEFAULT_SUBSCRIBERS' in os.environ:
+        for chat_id in os.environ.get('SMSBOT_DEFAULT_SUBSCRIBERS').split(','):
+            telegram_bot.add_subscriber(chat_id)
+
+    telegram_bot.start()
+
+    # Start webhooks
+    webhooks = TwilioWebhookHandler()
+    webhooks.set_bot(telegram_bot)
+    webhooks.serve(host=listen_host, port=listen_port)

smsbot/telegram.py

@@ -0,0 +1,77 @@
+import logging
+
+from telegram.ext import CommandHandler, Updater
+
+from smsbot.utils import get_smsbot_version
+
+
+class TelegramSmsBot(object):
+
+    def __init__(self, token, owner=None, subscribers=None):
+        self.logger = logging.getLogger(self.__class__.__name__)
+        self.bot_token = token
+        self.owner_id = owner
+        self.subscriber_ids = subscribers or []
+
+    def start(self):
+        self.logger.info('Starting bot...')
+        self.updater = Updater(self.bot_token, use_context=True)
+        self.updater.dispatcher.add_handler(CommandHandler('help', self.help_handler))
+        self.updater.dispatcher.add_handler(CommandHandler('start', self.help_handler))
+        self.updater.dispatcher.add_handler(CommandHandler('subscribe', self.subscribe_handler))
+        self.updater.dispatcher.add_handler(CommandHandler('unsubscribe', self.unsubscribe_handler))
+        self.updater.dispatcher.add_error_handler(self.error_handler)
+
+        self.updater.start_polling()
+        self.bot = self.updater.bot
+        self.logger.info('Bot Ready')
+
+    def stop(self):
+        self.updater.stop()
+
+    def help_handler(self, update, context):
+        """Send a message when the command /help is issued."""
+        self.logger.info('/help command received in chat: %s', update.message.chat)
+        update.message.reply_markdown('Smsbot v{0}\n\n/help\n/subscribe\n/unsubscribe'.format(get_smsbot_version()))
+
+    def subscribe_handler(self, update, context):
+        self.logger.info('/subscribe command received')
+        if update.message.chat['id'] not in self.subscriber_ids:
+            self.logger.info('{0} subscribed'.format(update.message.chat['username']))
+            self.subscriber_ids.append(update.message.chat['id'])
+            self.send_owner('{0} has subscribed'.format(update.message.chat['username']))
+            update.message.reply_markdown('You have been subscribed to SMS notifications')
+        else:
+            update.message.reply_markdown('You are already subscribed to SMS notifications')
+
+    def unsubscribe_handler(self, update, context):
+        self.logger.info('/unsubscribe command received')
+        if update.message.chat['id'] in self.subscriber_ids:
+            self.logger.info('{0} unsubscribed'.format(update.message.chat['username']))
+            self.subscriber_ids.remove(update.message.chat['id'])
+            self.send_owner('{0} has unsubscribed'.format(update.message.chat['username']))
+            update.message.reply_markdown('You have been unsubscribed to SMS notifications')
+        else:
+            update.message.reply_markdown('You are not subscribed to SMS notifications')
+
+    def error_handler(self, update, context):
+        """Log Errors caused by Updates."""
+        self.logger.warning('Update "%s" caused error "%s"', update, context.error)
+        self.send_owner('Update "%{0}" caused error "{1}"'.format(update, context.error))
+
+    def send_message(self, message, chat_id):
+        self.bot.sendMessage(text=message, chat_id=chat_id)
+
+    def send_owner(self, message):
+        if self.owner_id:
+            self.send_message(message, self.owner_id)
+
+    def send_subscribers(self, message):
+        for chat_id in self.subscriber_ids:
+            self.send_message(message, chat_id)
+
+    def set_owner(self, chat_id):
+        self.owner_id = chat_id
+
+    def add_subscriber(self, chat_id):
+        self.subscriber_ids.append(chat_id)

smsbot/utils.py

@@ -0,0 +1,5 @@
+import pkg_resources
+
+
+def get_smsbot_version():
+    return pkg_resources.require('smsbot')[0].version

smsbot/webhook_handler.py

@@ -0,0 +1,78 @@
+
+import os
+from functools import wraps
+
+from flask import Flask, abort, current_app, request
+from twilio.request_validator import RequestValidator
+from waitress import serve
+
+from smsbot.utils import get_smsbot_version
+
+
+def validate_twilio_request(func):
+    """Validates that incoming requests genuinely originated from Twilio"""
+    @wraps(func)
+    def decorated_function(*args, **kwargs):  # noqa: WPS430
+        # Create an instance of the RequestValidator class
+        twilio_token = os.environ.get('SMSBOT_TWILIO_AUTH_TOKEN')
+
+        if not twilio_token:
+            current_app.logger.warning('Twilio request validation skipped due to SMSBOT_TWILIO_AUTH_TOKEN missing')
+            return func(*args, **kwargs)
+
+        validator = RequestValidator(twilio_token)
+
+        # Validate the request using its URL, POST data,
+        # and X-TWILIO-SIGNATURE header
+        request_valid = validator.validate(
+            request.url,
+            request.form,
+            request.headers.get('X-TWILIO-SIGNATURE', ''),
+        )
+
+        # Continue processing the request if it's valid, return a 403 error if
+        # it's not
+        if request_valid or current_app.debug:
+            return func(*args, **kwargs)
+        return abort(403)
+    return decorated_function
+
+
+class TwilioWebhookHandler(object):
+
+    def __init__(self):
+        self.app = Flask(self.__class__.__name__)
+        self.app.add_url_rule('/', 'index', self.index, methods=['GET'])
+        self.app.add_url_rule('/health', 'health', self.health, methods=['GET'])
+        self.app.add_url_rule('/message', 'message', self.message, methods=['POST'])
+        self.app.add_url_rule('/call', 'call', self.call, methods=['POST'])
+
+    def set_bot(self, bot):  # noqa: WPS615
+        self.bot = bot
+
+    def index(self):
+        return ''
+
+    def health(self):
+        return '<h1>Smsbot v{0}</h1><p><b>Owner</b>: {1}</p><p><b>Subscribers</b>: {2}</p>'.format(get_smsbot_version(), self.bot.owner_id, self.bot.subscriber_ids)
+
+    @validate_twilio_request
+    def message(self):
+        current_app.logger.info('Received SMS from {From}: {Body}'.format(**request.values.to_dict()))
+
+        message = 'From: {From}\n\n{Body}'.format(**request.values.to_dict())
+        self.bot.send_subscribers(message)
+
+        # Return a blank response
+        return '<response></response>'
+
+    @validate_twilio_request
+    def call(self):
+        current_app.logger.info('Received Call from {From}'.format(**request.values.to_dict()))
+        self.bot.send_subscribers('Received Call from {From}, rejecting.'.format(**request.values.to_dict()))
+
+        # Always reject calls
+        return '<Response><Reject/></Response>'
+
+    def serve(self, host='0.0.0.0', port=80, debug=False):
+        serve(self.app, host=host, port=port)