Version 0.0.4

This reverts commit 692a7eab37.

.github/workflows/build-container.yaml

@@ -24,7 +24,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v4
         with:
           push: true
           tags: |

.github/workflows/lint.yaml

@@ -18,4 +18,4 @@ jobs:
         uses: actions/checkout@v3
 
       - name: wemake-python-styleguide
-        uses: wemake-services/wemake-python-styleguide@0.16.1
+        uses: wemake-services/wemake-python-styleguide@0.17.0

.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@v3
+        with:
+          version: v3.6.3
+
+      - name: Run chart-releaser
+        uses: helm/chart-releaser-action@v1.5.0
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          CR_RELEASE_NAME_TEMPLATE: "smsbot-helm-chart-{{ .Version }}"

.github/workflows/release.yaml

@@ -13,6 +13,8 @@ jobs:
         uses: actions/checkout@v3
 
       - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10' 
       - run: pip install -r requirements-dev.txt
 
       - name: Build Assets

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-alpine
+FROM python:3.11-alpine
 WORKDIR /app
 COPY . /app
 RUN pip install .

README.md

@@ -22,3 +22,16 @@ All configuration is provided via environment variables
 | 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              |
+
+## Setup
+
+To configure SMSBot, you'll need a Twilio account, either paid or trial is fine. 
+
+* Setup a number in the location you want.
+* Under Phone Numbers -> Manage -> Active Numbers, click the number you want to setup.
+* In the "Voice & Fax" section, update the "A Call Comes In" to the URL of your SMSBot instance, with the endpoint being `/call`, e.g. `http://mymachine.test.com/call`
+* In the "Messaging" section, update the "A Message Comes In" to the URL of your SMSBot instance, with the endpoint being `/message`, e.g. `http://mymachine.test.com/message`
+
+Your bot should now receive messages, on Telegram you need to start a chat or invite it into any channels you want, then update the `SMSBOT_DEFAULT_SUBSCRIBERS` values with their IDs.
+
+**Note**: You cannot send test messages from your Twilio account to your Twilio numbers, they'll be silently dropped or fail with an "Invalid Number" error.

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.4
+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.5.2

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

requirements.txt

@@ -1,4 +1,5 @@
 flask
 waitress
 twilio
-python-telegram-bot
+python-telegram-bot
+prometheus_client

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = smsbot
-version = 0.0.2
+version = 0.0.4
 description = A simple Telegram bot to receive SMS messages.
 long_description = file: README.md, LICENSE
 license = MIT
@@ -9,7 +9,7 @@ classifiers =
     Framework :: Flask
     License :: OSI Approved :: MIT License
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.11
 
 [options]
 zip_safe = False
@@ -19,15 +19,16 @@ install_requires =
     flask
     waitress
     twilio
-    python-telegram-bot
+    python-telegram-bot<=14
+    prometheus_client
 
 [options.entry_points]
 console_scripts =
-        smsbot = smsbot:main
+        smsbot = smsbot.cli:main
 
 [flake8]
 format = wemake
-ignore = D,E501,WPS432,WPS323,WPS2,S104,WPS412
+ignore = D,E501,WPS432,WPS323,WPS2,S104,WPS412,WPS100
 max-line-length = 120
 exclude = setup.py,env,build
 

smsbot/__init__.py

@@ -1,184 +0,0 @@
-import logging
-import os
-import sys
-from functools import wraps
-
-import pkg_resources
-from flask import Flask, abort, current_app, request
-from telegram.ext import CommandHandler, Updater
-from twilio.request_validator import RequestValidator
-from waitress import serve
-
-pkg_version = pkg_resources.require('smsbot')[0].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(pkg_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)
-
-
-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(pkg_version, self.bot.owner_id, self.bot.subscriber_ids)
-
-    @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)
-
-    # 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/__main__.py

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

smsbot/cli.py

@@ -0,0 +1,46 @@
+import argparse
+import logging
+import os
+
+import pkg_resources
+
+from smsbot.telegram import TelegramSmsBot
+from smsbot.webhook_handler import TwilioWebhookHandler
+
+pkg_version = pkg_resources.require('smsbot')[0].version
+
+
+def main():
+    parser = argparse.ArgumentParser('smsbot')
+    parser.add_argument('--listen-host', default=os.environ.get('SMSBOT_LISTEN_HOST') or '0.0.0.0')
+    parser.add_argument('--listen-port', default=os.environ.get('SMSBOT_LISTEN_PORT') or '80')
+    parser.add_argument('--telegram-bot-token', default=os.environ.get('SMSBOT_TELEGRAM_BOT_TOKEN'))
+    parser.add_argument('--owner-id', default=os.environ.get('SMSBOT_OWNER_ID'))
+    parser.add_argument('--default-subscribers', default=os.environ.get('SMSBOT_DEFAULT_SUBSCRIBERS'))
+    parser.add_argument('--log-level', default='INFO')
+    args = parser.parse_args()
+
+    logging.basicConfig(level=logging.getLevelName(args.log_level))
+    logging.info('smsbot v%s', pkg_version)
+    logging.debug('Arguments: %s', args)
+
+    # Start bot
+    telegram_bot = TelegramSmsBot(args.telegram_bot_token)
+
+    # Set the owner ID if configured
+    if args.owner_id:
+        telegram_bot.set_owner(args.owner_id)
+    else:
+        logging.warning('No Owner ID is set, which is not a good idea...')
+
+    # Add default subscribers
+    if args.default_subscribers:
+        for chat_id in args.default_subscribers.split(','):
+            telegram_bot.add_subscriber(chat_id)
+
+    telegram_bot.start()
+
+    # Start webhooks
+    webhooks = TwilioWebhookHandler()
+    webhooks.set_bot(telegram_bot)
+    webhooks.serve(host=args.listen_host, port=args.listen_port)

smsbot/telegram.py

@@ -0,0 +1,97 @@
+import logging
+
+from prometheus_client import Counter, Summary
+from telegram.ext import CommandHandler, Updater
+
+from smsbot.utils import get_smsbot_version
+
+REQUEST_TIME = Summary('telegram_request_processing_seconds', 'Time spent processing request')
+COMMAND_COUNT = Counter('telegram_command_count', 'Total number of commands processed')
+
+
+class TelegramSmsBot(object):
+
+    def __init__(self, telegram_token, allow_subscribing=False, owner=None, subscribers=None):
+        self.logger = logging.getLogger(self.__class__.__name__)
+        self.bot_token = telegram_token
+        self.subscriber_ids = subscribers or []
+        self.set_owner(owner)
+
+        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))
+
+        if allow_subscribing:
+            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)
+
+    def start(self):
+        self.logger.info('Starting bot...')
+        self.updater.start_polling()
+        self.bot = self.updater.bot
+        self.logger.info('Bot Ready')
+
+    def stop(self):
+        self.updater.stop()
+
+    @REQUEST_TIME.time()
+    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)
+
+        commands = []
+        for command in self.updater.dispatcher.handlers[0]:
+            commands.extend(['/{0}'.format(cmd) for cmd in command.command])
+
+        update.message.reply_markdown('Smsbot v{0}\n\n{1}'.format(get_smsbot_version(), '\n'.join(commands)))
+        COMMAND_COUNT.inc()
+
+    @REQUEST_TIME.time()
+    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')
+        COMMAND_COUNT.inc()
+
+    @REQUEST_TIME.time()
+    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')
+        COMMAND_COUNT.inc()
+
+    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
+        if self.owner_id and self.owner_id not in self.subscriber_ids:
+            self.subscriber_ids.append(self.owner_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,98 @@
+
+import os
+from functools import wraps
+
+from flask import Flask, abort, current_app, request
+from prometheus_client import Counter, Summary, make_wsgi_app
+from twilio.request_validator import RequestValidator
+from waitress import serve
+from werkzeug.middleware.dispatcher import DispatcherMiddleware
+
+from smsbot.utils import get_smsbot_version
+
+REQUEST_TIME = Summary('webhook_request_processing_seconds', 'Time spent processing request')
+MESSAGE_COUNT = Counter('webhook_message_count', 'Total number of messages processed')
+CALL_COUNT = Counter('webhook_call_count', 'Total number of calls processed')
+
+
+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'])
+
+        # Add prometheus wsgi middleware to route /metrics requests
+        self.app.wsgi_app = DispatcherMiddleware(self.app.wsgi_app, {
+            '/metrics': make_wsgi_app(),
+        })
+
+    def set_bot(self, bot):  # noqa: WPS615
+        self.bot = bot
+
+    def index(self):
+        return ''
+
+    @REQUEST_TIME.time()
+    def health(self):
+        return {
+            'version': get_smsbot_version(),
+            'owner': self.bot.owner_id,
+            'subscribers': self.bot.subscriber_ids,
+        }
+
+    @REQUEST_TIME.time()
+    @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
+        MESSAGE_COUNT.inc()
+        return '<response></response>'
+
+    @REQUEST_TIME.time()
+    @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
+        CALL_COUNT.inc()
+        return '<Response><Reject/></Response>'
+
+    def serve(self, host='0.0.0.0', port=80, debug=False):
+        serve(self.app, host=host, port=port)