oncall-engine/engine/apps/zvonok/views.py
Vadim Stepanov b2f4ffb98a
apps.get_model -> import (#2619)
# What this PR does

Remove
[`apps.get_model`](https://docs.djangoproject.com/en/3.2/ref/applications/#django.apps.apps.get_model)
invocations and use inline `import` statements in places where models
are imported within functions/methods to avoid circular imports.

I believe `import` statements are more appropriate for most use cases as
they allow for better static code analysis & formatting, and solve the
issue of circular imports without being unnecessarily dynamic as
`apps.get_model`. With `import` statements, it's possible to:

- Jump to model definitions in most IDEs
- Automatically sort inline imports with `isort`
- Find import errors faster/easier (most IDEs highlight broken imports)
- Have more consistency across regular & inline imports when importing
models

This PR also adds a flake8 rule to ban imports of `django.apps.apps`, so
it's harder to use `apps.get_model` by mistake (it's possible to ignore
this rule by using `# noqa: I251`). The rule is not enforced on
directories with migration files, because `apps.get_model` is often used
to get a historical state of a model, which is useful when writing
migrations ([see this SO answer for more
details](https://stackoverflow.com/a/37769213)). So `apps.get_model` is
considered OK in migrations (even necessary in some cases).

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-07-25 09:43:23 +00:00

52 lines
1.8 KiB
Python

from rest_framework import status
from rest_framework.permissions import BasePermission
from rest_framework.response import Response
from rest_framework.views import APIView
from apps.base.utils import live_settings
from .status_callback import update_zvonok_call_status
class AllowOnlyZvonok(BasePermission):
def has_permission(self, request, view):
call_id = request.GET.get(live_settings.ZVONOK_POSTBACK_CALL_ID)
if not call_id:
return False
campaign_id = request.GET.get(live_settings.ZVONOK_POSTBACK_CAMPAIGN_ID)
if not campaign_id:
return False
if campaign_id != live_settings.ZVONOK_CAMPAIGN_ID:
return False
from apps.zvonok.models import ZvonokPhoneCall
call = ZvonokPhoneCall.objects.filter(call_id=call_id, campaign_id=campaign_id).first()
if call:
return self.validate_request(request)
return False
def validate_request(self, request):
if request.GET.get(live_settings.ZVONOK_POSTBACK_STATUS):
return True
return False
# Receive Call Status from Zvonok
class CallStatusCallback(APIView):
permission_classes = [AllowOnlyZvonok]
def get(self, request):
self._handle_call_status(request)
return Response(data="", status=status.HTTP_204_NO_CONTENT)
def post(self, request):
self._handle_call_status(request)
return Response(data="", status=status.HTTP_204_NO_CONTENT)
def _handle_call_status(self, request):
call_id = request.GET.get(live_settings.ZVONOK_POSTBACK_CALL_ID)
call_status = request.GET.get(live_settings.ZVONOK_POSTBACK_STATUS)
user_choice = request.GET.get(live_settings.ZVONOK_POSTBACK_USER_CHOICE)
update_zvonok_call_status(call_id=call_id, call_status=call_status, user_choice=user_choice)