Merge pull request #6190 from stsewd/refactor-views-search-analytics

Refactor SearchAnalytics view

Author: stsewd

readthedocs/projects/urls/private.py

@@ -34,6 +34,7 @@
     ProjectUpdate,
     ProjectUsersCreateList,
     ProjectUsersDelete,
+    SearchAnalytics,
 )
 
 urlpatterns = [
@@ -123,7 +124,8 @@
     ),
     url(
         r'^(?P<project_slug>[-\w]+)/search-analytics/$',
-        private.search_analytics_view, name='projects_search_analytics',
+        SearchAnalytics.as_view(),
+        name='projects_search_analytics',
     ),
 ]
 

readthedocs/projects/views/private.py

@@ -932,98 +932,86 @@ class EnvironmentVariableDelete(EnvironmentVariableMixin, DeleteView):
     http_method_names = ['post']
 
 
-@login_required
-def search_analytics_view(request, project_slug):
-    """View for search analytics."""
-    project = get_object_or_404(
-        Project.objects.for_admin_user(request.user),
-        slug=project_slug,
-    )
+class SearchAnalytics(ProjectAdminMixin, PrivateViewMixin, TemplateView):
 
-    if not project.has_feature(Feature.SEARCH_ANALYTICS):
-        return render(
-            request,
-            'projects/projects_search_analytics.html',
-            {
-                'project': project,
-                'show_analytics': False,
-            }
-        )
-
-    download_data = request.GET.get('download', False)
+    template_name = 'projects/projects_search_analytics.html'
+    http_method_names = ['get']
 
-    # if the user has requested to download all data
-    # return csv file in response.
-    if download_data:
-        return _search_analytics_csv_data(request, project_slug)
+    def get(self, request, *args, **kwargs):
+        download_data = request.GET.get('download', False)
+        if download_data:
+            return self._search_analytics_csv_data()
+        return super().get(request, *args, **kwargs)
 
-    # data for plotting the line-chart
-    query_count_of_1_month = SearchQuery.generate_queries_count_of_one_month(
-        project_slug
-    )
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        project = self.get_project()
 
-    queries = []
-    qs = SearchQuery.objects.filter(project=project)
-    if qs.exists():
-        qs = (
-            qs.values('query')
-            .annotate(count=Count('id'))
-            .order_by('-count', 'query')
-            .values_list('query', 'count')
+        context['show_analytics'] = project.has_feature(
+            Feature.SEARCH_ANALYTICS,
         )
+        if not context['show_analytics']:
+            return context
 
-        # only show top 100 queries
-        queries = qs[:100]
-
-    return render(
-        request,
-        'projects/projects_search_analytics.html',
-        {
-            'project': project,
-            'queries': queries,
-            'show_analytics': True,
-            'query_count_of_1_month': query_count_of_1_month,
-        }
-    )
+        # data for plotting the line-chart
+        query_count_of_1_month = SearchQuery.generate_queries_count_of_one_month(
+            project.slug,
+        )
 
+        queries = []
+        qs = SearchQuery.objects.filter(project=project)
+        if qs.exists():
+            qs = (
+                qs.values('query')
+                .annotate(count=Count('id'))
+                .order_by('-count', 'query')
+                .values_list('query', 'count')
+            )
 
-def _search_analytics_csv_data(request, project_slug):
-    """Generate raw csv data of search queries."""
-    project = get_object_or_404(
-        Project.objects.for_admin_user(request.user),
-        slug=project_slug,
-    )
+            # only show top 100 queries
+            queries = qs[:100]
 
-    now = timezone.now().date()
-    last_3_month = now - timezone.timedelta(days=90)
+        context.update(
+            {
+                'queries': queries,
+                'query_count_of_1_month': query_count_of_1_month,
+            },
+        )
+        return context
 
-    data = (
-        SearchQuery.objects.filter(
-            project=project,
-            created__date__gte=last_3_month,
-            created__date__lte=now,
+    def _search_analytics_csv_data(self):
+        """Generate raw csv data of search queries."""
+        project = self.get_project()
+        now = timezone.now().date()
+        last_3_month = now - timezone.timedelta(days=90)
+
+        data = (
+            SearchQuery.objects.filter(
+                project=project,
+                created__date__gte=last_3_month,
+                created__date__lte=now,
+            )
+            .order_by('-created')
+            .values_list('created', 'query')
         )
-        .order_by('-created')
-        .values_list('created', 'query')
-    )
 
-    file_name = '{project_slug}_from_{start}_to_{end}.csv'.format(
-        project_slug=project_slug,
-        start=timezone.datetime.strftime(last_3_month, '%Y-%m-%d'),
-        end=timezone.datetime.strftime(now, '%Y-%m-%d'),
-    )
-    # remove any spaces in filename.
-    file_name = '-'.join([text for text in file_name.split() if text])
+        file_name = '{project_slug}_from_{start}_to_{end}.csv'.format(
+            project_slug=project.slug,
+            start=timezone.datetime.strftime(last_3_month, '%Y-%m-%d'),
+            end=timezone.datetime.strftime(now, '%Y-%m-%d'),
+        )
+        # remove any spaces in filename.
+        file_name = '-'.join([text for text in file_name.split() if text])
 
-    csv_data = (
-        [timezone.datetime.strftime(time, '%Y-%m-%d %H:%M:%S'), query]
-        for time, query in data
-    )
-    pseudo_buffer = Echo()
-    writer = csv.writer(pseudo_buffer)
-    response = StreamingHttpResponse(
-        (writer.writerow(row) for row in csv_data),
-        content_type="text/csv",
-    )
-    response['Content-Disposition'] = f'attachment; filename="{file_name}"'
-    return response
+        csv_data = (
+            [timezone.datetime.strftime(time, '%Y-%m-%d %H:%M:%S'), query]
+            for time, query in data
+        )
+        pseudo_buffer = Echo()
+        writer = csv.writer(pseudo_buffer)
+        response = StreamingHttpResponse(
+            (writer.writerow(row) for row in csv_data),
+            content_type="text/csv",
+        )
+        response['Content-Disposition'] = f'attachment; filename="{file_name}"'
+        return response