COPS-IITBHU · ankur12-1610 · Aug 3, 2021 · Aug 3, 2021 · Aug 3, 2021 · Aug 3, 2021
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/Pipfile b/Pipfile
@@ -12,6 +12,8 @@ django-cors-headers = "*"
 django-heroku = "*"
 gunicorn = "*"
 drf-yasg = "*"
+pyjwt = "*"
+pipenv = "==2021.5.29"
 
 [requires]
 python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 
-# Todo App API - CSoC Dev Task 5
-
+# Todo App API-
 ## Introduction
 
-Welcome to the Task 5 of CSOC Dev. In this assignment, you will be working on the Django REST Framework. You will be implementing the TODO API server . Also, you will be adding some additional functionality to the API.
+Todo API server made with Django Rest framework and heroku postgresql.
 
 
 ### Setting up the project
@@ -14,202 +13,6 @@ Welcome to the Task 5 of CSOC Dev. In this assignment, you will be working on th
 - Run `python manage.py migrate` to apply migrations.
 - Start the development server using `python manage.py runserver`
 
-### Working
-We are including the description of the API at the end of this readme for your reference.
-
-You'll have to complete two subtasks:
-
-- **Complete all the basic endpoints (API Description is included below)**:
-
-  Auth - Login, Register, Get Profile and Todo - Get Detail, Get List, Create, Edit and Delete. In this subtask, only the creator of the Todo will have the access to View, Edit or Delete the Todo. As an example, we have created the endpoint `/todo/create/` for you. However, it just returns an empty `200 RESPONSE` on success. You will have to modify the endpoint to return the created Todo details too in the response body, along with a `200 RESPONSE`. The necessary details for this subtask are mentioned in the comments too.
-
-- **Implement collaborator feature**:
-
-  In this subtask, you will have to implement a feature where the creator of a todo can add or remove the collaborators to a todo. Specifically, for every todo, the owner can add one or more collaborator to a todo and can remove one or more collaborators from a todo. So, every todo will have a set of collaborators (may be empty too). The collaborator of a todo will have the access to Edit or Delete the todo, but he won't be able to add or delete the collaborators to the todo. Only the creator of the todo will have the permission to add or remove collaborators.
-
-  For this subtask, you may need to fiddle around with the models, create some views and serializers and make the necessary endpoints. We suggest you to create the two endpoints `/todo/{id}/add-collaborators/` and `/todo/{id}/remove-collaborators/` for adding and removing collaborators, respectively. Also, you will need to modify the GET Todo endpoint to display all the Todo - the one which the user has created, and the one for which the user is collaborating. Make sure to distinguish between the two of them, and we leave your imagination on how to do this.
-
-Make sure to do proper validation of the requests, and grant proper permissions to a user.
-
-## Tasks
-- ### Complete all the basic endpoints (100 points)
-- ### Collaborator feature (100 points)
-
-## Deadline
-You'll have a week to complete this task.
-
-## Submission
-* Follow the instructions to setup and run this project.
-* Complete the task by making the required changes in the files.
-* When done, commit your work locally and push it to your origin (forked repository).
-* Make a pull request to our repository, stating the tasks which you have completed.
-* Let us review your pull request.
-
-## API Description (Only for Subtask 1)
-
-### Auth System
-For this API, you will have to use Token-based Authorization. We have already created the serializer and the functions required to create token for a user, for your reference. All the requests made to the API (except the Login and Register endpoints) shall need an  **Authorization header**  with a valid token and the prefix  **Token**. Make sure to add proper permissions in the views to implement this.
-
-The authorization header shall have the following format:
-`Authorization: Token <token>`
-
-In order to obtain a valid token it's necessary to send a request  `POST /auth/login/`  with  **username**  and  **password**. To register a new user it's necessary to make a request  `POST /auth/register/`  with name, email, username and password.
-
-### End Points
-
-**Auth**
-
--   `POST /auth/login/` 
-
-	Takes the username and password as input, validates them and returns the **Token**, if the credentials are valid.  
-
-	Request Body (Sample):
-	```
-	{
-	  "username": "string",
-	  "password": "string"
-	}
-	```
-	Response Body (Sample):
-	```
-	{
-	  "token":  "string"
-	}
-	```
-	Response Code: `200`
-
--   `POST /auth/register/`
-
-	Register a user in Django by taking the name, email, username and password as input.
-
-	Request Body (Sample):
-	```
-	{
-	  "name": "string",
-	  "email": "user@example.com",
-	  "username": "string",
-	  "password": "string"
-	}
-	```
-	Response Body (Sample):
-	```
-	{
-	  "token":  "string"
-	}
-	```
-	Response Code: `200`
-
--   `POST /auth/profile/`
-
-	Retrieve the id, name, email and username of the logged in user. Requires token in the Authorization header.
-
-	Response Body (Sample):
-	```
-	{
-	  "id":  1,
-	  "name":  "string",
-	  "email":  "user@example.com",
-	  "username":  "string"
-	}
-	```
-	Response Code: `200`
-
-
-**Todo**
-
--   `GET /todo/`
-
-	Get all the Todos of the logged in user. Requires token in the Authorization header.
-
-	Response Body (Sample):
-	```
-	[
-	  {
-	    "id":  1,
-	    "title":  "string"
-	  },
-	  {
-	    "id":  2,
-	    "title":  "string"
-	  }
-	]
-	```
-	Response Code: `200`
-
--   `POST /todo/create/` 
-
-	Create a Todo entry for the logged in user. Requires token in the Authorization header.
-
-	Request Body (Sample):
-	```
-	{
-	  "title": "string"
-	}
-	```
-	Response Body (Sample):
-	```
-	{
-	  "id":  1,
-	  "title":  "string"
-	}
-	```
-	Response Code: `200`
-
--   `GET /todo/{id}/`
-
-	Get the Todo of the logged in user with given id. Requires token in the Authorization header.
-
-	Response Body (Sample):
-	```
-	{
-	  "id":  1,
-	  "title":  "string"
-	}
-	```
-	Response Code: `200`
-
--   `PUT /todo/{id}/`
-
-	Change the title of the Todo with given id, and get the new title as response. Requires token in the Authorization header.
-
-	Request Body (Sample):
-	```
-	{
-	  "title": "string"
-	}
-	```
-	Response Body (Sample):
-	```
-	{
-	  "id":  1,
-	  "title":  "string"
-	}
-	```
-
--   `PATCH /todo/{id}/`
-
-	Change the title of the Todo with given id, and get the new title as response. Requires token in the Authorization header.
-
-	Request Body (Sample):
-	```
-	{
-	  "title": "string"
-	}
-	```
-	Response Body (Sample):
-	```
-	{
-	  "id":  1,
-	  "title":  "string"
-	}
-	```
-
--   `DELETE /todo/{id}/`
-
-	Delete the Todo with given id. Requires token in the Authorization header.
-
-	Response Code: `204`
-
 ### Testing the API
 
 The API can be tested by running the Django server locally, going to the following url: [http://127.0.0.1:8000/](http://127.0.0.1:8000/), clicking the "Try it out" button after selecting the endpoint and finally executing it along with the Response Body (if required).

diff --git a/api/admin.py b/api/admin.py
@@ -1,4 +1,5 @@
 from django.contrib import admin
-from .models import Todo
+from .models import *
 
-admin.site.register(Todo)
+admin.site.register(Todo)
+admin.site.register(Collaboration)
diff --git a/api/migrations/0001_initial.py b/api/migrations/0001_initial.py
@@ -1,13 +1,16 @@
-# Generated by Django 3.0.5 on 2020-04-21 08:58
+# Generated by Django 3.2.6 on 2021-08-16 18:36
 
+from django.conf import settings
 from django.db import migrations, models
+import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
 
     initial = True
 
     dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
@@ -16,6 +19,15 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('title', models.CharField(max_length=255)),
+                ('creator', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='collab',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('todo', models.ManyToManyField(null=True, to='api.Todo')),
+                ('user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
             ],
         ),
     ]
diff --git a/api/migrations/0002_rename_todo_collab_todos.py b/api/migrations/0002_rename_todo_collab_todos.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.6 on 2021-08-18 17:16
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='collab',
+            old_name='todo',
+            new_name='todos',
+        ),
+    ]
diff --git a/api/migrations/0002_todo_creator.py b/api/migrations/0002_todo_creator.py
diff --git a/api/migrations/0003_auto_20210819_1124.py b/api/migrations/0003_auto_20210819_1124.py
@@ -0,0 +1,27 @@
+# Generated by Django 3.2.6 on 2021-08-19 05:54
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('api', '0002_rename_todo_collab_todos'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Collaboration',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('collaborators', models.ManyToManyField(null=True, to=settings.AUTH_USER_MODEL)),
+                ('todo', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='api.todo')),
+            ],
+        ),
+        migrations.DeleteModel(
+            name='collab',
+        ),
+    ]
diff --git a/api/migrations/0004_rename_collaborators_collaboration_user.py b/api/migrations/0004_rename_collaborators_collaboration_user.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.6 on 2021-08-19 05:58
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0003_auto_20210819_1124'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='collaboration',
+            old_name='collaborators',
+            new_name='user',
+        ),
+    ]
diff --git a/api/migrations/0005_rename_user_collaboration_collaborator.py b/api/migrations/0005_rename_user_collaboration_collaborator.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.6 on 2021-08-19 06:23
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0004_rename_collaborators_collaboration_user'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='collaboration',
+            old_name='user',
+            new_name='collaborator',
+        ),
+    ]