aboutsummaryrefslogtreecommitdiffstats
path: root/examples/permissionsexample/views.py
blob: 0bc31b270defa9039145486e4f2dc8ed83ba41a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
from djangorestframework.views import View
from djangorestframework.response import Response
from djangorestframework.permissions import PerUserThrottling, IsAuthenticated
from djangorestframework.utils import reverse


class PermissionsExampleView(View):
    """
    A container view for permissions examples.
    """

    def get(self, request):
        return Response([
            {
                'name': 'Throttling Example',
                'url': reverse('throttled-resource', request)
            },
            {
                'name': 'Logged in example',
                'url': reverse('loggedin-resource', request)
            },
        ])


class ThrottlingExampleView(View):
    """
    A basic read-only View that has a **per-user throttle** of 10 requests per minute.

    If a user exceeds the 10 requests limit within a period of one minute, the
    throttle will be applied until 60 seconds have passed since the first request.
    """

    permissions = (PerUserThrottling,)
    throttle = '10/min'

    def get(self, request):
        """
        Handle GET requests.
        """
        return Response("Successful response to GET request because throttle is not yet active.")


class LoggedInExampleView(View):
    """
    You can login with **'test', 'test'.** or use curl:

    `curl -X GET -H 'Accept: application/json' -u test:test http://localhost:8000/permissions-example`
    """

    permissions = (IsAuthenticated, )

    def get(self, request):
        return Response('You have permission to view this resource')