Merge pull request #6630 from stsewd/proxi-api-on-docs-domain

Proxy footer api on docs' domains

readthedocs/api/v2/proxied_urls.py

@@ -0,0 +1,18 @@
+"""
+Proxied API URLs.
+
+Served from the same domain docs are served,
+so they can make use of features that require to have access to their cookies.
+"""
+
+from django.conf.urls import include, url
+
+from .views.proxied import ProxiedFooterHTML
+from readthedocs.search.proxied_api import ProxiedPageSearchAPIView
+
+api_footer_urls = [
+    url(r'footer_html/', ProxiedFooterHTML.as_view(), name='footer_html'),
+    url(r'docsearch/$', ProxiedPageSearchAPIView.as_view(), name='doc_search'),
+]
+
+urlpatterns = api_footer_urls

readthedocs/api/v2/views/proxied.py

@@ -0,0 +1,15 @@
+from readthedocs.core.utils.extend import SettingsOverrideObject
+
+from .footer_views import BaseFooterHTML
+
+
+class BaseProxiedFooterHTML(BaseFooterHTML):
+
+    # DRF has BasicAuthentication and SessionAuthentication as default classes.
+    # We don't support neither in the community site.
+    authentication_classes = []
+
+
+class ProxiedFooterHTML(SettingsOverrideObject):
+
+    _default_class = BaseProxiedFooterHTML

readthedocs/proxito/tests/test_proxied_api.py

@@ -0,0 +1,18 @@
+from django.test import TestCase, override_settings
+
+from readthedocs.rtd_tests.tests.test_footer import BaseTestFooterHTML
+
+
+@override_settings(
+    PUBLIC_DOMAIN='readthedocs.io',
+    ROOT_URLCONF='readthedocs.proxito.urls',
+)
+class TestProxiedFooterHTML(BaseTestFooterHTML, TestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.host = 'pip.readthedocs.io'
+
+    def render(self):
+        r = self.client.get(self.url, HTTP_HOST=self.host)
+        return r

readthedocs/proxito/urls.py

@@ -27,18 +27,22 @@
 * Can't have subprojects (pip.rtfd.io/en/projects/foo/en/latestindex.html)
     * This would stop us from detaching translations from Project modeling
 * Can't be translated (pip.rtfd.io/cz/en/latest/index.html)
+
+## Proxied API
+
+pip.rtd.io/_/api/*
 """
 
 from django.conf import settings
-from django.conf.urls import url
+from django.conf.urls import include, url
 from django.views import defaults
 
 from readthedocs.constants import pattern_opts
 from readthedocs.projects.views.public import ProjectDownloadMedia
 from readthedocs.proxito.views.serve import (
-    ServePageRedirect,
     ServeDocs,
     ServeError404,
+    ServePageRedirect,
     ServeRobotsTXT,
     ServeSitemapXML,
 )
@@ -77,6 +81,14 @@
         name='project_download_media',
     ),
 
+    # Serve proxied API
+    url(
+        r'^{DOC_PATH_PREFIX}api/v2/'.format(
+            DOC_PATH_PREFIX=DOC_PATH_PREFIX,
+        ),
+        include('readthedocs.api.v2.proxied_urls'),
+    ),
+
     # Serve custom 404 pages
     url(
         r'^_proxito_404_(?P<proxito_path>.*)$',

readthedocs/rtd_tests/tests/test_footer.py

@@ -17,7 +17,7 @@
 from readthedocs.projects.models import Project
 
 
-class TestFooterHTML(TestCase):
+class BaseTestFooterHTML:
 
     def setUp(self):
         self.pip = get(
@@ -27,6 +27,8 @@ def setUp(self):
             privacy_level=PUBLIC,
             main_language_project=None,
         )
+        self.pip.versions.update(privacy_level=PUBLIC)
+
         self.latest = self.pip.versions.get(slug=LATEST)
         self.url = (
             reverse('footer_html') +
@@ -142,6 +144,11 @@ def test_not_show_edit_on_github(self):
         self.assertNotIn('Edit', response.data['html'])
 
 
+class TestFooterHTML(BaseTestFooterHTML, TestCase):
+
+    pass
+
+
 @override_settings(
     USE_SUBDOMAIN=True,
     PUBLIC_DOMAIN='readthedocs.io',

readthedocs/search/proxied_api.py

@@ -0,0 +1,12 @@
+from readthedocs.core.utils.extend import SettingsOverrideObject
+from .api import PageSearchAPIView
+
+
+class BaseProxiedPageSearchAPIView(PageSearchAPIView):
+
+    pass
+
+
+class ProxiedPageSearchAPIView(SettingsOverrideObject):
+
+    _default_class = BaseProxiedPageSearchAPIView

readthedocs/search/tests/test_api.py

@@ -17,14 +17,13 @@
 
 @pytest.mark.django_db
 @pytest.mark.search
-class TestDocumentSearch:
+class BaseTestDocumentSearch:
 
-    @classmethod
-    def setup_class(cls):
-        # This reverse needs to be inside the ``setup_class`` method because from
+    def setup_method(self, method):
+        # This reverse needs to be inside the ``setup_method`` method because from
         # the Corporate site we don't define this URL if ``-ext`` module is not
         # installed
-        cls.url = reverse('doc_search')
+        self.url = reverse('doc_search')
 
     def get_search(self, api_client, search_params):
         return api_client.get(self.url, search_params)
@@ -260,3 +259,8 @@ def test_doc_search_unexisting_version(self, api_client, project):
 
         data = resp.data['results']
         assert len(data) == 0
+
+
+class TestDocumentSearch(BaseTestDocumentSearch):
+
+    pass

readthedocs/search/tests/test_proxied_api.py

@@ -0,0 +1,13 @@
+import pytest
+
+from readthedocs.search.tests.test_api import BaseTestDocumentSearch
+
+
+@pytest.mark.urls('readthedocs.proxito.urls')
+@pytest.mark.search
+class TestProxiedSearchAPI(BaseTestDocumentSearch):
+
+    host = 'pip.readthedocs.io'
+
+    def get_search(self, api_client, search_params):
+        return api_client.get(self.url, search_params, HTTP_HOST=self.host)