feat(search functionality): Add search functionality

This commit delivers a feature that adds search
functionality and custom filtering to articles based
on parameters

[Delivers #162163278]

authors/apps/articles/serializers.py

@@ -71,14 +71,14 @@ class Meta:
 
 class UpdateRetrieveArticleViewSerializer(serializers.ModelSerializer):
     author = ProfileSerializer(read_only=True)
-
+    tagList = TagField(many=True, required=False, source='tags')
     class Meta:
         model = Article
         """
         List all of the fields that could possibly be included in a request
         or response, this includes fields specified explicitly above.
         """
-        fields = ['title', 'body', 'description',
+        fields = ['title', 'body', 'description', 'tagList',
                   'author', 'slug', 'published', 'created_at', 'updated_at', ]
 
 

authors/apps/articles/urls.py

@@ -9,17 +9,20 @@
     ArticleDeleteAPIView,
     FavouritesView,
     LikeArticleView,
-    ReadingView
+    ReadingView,
+    SearchArticlesAPIView
 )
 
 urlpatterns = [
-    path('articles', RetrieveArticlesAPIView.as_view(),),
+    path('articles', SearchArticlesAPIView.as_view()),
+    path('articles', RetrieveArticlesAPIView.as_view()),
     path('articles/<str:slug>/like/',
          LikeArticleView.as_view(), name='article-like'),
     path('articles/<str:slug>/', CreateArticleView.as_view()),
     path('articles/<slug>/<count>', ReadingView.as_view(), name='reading'),
     path('articles/', CreateArticleView.as_view(), name='article-create'),
     path('<slug>/tags/', ArticleTagsAPIView.as_view(), name='article-tags'),
     path('<slug>/tags/<tag>/', ArticleDeleteAPIView.as_view(), name='delete-tag'),
-    path('articles/<slug>/favorite/', FavouritesView.as_view())
+    path('articles/<slug>/favorite/', FavouritesView.as_view()),
+
 ]

authors/apps/articles/views.py

@@ -1,6 +1,9 @@
 
 import uuid, readtime
 from django.shortcuts import render
+from rest_framework.filters import SearchFilter, OrderingFilter
+from django_filters.rest_framework import DjangoFilterBackend
+from django_filters import rest_framework as filters
 from rest_framework import generics, mixins, status, viewsets
 from rest_framework import status, exceptions
 from rest_framework.generics import(
@@ -225,10 +228,8 @@ def put(self, request, slug):
 
 class RetrieveArticlesAPIView(GenericAPIView):
     serializer_class = UpdateRetrieveArticleViewSerializer
-
     permission_classes = (IsAuthenticated,)
     renderer_classes = (ListArticlesJSONRenderer,)
-
     def get(self, request):
         """
          This class method is used retrieve articles
@@ -492,4 +493,17 @@ def post(self, request, slug, count):
             return Response(serializer.data, status=status.HTTP_200_OK)
 
 
+class ArticlesFilter(filters.FilterSet):
+    tag = filters.CharFilter(field_name='tags__tag', lookup_expr='exact')
+    author = filters.CharFilter(field_name='author__user__username', lookup_expr='exact')
+    keyword = filters.CharFilter(field_name='title', lookup_expr='contains')
+
+class SearchArticlesAPIView(generics.ListAPIView):
+    permission_classes = (AllowAny,)
+    serializer_class = UpdateRetrieveArticleViewSerializer
+    queryset = Article.objects.all()
 
+    filter_backends = (DjangoFilterBackend, SearchFilter)
+    filterset_class = ArticlesFilter
+    search_fields = ('tags__tag', 'author__user__username', 'title', 'body', 'description')
+

authors/settings.py

@@ -37,7 +37,7 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-
+    'django_filters',
     'corsheaders',
     'django_extensions',
     'rest_framework',

requirements.txt

@@ -18,6 +18,8 @@ django-allauth==0.38.0
 django-cors-headers==2.4.0
 django-cors-middleware==1.3.1
 django-extensions==2.1.4
+django-filter==2.0.0
+django-filters==0.2.1
 django-heroku==0.3.1
 django-rest-auth==0.9.3
 djangorestframework==3.9.0