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