add to api: keyset pagination, recommended, newest
[wolnelektury.git] / src / api / urls.py
1 # -*- coding: utf-8 -*-
2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
4 #
5 from django.conf.urls import patterns, url
6 from django.views.decorators.csrf import csrf_exempt
7 from django.views.generic import TemplateView
8 from piston.authentication import OAuthAuthentication, oauth_access_token
9 from piston.resource import Resource
10 from ssify import ssi_included
11 from api import handlers
12 from api.helpers import CsrfExemptResource
13
14 auth = OAuthAuthentication(realm="Wolne Lektury")
15
16 book_list_resource = CsrfExemptResource(handler=handlers.BooksHandler, authentication=auth)
17 ebook_list_resource = Resource(handler=handlers.EBooksHandler)
18 # book_list_resource = Resource(handler=handlers.BooksHandler)
19 book_resource = Resource(handler=handlers.BookDetailHandler)
20
21 collection_resource = Resource(handler=handlers.CollectionDetailHandler)
22 collection_list_resource = Resource(handler=handlers.CollectionsHandler)
23
24 tag_list_resource = Resource(handler=handlers.TagsHandler)
25 tag_resource = Resource(handler=handlers.TagDetailHandler)
26
27 fragment_resource = Resource(handler=handlers.FragmentDetailHandler)
28 fragment_list_resource = Resource(handler=handlers.FragmentsHandler)
29
30 picture_resource = CsrfExemptResource(handler=handlers.PictureHandler, authentication=auth)
31
32
33 tags_re = r'^(?P<tags>(?:(?:[a-z0-9-]+/){2}){0,6})'
34 paginate_re = r'(?:before/(?P<before>[a-z0-9-]+)/)?(?:after/(?P<after>[a-z0-9-]+)/)?(?:count/(?P<count>[0-9]+)/)?$'
35
36
37 @ssi_included
38 def incl(request, model, pk, emitter_format):
39     resource = {
40         'book': book_list_resource,
41         'fragment': fragment_list_resource,
42         'tag': tag_list_resource,
43         }[model]
44     request.piwik_track = False
45     resp = resource(request, pk=pk, emitter_format=emitter_format)
46     if emitter_format == 'xml':
47         # Ugly, but quick way of stripping <?xml?> header and <response> tags.
48         resp.content = resp.content[49:-11]
49     return resp
50
51
52 urlpatterns = patterns(
53     'piston.authentication',
54     url(r'^oauth/request_token/$', 'oauth_request_token'),
55     url(r'^oauth/authorize/$', 'oauth_user_auth'),
56     url(r'^oauth/access_token/$', csrf_exempt(oauth_access_token)),
57
58 ) + patterns(
59     '',
60     url(r'^$', TemplateView.as_view(template_name='api/main.html'), name='api'),
61     url(r'^include/(?P<model>book|fragment|tag)/(?P<pk>\d+)\.(?P<lang>.+)\.(?P<emitter_format>xml|json)$',
62         incl, name='api_include'),
63
64     # info boxes (used by mobile app)
65     url(r'book/(?P<book_id>\d*?)/info\.html$', 'catalogue.views.book_info'),
66     url(r'tag/(?P<tag_id>\d*?)/info\.html$', 'catalogue.views.tag_info'),
67
68     # books by collections
69     url(r'^collections/$', collection_list_resource, name="api_collections"),
70     url(r'^collections/(?P<slug>[^/]+)/$', collection_resource, name="api_collection"),
71
72     # objects details
73     url(r'^books/(?P<book>[a-z0-9-]+)/$', book_resource, name="api_book"),
74     url(r'^(?P<category>[a-z0-9-]+)/(?P<slug>[a-z0-9-]+)/$',
75         tag_resource, name="api_tag"),
76     url(r'^books/(?P<book>[a-z0-9-]+)/fragments/(?P<anchor>[a-z0-9-]+)/$',
77         fragment_resource, name="api_fragment"),
78
79     # books by tags
80     url(tags_re + r'books/' + paginate_re,
81         book_list_resource, name='api_book_list'),
82     url(tags_re + r'ebooks/' + paginate_re,
83         ebook_list_resource, name='api_ebook_list'),
84     url(tags_re + r'parent_books/' + paginate_re,
85         book_list_resource, {"top_level": True}, name='api_parent_book_list'),
86     url(tags_re + r'parent_ebooks/' + paginate_re,
87         ebook_list_resource, {"top_level": True}, name='api_parent_ebook_list'),
88     url(tags_re + r'audiobooks/' + paginate_re,
89         book_list_resource, {"audiobooks": True}, name='api_audiobook_list'),
90     url(tags_re + r'daisy/' + paginate_re,
91         book_list_resource, {"daisy": True}, name='api_daisy_list'),
92
93     url(r'^recommended/' + paginate_re, book_list_resource, {"recommended": True}, name='api_recommended_list'),
94     url(r'^newest/', book_list_resource, {"newest": True, "count": 20}, name='api_newest_list'),
95
96     url(r'^pictures/$', picture_resource),
97
98     # fragments by book, tags, themes
99     # this should be paged
100     url(r'^(?P<tags>(?:(?:[a-z0-9-]+/){2}){1,6})fragments/$', fragment_list_resource),
101
102     # tags by category
103     url(r'^(?P<category>[a-z0-9-]+)/$', tag_list_resource, name='api_tag_list'),
104 )