Przywrócenie wersji 0.63 z poprawkami:
[redakcja.git] / apps / api / response.py
1 # -*- encoding: utf-8 -*-
2
3 __author__= "Łukasz Rekucki"
4 __date__ = "$2009-09-26 00:32:18$"
5 __doc__ = "Extensible HTTP Responses."
6
7 from django.http import HttpResponse
8 from django.utils import simplejson as json
9
10 MIME_PLAIN = 'text/plain'
11 MIME_JSON = 'application/json'
12
13 class ResponseObject(object):
14
15     def __init__(self, code, mimetype=MIME_JSON):
16         self._code = code
17         self._mime = mimetype        
18
19     def django_response(self, body=None):
20         if body is None:
21             data = ''
22         elif self._mime == MIME_JSON:
23             data = json.dumps(body, default=lambda o: repr(o) )
24         else:
25             # data = u"%s\n%s" % (self.MESSAGE, unicode(body))
26             data = unicode(body).encode('utf-8')
27             
28         return HttpResponse(content=data, status=self._code, \
29                 content_type=self._mime+'; charset=utf-8' )        
30     
31 class SuccessAllOk(ResponseObject):
32     def __init__(self, **kwargs):
33         ResponseObject.__init__(self, 200, **kwargs)
34         
35 class EntityCreated(ResponseObject):
36
37     def __init__(self, **kwargs):
38         ResponseObject.__init__(self, 201, **kwargs)
39
40     def django_response(self, url, body):        
41         response = ResponseObject.django_response(self, body)
42         response['Location'] = url
43         return response
44
45 class RequestAccepted(ResponseObject):
46
47     def __init__(self, **kwargs):
48         ResponseObject.__init__(self, 202, **kwargs)
49
50     def django_response(self, ticket_status, ticket_uri):
51         return ResponseObject.django_response(self, {
52             'result': 'accepted',
53             'status': ticket_status,
54             'refer_to': ticket_uri })     
55         
56 class SuccessNoContent(ResponseObject):
57
58     def __init__(self, **kwargs):
59         ResponseObject.__init__(self, 204, **kwargs)
60
61     def django_response(self):
62         return ResponseObject.django_response(self, body=None)
63
64 #
65 # Client errors
66 #
67
68 class BadRequest(ResponseObject):
69
70     def __init__(self, **kwargs):
71         ResponseObject.__init__(self, 400, **kwargs)
72     
73 class AccessDenied(ResponseObject):
74
75     def __init__(self, **kwargs):
76         ResponseObject.__init__(self, 403, **kwargs)
77     
78
79 class EntityNotFound(ResponseObject):
80
81     def __init__(self, **kwargs):
82         ResponseObject.__init__(self, 404, **kwargs)
83
84 class EntityGone(ResponseObject):
85
86     def __init__(self, **kwargs):
87         ResponseObject.__init__(self, 410, **kwargs)
88
89
90 class EntityConflict(ResponseObject):
91
92     def __init__(self, **kwargs):
93         ResponseObject.__init__(self, 409, **kwargs)
94
95
96 #
97 # Server side errors
98 #
99 class InternalError(ResponseObject):
100
101     def __init__(self, **kwargs):
102         ResponseObject.__init__(self, 500, **kwargs)
103
104 class NotImplemented(ResponseObject):
105
106     def __init__(self, **kwargs):
107         ResponseObject.__init__(self, 501, **kwargs)