matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #128, Add Indexes API endpoints

Browse Source
This commit is contained in:
Roberto Rosario
2014-12-16 01:37:49 -04:00
parent 0e0428b501
commit 6fb768a6f8
6 changed files with 118 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
mayan/apps/document_indexing/__init__.py
View File

@@ -54,4 +54,4 @@ register_setup(index_setup)
register_top_menu('indexes', document_index_main_menu_link)
APIEndPoint('indexes')
APIEndPoint('indexes', app_name='document_indexing')

112
mayan/apps/document_indexing/api_views.py
View File

@@ -12,28 +12,16 @@ from permissions.models import Permission
from rest_api.filters import MayanObjectPermissionsFilter
from rest_api.permissions import MayanPermission
from .models import Index, IndexInstanceNode
from .models import Index, IndexInstanceNode, IndexTemplateNode
from .permissions import (PERMISSION_DOCUMENT_INDEXING_CREATE,
PERMISSION_DOCUMENT_INDEXING_DELETE,
PERMISSION_DOCUMENT_INDEXING_EDIT,
PERMISSION_DOCUMENT_INDEXING_VIEW)
from .serializers import IndexInstanceNodeSerializer, IndexSerializer
class APIIndexView(generics.RetrieveAPIView):
"""
Details of the selected index.
"""
serializer_class = IndexSerializer
queryset = Index.objects.all()
permission_classes = (MayanPermission,)
mayan_object_permissions = {'GET': [PERMISSION_DOCUMENT_INDEXING_VIEW]}
from .serializers import (IndexInstanceNodeSerializer, IndexSerializer,
IndexTemplateNodeSerializer)
class APIIndexListView(generics.ListCreateAPIView):
"""
Returns a list of all the defined indexes.
"""
serializer_class = IndexSerializer
queryset = Index.objects.all()
@@ -41,6 +29,43 @@ class APIIndexListView(generics.ListCreateAPIView):
mayan_object_permissions = {'GET': [PERMISSION_DOCUMENT_INDEXING_VIEW]}
mayan_view_permissions = {'POST': [PERMISSION_DOCUMENT_INDEXING_CREATE]}
def get(self, *args, **kwargs):
"""Returns a list of all the defined indexes."""
return super(APIIndexListView, self).get(*args, **kwargs)
def post(self, *args, **kwargs):
"""Create a new index."""
return super(APIIndexListView, self).post(*args, **kwargs)
class APIIndexView(generics.RetrieveUpdateDestroyAPIView):
serializer_class = IndexSerializer
queryset = Index.objects.all()
permission_classes = (MayanPermission,)
mayan_object_permissions = {
'GET': [PERMISSION_DOCUMENT_INDEXING_VIEW],
'PUT': [PERMISSION_DOCUMENT_INDEXING_EDIT],
'PATCH': [PERMISSION_DOCUMENT_INDEXING_EDIT],
'DELETE': [PERMISSION_DOCUMENT_INDEXING_DELETE]
}
def delete(self, *args, **kwargs):
"""Delete the selected index."""
return super(APIIndexView, self).delete(*args, **kwargs)
def get(self, *args, **kwargs):
"""Returns the details of the selected index."""
return super(APIIndexView, self).get(*args, **kwargs)
def patch(self, *args, **kwargs):
"""Partially edit an index."""
return super(APIIndexView, self).patch(*args, **kwargs)
def put(self, *args, **kwargs):
"""Edit an index."""
return super(APIIndexView, self).put(*args, **kwargs)
class APIIndexNodeInstanceDocumentListView(generics.ListAPIView):
"""
@@ -64,6 +89,59 @@ class APIIndexNodeInstanceDocumentListView(generics.ListAPIView):
return index_node_instance.documents.all()
class APIIndexTemplateListView(generics.ListCreateAPIView):
serializer_class = IndexTemplateNodeSerializer
filter_backends = (MayanObjectPermissionsFilter,)
mayan_object_permissions = {'GET': [PERMISSION_DOCUMENT_INDEXING_VIEW]}
def get_queryset(self):
index = get_object_or_404(Index, pk=self.kwargs['pk'])
try:
Permission.objects.check_permissions(self.request.user, [PERMISSION_DOCUMENT_INDEXING_EDIT])
except PermissionDenied:
AccessEntry.objects.check_access(PERMISSION_DOCUMENT_INDEXING_EDIT, self.request.user, index_node_instance.index)
return index.node_templates.all()
def get(self, *args, **kwargs):
"""Returns a list of all the template nodes for the selected index."""
return super(APIIndexTemplateListView, self).get(*args, **kwargs)
def post(self, *args, **kwargs):
"""Create a new template node for the selected new index."""
return super(APIIndexTemplateListView, self).post(*args, **kwargs)
class APIIndexTemplateView(generics.RetrieveUpdateDestroyAPIView):
serializer_class = IndexTemplateNodeSerializer
queryset = IndexTemplateNode.objects.all()
permission_classes = (MayanPermission,)
mayan_object_permissions = {
'GET': [PERMISSION_DOCUMENT_INDEXING_VIEW],
'PUT': [PERMISSION_DOCUMENT_INDEXING_EDIT],
'PATCH': [PERMISSION_DOCUMENT_INDEXING_EDIT],
'DELETE': [PERMISSION_DOCUMENT_INDEXING_EDIT]
}
def delete(self, *args, **kwargs):
"""Delete the selected index template node."""
return super(APIIndexTemplateView, self).delete(*args, **kwargs)
def get(self, *args, **kwargs):
"""Returns the details of the selected index template node."""
return super(APIIndexTemplateView, self).get(*args, **kwargs)
def patch(self, *args, **kwargs):
"""Partially edit an index template node."""
return super(APIIndexTemplateView, self).patch(*args, **kwargs)
def put(self, *args, **kwargs):
"""Edit an index template node."""
return super(APIIndexTemplateView, self).put(*args, **kwargs)
class APIDocumentIndexListView(generics.ListAPIView):
"""
Returns a list of all the indexes to which a document belongs.

9
mayan/apps/document_indexing/models.py
View File

@@ -54,10 +54,6 @@ class Index(models.Model):
except IndexInstanceNode.DoesNotExist:
return 0
@property
def node_instances(self):
return [template_node.node_instance.get() for template_node in self.node_templates.all()]
class Meta:
verbose_name = _(u'Index')
verbose_name_plural = _(u'Indexes')
@@ -94,6 +90,11 @@ class IndexInstanceNode(MPTTModel):
def get_absolute_url(self):
return ('indexing:index_instance_node_view', [self.pk])
@property
def children(self):
# Convenience method for serializer
return self.get_children()
class Meta:
verbose_name = _(u'Index node instance')
verbose_name_plural = _(u'Indexes node instances')

14
mayan/apps/document_indexing/serializers.py
View File

@@ -6,21 +6,29 @@ from .models import Index, IndexInstanceNode, IndexTemplateNode
class IndexInstanceNodeSerializer(serializers.ModelSerializer):
documents = serializers.HyperlinkedIdentityField(view_name='index-node-documents')
documents = serializers.SerializerMethodField('get_documents_count')
class Meta:
fields = ('id', 'parent', 'index_template_node', 'value', 'level', 'documents')
fields = ('id', 'parent', 'value', 'level', 'documents', 'children')
model = IndexInstanceNode
def get_documents_count(self, obj):
return obj.documents.count()
IndexInstanceNodeSerializer.base_fields['children'] = IndexInstanceNodeSerializer(many=True)
class IndexTemplateNodeSerializer(serializers.ModelSerializer):
class Meta:
fields = ('id', 'parent', 'index', 'expression', 'enabled', 'link_documents', 'level')
model = IndexTemplateNode
class IndexSerializer(serializers.ModelSerializer):
node_templates = IndexTemplateNodeSerializer(read_only=True, many=True)
node_instances = IndexInstanceNodeSerializer(read_only=True, many=True)
instance_root = IndexInstanceNodeSerializer(read_only=True)#, many=False)
class Meta:
fields = ('id', 'name', 'title', 'enabled', 'document_types', 'node_templates', 'instance_root')
model = Index

6
mayan/apps/document_indexing/urls.py
View File

@@ -1,9 +1,11 @@
from django.conf.urls import patterns, url
from .api_views import (APIDocumentIndexListView,
APIIndexNodeInstanceDocumentListView, APIIndexListView,
APIIndexListView, APIIndexNodeInstanceDocumentListView,
APIIndexTemplateListView, APIIndexTemplateView,
APIIndexView)
urlpatterns = patterns('document_indexing.views',
url(r'^setup/index/list/$', 'index_setup_list', (), 'index_setup_list'),
url(r'^setup/index/create/$', 'index_setup_create', (), 'index_setup_create'),
@@ -25,7 +27,9 @@ urlpatterns = patterns('document_indexing.views',
api_urls = patterns('',
url(r'^index/node/(?P<pk>[0-9]+)/documents/$', APIIndexNodeInstanceDocumentListView.as_view(), name='index-node-documents'),
url(r'^index/template/(?P<pk>[0-9]+)/$', APIIndexTemplateView.as_view(), name='index-template-detail'),
url(r'^indexes/(?P<pk>[0-9]+)/$', APIIndexView.as_view(), name='index-detail'),
url(r'^index/(?P<pk>[0-9]+)/template/$', APIIndexTemplateListView.as_view(), name='index-template-detail'),
url(r'^indexes/$', APIIndexListView.as_view(), name='index-list'),
url(r'^document/(?P<pk>[0-9]+)/indexes/$', APIDocumentIndexListView.as_view(), name='document-index-list'),
)

2
mayan/apps/document_indexing/views.py
View File

@@ -320,7 +320,7 @@ def index_instance_node_view(request, index_instance_node_pk):
of documents
"""
index_instance = get_object_or_404(IndexInstanceNode, pk=index_instance_node_pk)
index_instance_list = [index for index in index_instance.get_children().order_by('value')]
index_instance_list = index_instance.get_children().order_by('value')
breadcrumbs = get_breadcrumbs(index_instance)
try: