Use pinpoint for designated templates

app/__init__.py

@@ -29,6 +29,7 @@
 )
 from app.clients.salesforce.salesforce_client import SalesforceClient
 from app.clients.sms.aws_sns import AwsSnsClient
+from app.clients.sms.aws_pinpoint import AwsPinpointClient
 from app.dbsetup import RoutingSQLAlchemy
 from app.encryption import CryptoSigner
 from app.json_provider import NotifyJSONProvider
@@ -45,6 +46,7 @@
 notify_celery = NotifyCelery()
 aws_ses_client = AwsSesClient()
 aws_sns_client = AwsSnsClient()
+aws_pinpoint_client = AwsPinpointClient()
 signer_notification = CryptoSigner()
 signer_personalisation = CryptoSigner()
 signer_complaint = CryptoSigner()
@@ -107,6 +109,7 @@ def create_app(application, config=None):
     statsd_client.init_app(application)
     logging.init_app(application, statsd_client)
     aws_sns_client.init_app(application, statsd_client=statsd_client)
+    aws_pinpoint_client.init_app(application, statsd_client=statsd_client)
     aws_ses_client.init_app(application.config["AWS_REGION"], statsd_client=statsd_client)
     notify_celery.init_app(application)
 
@@ -120,7 +123,7 @@ def create_app(application, config=None):
 
     performance_platform_client.init_app(application)
     document_download_client.init_app(application)
-    clients.init_app(sms_clients=[aws_sns_client], email_clients=[aws_ses_client])
+    clients.init_app(sms_clients=[aws_sns_client, aws_pinpoint_client], email_clients=[aws_ses_client])
 
     if application.config["FF_SALESFORCE_CONTACT"]:
         salesforce_client.init_app(application)

app/clients/sms/aws_pinpoint.py

@@ -0,0 +1,92 @@
+import boto3
+from botocore.exceptions import ClientError
+import phonenumbers
+from time import monotonic
+from app.clients.sms import SmsClient
+
+
+class AwsPinpointClient(SmsClient):
+    '''
+    AWS Pinpoint SMS client
+    '''
+
+    def init_app(self, current_app, statsd_client, *args, **kwargs):
+        self._client = boto3.client('pinpoint-sms-voice-v2', region_name="ca-central-1")
+        super(SmsClient, self).__init__(*args, **kwargs)
+        self.current_app = current_app
+        self.name = 'pinpoint'
+        self.statsd_client = statsd_client
+
+    def get_name(self):
+        return self.name
+
+    def send_sms(self, to, content, reference, multi=True, sender=None):
+
+
+        # The phone number or short code to send the message from. The phone number
+        # or short code that you specify has to be associated with your Amazon Pinpoint
+        # account. For best results, specify long codes in E.164 format.
+        # originationNumber = sender
+
+        # The recipient's phone number.  For best results, you should specify the
+        # phone number in E.164 format.
+        # destinationNumber = "+14255550142"
+
+        # The Amazon Pinpoint project/application ID to use when you send this message.
+        # Make sure that the SMS channel is enabled for the project or application
+        # that you choose.
+        applicationId = self.current_app.config['AWS_PINPOINT_APP_ID']
+
+        # The type of SMS message that you want to send. If you plan to send
+        # time-sensitive content, specify TRANSACTIONAL. If you plan to send
+        # marketing-related content, specify PROMOTIONAL.
+        messageType = "TRANSACTIONAL"
+
+        # The registered keyword associated with the originating short code.
+        registeredKeyword = self.current_app.config['AWS_PINPOINT_KEYWORD']
+        # The sender ID to use when sending the message. Support for sender ID
+        # varies by country or region. For more information, see
+        # https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
+        # senderId = "MySenderID"
+
+        matched = False
+
+        for match in phonenumbers.PhoneNumberMatcher(to, "US"):
+            matched = True
+            to = phonenumbers.format_number(match.number, phonenumbers.PhoneNumberFormat.E164)
+            destinationNumber = to
+
+            try:
+                start_time = monotonic()
+
+                # from https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/pinpoint-sms-voice-v2/client/send_text_message.html
+                response = self._client.send_text_message(
+                    DestinationPhoneNumber=destinationNumber,
+                    OriginationIdentity=self.pool_id,
+                    MessageBody=content,
+                    MessageType=messageType,
+                    Keyword=registeredKeyword                    
+                )
+
+                # this will be true if the OriginationIdentity does not exist in pinpoint
+                if response['MessageResponse']['Result'][destinationNumber]['StatusCode'] == 400:
+                    self.statsd_client.incr("clients.pinpoint.error")
+                    raise Exception(response['MessageResponse']['Result'][destinationNumber]['StatusMessage'])
+            except ClientError as e:
+                self.statsd_client.incr("clients.pinpoint.error")
+                raise Exception(e)
+            except Exception as e:
+                self.statsd_client.incr("clients.pinpoint.error")
+                raise Exception(e)
+            finally:
+                elapsed_time = monotonic() - start_time
+                self.current_app.logger.info("AWS Pinpoint request finished in {}".format(elapsed_time))
+                self.statsd_client.timing("clients.pinpoint.request-time", elapsed_time)
+                self.statsd_client.incr("clients.pinpoint.success")
+
+            return response['MessageResponse']['Result'][destinationNumber]['MessageId']
+
+        if not matched:
+            self.statsd_client.incr("clients.pinpoint.error")
+            self.current_app.logger.error("No valid numbers found in {}".format(to))
+            raise ValueError("No valid numbers found for SMS delivery")

app/delivery/send_to_providers.py

@@ -69,6 +69,8 @@
             notification.international,
             notification.reply_to_text,
         )
+
+
 
         template_dict = dao_get_template_by_id(notification.template_id, notification.template_version).__dict__
 
@@ -334,7 +336,7 @@
     dao_update_notification(notification)
 
 
 def provider_to_use(notification_type, notification_id, international=False, sender=None):
     active_providers_in_order = [
         p for p in get_provider_details_by_notification_type(notification_type, international) if p.active
     ]
@@ -343,7 +345,11 @@
         current_app.logger.error("{} {} failed as no active providers".format(notification_type, notification_id))
         raise Exception("No active {} providers".format(notification_type))
 
-    return clients.get_client_by_name_and_type(active_providers_in_order[0].identifier, notification_type)
+    # return clients.get_client_by_name_and_type(active_providers_in_order[0].identifier, notification_type)
+
+    if notification_type == SMS_TYPE:
+        return clients.get_client_by_name_and_type('pinpoint', notification_type)
+
 
 
 def get_html_email_options(service: Service):

app/models.py

@@ -1272,9 +1272,10 @@ def get_link(self):
 
 
 SNS_PROVIDER = "sns"
+PINPOINT_PROVIDER = 'pinpoint'
 SES_PROVIDER = "ses"
 
-SMS_PROVIDERS = [SNS_PROVIDER]
+SMS_PROVIDERS = [SNS_PROVIDER, PINPOINT_PROVIDER]
 EMAIL_PROVIDERS = [SES_PROVIDER]
 PROVIDERS = SMS_PROVIDERS + EMAIL_PROVIDERS