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
14 Schema of the generator object:
15 all: Set of all Model objects
16 all_if(regex): Set of Model objects that match regex
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
24 TODO: Deal with subnets
27 def get_REST_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'),
38 def api_root(request, format=None):
40 {% for object in generator.all %}'{{ object.plural }}': reverse('{{ object }}-list', request=request, format=format),
44 # Based on serializers.py
46 {% for object in generator.all %}
48 class {{ object.camel }}Serializer(serializers.HyperlinkedModelSerializer):
49 id = serializers.Field()
50 {% for ref in object.refs %}
52 {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
54 {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
57 humanReadableName = serializers.SerializerMethodField("getHumanReadableName")
58 def getHumanReadableName(self, obj):
\r
61 model = {{ object.camel }}
62 fields = ('humanReadableName', {% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
64 class {{ object.camel }}IdSerializer(serializers.ModelSerializer):
65 id = serializers.Field()
66 {% for ref in object.refs %}
68 {{ ref.plural }} = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name='{{ ref }}-detail')
70 {{ ref }} = serializers.HyperlinkedRelatedField(read_only=True, view_name='{{ ref }}-detail')
73 humanReadableName = serializers.SerializerMethodField("getHumanReadableName")
74 def getHumanReadableName(self, obj):
\r
77 model = {{ object.camel }}
78 fields = ('humanReadableName', {% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
84 {% for object in generator.all %}
85 {{ object.camel }}: {{ object.camel }}Serializer,
90 class PlanetStackRetrieveUpdateDestroyAPIView(generics.RetrieveUpdateDestroyAPIView):
92 # To handle fine-grained field permissions, we have to check can_update
93 # the object has been updated but before it has been saved.
95 def update(self, request, *args, **kwargs):
\r
96 partial = kwargs.pop('partial', False)
\r
97 self.object = self.get_object_or_none()
\r
99 serializer = self.get_serializer(self.object, data=request.DATA,
\r
100 files=request.FILES, partial=partial)
\r
102 if not serializer.is_valid():
\r
103 print "UpdateModelMixin: not serializer.is_valid"
\r
104 print serializer.errors
\r
105 return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
\r
108 self.pre_save(serializer.object)
\r
109 except ValidationError as err:
\r
110 # full_clean on model instance may be called in pre_save,
\r
111 # so we have to handle eventual errors.
\r
112 return Response(err.message_dict, status=status.HTTP_400_BAD_REQUEST)
\r
114 if serializer.object is not None:
\r
115 if not serializer.object.can_update(request.user):
\r
116 return Response(status=status.HTTP_400_BAD_REQUEST)
\r
118 if self.object is None:
\r
119 self.object = serializer.save(force_insert=True)
\r
120 self.post_save(self.object, created=True)
\r
121 return Response(serializer.data, status=status.HTTP_201_CREATED)
\r
123 self.object = serializer.save(force_update=True)
\r
124 self.post_save(self.object, created=False)
\r
125 return Response(serializer.data, status=status.HTTP_200_OK)
127 def destroy(self, request, *args, **kwargs):
128 obj = self.get_object()
129 if obj.can_update(request.user):
130 return super(generics.RetrieveUpdateDestroyAPIView, self).destroy(request, *args, **kwargs)
132 return Response(status=status.HTTP_400_BAD_REQUEST)
135 # Based on core/views/*.py
136 {% for object in generator.all %}
138 class {{ object.camel }}List(generics.ListCreateAPIView):
139 queryset = {{ object.camel }}.objects.select_related().all()
140 serializer_class = {{ object.camel }}Serializer
141 id_serializer_class = {{ object.camel }}IdSerializer
142 filter_backends = (filters.DjangoFilterBackend,)
143 filter_fields = ({% for prop in object.props %}'{{ prop }}',{% endfor %}{% for ref in object.refs %}{%if ref.multi %}'{{ ref.plural }}'{% else %}'{{ ref }}'{% endif %},{% endfor %})
145 def get_serializer_class(self):
146 no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
148 return self.id_serializer_class
150 return self.serializer_class
152 def get_queryset(self):
153 return {{ object.camel }}.select_by_user(self.request.user)
155 def create(self, request, *args, **kwargs):
156 serializer = self.get_serializer(data=request.DATA, files=request.FILES)
157 if not (serializer.is_valid()):
158 raise Exception("failed serializer.is_valid: " + str(serializer.errors))
159 obj = serializer.object
160 obj.caller = request.user
161 if obj.can_update(request.user):
162 return super({{ object.camel }}List, self).create(request, *args, **kwargs)
164 raise Exception("failed obj.can_update")
166 ret = super({{ object.camel }}List, self).create(request, *args, **kwargs)
167 if (ret.status_code%100 != 200):
168 raise Exception(ret.data)
173 class {{ object.camel }}Detail(PlanetStackRetrieveUpdateDestroyAPIView):
174 queryset = {{ object.camel }}.objects.select_related().all()
175 serializer_class = {{ object.camel }}Serializer
176 id_serializer_class = {{ object.camel }}IdSerializer
178 def get_serializer_class(self):
179 no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
181 return self.id_serializer_class
183 return self.serializer_class
185 def get_queryset(self):
186 return {{ object.camel }}.select_by_user(self.request.user)
188 # update() is handled by PlanetStackRetrieveUpdateDestroyAPIView
190 # destroy() is handled by PlanetStackRetrieveUpdateDestroyAPIView
193 XXX smbaker: my intent was to create a view that would return 'new' objects
194 filled with defaults. I solved it another way, so this code may soon be
197 class {{ object.camel }}New(GenericAPIView):
198 serializer_class = {{ object.camel }}Serializer
199 id_serializer_class = {{ object.camel }}IdSerializer
201 def get(self, request, *args, **kwargs):
202 return self.makenew(request, *args, **kwargs)
204 def get_serializer_class(self):
205 no_hyperlinks = self.request.QUERY_PARAMS.get('no_hyperlinks', False)
207 return self.id_serializer_class
209 return self.serializer_class
211 def makenew(self, request, *args, **kwargs):
212 obj = {{ object.camel }}()
213 serializer = self.get_serializer(obj)
214 return Response(serializer.data)