Endpoint to import a project

Author: humitos

readthedocs/api/v3/mixins.py

@@ -1,5 +1,4 @@
 from django.shortcuts import get_object_or_404
-from rest_framework.exceptions import NotFound
 
 from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project

readthedocs/api/v3/tests/responses/projects-list_POST.json

@@ -0,0 +1,47 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/test-project/",
+        "builds": "https://readthedocs.org/api/v3/projects/test-project/builds/",
+        "subprojects": "https://readthedocs.org/api/v3/projects/test-project/subprojects/",
+        "superproject": "https://readthedocs.org/api/v3/projects/test-project/superproject/",
+        "translations": "https://readthedocs.org/api/v3/projects/test-project/translations/",
+        "versions": "https://readthedocs.org/api/v3/projects/test-project/versions/"
+    },
+    "created": "2019-04-29T14:00:00Z",
+    "default_branch": "master",
+    "default_version": "latest",
+    "description": null,
+    "id": 4,
+    "language": {
+        "code": "en",
+        "name": "English"
+    },
+    "modified": "2019-04-29T14:00:00Z",
+    "name": "Test Project",
+    "privacy_level": {
+        "code": "public",
+        "name": "Public"
+    },
+    "programming_language": {
+        "code": "words",
+        "name": "Only Words"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/rtfd/template"
+    },
+    "slug": "test-project",
+    "subproject_of": null,
+    "tags": [],
+    "translation_of": null,
+    "urls": {
+        "documentation": "http://readthedocs.org/docs/test-project/en/latest/",
+        "project_homepage": null
+    },
+    "users": [
+        {
+            "created": "2019-04-29T10:00:00Z",
+            "username": "testuser"
+        }
+    ]
+}

readthedocs/api/v3/tests/test_projects.py

@@ -1,4 +1,5 @@
 import datetime
+import mock
 import json
 from pathlib import Path
 
@@ -372,3 +373,56 @@ def test_projects_versions_detail_unique(self):
 
         )
         self.assertEqual(response.status_code, 200)
+
+    @mock.patch('readthedocs.api.v3.views.trigger_initial_build')
+    @mock.patch('readthedocs.api.v3.views.project_import')
+    def test_import_project(self, project_import, trigger_initial_build):
+        data = {
+            'name': 'Test Project',
+            'repository': {
+                'url': 'https://github.com/rtfd/template',
+                'type': 'git',
+            },
+        }
+
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.post(reverse('projects-list'), data)
+        self.assertEqual(response.status_code, 201)
+
+        query = Project.objects.filter(slug='test-project')
+        self.assertTrue(query.exists())
+
+        project = query.first()
+        self.assertEqual(project.name, 'Test Project')
+        self.assertEqual(project.slug, 'test-project')
+        self.assertEqual(project.repo, 'https://github.com/rtfd/template')
+        self.assertEqual(project.language, 'en')
+        self.assertIn(self.me, project.users.all())
+
+        # Signal sent
+        project_import.send.assert_has_calls(
+            [
+                mock.call(
+                    sender=project,
+                    request=mock.ANY,
+                ),
+            ],
+        )
+
+        # Build triggered
+        trigger_initial_build.assert_has_calls(
+            [
+                mock.call(
+                    project,
+                    self.me,
+                ),
+            ],
+        )
+
+        response_json = response.json()
+        response_json['created'] = '2019-04-29T14:00:00Z'
+        response_json['modified'] = '2019-04-29T14:00:00Z'
+        self.assertDictEqual(
+            response_json,
+            self._get_response_dict('projects-list_POST'),
+        )

readthedocs/api/v3/views.py

@@ -136,7 +136,7 @@ def get_serializer_class(self):
         For GET it returns a serializer with many fields and on PUT/PATCH/POST,
         it return a serializer to validate just a few fields.
         """
-        if self.action in ('list', 'retrieve'):
+        if self.action in ('list', 'retrieve', 'superproject'):
             return ProjectSerializer
         elif self.action in ('create',):
             return ProjectCreateSerializer

readthedocs/settings/base.py

@@ -512,6 +512,7 @@ def USE_PROMOS(self):  # noqa
             'user': '60/minute',
         },
         'PAGE_SIZE': 10,
+        'TEST_REQUEST_DEFAULT_FORMAT': 'json',
     }
 
     SILENCED_SYSTEM_CHECKS = ['fields.W342', 'guardian.W001']