Develop

.dockerignore

@@ -0,0 +1,4 @@
+venv
+.env
+.idea
+static

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+inline-quotes = "
+ignore = E203, E266, W503, N807, N818, F401
+max-line-length = 79
+max-complexity = 18
+select = B,C,E,F,W,T4,B9,Q0,N8,VNE
+exclude =
+    **migrations
+    venv
+    tests

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

Dockerfile

@@ -0,0 +1,26 @@
+FROM python:3.9.18-alpine3.18
+LABEL maintainer="[email protected]"
+
+ENV PYTHONUNBUFFERED 1
+
+WORKDIR app/
+
+COPY requirements.txt  requirements.txt
+
+RUN pip install -r requirements.txt
+
+COPY . .
+
+RUN mkdir -p /vol/web/media
+
+RUN adduser \
+    --disabled-password \
+    --no-create-home \
+    django-user
+
+RUN chown -R django-user:django-user /vol/
+RUN chmod -R 755 /vol/web/
+
+RUN apk add --no-cache bash
+
+USER django-user

README.md

@@ -1 +1,113 @@
-# airport_api_service
+# Airport-API-Service 
+
+Welcome to the Airport Service API! Best solution for managing flight orders, routes, planes, tickets ordering and more. Airport Service API suites both developers integrating airport management infrastructure or airline company in need of efficient system to handle reservations and flights .
+
+___
+
+## Airport Service DB Structure
+
+![Airport Service DB Structure](media/readme_images/img.png)
+
+## Features
+
+
+* ___Tickets Ordering ___: Users can easily order tickets for their desired flights.
+* ___Flight Management___: Administrators can add new flights to the system and manage existing ones. 
+* ___Authentication and Permissions___: The API is secured with JWT authentication using the Django Rest Framework (DRF).
+* ___Filtering and Pagination___: The API supports filtering of flight, airports, airplanes and crew. Even more, pagination is implemented to efficiently manage large sets of data.
+* ___API Documentation___: The API documentation is automatically generated using DRF Spectacular. It provides a clear overview of available endpoints, request parameters, response formats, and authentication requirements.
+* ___User Order Management___: Users can only view and manage their own orders. The API enforces this restriction in order to ensure privacy and security of data.
+* ___Preloaded data for better first time experience___: API is presented with preloaded data. It will allow you to test all functionality of API.
+___
+
+## Prerequisites
+Following prerequisites need to be installed on your system:
+
+* ___Docker___: You can download and install Docker from the official website: https://www.docker.com/.
+* ___ModHeader___: You can download and install ModHeader from the official website: https://modheader.com/.
+
+
+## How to use
+
+### Easy and quick way
+
+Follow the link [Airport Service API](https://airport-service-api-v9qf.onrender.com)
+
+### More complex but full of fun way
+
+#### Working with git repository
+
+To set up the Airport Service API, follow these steps:
+
+1. Clone the repository:
+    ```
+    git clone https://github.com/Naz-iv/airport_api_service.git
+    ```
+2. Navigate to Project Directory: Change into the project directory using the following command:
+    ```
+    cd airport_api_service
+    ```
+3. Build and Run Docker Container: Use Docker Compose to build the API's Docker container and start the API server:
+    ```
+    docker-compose build
+    docker-compose up
+    ```
+
+#### Working with Docker Hub
+
+To set up the Airport Service API, follow these steps:
+
+1. Pull image from Docker Hub:
+    ```
+    docker pull nivankiv/airport_api_service-app:latest
+    ```
+2. Run Docker Container:
+    ```
+    docker-compose up
+    ```
+
+##### When Git API project or Docker Hub image is ready for user:
+
+You need to generate access token. Do to: ``127.0.0.1:8000/api/users/token``
+
+To use servie as admin enter following credentials:
+- login: ``[email protected]``
+- password: ``1qazcde3``
+
+To use servie as user enter following credentials:
+- login: ``[email protected]``
+- password: ``1qazcde3``
+
+After logging in with provided credentials you will receive two tokens: access token and refresh token.
+Add new request headed and enter information:
+
+Name: ``Authorization``
+
+Value: ``Bearer_space_*your_access_token*`` 
+
+Access token example. ``Bearer dmwkejeowk.ewkjeoqdowkjefowfejwefjwef.efhnwefowhefojw``
+
+![ModHeader interface](media/readme_images/img_1.png)
+
+Go to ``127.0.0.1:8000/api/flight_service/`` and discover all hidden gems
+
+
+## Conclusion
+
+Thank you for using the Airport Service API! 
+
+## Screenshots
+
+![API main](media/readme_images/img_2.png)
+![Crew List](media/readme_images/img_3.png)
+![Airport List](media/readme_images/img_4.png)
+![Order List](media/readme_images/img_5.png)
+![Airplane Types List](media/readme_images/img_6.png)
+![Airplane List](media/readme_images/img_7.png)
+![Flight List](media/readme_images/img_8.png)
+![Ticket List](media/readme_images/img_9.png)
+![Route List](media/readme_images/img_10.png)
+![Order Details](media/readme_images/img_11.png)
+![Flight Details](media/readme_images/img_12.png)
+![Ticket Details](media/readme_images/img_13.png)
+![Route Details](media/readme_images/img_14.png)

core/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for core 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/4.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
+
+application = get_asgi_application()

core/settings.py

@@ -0,0 +1,170 @@
+import os
+from datetime import timedelta
+from pathlib import Path
+from dotenv import load_dotenv
+
+load_dotenv()
+
+# 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/4.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.environ["SECRET_KEY"]
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = os.environ["DEBUG"]
+
+ALLOWED_HOSTS = []
+
+INTERNAL_IPS = [
+    "127.0.0.1",
+]
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "rest_framework",
+    "drf_spectacular",
+    "debug_toolbar",
+    "flight_service",
+    "user",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
+    "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 = "core.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 = "core.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "HOST": os.environ["POSTGRES_HOST"],
+        "NAME": os.environ["POSTGRES_DB"],
+        "USER": os.environ["POSTGRES_USER"],
+        "PASSWORD": os.environ["POSTGRES_PASSWORD"],
+        "PORT": os.environ["POSTGRES_PORT"]
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.0/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",
+    },
+]
+
+AUTH_USER_MODEL = "user.User"
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = False
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.0/howto/static-files/
+
+STATIC_URL = "static/"
+
+MEDIA_URL = "/media/"
+MEDIA_ROOT = "/vol/web/media"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+REST_FRAMEWORK = {
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+    "DEFAULT_THROTTLE_CLASSES": [
+        "rest_framework.throttling.AnonRateThrottle",
+        "rest_framework.throttling.UserRateThrottle",
+    ],
+    "DEFAULT_THROTTLE_RATES": {"anon": "10/day", "user": "30/day"},
+    "DEFAULT_AUTHENTICATION_CLASSES": (
+        "rest_framework_simplejwt.authentication.JWTAuthentication",
+    ),
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
+    "PAGE_SIZE": 4
+}
+
+SPECTACULAR_SETTINGS = {
+    "TITLE": "Airport Service API",
+    "DESCRIPTION": "Order flight tickets and check flights",
+    "VERSION": "1.0.0",
+    "SERVE_INCLUDE_SCHEMA": False,
+    "SWAGGER_UI_SETTINGS": {
+        "deepLinking": True,
+        "defaultModelRendering": "model",
+        "defaultModelsExpandDepth": 2,
+        "defaultModelExpandDepth": 2,
+    },
+}
+
+SIMPLE_JWT = {
+    "ACCESS_TOKEN_LIFETIME": timedelta(minutes=50),
+    "REFRESH_TOKEN_LIFETIME": timedelta(days=1),
+    "ROTATE_REFRESH_TOKENS": False,
+}

core/urls.py

@@ -0,0 +1,21 @@
+from django.conf.urls.static import static
+from django.contrib import admin
+from django.urls import path, include
+from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView, SpectacularRedocView
+
+from core import settings
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("api/user/", include("user.urls", namespace="user")),
+    path(
+        "api/flight_service/",
+        include("flight_service.urls", namespace="flight-service"),
+    ),
+
+    path("__debug__/", include("debug_toolbar.urls")),
+
+    path("api/schema/", SpectacularAPIView.as_view(), name="schema"),
+    path("api/schema/swagger/", SpectacularSwaggerView.as_view(url_name="schema"), name="swagger"),
+    path("api/schema/redoc/", SpectacularRedocView.as_view(url_name="schema"), name="redoc"),
+] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

core/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for core 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/4.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
+
+application = get_wsgi_application()