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