diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f25f983 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM python:3 +ENV PYTHONUNBUFFERED=1 +RUN mkdir /code +WORKDIR /code +COPY requirements.txt /code/ +RUN pip install -r requirements.txt +COPY . /code/ diff --git a/api/__init__.py b/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/__pycache__/__init__.cpython-38.pyc b/api/__pycache__/__init__.cpython-38.pyc new file mode 100644 index 0000000..6924934 Binary files /dev/null and b/api/__pycache__/__init__.cpython-38.pyc differ diff --git a/api/__pycache__/admin.cpython-38.pyc b/api/__pycache__/admin.cpython-38.pyc new file mode 100644 index 0000000..7584994 Binary files /dev/null and b/api/__pycache__/admin.cpython-38.pyc differ diff --git a/api/__pycache__/apps.cpython-38.pyc b/api/__pycache__/apps.cpython-38.pyc new file mode 100644 index 0000000..ce858b4 Binary files /dev/null and b/api/__pycache__/apps.cpython-38.pyc differ diff --git a/api/__pycache__/models.cpython-38.pyc b/api/__pycache__/models.cpython-38.pyc new file mode 100644 index 0000000..6ad59d3 Binary files /dev/null and b/api/__pycache__/models.cpython-38.pyc differ diff --git a/api/__pycache__/serializers.cpython-38.pyc b/api/__pycache__/serializers.cpython-38.pyc new file mode 100644 index 0000000..4ff5d41 Binary files /dev/null and b/api/__pycache__/serializers.cpython-38.pyc differ diff --git a/api/__pycache__/tests.cpython-38.pyc b/api/__pycache__/tests.cpython-38.pyc new file mode 100644 index 0000000..60c2b02 Binary files /dev/null and b/api/__pycache__/tests.cpython-38.pyc differ diff --git a/api/__pycache__/urls.cpython-38.pyc b/api/__pycache__/urls.cpython-38.pyc new file mode 100644 index 0000000..46ca879 Binary files /dev/null and b/api/__pycache__/urls.cpython-38.pyc differ diff --git a/api/__pycache__/views.cpython-38.pyc b/api/__pycache__/views.cpython-38.pyc new file mode 100644 index 0000000..2fadc20 Binary files /dev/null and b/api/__pycache__/views.cpython-38.pyc differ diff --git a/api/admin.py b/api/admin.py new file mode 100644 index 0000000..535c8ca --- /dev/null +++ b/api/admin.py @@ -0,0 +1,5 @@ +from django.contrib import admin +from api.models import Profile + +# Register your models here. +admin.site.register(Profile) diff --git a/api/apps.py b/api/apps.py new file mode 100644 index 0000000..d87006d --- /dev/null +++ b/api/apps.py @@ -0,0 +1,5 @@ +from django.apps import AppConfig + + +class ApiConfig(AppConfig): + name = 'api' diff --git a/api/migrations/0001_initial.py b/api/migrations/0001_initial.py new file mode 100644 index 0000000..4425e45 --- /dev/null +++ b/api/migrations/0001_initial.py @@ -0,0 +1,28 @@ +# Generated by Django 3.1.2 on 2020-10-04 00:18 + +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 = [ + migrations.CreateModel( + name='Profile', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('avatar', models.CharField(max_length=1024, null=True)), + ('token', models.CharField(max_length=1024, null=True)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('updated_at', models.DateTimeField(auto_now=True)), + ('user', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='profile', to=settings.AUTH_USER_MODEL)), + ], + ), + ] diff --git a/api/migrations/__init__.py b/api/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/migrations/__pycache__/0001_initial.cpython-38.pyc b/api/migrations/__pycache__/0001_initial.cpython-38.pyc new file mode 100644 index 0000000..bf8bf72 Binary files /dev/null and b/api/migrations/__pycache__/0001_initial.cpython-38.pyc differ diff --git a/api/migrations/__pycache__/__init__.cpython-38.pyc b/api/migrations/__pycache__/__init__.cpython-38.pyc new file mode 100644 index 0000000..554e3d4 Binary files /dev/null and b/api/migrations/__pycache__/__init__.cpython-38.pyc differ diff --git a/api/models.py b/api/models.py new file mode 100644 index 0000000..7054877 --- /dev/null +++ b/api/models.py @@ -0,0 +1,10 @@ +from django.db import models +from django.contrib.auth.models import User + +# Create your models here. +class Profile(models.Model): + user = models.OneToOneField(User, on_delete=models.CASCADE, related_name='profile') + avatar = models.CharField(max_length=1024, null=True) + token = models.CharField(max_length=1024, null=True) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) \ No newline at end of file diff --git a/api/serializers.py b/api/serializers.py new file mode 100644 index 0000000..e196e7a --- /dev/null +++ b/api/serializers.py @@ -0,0 +1,36 @@ +from rest_framework import serializers +from django.contrib.auth.models import User +from api.models import Profile +from django.utils.crypto import get_random_string + +class UserSerializer(serializers.ModelSerializer): + avatar = serializers.SerializerMethodField('get_avatar') + + def get_avatar(self, foo): + try: + return Profile.objects.get(user=foo.id).avatar + except Profile.DoesNotExist: + return None + + class Meta: + model = User + fields = ['id', 'email', 'first_name', 'last_name', 'avatar'] + + +class RegisterSerializer(serializers.ModelSerializer): + token = serializers.SerializerMethodField('get_token') + + def get_token(self, foo): + try: + return Profile.objects.get(user=foo.id).token + except Profile.DoesNotExist: + return None + + def create(self, validated_data): + user = User.objects.create(**validated_data) + Profile.objects.create(user=user, token=get_random_string(length=18)) + return user + + class Meta: + model = User + fields = ['id', 'email', 'password', 'username', 'token'] diff --git a/api/tests.py b/api/tests.py new file mode 100644 index 0000000..d1f6225 --- /dev/null +++ b/api/tests.py @@ -0,0 +1,69 @@ +from django.test import TestCase +from django.urls import reverse +from rest_framework import status +from rest_framework.test import APITestCase +from django.contrib.auth.models import User +from api.models import Profile + +# Create your tests here. +class UserTests(APITestCase): + def test_register_success(self): + url = reverse('register') + data = { + "email": "admin@mail.co", + "password": "admin" + } + response = self.client.post(url, data, format='json') + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(User.objects.count(), 1) + self.assertEqual(User.objects.get().username, 'admin') + + def test_register_failed(self): + url = reverse('register') + data = { + "email": "admin@mail.co" + } + response = self.client.post(url, data, format='json') + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + + def test_login_success(self): + self.user = User.objects.create(username='admin', email='admin@mail.co', password='admin') + self.profile = Profile.objects.create(user=self.user) + url = reverse('login') + data = { + "email": "admin@mail.co", + "password": "admin" + } + response = self.client.post(url, data, format='json') + self.assertEqual(response.status_code, status.HTTP_200_OK) + + def test_login_failed(self): + self.user = User.objects.create(username='admin', email='admin@mail.co', password='admin') + self.profile = Profile.objects.create(user=self.user) + url = reverse('login') + data = { + "email": "admin@mail.co" + } + response = self.client.post(url, data, format='json') + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + + + def test_user_list(self): + self.user = User.objects.create(username='admin', email='admin@mail.co', password='admin') + self.profile = Profile.objects.create(user=self.user) + url = reverse('user_list') + + response = self.client.get(url, format='json') + self.assertEqual(response.status_code, status.HTTP_200_OK) + + def test_user_detail(self): + self.user = User.objects.create(username='admin', email='admin@mail.co', password='admin') + self.profile = Profile.objects.create(user=self.user) + + url = reverse('user_detail', args=[1]) + response = self.client.get(url, format='json') + self.assertEqual(response.status_code, status.HTTP_200_OK) + + url_2 = reverse('user_detail', args=[2]) + response = self.client.get(url_2, format='json') + self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) \ No newline at end of file diff --git a/api/urls.py b/api/urls.py new file mode 100644 index 0000000..460b14c --- /dev/null +++ b/api/urls.py @@ -0,0 +1,13 @@ +from django.urls import path +from api import views + +urlpatterns = [ + path('register', views.register, name='register'), + path('register/', views.register, name='register'), + path('login', views.login, name='login'), + path('login/', views.login, name='login'), + path('users', views.user_list, name='user_list'), + path('users/', views.user_list, name='user_list'), + path('users/', views.user_detail, name='user_detail'), + path('users//', views.user_detail, name='user_detail'), +] diff --git a/api/views.py b/api/views.py new file mode 100644 index 0000000..40ec3f9 --- /dev/null +++ b/api/views.py @@ -0,0 +1,116 @@ +from django.shortcuts import render +from django.http import HttpResponse, JsonResponse +from django.views.decorators.csrf import csrf_exempt +from rest_framework.parsers import JSONParser +from django.contrib.auth.models import User +from api.models import Profile +from api.serializers import UserSerializer, RegisterSerializer +from django.core.paginator import Paginator +import time + + +# Create your views here. +@csrf_exempt +def user_list(request): + if request.method == 'GET': + page_size = 6 + page_number = 1 + + if 'page' in request.GET: + page_number = request.GET['page'] + + if 'delay' in request.GET: + delay = request.GET['delay'] + time.sleep(int(delay)) + + users = User.objects.all().order_by('id') + paginator = Paginator(users, page_size) + + if int(page_number) > paginator.num_pages: + return HttpResponse(status=404) + + paginated_users = paginator.page(page_number).object_list + + serializer = UserSerializer(paginated_users, many=True) + Response = { + "page": page_number, + "per_page": page_size, + "total": users.count(), + "total_pages": paginator.num_pages, + "data": serializer.data + } + return JsonResponse(Response, safe=False) + + +@csrf_exempt +def user_detail(request, pk): + try: + user = User.objects.get(pk=pk) + except User.DoesNotExist: + return HttpResponse(status=404) + + if request.method == 'GET': + serializer = UserSerializer(user) + return JsonResponse(serializer.data) + elif request.method == 'PUT' or request.method == 'PATCH': + data = JSONParser().parse(request) + if 'avatar' in data: + avatar = data.pop('avatar') + try: + profile = Profile.objects.get(user=pk) + profile.avatar = avatar + profile.save() + except Profile.DoesNotExist: + Profile.objects.create(user=user, avatar=avatar) + elif 'token' in data: + token = data.pop('token') + try: + profile = Profile.objects.get(user=pk) + profile.token = token + profile.save() + except Profile.DoesNotExist: + Profile.objects.create(user=user, avatar=avatar) + + serializer = UserSerializer(user, data=data) + if serializer.is_valid(): + serializer.save() + return JsonResponse(serializer.data) + return JsonResponse(serializer.errors, status=400) + + elif request.method == 'DELETE': + user.delete() + return HttpResponse(status=204) + + +@csrf_exempt +def register(request): + if request.method == 'POST': + data = JSONParser().parse(request) + username = data['email'].split('@')[0] + data['username'] = username + + serializer = RegisterSerializer(data=data) + if serializer.is_valid(): + serializer.save() + Response = { + "id": serializer.data['id'], + "token": serializer.data['token'] + } + return JsonResponse(Response) + return HttpResponse(status=404) + + +@csrf_exempt +def login(request): + if request.method == 'POST': + data = JSONParser().parse(request) + + try: + user = User.objects.get(email=data['email'], password=data['password']) + profile = Profile.objects.get(user=user) + Response = { + "token": profile.token + } + return JsonResponse(Response) + except: + return HttpResponse(status=404) \ No newline at end of file diff --git a/codingchallenge/__init__.py b/codingchallenge/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/codingchallenge/__pycache__/__init__.cpython-38.pyc b/codingchallenge/__pycache__/__init__.cpython-38.pyc new file mode 100644 index 0000000..7ff6566 Binary files /dev/null and b/codingchallenge/__pycache__/__init__.cpython-38.pyc differ diff --git a/codingchallenge/__pycache__/settings.cpython-38.pyc b/codingchallenge/__pycache__/settings.cpython-38.pyc new file mode 100644 index 0000000..6396611 Binary files /dev/null and b/codingchallenge/__pycache__/settings.cpython-38.pyc differ diff --git a/codingchallenge/__pycache__/urls.cpython-38.pyc b/codingchallenge/__pycache__/urls.cpython-38.pyc new file mode 100644 index 0000000..3f829d6 Binary files /dev/null and b/codingchallenge/__pycache__/urls.cpython-38.pyc differ diff --git a/codingchallenge/__pycache__/wsgi.cpython-38.pyc b/codingchallenge/__pycache__/wsgi.cpython-38.pyc new file mode 100644 index 0000000..5dc81b4 Binary files /dev/null and b/codingchallenge/__pycache__/wsgi.cpython-38.pyc differ diff --git a/codingchallenge/asgi.py b/codingchallenge/asgi.py new file mode 100644 index 0000000..31bd7ee --- /dev/null +++ b/codingchallenge/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for codingchallenge project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'codingchallenge.settings') + +application = get_asgi_application() diff --git a/codingchallenge/settings.py b/codingchallenge/settings.py new file mode 100644 index 0000000..04c0e86 --- /dev/null +++ b/codingchallenge/settings.py @@ -0,0 +1,122 @@ +""" +Django settings for codingchallenge project. + +Generated by 'django-admin startproject' using Django 3.1.2. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.1/ref/settings/ +""" + +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'p=e8@%i-com_+*m!b#wky%#ooql3m!a9re(=xx0e_g0c4hl(c_' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = ['*'] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'rest_framework', + 'api.apps.ApiConfig' +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'codingchallenge.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'codingchallenge.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/3.1/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.1/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/codingchallenge/urls.py b/codingchallenge/urls.py new file mode 100644 index 0000000..11b767f --- /dev/null +++ b/codingchallenge/urls.py @@ -0,0 +1,24 @@ +"""codingchallenge URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.1/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.views import debug +from django.urls import path, include + +urlpatterns = [ + path('', debug.default_urlconf), + path('admin/', admin.site.urls), + path('api/', include('api.urls')) +] diff --git a/codingchallenge/wsgi.py b/codingchallenge/wsgi.py new file mode 100644 index 0000000..aafc5a6 --- /dev/null +++ b/codingchallenge/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for codingchallenge project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'codingchallenge.settings') + +application = get_wsgi_application() diff --git a/db.sqlite3 b/db.sqlite3 new file mode 100644 index 0000000..e459ed7 Binary files /dev/null and b/db.sqlite3 differ diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..1038f69 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,17 @@ +version: "3.8" + +services: + migration: + build: . + command: python manage.py migrate --noinput + + web: + build: . + command: python manage.py runserver 0.0.0.0:8000 + volumes: + - .:/code + - .db_data/db.sqlite3:/db.sqlite3 + ports: + - "8000:8000" + depends_on: + - migration diff --git a/instruction.md b/instruction.md new file mode 100644 index 0000000..996eb2a --- /dev/null +++ b/instruction.md @@ -0,0 +1,4 @@ +To run this application: +1. Run "docker-compose up" in this directory +2. Check the api with the same documentation with https://reqres.in/ +3. Example, to get all users http://0.0.0.0:8000/api/users or http://0.0.0.0:8000/api/users?page=2 \ No newline at end of file diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..b143a22 --- /dev/null +++ b/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'codingchallenge.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d6970e8 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Django>=3.0,<4.0 +psycopg2-binary>=2.8 +djangorestframework