Library Service API: core functionality

.dockerignore

@@ -0,0 +1,6 @@
+venv
+.env
+.gitignore
+.github
+media
+.idea

.env.sample

@@ -0,0 +1,12 @@
+DJANGO_SECRET_KEY=DJANGO_SECRET_KEY
+ALLOWED_HOSTS=ALLOWED_HOSTS
+POSTGRES_DB=POSTGRES_DB
+POSTGRES_USER=POSTGRES_USER
+POSTGRES_PASSWORD=POSTGRES_PASSWORD
+POSTGRES_HOST=POSTGRES_HOST
+POSTGRES_PORT=POSTGRES_PORT
+TELEGRAM_BOT_TOKEN=TELEGRAM_BOT_TOKEN
+TELEGRAM_CHAT_ID=TELEGRAM_CHAT_ID
+CELERY_BROKER_URL=CELERY_BROKER_URL
+CELERY_RESULT_BACKEND=CELERY_RESULT_BACKEND
+STRIPE_API_KEY=STRIPE_API_KEY

Dockerfile

@@ -0,0 +1,28 @@
+FROM python:3.11.2-slim-buster
+LABEL maintainer="callogan217@gmail.com"
+
+ENV PYTHONUNBUFFERED 1
+
+WORKDIR app/
+
+COPY requirements.txt requirements.txt
+RUN pip install debugpy
+
+RUN apt-get update \
+    && apt-get -y install libpq-dev gcc
+
+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 chown -R 755 /vol/web/
+
+USER django-user

README.md

@@ -1 +1,156 @@
 # Library Service API
+
+Library Service API is overarching web application programming interface aimed to provide 
+a diverse features and operations for managing the library. Its main goal is to make functioning
+of the library more efficient by applying automation means.
+
+All the API features are grouped by the following services (as stacks of homogenous functionalities).
+
+## Book Service
+
+Book Service is intended for managing book stock at the library, including creation of books and making
+various operations with them. Nonetheless, only admin can create, update or delete books. Ordinary users 
+have an access to a list of all books as well as to single book details without the possibility 
+to make operations with them. 
+
+## User Service
+
+Users can register providing an email and a password. After going through authentication procedure users 
+can view and update their profile information. 
+
+## Borrowing Service
+
+Borrowing Service operates the borrowing of books by users and provides all the necessary actions related 
+to that functionality. 
+
+* Create new borrowing: borrowing the book results in making the record in the ledger about borrowing
+creation and corresponding changes of the inventory.
+* Get borrowing collection - glean a list of borrowings based on 2 criteria:
+  - user ID (for admin only);
+  - "is_active" status for the borrowing (either the book is returned or not).
+* Get certain borrowing: retrieve detailed information about specified borrowing information.
+* Return the book: assign the value for "actual return date" of borrowed book. Simultaneously the payment 
+for the borrowing is being created.
+
+## Notification Service (Telegram chat)
+
+Notification Service is in charge of sending notifications associated with library operations using 
+Telegram chat.
+
+* Keep library administrators informed about creation of new borrowing.
+* Issue the alert on overdue borrowings.
+* Notify administrators about successful payments.
+
+## Payment Service (Stripe API integration)
+
+Payment Service provides payment processing for borrowings in reliable and secure way using 
+Stripe payment gateway.
+
+* Perform payments for borrowings: deliver full-fledged financial infrastructure to users 
+for making payments.
+* Checking payment processing status: verify that the payment has been processed successfully
+or inform about payment cancellation.
+* Ensures the control of expiration time for the payments session and for the payment.
+
+## Installation
+
+Clone this repository:
+
+   ```bash
+   git clone https://github.com/callogan/library-service-api
+   cd library-service-api
+   ```
+
+* The main branch is considered as the most sustainable branch, therefore it is recommended to work from it.
+
+* If you intend to run the application locally, follow the next steps:
+
+1. Create the virtual environment:
+
+   ```bash
+   python -m venv venv
+   ```
+
+2. Activate the virtual environment:
+
+   On Windows:
+
+      ```bash
+      venv\Scripts\activate
+      ```
+
+   On macOS and Linux:
+
+      ```bash
+      source venv/bin/activate
+      ```
+
+3. Install dependencies:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. Copy this file ".env.sample" and rename it to ".env", then fill in the actual values for your local environment.
+
+STRIPE_API_KEY (as secret key) is available here: https://sripe.com/. You can get Telegram Bot Token 
+here: https://t.me/BotFather. 
+
+5. Apply the migrations:
+
+   ```bash
+   python manage.py migrate
+   ```
+
+6. In order to run the development server, use the following command:
+
+   ```bash
+   python manage.py runserver
+   ```
+
+* You might as well run the application via the Docker. For this purpose make certain the Docker is installed 
+on your computer and follow the next steps:
+1. Fill the actual data for ".env" file (as was mentioned above).
+2. Build the Docker image and start the containers for the application and the database:
+   ```bash
+   docker-compose up --build
+   ```
+
+Access the application in your web browser at http://localhost:8000.
+
+## Project Fixture
+
+ - This project includes the fixture that is used for demonstration purpose. The fixture contains basic dataset
+representing various project entities.
+ - The fixture named `library_service_db_data.json` is located in the root directory.
+ - In order to load the fixture data into the application, use the following command:
+
+   ```bash
+   python manage.py loaddata library_service_db_data.json
+   ```
+
+## Technologies
+
+* [Django REST Framework](https://www.django-rest-framework.org/) This is toolbox for designing Web APIs, providing 
+features such as serialization, authentication, API views and viewsets to streamline the development of RESTful services
+in Django applications.
+* [Celery](https://docs.celeryq.dev/en/stable/) This is the system to operate task queue with focus on real-time 
+processing and option to schedule tasks.    
+* [Redis](https://redis.io/) This is a source available, im-memory storage, used as distributed, in-memory key-value 
+database, cache and message broker.
+* [Docker](https://www.docker.com/) This is open source containerization platform that enables developers to package 
+applications into containers, simplifying the process of building, running, managing and distributing applications 
+throughout different execution environments.
+* [PostgreSQL](https://www.postgresql.org/) This is a powerful, open source object-relational database management 
+system.
+* [Swagger](https://swagger.io/) This is open source suite of tools to generate API documentation.
+
+## Demo
+
+![ER Diagram](demo/entity-relationship-diagram.png)
+![API Endpoints part 1](demo/swagger-all-endpoints-1.png)
+![API Endpoints part 2](demo/swagger-all-endpoints-2.png)
+
+## Copyright
+
+Copyright (c) 2024 Ruslan Kazmiryk

book/admin.py

@@ -0,0 +1,12 @@
+from django.contrib import admin
+
+from book.models import Book
+
+
+@admin.register(Book)
+class BookAdmin(admin.ModelAdmin):
+    list_display = (
+        "id", "title", "author", "cover", "inventory", "daily_fee"
+    )
+    list_filter = ("author", )
+    search_fields = ("title", )

book/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class BookConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "book"

book/migrations/0001_initial.py

@@ -0,0 +1,47 @@
+# Generated by Django 5.0.6 on 2024-06-16 13:35
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Book",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255)),
+                ("author", models.CharField(max_length=255)),
+                (
+                    "cover",
+                    models.CharField(
+                        choices=[("H", "HARD"), ("S", "SOFT")], max_length=1
+                    ),
+                ),
+                ("inventory", models.PositiveIntegerField()),
+                (
+                    "daily_fee",
+                    models.DecimalField(
+                        decimal_places=2,
+                        max_digits=5,
+                        validators=[django.core.validators.MinValueValidator(0)],
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("title",),
+            },
+        ),
+    ]

book/models.py

@@ -0,0 +1,21 @@
+from django.core.validators import MinValueValidator
+from django.db import models
+
+
+class Book(models.Model):
+    COVER_CHOICES = [("H", "HARD"), ("S", "SOFT")]
+
+    title = models.CharField(max_length=255)
+    author = models.CharField(max_length=255)
+    cover = models.CharField(max_length=1, choices=COVER_CHOICES)
+    inventory = models.PositiveIntegerField()
+    daily_fee = models.DecimalField(
+        max_digits=5, decimal_places=2, validators=[MinValueValidator(0)]
+    )
+
+    class Meta:
+        ordering = ("title",)
+
+    def __str__(self):
+        return self.title
+

book/serializers.py

@@ -0,0 +1,15 @@
+from rest_framework import serializers
+
+from book.models import Book
+
+
+class BookSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Book
+        fields = ("id", "title", "author", "cover", "inventory", "daily_fee")
+
+
+class BookListSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Book
+        fields = ("id", "title", "author", "daily_fee")