Adds the search page component and an API route for searching authors…

… and articles in the same query — issue ScienceCommons#55

curate/serializers.py

@@ -15,6 +15,22 @@
 import re
 
 
+class AuthorSearchResultSerializer(serializers.ModelSerializer):
+    number_of_articles = serializers.IntegerField(source='articles.count')
+    search_result_type = serializers.ReadOnlyField(default='AUTHOR')
+
+    class Meta:
+        model = Author
+        fields = (
+            'id',
+            'name',
+            'affiliations',
+            'number_of_articles',
+            'slug',
+            'search_result_type',
+        )
+
+
 class AuthorSerializer(serializers.ModelSerializer):
     account = serializers.SlugRelatedField(
         slug_field='username',
@@ -82,6 +98,11 @@ class Meta:
             },
         }
 
+
+class ArticleSearchResultSerializer(ArticleListSerializer):
+    search_result_type = serializers.ReadOnlyField(default='ARTICLE')
+
+
 class ArticleSerializerNested(WritableNestedModelSerializer):
     key_figures = KeyFigureSerializer(many=True, required=False, allow_null=True)
     commentaries = CommentarySerializer(many=True)

curate/views_api.py

@@ -1,3 +1,5 @@
+from itertools import chain
+
 from django.shortcuts import get_object_or_404
 from rest_framework.pagination import PageNumberPagination
 from django.contrib.auth.mixins import LoginRequiredMixin
@@ -24,8 +26,10 @@
     KeyFigure,
 )
 from curate.serializers import (
+    AuthorSearchResultSerializer,
     AuthorSerializer,
     AuthorArticleSerializer,
+    ArticleSearchResultSerializer,
     ArticleSerializerNested,
     ArticleListSerializer,
     CommentarySerializer,
@@ -154,20 +158,16 @@ def delete_author(request, slug):
     author.delete()
     return Response(status=status.HTTP_200_OK)
 
-# Article views
-@api_view(('GET', ))
-def list_articles(request):
-    '''
-    Return a list of all existing articles.
-    '''
-    # Only show live articles
-    queryset = Article.objects.filter(is_live=True)
-
+def filter_and_sort_articles(request):
+    """ Parses transparency filters, content filters and ordering query parameters
+        from the request and return the appropriate Article queryset.
+    """
     # Sort the results by created or impact
     ordering = request.query_params.get('ordering')
     if ordering not in ['created', 'impact']:
-        ordering = 'created'
+        ordering = None
 
+    queryset = Article.objects.all()
     if ordering == 'created':
         queryset = queryset.order_by('-created')
     elif ordering == 'impact':
@@ -183,7 +183,10 @@ def list_articles(request):
         impact = sum(map(F, impact_fields))
         queryset = queryset.annotate(impact=impact).order_by('-impact')
 
-    # Transparency ilters
+    # Transparency filters
+    # There are two types of transparency filters
+    #     - Preregistration
+    #     - Openness
     transparency_filters = request.query_params.getlist('transparency')
 
     # Preregistration options
@@ -196,6 +199,8 @@ def list_articles(request):
     ]
 
     if prereg_values:
+        # The preregistration values are combined with an OR so any articles
+        # matching at least one of the filters are returned
         queryset = queryset.filter(prereg_protocol_type__in=prereg_values)
 
     # A dict where the key is the expected query parameter and the value is a
@@ -223,6 +228,18 @@ def list_articles(request):
 
     queryset = queryset.prefetch_related('commentaries', 'authors')
 
+    return queryset
+
+# Article views
+@api_view(('GET', ))
+def list_articles(request):
+    '''
+    Return a list of all existing articles.
+    '''
+    queryset = filter_and_sort_articles(request)
+    queryset = queryset.filter(is_live=True)
+    queryset = queryset.prefetch_related('commentaries', 'authors')
+
     serializer = ArticleListSerializer(instance=queryset, many=True)
 
     paginator = PageNumberPagination()
@@ -436,6 +453,55 @@ def search_articles(request):
     serializer=ArticleListSerializer(instance=result_page, many=True)
     return Response(serializer.data)
 
+@api_view(('GET', ))
+def search_articles_and_authors(request):
+    q = request.GET.get('q', '')
+    page_size = int(request.GET.get('page_size', 10))
+    if q:
+        logger.warning('Query: %s' % q)
+
+        article_queryset = filter_and_sort_articles(request)
+        article_queryset = (
+            article_queryset
+            .prefetch_related('authors', 'commentaries')
+            .filter(
+                Q(authors__name__icontains=q) |
+                Q(title__icontains=q) |
+                Q(author_list__icontains=q)
+            )
+            .distinct()
+        )
+
+        author_queryset = (
+            Author
+            .objects
+            .prefetch_related('articles')
+            .filter(
+                Q(name__icontains=q) |
+                Q(affiliations__icontains=q)
+            )
+        )
+    else:
+        author_queryset = Author.objects.order_by('name')
+        article_queryset = Article.objects.order_by('updated')
+
+    results = list(chain(author_queryset, article_queryset))
+    paginator = PageNumberPagination()
+    paginator.page_size = page_size
+    paginated_results = paginator.paginate_queryset(results, request)
+
+    data = []
+    # Loop through results and use the appropriate serializer
+    authors = [result for result in paginated_results if type(result) is Author]
+    articles = [result for result in paginated_results if type(result) is Article]
+
+    data = {
+        'authors': AuthorSearchResultSerializer(authors, many=True).data,
+        'articles': ArticleSearchResultSerializer(articles, many=True).data,
+    }
+    return Response(data)
+
+
 class ImageUploadView(APIView):
     permission_classes = (IsAuthenticated,)
     parser_classes = (MultiPartParser,)

curate_science/urls.py

@@ -61,4 +61,5 @@
     path('api/commentaries/<int:pk>/', api.view_commentary, name='api-view-commentary'),
     path('api/commentaries/<int:pk>/update/', api.update_commentary, name='api-update-commentary'),
     path('api/commentaries/<int:pk>/delete/', api.delete_commentary, name='api-delete-commentary'),
+    path('api/search/', api.search_articles_and_authors, name='api-search-articles-and-authors'),
 ]