planetstack/apigen/api.template.py

   1 from rest_framework.decorators import api_view
   2 from rest_framework.response import Response
   3 from rest_framework.reverse import reverse
   4 from rest_framework import serializers
   5 from rest_framework import generics
   6 from rest_framework import status
   7 from core.models import *
   8 from django.forms import widgets
   9 from rest_framework import filters
  10
  11 """
  12     Schema of the generator object:
  13         all: Set of all Model objects
  14         all_if(regex): Set of Model objects that match regex
  15
  16     Model object:
  17         plural: English plural of object name
  18         camel: CamelCase version of object name
  19         refs: list of references to other Model objects
  20         props: list of properties minus refs
  21
  22     TODO: Deal with subnets
  23 """
  24
  25 # Based on api_root.py
  26
  27 @api_view(['GET'])
  28 def api_root(request, format=None):
  29     return Response({
  30         {% for object in generator.all %}'{{ object.plural }}': reverse('{{ object }}-list', request=request, format=format),
  31         {% endfor %}
  32     })
  33
  34 # Based on serializers.py
  35
  36 {% for object in generator.all %}
  37
  38 class {{ object.camel }}Serializer(serializers.HyperlinkedModelSerializer):
  39     id = serializers.Field()
  40     {% for ref in object.refs %}
  41     {% if ref.multi %}
  42     {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
  43     {% else %}
  44     {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
  45     {% endif %}
  46     {% endfor %}
  47     class Meta:
  48         model = {{ object.camel }}
  49         fields = ({% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
  50
  51 class {{ object.camel }}IdSerializer(serializers.ModelSerializer):
  52     id = serializers.Field()
  53     {% for ref in object.refs %}
  54     {% if ref.multi %}
  55     {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
  56     {% else %}
  57     {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
  58     {% endif %}
  59     {% endfor %}
  60     class Meta:
  61         model = {{ object.camel }}
  62         fields = ({% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
  63
  64
  65 {% endfor %}
  66
  67 serializerLookUp = {
  68 {% for object in generator.all %}
  69                  {{ object.camel }}: {{ object.camel }}Serializer,
  70 {% endfor %}
  71                  None: None,
  72                 }
  73
  74 class PlanetStackRetrieveUpdateDestroyAPIView(generics.RetrieveUpdateDestroyAPIView):
  75
  76     # To handle fine-grained field permissions, we have to check can_update
  77     # the object has been updated but before it has been saved.
  78
  79     def update(self, request, *args, **kwargs):\r
  80         partial = kwargs.pop('partial', False)\r
  81         self.object = self.get_object_or_none()\r
  82 \r
  83         serializer = self.get_serializer(self.object, data=request.DATA,\r
  84                                          files=request.FILES, partial=partial)\r
  85 \r
  86         if not serializer.is_valid():\r
  87             print "UpdateModelMixin: not serializer.is_valid"\r
  88             print serializer.errors\r
  89             return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)\r
  90 \r
  91         try:\r
  92             self.pre_save(serializer.object)\r
  93         except ValidationError as err:\r
  94             # full_clean on model instance may be called in pre_save,\r
  95             # so we have to handle eventual errors.\r
  96             return Response(err.message_dict, status=status.HTTP_400_BAD_REQUEST)\r
  97 \r
  98         if serializer.object is not None:\r
  99             if not serializer.object.can_update(request.user):\r
 100                 return Response(status=status.HTTP_400_BAD_REQUEST)\r
 101 \r
 102         if self.object is None:\r
 103             self.object = serializer.save(force_insert=True)\r
 104             self.post_save(self.object, created=True)\r
 105             return Response(serializer.data, status=status.HTTP_201_CREATED)\r
 106 \r
 107         self.object = serializer.save(force_update=True)\r
 108         self.post_save(self.object, created=False)\r
 109         return Response(serializer.data, status=status.HTTP_200_OK)
 110
 111     def destroy(self, request, *args, **kwargs):
 112         obj = self.get_object()
 113         if obj.can_update(request.user):
 114             return super(generics.RetrieveUpdateDestroyAPIView, self).destroy(request, *args, **kwargs)
 115         else:
 116             return Response(status=status.HTTP_400_BAD_REQUEST)
 117
 118
 119 # Based on core/views/*.py
 120 {% for object in generator.all %}
 121
 122 class {{ object.camel }}List(generics.ListCreateAPIView):
 123     queryset = {{ object.camel }}.objects.select_related().all()
 124     serializer_class = {{ object.camel }}Serializer
 125     id_serializer_class = {{ object.camel }}IdSerializer
 126     filter_backends = (filters.DjangoFilterBackend,)
 127     filter_fields = ({% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
 128
 129     def get_serializer_class(self):
 130         no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
 131         if (no_hyperlinks):
 132             return self.id_serializer_class
 133         else:
 134             return self.serializer_class
 135
 136     def get_queryset(self):
 137         return {{ object.camel }}.select_by_user(self.request.user)
 138
 139     def create(self, request, *args, **kwargs):
 140         obj = {{ object.camel }}(**request.DATA)
 141         obj.caller = request.user
 142         if obj.can_update(request.user):
 143             return super({{ object.camel }}List, self).create(request, *args, **kwargs)
 144         else:
 145             raise Exception("failed obj.can_update")
 146
 147         ret = super({{ object.camel }}List, self).create(request, *args, **kwargs)
 148         if (ret.status_code%100 != 200):
 149             raise Exception(ret.data)
 150
 151         return ret
 152
 153
 154 class {{ object.camel }}Detail(PlanetStackRetrieveUpdateDestroyAPIView):
 155     queryset = {{ object.camel }}.objects.select_related().all()
 156     serializer_class = {{ object.camel }}Serializer
 157     id_serializer_class = {{ object.camel }}IdSerializer
 158
 159     def get_serializer_class(self):
 160         no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
 161         if (no_hyperlinks):
 162             return self.id_serializer_class
 163         else:
 164             return self.serializer_class
 165
 166     def get_queryset(self):
 167         return {{ object.camel }}.select_by_user(self.request.user)
 168
 169     # update() is handled by PlanetStackRetrieveUpdateDestroyAPIView
 170
 171     # destroy() is handled by PlanetStackRetrieveUpdateDestroyAPIView
 172
 173 {% endfor %}