Merge pull request #21 from Worth-NL/feature/clients/sms/spryng

Spryng client

Author: pgaetani

.gitignore

@@ -68,6 +68,7 @@ target/
 # Mac
 *.DS_Store
 environment.sh
+environment.fish
 .envrc
 
 celerybeat-schedule

app/__init__.py

@@ -37,6 +37,7 @@
 from app.clients.letter.dvla import DVLAClient
 from app.clients.sms.firetext import FiretextClient
 from app.clients.sms.mmg import MMGClient
+from app.clients.sms.spryng import SpryngClient
 
 db = SQLAlchemy()
 migrate = Migrate()
@@ -47,6 +48,7 @@
 aws_ses_client = AwsSesClient()
 aws_ses_stub_client = AwsSesStubClient()
 dvla_client = DVLAClient()
+spryng_client = SpryngClient()
 signing = Signing()
 zendesk_client = ZendeskClient()
 statsd_client = StatsdClient()
@@ -90,14 +92,17 @@ def create_app(application):
     logging.init_app(application, statsd_client)
     firetext_client.init_app(application, statsd_client=statsd_client)
     mmg_client.init_app(application, statsd_client=statsd_client)
+    spryng_client.init_app(application, statsd_client=statsd_client)
     dvla_client.init_app(application, statsd_client=statsd_client)
     aws_ses_client.init_app(application.config["AWS_REGION"], statsd_client=statsd_client)
     aws_ses_stub_client.init_app(
         application.config["AWS_REGION"], statsd_client=statsd_client, stub_url=application.config["SES_STUB_URL"]
     )
     # If a stub url is provided for SES, then use the stub client rather than the real SES boto client
     email_clients = [aws_ses_stub_client] if application.config["SES_STUB_URL"] else [aws_ses_client]
-    notification_provider_clients.init_app(sms_clients=[firetext_client, mmg_client], email_clients=email_clients)
+    notification_provider_clients.init_app(
+        sms_clients=[firetext_client, mmg_client, spryng_client], email_clients=email_clients
+    )
 
     notify_celery.init_app(application)
     signing.init_app(application)
@@ -411,8 +416,7 @@ def checkout(dbapi_connection, connection_record, connection_proxy):
                 elif current_task:
                     connection_record.info["request_data"] = {
                         "method": "celery",
-                        # worker name
-                        "host": current_app.config["NOTIFY_APP_NAME"],
+                        "host": current_app.config["NOTIFY_APP_NAME"],  # worker name
                         "url_rule": current_task.name,  # task name
                     }
                 # anything else. migrations possibly, or flask cli commands.

app/celery/process_sms_client_response_tasks.py

@@ -8,17 +8,15 @@
 from app.clients import ClientException
 from app.clients.sms.firetext import get_firetext_responses
 from app.clients.sms.mmg import get_mmg_responses
+from app.clients.sms.spryng import get_spryng_responses
 from app.constants import NOTIFICATION_PENDING
 from app.dao import notifications_dao
 from app.dao.templates_dao import dao_get_template_by_id
 from app.notifications.notifications_ses_callback import (
     check_and_queue_callback_task,
 )
 
-sms_response_mapper = {
-    "MMG": get_mmg_responses,
-    "Firetext": get_firetext_responses,
-}
+sms_response_mapper = {"MMG": get_mmg_responses, "Firetext": get_firetext_responses, "Spryng": get_spryng_responses}
 
 
 @notify_celery.task(bind=True, name="process-sms-client-response", max_retries=5, default_retry_delay=300)

app/clients/sms/spryng.py

@@ -0,0 +1,77 @@
+import json
+import logging
+
+from requests import RequestException, request
+
+from app.clients.sms import SmsClient, SmsClientResponseException
+
+logger = logging.getLogger(__name__)
+
+spryng_response_map = {
+    "10": {"status": "delivered", "reasoncode": {"0": "No error"}},
+    "20": {
+        "status": "permanent-failure",
+        "reasoncode": {
+            "20": "Recipient number unreachable",
+            "21": "Recipient number incorrect",
+            "22": "Delivery failure",
+            "31": "The recipient is blacklisted",
+            "32": "The originator is not registered for this country",
+        },
+    },
+}
+
+
+def get_spryng_responses(status, detailed_status_code=None):
+    return (
+        spryng_response_map[status]["status"],
+        spryng_response_map[status]["reasoncode"].get(detailed_status_code, None),
+    )
+
+
+class SpryngClient(SmsClient):
+    """
+    Spryng sms client.
+    """
+
+    def init_app(self, *args, **kwargs):
+        super().init_app(*args, **kwargs)
+        self.api_key = self.current_app.config.get("SPRYNG_API_KEY")
+        self.url = self.current_app.config.get("SPRYNG_URL")
+
+    @property
+    def name(self):
+        return "spryng"
+
+    def try_send_sms(self, to, content, reference, international, sender):
+        data = {
+            "originator": sender,
+            "recipients": [to.replace("+", "")],
+            "body": content,
+            "reference": reference,
+            "route": "business",
+            "encoding": "unicode",
+        }
+
+        try:
+            response = request(
+                "POST",
+                self.url,
+                data=json.dumps(data),
+                timeout=60,
+                headers={"Content-Type": "application/json", "Authorization": "Bearer {}".format(self.api_key)},
+            )
+
+            response.raise_for_status()
+
+            try:
+                json.loads(response.text)
+
+                if response.status_code != 200:
+                    raise ValueError("Expected 'status code' to be '200'")
+            except (ValueError, AttributeError) as e:
+                raise SmsClientResponseException("Invalid response JSON") from e
+        except RequestException as e:
+            raise SmsClientResponseException("Request failed") from e
+
+        return response

app/config.py

@@ -102,6 +102,9 @@ class Config(object):
     FIRETEXT_API_KEY = os.getenv("FIRETEXT_API_KEY")
     FIRETEXT_INTERNATIONAL_API_KEY = os.getenv("FIRETEXT_INTERNATIONAL_API_KEY", "placeholder")
 
+    # Spryng API key
+    SPRYNG_API_KEY = os.environ.get("SPRYNG_API_KEY")
+
     # Prefix to identify queues in SQS
     NOTIFICATION_QUEUE_PREFIX = os.getenv("NOTIFICATION_QUEUE_PREFIX")
 
@@ -154,7 +157,7 @@ class Config(object):
     CHECK_PROXY_HEADER = False
 
     # these should always add up to 100%
-    SMS_PROVIDER_RESTING_POINTS = {"mmg": 51, "firetext": 49}
+    SMS_PROVIDER_RESTING_POINTS = {"mmg": 0, "firetext": 0, "spryng": 100}
 
     NOTIFY_SERVICE_ID = "d6aa2c68-a2d9-4437-ab19-3ae8eb202553"
     NOTIFY_USER_ID = "6af522d0-2915-4e52-83a3-3690455a5fe6"
@@ -275,12 +278,14 @@ class Config(object):
             },
             "create-nightly-notification-status": {
                 "task": "create-nightly-notification-status",
-                "schedule": crontab(hour=0, minute=30),  # after 'timeout-sending-notifications'
+                # after 'timeout-sending-notifications'
+                "schedule": crontab(hour=0, minute=30),
                 "options": {"queue": QueueNames.REPORTING},
             },
             "delete-notifications-older-than-retention": {
                 "task": "delete-notifications-older-than-retention",
-                "schedule": crontab(hour=3, minute=0),  # after 'create-nightly-notification-status'
+                # after 'create-nightly-notification-status'
+                "schedule": crontab(hour=3, minute=0),
                 "options": {"queue": QueueNames.REPORTING},
             },
             "delete-inbound-sms": {
@@ -416,6 +421,7 @@ class Config(object):
     # these environment vars aren't defined in the manifest so to set them on paas use `cf set-env`
     MMG_URL = os.environ.get("MMG_URL", "https://api.mmg.co.uk/jsonv2a/api.php")
     FIRETEXT_URL = os.environ.get("FIRETEXT_URL", "https://www.firetext.co.uk/api/sendsms/json")
+    SPRYNG_URL = os.environ.get("SPRYNG_URL", "https://rest.spryngsms.com/v1/messages")
     SES_STUB_URL = os.environ.get("SES_STUB_URL")
 
     AWS_REGION = "eu-west-1"
@@ -446,8 +452,6 @@ class Config(object):
 ######################
 # Config overrides ###
 ######################
-
-
 class Development(Config):
     DEBUG = True
     SQLALCHEMY_ECHO = False

app/dao/provider_details_dao.py

@@ -24,11 +24,9 @@ def get_provider_details_by_identifier(identifier):
 
 
 def get_alternative_sms_provider(identifier):
-    if identifier == "firetext":
-        return "mmg"
-    elif identifier == "mmg":
-        return "firetext"
-    raise ValueError("Unrecognised sms provider {}".format(identifier))
+    if identifier in ["firetext", "mmg", "spryng"]:
+        return identifier
+    raise ValueError(f"Unrecognised sms provider {identifier}")
 
 
 def dao_get_provider_versions(provider_id):

app/notifications/notifications_sms_callback.py

@@ -50,6 +50,24 @@ def process_firetext_response():
     return jsonify(result="success"), 200
 
 
+@sms_callback_blueprint.route("/spryng", methods=["GET"])
+def process_spryng_response():
+    client_name = "Spryng"
+    errors = validate_callback_data(data=request.args, fields=["STATUS", "REASONCODE"], client_name=client_name)
+    if errors:
+        raise InvalidRequest(errors, status_code=400)
+
+    status = request.args.get("STATUS")
+    detailed_status_code = request.args.get("REASONCODE")
+    provider_reference = request.args.get("REFERENCE")
+
+    process_sms_client_response.apply_async(
+        [status, provider_reference, client_name, detailed_status_code], queue=QueueNames.SMS_CALLBACKS
+    )
+
+    return jsonify(result="success"), 200
+
+
 def validate_callback_data(data, fields, client_name):
     errors = []
     for f in fields:

migrations/versions/0443_add_spryng_provider.py

@@ -0,0 +1,30 @@
+"""
+
+Revision ID: 0443_add_spryng_provider
+Revises: 0442_new_sms_allowance_n_rate
+Create Date: 2024-05-07 13:05:00.000000
+
+"""
+
+import uuid
+from datetime import datetime
+
+from alembic import op
+
+
+revision = "0443_add_spryng_provider"
+down_revision = "0442_new_sms_allowance_n_rate"
+
+
+identifier = "spryng"
+provider_id = str(uuid.uuid4())
+
+
+def upgrade():
+    op.execute(
+        f"INSERT INTO provider_details (id, display_name, identifier, priority, notification_type, active, version, supports_international) values ('{provider_id}', '{identifier.capitalize()}', '{identifier}', 30, 'sms', true, 1, true)"
+    )
+
+
+def downgrade():
+    op.execute(f"DELETE FROM provider_details WHERE identifier = '{identifier}'")