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     {% endfor %}
  34     )
  35
  36 @api_view(['GET'])
  37 def api_root(request, format=None):
  38     return Response({
  39         {% for object in generator.all %}'{{ object.plural }}': reverse('{{ object }}-list', request=request, format=format),
  40         {% endfor %}
  41     })
  42
  43 # Based on serializers.py
  44
  45 {% for object in generator.all %}
  46
  47 class {{ object.camel }}Serializer(serializers.HyperlinkedModelSerializer):
  48     id = serializers.Field()
  49     {% for ref in object.refs %}
  50     {% if ref.multi %}
  51     {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
  52     {% else %}
  53     {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
  54     {% endif %}
  55     {% endfor %}
  56     humanReadableName = serializers.SerializerMethodField("getHumanReadableName")
  57     validators = serializers.SerializerMethodField("getValidators")
  58     def getHumanReadableName(self, obj):\r
  59         return str(obj)
  60     def getValidators(self, obj):
  61         try:
  62             return obj.getValidators()
  63         except:
  64             return None
  65     class Meta:
  66         model = {{ object.camel }}
  67         fields = ('humanReadableName', 'validators', {% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
  68
  69 class {{ object.camel }}IdSerializer(serializers.ModelSerializer):
  70     id = serializers.Field()
  71     {% for ref in object.refs %}
  72     {% if ref.multi %}
  73     {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
  74     {% else %}
  75     {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
  76     {% endif %}
  77     {% endfor %}
  78     humanReadableName = serializers.SerializerMethodField("getHumanReadableName")
  79     validators = serializers.SerializerMethodField("getValidators")
  80     def getHumanReadableName(self, obj):\r
  81         return str(obj)\r
  82     def getValidators(self, obj):\r
  83         try:
  84             return obj.getValidators()
  85         except:
  86             return None\r
  87     class Meta:
  88         model = {{ object.camel }}
  89         fields = ('humanReadableName', 'validators', {% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
  90
  91
  92 {% endfor %}
  93
  94 serializerLookUp = {
  95 {% for object in generator.all %}
  96                  {{ object.camel }}: {{ object.camel }}Serializer,
  97 {% endfor %}
  98                  None: None,
  99                 }
 100
 101 class PlanetStackRetrieveUpdateDestroyAPIView(generics.RetrieveUpdateDestroyAPIView):
 102
 103     # To handle fine-grained field permissions, we have to check can_update
 104     # the object has been updated but before it has been saved.
 105
 106     def update(self, request, *args, **kwargs):\r
 107         partial = kwargs.pop('partial', False)\r
 108         self.object = self.get_object_or_none()\r
 109 \r
 110         serializer = self.get_serializer(self.object, data=request.DATA,\r
 111                                          files=request.FILES, partial=partial)\r
 112 \r
 113         if not serializer.is_valid():\r
 114             response = {"error": "validation",\r
 115                         "specific_error": "not serializer.is_valid()",\r
 116                         "reasons": serializer.errors}\r
 117             return Response(response, status=status.HTTP_400_BAD_REQUEST)\r
 118 \r
 119         try:\r
 120             self.pre_save(serializer.object)\r
 121         except ValidationError as err:\r
 122             # full_clean on model instance may be called in pre_save,\r
 123             # so we have to handle eventual errors.\r
 124             response = {"error": "validation",\r
 125                          "specific_error": "ValidationError in pre_save",\r
 126                          "reasons": err.message_dict}\r
 127             return Response(response, status=status.HTTP_400_BAD_REQUEST)\r
 128 \r
 129         if serializer.object is not None:\r
 130             if not serializer.object.can_update(request.user):\r
 131                 return Response(status=status.HTTP_400_BAD_REQUEST)\r
 132 \r
 133         if self.object is None:\r
 134             self.object = serializer.save(force_insert=True)\r
 135             self.post_save(self.object, created=True)\r
 136             return Response(serializer.data, status=status.HTTP_201_CREATED)\r
 137 \r
 138         self.object = serializer.save(force_update=True)\r
 139         self.post_save(self.object, created=False)\r
 140         return Response(serializer.data, status=status.HTTP_200_OK)
 141
 142     def destroy(self, request, *args, **kwargs):
 143         obj = self.get_object()
 144         if obj.can_update(request.user):
 145             return super(generics.RetrieveUpdateDestroyAPIView, self).destroy(request, *args, **kwargs)
 146         else:
 147             return Response(status=status.HTTP_400_BAD_REQUEST)
 148
 149
 150 # Based on core/views/*.py
 151 {% for object in generator.all %}
 152
 153 class {{ object.camel }}List(generics.ListCreateAPIView):
 154     queryset = {{ object.camel }}.objects.select_related().all()
 155     serializer_class = {{ object.camel }}Serializer
 156     id_serializer_class = {{ object.camel }}IdSerializer
 157     filter_backends = (filters.DjangoFilterBackend,)
 158     filter_fields = ({% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
 159
 160     def get_serializer_class(self):
 161         no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
 162         if (no_hyperlinks):
 163             return self.id_serializer_class
 164         else:
 165             return self.serializer_class
 166
 167     def get_queryset(self):
 168         return {{ object.camel }}.select_by_user(self.request.user)
 169
 170     def create(self, request, *args, **kwargs):
 171         serializer = self.get_serializer(data=request.DATA, files=request.FILES)
 172         if not (serializer.is_valid()):
 173             response = {"error": "validation",
 174                         "specific_error": "not serializer.is_valid()",\r
 175                         "reasons": serializer.errors}\r
 176             return Response(response, status=status.HTTP_400_BAD_REQUEST)
 177         obj = serializer.object
 178         obj.caller = request.user
 179         if obj.can_update(request.user):
 180             return super({{ object.camel }}List, self).create(request, *args, **kwargs)
 181         else:
 182             raise Exception("failed obj.can_update")
 183
 184         ret = super({{ object.camel }}List, self).create(request, *args, **kwargs)
 185         if (ret.status_code%100 != 200):
 186             raise Exception(ret.data)
 187
 188         return ret
 189
 190
 191 class {{ object.camel }}Detail(PlanetStackRetrieveUpdateDestroyAPIView):
 192     queryset = {{ object.camel }}.objects.select_related().all()
 193     serializer_class = {{ object.camel }}Serializer
 194     id_serializer_class = {{ object.camel }}IdSerializer
 195
 196     def get_serializer_class(self):
 197         no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
 198         if (no_hyperlinks):
 199             return self.id_serializer_class
 200         else:
 201             return self.serializer_class
 202
 203     def get_queryset(self):
 204         return {{ object.camel }}.select_by_user(self.request.user)
 205
 206     # update() is handled by PlanetStackRetrieveUpdateDestroyAPIView
 207
 208     # destroy() is handled by PlanetStackRetrieveUpdateDestroyAPIView
 209
 210 {% endfor %}