Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 1 | """REST API for accessing heartbeats.""" |
| 2 | |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 3 | from django.shortcuts import get_object_or_404 |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 4 | from django.utils.decorators import method_decorator |
| 5 | from drf_yasg import openapi |
| 6 | from drf_yasg.utils import swagger_auto_schema |
| 7 | from rest_framework import generics, status |
| 8 | from rest_framework.exceptions import NotFound, ValidationError |
| 9 | |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 10 | from crashreports.models import HeartBeat |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 11 | from crashreports.permissions import HasRightsOrIsDeviceOwnerDeviceCreation |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 12 | from crashreports.response_descriptions import default_desc |
| 13 | from crashreports.serializers import HeartBeatSerializer |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 14 | |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 15 | # TODO: There is quite some code duplciation between here and the corresponding |
| 16 | # crashreport code. We should revisit this later. |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 17 | |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 18 | |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 19 | @method_decorator( |
| 20 | name="get", |
| 21 | decorator=swagger_auto_schema(operation_description="List heartbeats"), |
| 22 | ) |
| 23 | @method_decorator( |
| 24 | name="post", |
| 25 | decorator=swagger_auto_schema( |
| 26 | operation_description="Create a heartbeat", |
| 27 | request_body=HeartBeatSerializer, |
| 28 | responses=dict( |
| 29 | [ |
| 30 | default_desc(ValidationError), |
| 31 | ( |
| 32 | status.HTTP_404_NOT_FOUND, |
| 33 | openapi.Response( |
| 34 | "No device with the given uuid could be found." |
| 35 | ), |
| 36 | ), |
| 37 | ] |
| 38 | ), |
| 39 | ), |
| 40 | ) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 41 | class ListCreateView(generics.ListCreateAPIView): |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 42 | """Endpoint for listing heartbeats and creating new heartbeats.""" |
| 43 | |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 44 | queryset = HeartBeat.objects.all() |
| 45 | paginate_by = 20 |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 46 | permission_classes = (HasRightsOrIsDeviceOwnerDeviceCreation,) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 47 | serializer_class = HeartBeatSerializer |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 48 | filter_fields = ("device", "build_fingerprint", "radio_version") |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 49 | |
| 50 | def get(self, *args, **kwargs): |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 51 | """Override device__uuid parameter with uuid.""" |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 52 | if "uuid" in kwargs: |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 53 | self.queryset = HeartBeat.objects.filter( |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 54 | device__uuid=kwargs["uuid"] |
| 55 | ) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 56 | return generics.ListCreateAPIView.get(self, *args, **kwargs) |
| 57 | |
| 58 | |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 59 | @method_decorator( |
| 60 | name="get", |
| 61 | decorator=swagger_auto_schema( |
| 62 | operation_description="Get a heartbeat", |
| 63 | responses=dict([default_desc(NotFound)]), |
| 64 | ), |
| 65 | ) |
| 66 | @method_decorator( |
| 67 | name="put", |
| 68 | decorator=swagger_auto_schema( |
| 69 | operation_description="Update a heartbeat", |
| 70 | responses=dict([default_desc(NotFound), default_desc(ValidationError)]), |
| 71 | ), |
| 72 | ) |
| 73 | @method_decorator( |
| 74 | name="patch", |
| 75 | decorator=swagger_auto_schema( |
| 76 | operation_description="Partially update a heartbeat", |
| 77 | responses=dict([default_desc(NotFound), default_desc(ValidationError)]), |
| 78 | ), |
| 79 | ) |
| 80 | @method_decorator( |
| 81 | name="delete", |
| 82 | decorator=swagger_auto_schema( |
| 83 | operation_description="Delete a heartbeat", |
| 84 | responses=dict([default_desc(NotFound)]), |
| 85 | ), |
| 86 | ) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 87 | class RetrieveUpdateDestroyView(generics.RetrieveUpdateDestroyAPIView): |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 88 | """Endpoint for retrieving, updating and deleting heartbeats.""" |
| 89 | |
| 90 | # pylint: disable=too-many-ancestors |
| 91 | |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 92 | queryset = HeartBeat.objects.all() |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 93 | permission_classes = (HasRightsOrIsDeviceOwnerDeviceCreation,) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 94 | serializer_class = HeartBeatSerializer |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 95 | multiple_lookup_fields = {"id", "device__uuid", "device_local_id"} |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 96 | |
| 97 | def get_object(self): |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 98 | """Retrieve a heartbeat.""" |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 99 | queryset = self.get_queryset() |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 100 | query_filter = {} |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 101 | for field in self.multiple_lookup_fields: |
| 102 | if field in self.kwargs: |
Mitja Nikolaus | 1280ef4 | 2018-08-21 16:20:07 +0200 | [diff] [blame] | 103 | query_filter[field] = self.kwargs[field] |
| 104 | obj = get_object_or_404(queryset, **query_filter) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 105 | self.check_object_permissions(self.request, obj) |
| 106 | return obj |