oncall-engine/engine/apps/twilioapp/views.py
Joey Orlando 9dde1805aa
add mypy static type checker to backend codebase (#2151)
# What this PR does

- Adds [`mypy` static type checking](https://mypy-lang.org/) to our CI
pipeline. Currently there is still a **ton** of errors being returned by
the tool, as we'll need to fix pre-existing errors. I think we can
slowly chip away at these errors in small PRs, doing them all in one
large PR is likely very risky.
- Also, this PR starts chipping away at one of the main type errors that
we have which is accessing the `datetime` class (from the `datetime`
library) or `timedelta` function on the `django.utils.timezone` module.
Basically we should be instead accessing these two objects from the
native `datetime` module. This makes sense because the [`__all__`
attribute](https://github.com/django/django/blob/main/django/utils/timezone.py#L14-L30)
in `django.utils.timezone` does not re-export `datetime` or `timedelta`.
- splits `engine` dependencies out into `requirements.txt` and
`requirements-dev.txt`

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated (N/A)
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required) (N/A)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required) (N/A)
2023-06-12 12:50:33 -04:00

85 lines
3.1 KiB
Python

import logging
from django.apps import apps
from django.http import HttpResponse
from rest_framework import status
from rest_framework.permissions import BasePermission
from rest_framework.response import Response
from rest_framework.views import APIView
from twilio.request_validator import RequestValidator
from apps.base.utils import live_settings
from common.api_helpers.utils import create_engine_url
from .gather import process_gather_data
from .status_callback import update_twilio_call_status, update_twilio_sms_status
logger = logging.getLogger(__name__)
class AllowOnlyTwilio(BasePermission):
# https://www.twilio.com/docs/usage/tutorials/how-to-secure-your-django-project-by-validating-incoming-twilio-requests
# https://www.django-rest-framework.org/api-guide/permissions/
def has_permission(self, request, view):
request_account_sid = request.data.get("AccountSid")
if not request_account_sid:
return False
TwilioAccount = apps.get_model("twilioapp", "TwilioAccount")
account = TwilioAccount.objects.filter(account_sid=request_account_sid).first()
if account:
return self.validate_request(request, account.account_sid, account.auth_token)
return self.validate_request(request, live_settings.TWILIO_ACCOUNT_SID, live_settings.TWILIO_AUTH_TOKEN)
def validate_request(self, request, expected_account_sid, auth_token):
if auth_token:
validator = RequestValidator(auth_token)
location = create_engine_url(request.get_full_path())
request_valid = validator.validate(
request.build_absolute_uri(location=location),
request.POST,
request.META.get("HTTP_X_TWILIO_SIGNATURE", ""),
)
return request_valid
else:
return expected_account_sid == request.data["AccountSid"]
class HealthCheckView(APIView):
def get(self, request):
return Response("OK")
class GatherView(APIView):
permission_classes = [AllowOnlyTwilio]
def post(self, request):
call_sid = request.POST.get("CallSid")
digit = request.POST.get("Digits")
response = process_gather_data(call_sid, digit)
return HttpResponse(str(response), content_type="application/xml; charset=utf-8")
# Receive SMS Status Update from Twilio
class SMSStatusCallback(APIView):
permission_classes = [AllowOnlyTwilio]
def post(self, request):
message_sid = request.POST.get("MessageSid")
message_status = request.POST.get("MessageStatus")
update_twilio_sms_status(message_sid=message_sid, message_status=message_status)
return Response(data="", status=status.HTTP_204_NO_CONTENT)
# Receive Call Status Update from Twilio
class CallStatusCallback(APIView):
permission_classes = [AllowOnlyTwilio]
def post(self, request):
call_sid = request.POST.get("CallSid")
call_status = request.POST.get("CallStatus")
update_twilio_call_status(call_sid=call_sid, call_status=call_status)
return Response(data="", status=status.HTTP_204_NO_CONTENT)