Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 1 | """REST API for accessing devices.""" |
| 2 | |
| 3 | from django.contrib.auth.models import Permission |
| 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 | from rest_framework.authtoken.models import Token |
| 10 | from rest_framework.decorators import api_view, permission_classes |
| 11 | from rest_framework.permissions import AllowAny |
| 12 | from rest_framework.response import Response |
| 13 | |
| 14 | from crashreports.models import Device, User |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 15 | from crashreports.permissions import ( |
| 16 | HasRightsOrIsDeviceOwnerDeviceCreation, |
| 17 | SWAGGER_SECURITY_REQUIREMENTS_ALL, |
| 18 | ) |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 19 | from crashreports.serializers import DeviceSerializer, DeviceCreateSerializer |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 20 | from crashreports.response_descriptions import default_desc |
Dirk Vogt | 7160b5e | 2016-10-12 17:04:40 +0200 | [diff] [blame] | 21 | |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 22 | |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 23 | @method_decorator( |
| 24 | name="get", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 25 | decorator=swagger_auto_schema( |
| 26 | operation_description="List devices", |
| 27 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
| 28 | ), |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 29 | ) |
| 30 | @method_decorator( |
| 31 | name="post", |
| 32 | decorator=swagger_auto_schema( |
| 33 | operation_description="Create a device", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 34 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 35 | responses=dict([default_desc(ValidationError)]), |
| 36 | ), |
| 37 | ) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 38 | class ListCreateDevices(generics.ListCreateAPIView): |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 39 | """Endpoint for listing devices and creating new devices.""" |
| 40 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 41 | queryset = Device.objects.all() |
| 42 | paginate_by = 20 |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 43 | permission_classes = (HasRightsOrIsDeviceOwnerDeviceCreation,) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 44 | serializer_class = DeviceSerializer |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 45 | filter_fields = ("uuid", "board_date", "chipset") |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 46 | |
Dirk Vogt | 7160b5e | 2016-10-12 17:04:40 +0200 | [diff] [blame] | 47 | |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 48 | @method_decorator( |
| 49 | name="get", |
| 50 | decorator=swagger_auto_schema( |
| 51 | operation_description="Get a device", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 52 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 53 | responses=dict([default_desc(NotFound)]), |
| 54 | ), |
| 55 | ) |
| 56 | @method_decorator( |
| 57 | name="put", |
| 58 | decorator=swagger_auto_schema( |
| 59 | operation_description="Update a device", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 60 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 61 | responses=dict([default_desc(NotFound), default_desc(ValidationError)]), |
| 62 | ), |
| 63 | ) |
| 64 | @method_decorator( |
| 65 | name="patch", |
| 66 | decorator=swagger_auto_schema( |
| 67 | operation_description="Make a partial update for a device", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 68 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 69 | responses=dict([default_desc(NotFound), default_desc(ValidationError)]), |
| 70 | ), |
| 71 | ) |
| 72 | @method_decorator( |
| 73 | name="delete", |
| 74 | decorator=swagger_auto_schema( |
| 75 | operation_description="Delete a device", |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 76 | security=SWAGGER_SECURITY_REQUIREMENTS_ALL, |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 77 | responses=dict([default_desc(NotFound)]), |
| 78 | ), |
| 79 | ) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 80 | class RetrieveUpdateDestroyDevice(generics.RetrieveUpdateDestroyAPIView): |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 81 | """Endpoint for retrieving, updating, patching and deleting devices.""" |
| 82 | |
| 83 | # pylint: disable=too-many-ancestors |
| 84 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 85 | queryset = Device.objects.all() |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 86 | permission_classes = (HasRightsOrIsDeviceOwnerDeviceCreation,) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 87 | serializer_class = DeviceSerializer |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 88 | lookup_field = "uuid" |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 89 | |
Dirk Vogt | 7160b5e | 2016-10-12 17:04:40 +0200 | [diff] [blame] | 90 | |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 91 | class DeviceRegisterResponseSchema(DeviceSerializer): |
| 92 | """Response schema for successful device registration.""" |
| 93 | |
| 94 | class Meta: # noqa: D106 |
| 95 | model = Device |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 96 | fields = ["uuid", "token"] |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 97 | |
| 98 | |
| 99 | @swagger_auto_schema( |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 100 | method="post", |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 101 | request_body=DeviceCreateSerializer, |
Mitja Nikolaus | 4d759da | 2018-08-28 15:31:29 +0200 | [diff] [blame] | 102 | security=[], |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 103 | responses=dict( |
| 104 | [ |
| 105 | default_desc(ValidationError), |
| 106 | ( |
| 107 | status.HTTP_200_OK, |
| 108 | openapi.Response( |
| 109 | "The device has been successfully registered.", |
| 110 | DeviceRegisterResponseSchema, |
| 111 | ), |
| 112 | ), |
| 113 | ] |
| 114 | ), |
| 115 | ) |
| 116 | @api_view(http_method_names=["POST"]) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 117 | @permission_classes((AllowAny,)) |
| 118 | def register_device(request): |
Mitja Nikolaus | e920808 | 2018-07-30 14:22:09 +0200 | [diff] [blame] | 119 | """Register a new device. |
| 120 | |
| 121 | This endpoint will generate a django user for the new device. The device is |
| 122 | identified by a uuid, and authenticated with a token. |
Dirk Vogt | 7160b5e | 2016-10-12 17:04:40 +0200 | [diff] [blame] | 123 | We generate the uuid here as this makes it easier to deal with collisions. |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 124 | """ |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 125 | serializer = DeviceCreateSerializer(data=request.data) |
| 126 | serializer.is_valid(raise_exception=True) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 127 | device = Device() |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 128 | user = User.objects.create_user("device_" + str(device.uuid), "", None) |
| 129 | permission = Permission.objects.get(name="Can add crashreport") |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 130 | user.user_permissions.add(permission) |
| 131 | user.save() |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 132 | device.board_date = serializer.validated_data["board_date"] |
| 133 | device.chipset = serializer.validated_data["chipset"] |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 134 | device.user = user |
Dirk Vogt | 7160b5e | 2016-10-12 17:04:40 +0200 | [diff] [blame] | 135 | device.token = Token.objects.create(user=user).key |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 136 | device.save() |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 137 | return Response({"uuid": device.uuid, "token": device.token}) |