feat: revert back to django 2.2 (#465)

Author: zacharis278

.travis.yml

@@ -20,7 +20,7 @@ matrix:
     - python: '3.8'
       env: TESTNAME=test-python-3.8 TARGETS="PYTHON_ENV=py38 main.test"
     - python: '3.8'
-      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django32 main.test"
+      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django30 main.test"
       after_success:
         - docker exec analytics_api_testing /edx/app/analytics_api/analytics_api/.travis/run_coverage.sh
         - codecov --disable pycov

Makefile

@@ -3,7 +3,7 @@ COVERAGE_DIR = $(ROOT)/build/coverage
 PACKAGES = analyticsdataserver analytics_data_api
 DATABASES = default analytics
 PYTHON_ENV=py38
-DJANGO_VERSION=django32
+DJANGO_VERSION=django22
 .DEFAULT_GOAL := help
 
 help: ## display this help message

analyticsdataserver/settings/base.py

@@ -245,8 +245,7 @@
     'rest_framework.authtoken',
     'rest_framework_jwt',
     'django_countries',
-    'drf_yasg',
-    'edx_api_doc_tools',
+    'rest_framework_swagger',
     'storages',
     'enterprise_data',
     'rules.apps.AutodiscoverRulesConfig',

analyticsdataserver/urls.py

@@ -1,30 +1,21 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 from django.views.generic import RedirectView
-from edx_api_doc_tools import make_api_info, make_docs_ui_view
 from rest_framework.authtoken.views import obtain_auth_token
 
 from analyticsdataserver import views
 
 admin.site.site_header = 'Analytics Data API Service Administration'
 admin.site.site_title = admin.site.site_header
 
-api_ui_view = make_docs_ui_view(
-    make_api_info(
-        title="edX Analytics Data API",
-        version="v1",
-        email="program-cosmonauts@edx.org"
-    )
-)
-
 urlpatterns = [
     url(r'^$', RedirectView.as_view(url='/docs')),  # pylint: disable=no-value-for-parameter
 
     url(r'^api-auth/', include('rest_framework.urls', 'rest_framework')),
     url(r'^api-token-auth/', obtain_auth_token),
 
     url(r'^api/', include('analytics_data_api.urls')),
-    url(r'^docs/$', api_ui_view, name='api-docs'),
+    url(r'^docs/', views.SwaggerSchemaView.as_view()),
     url(r'^status/$', views.StatusView.as_view(), name='status'),
     url(r'^authenticated/$', views.AuthenticationTestView.as_view(), name='authenticated'),
     url(r'^health/$', views.HealthView.as_view(), name='health'),

analyticsdataserver/views.py

@@ -3,10 +3,12 @@
 from django.conf import settings
 from django.db import connections
 from django.http import HttpResponse
-from rest_framework import permissions
+from rest_framework import permissions, schemas
+from rest_framework.permissions import AllowAny
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
 from rest_framework.views import APIView
+from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
 
 logger = logging.getLogger(__name__)
 
@@ -31,6 +33,21 @@ def _handle_error(status_code):
     return HttpResponse(renderer.render(info), content_type=content_type, status=status_code)
 
 
+class SwaggerSchemaView(APIView):
+    """
+    Renders the swagger schema for the documentation regardless of permissions.
+    """
+    permission_classes = [AllowAny]
+    renderer_classes = [
+        OpenAPIRenderer,
+        SwaggerUIRenderer
+    ]
+
+    def get(self, _request):
+        generator = schemas.SchemaGenerator(title='Analytics API')
+        return Response(generator.get_schema())
+
+
 class StatusView(APIView):
     """
     Simple check to determine if the server is alive

requirements/base.in

@@ -2,21 +2,20 @@
 
 -c constraints.txt
 
-edx-api-doc-tools
 boto==2.42.0                        # MIT
 boto3
-coreapi
 Django                              # BSD License
 django-countries                    # MIT
 python-memcached                    # Python Software Foundation License v2
 djangorestframework                 # BSD
+django-rest-swagger		    # BSD
 djangorestframework-csv             # BSD
 django-storages                     # BSD
 elasticsearch-dsl                   # Apache 2.0
 ordered-set                         # MIT
 tqdm                                # MIT
 urllib3                             # MIT
-Markdown                            # BSD:markdown is used by swagger for rendering the api docs
+Markdown==2.6.6		            # BSD:markdown is used by swagger for rendering the api docs
 edx-ccx-keys
 edx-django-release-util
 edx-opaque-keys

requirements/base.txt

@@ -4,8 +4,6 @@
 #
 #    make upgrade
 #
-asgiref==3.4.1
-    # via django
 boto==2.42.0
     # via -r requirements/base.in
 boto3==1.18.12
@@ -24,18 +22,17 @@ charset-normalizer==2.0.4
     # via requests
 coreapi==2.3.3
     # via
-    #   -r requirements/base.in
-    #   drf-yasg
+    #   django-rest-swagger
+    #   openapi-codec
 coreschema==0.0.4
-    # via
-    #   coreapi
-    #   drf-yasg
+    # via coreapi
 cryptography==3.4.7
     # via
     #   django-fernet-fields
     #   pyjwt
-django==3.2.6
+django==2.2.24
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/base.in
     #   django-cors-headers
     #   django-crum
@@ -44,8 +41,6 @@ django==3.2.6
     #   django-storages
     #   djangorestframework
     #   drf-jwt
-    #   drf-yasg
-    #   edx-api-doc-tools
     #   edx-django-release-util
     #   edx-django-utils
     #   edx-drf-extensions
@@ -66,6 +61,8 @@ django-model-utils==4.1.1
     # via
     #   edx-enterprise-data
     #   edx-rbac
+django-rest-swagger==2.2.0
+    # via -r requirements/base.in
 django-storages==1.8
     # via
     #   -c requirements/constraints.txt
@@ -77,20 +74,17 @@ django-waffle==2.2.1
 djangorestframework==3.12.4
     # via
     #   -r requirements/base.in
+    #   django-rest-swagger
     #   djangorestframework-csv
     #   drf-jwt
-    #   drf-yasg
-    #   edx-api-doc-tools
     #   edx-drf-extensions
     #   rest-condition
 djangorestframework-csv==2.1.1
     # via -r requirements/base.in
-drf-jwt==1.19.1
-    # via edx-drf-extensions
-drf-yasg==1.20.0
-    # via edx-api-doc-tools
-edx-api-doc-tools==1.4.3
-    # via -r requirements/base.in
+drf-jwt==1.19.0
+    # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
+    #   edx-drf-extensions
 edx-ccx-keys==1.2.1
     # via -r requirements/base.in
 edx-django-release-util==1.1.0
@@ -131,8 +125,6 @@ future==0.18.2
     # via pyjwkest
 idna==3.2
     # via requests
-inflection==0.5.1
-    # via drf-yasg
 itypes==1.2.0
     # via coreapi
 jinja2==3.0.1
@@ -141,18 +133,18 @@ jmespath==0.10.0
     # via
     #   boto3
     #   botocore
-markdown==3.3.4
+markdown==2.6.6
     # via -r requirements/base.in
 markupsafe==2.0.1
     # via jinja2
 newrelic==6.6.0.162
     # via edx-django-utils
+openapi-codec==1.3.2
+    # via django-rest-swagger
 ordered-set==3.1.1
     # via
     #   -c requirements/constraints.txt
     #   -r requirements/base.in
-packaging==21.0
-    # via drf-yasg
 pbr==5.6.0
     # via stevedore
 psutil==5.8.0
@@ -163,14 +155,13 @@ pycryptodomex==3.10.1
     # via pyjwkest
 pyjwkest==1.4.2
     # via edx-drf-extensions
-pyjwt[crypto]==2.1.0
+pyjwt[crypto]==1.7.1
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   drf-jwt
     #   edx-rest-api-client
 pymongo==3.12.0
     # via edx-opaque-keys
-pyparsing==2.4.7
-    # via packaging
 python-dateutil==2.8.2
     # via
     #   botocore
@@ -192,16 +183,14 @@ requests==2.26.0
     #   slumber
 rest-condition==1.0.3
     # via edx-drf-extensions
-ruamel.yaml==0.17.10
-    # via drf-yasg
-ruamel.yaml.clib==0.2.6
-    # via ruamel.yaml
 rules==3.0
     # via edx-enterprise-data
 s3transfer==0.5.0
     # via boto3
 semantic-version==2.8.5
     # via edx-drf-extensions
+simplejson==3.17.3
+    # via django-rest-swagger
 six==1.16.0
     # via
     #   djangorestframework-csv
@@ -226,9 +215,7 @@ tqdm==4.62.0
 unicodecsv==0.14.1
     # via djangorestframework-csv
 uritemplate==3.0.1
-    # via
-    #   coreapi
-    #   drf-yasg
+    # via coreapi
 urllib3==1.26.6
     # via
     #   -r requirements/base.in

requirements/constraints.txt

@@ -8,6 +8,9 @@
 # pin when possible.  Writing an issue against the offending project and
 # linking to it here is good.
 
+# Common constraints for edx repos
+-c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
+
 # TODO: Many pinned dependencies should be unpinned and/or moved to this constraints file.
 
 # django-storages version 1.9 drops support for boto storage backend.