a-kuz/NestForHyndai

Описание

Nest framework TypeScript starter repository.

Техническое задание для Hyndai Mobility.
Данный сервис позволяет бронировать автомобиль.
И собирать отчет по средней загрузки автомобилей за месяц.

Установка

$ npm install

• Не забудьте установить и поднять PostreSQL сервер
• Настройки connect к базе-[./cars/connectDB.ts]

Базы cars и Price создаются и база Price заполняется при первом POST запросе.  
SQL запросы для работы с БД хранятся в [./cars/Request.ts]
- Цена дня берется из базы Price.

Запуск приложения

# development

$ npm run start

Описание действий бронирования.

После открыть программу для отправки GET/POST запроса.Для примера воспользуемся POSTMAN. Либо зайти по адресу: http://localhost:3000/swagger/

Swagger

PostMan

-В строке адресс пишем - [localhost:3000/]
В тело запроса помещаем JSON (Для резервирования или проверки статуса)
  {
    "idCar": 0,
    "dateStart": "2022-01-20",
    "dateEnd": "2022-02-03"
}
Отправляем
Типы запроса и ответ на них: 
- Post('check') 
    в ответ если все ок, вернет: Rezerv / Not Rezerv + стоимость аренды
- Post('reserve') 
    в ответ если все ок, вернет: (I have reserved a car, everything is fine + стоимость аренды) / (The car has already been reserved, choose another car or dates).
- Post
    Если дата начала брони или конца выподает на выходные то вернет: The beginning or end of the lease should fall on weekdays
    Если дата не валидная: Dates are not correctly selected
    Если длина брони больше 30 дней: It is not possible to reserve for more than 30 days
    Если id автомобиля больше 5 то: The identification car is specified more than there is in the park 

Описание работы

    Сервис принимает Post запросы и работает с бд.

Пример работы для бронирования авто.

  #В независимости от типа запроса, мы проверяем connect к бд и наличие табл cars, если нет соедениения то создаем, и если нет table тоже создаем.
  Принимаем Post('/check') с телом :
  {
    "idCar": 0,
    "dateStart": "2022-01-20",
    "dateEnd": "2022-02-03"
    }
  Проверяем существование табл cars, если ее нет то создаем.
  Проверяем валидность дат, id автомобиля, срок аренды. Если все ок, то делаем select в бд и если записей в бд нет, то считаем что ссесии аренды нет для данных критериев.
  Возвращаем Not Rezerv.

 Принимаем Post('/reserve') с телом :
 {
   "idCar": 0,
   "dateStart": "2022-01-20",
   "dateEnd": "2022-02-03"
} 
 Проверяем существование табл cars, если ее нет то создаем.
 Проверяем валидность дат, id автомобиля, срок аренды. Если все ок, то проверяем наличие ссесии для этих критериев, работает как и для GET, если ссесии нет, то рассчитываем стоимость и делаем Insert в бд, куда пишем ID(порядковый номер записи), idCar(ID машины), dateStart(Дата начала аренды), dateEnd(Дата конца аренды), Price(стоимость аренды за весь срок). 
 Возвращаем если все ок(I have reserved a car, everything is fine).

Записи в БД

Отчет средней загрузки автомобилей за месяц, по каждому авто и по всем.

Точка входа одна Post на '/order'. 
В тело помещаем JSON
{
    "idCar": 1,
    "month": "2022-05",
    "all": false 
}
Флаг all Отвечает за тип отчета, по одному авто или по всем.
month передаем год-мес.
idCar нужно только если берем статистику по одному авто.
Проверяем существование табл cars, если ее нет то создаем. Если по одному авто, то проверяем валидность IDcar.
Дальше уже по флагу смотрим, запускаем разные функ.
Запрос к бд один и тот же.
Если запрос не нашел записей удовл условиям, то возвращаем 0%, иначе возвращаем что вернул select

Автор

• Author - [Titov Maxim]