first commit

.gitignore

@@ -0,0 +1,32 @@
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### IntelliJ IDEA ###
+.idea
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

pom.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.example</groupId>
+    <artifactId>NTO-2024</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.5.5</version>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>1.7.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

readme.md

@@ -0,0 +1,81 @@
+# НТО 2024. II отборочный этап. Командные задания — серверная часть
+
+## 📖 Предыстория
+
+В компании S контроль доступа в офис осуществляется с помощью СКУД (системы контроля управления доступом). На данный момент у каждого сотрудника компании есть карта-пропуск с NFC меткой. А у каждой входной двери есть считыватель с обеих сторон. При поднесении карты к считывателю, дверь открывается, а информация о времени входа или выхода сотрудника фиксируется в базе данных. 
+Администрации компании S требуется мобильное приложение, как для рядовых сотрудников, так и для администрации с возможностью просмотра посещений и работой электронного пропуска как временной замены обычного (при помощи сканировании QR кода, который находится на считывателе). Поскольку в приложении есть возможность использовать телефон как пропуск - то к данному приложению повышенные требования к безопасности всех данных, находящихся внутри него.
+
+
+
+## 🛠️ Техническое задание
+
+Требуется разработать серверное приложение на Java (Java 11) с использованием Spring Boot, которое работает на основе протоколов TCP/IP и взаимодействует с клиентами благодаря RESTful API. Для хранения данных о сотрудниках и их посещениях должна использоваться реляционная база данных (H2). Сотрудникам не нужно регистрироваться, все данные в базе должны быть предзаполнены. Картинки для аватаров пользователей не должны храниться в БД. Должны быть сохранены лишь URL-адреса на ресурсы, откуда в последующем мобильное приложение загрузит соответствующий аватар. 
+
+Сервер разрабатывается на основе предоставляемой заготовки проекта. Версии зависимостей и сами зависимости изменяться не должны. 
+
+
+
+## 📂 Правила работы с проектом-заготовкой
+
+В предоставленном проекте необходимо изучить, но никак не модифицировать, не перемещать и не удалять следующие файлы:
+- `pom.xml`
+- `application.yml`
+- все файлы из `db.changelog`
+
+Кроме описанных выше файлов, в проекте уже созданы основные классы-сущности и добавлены пустые классы всех слоев. В этих классах необходимо будет написать программный код и добавить аннотации для реализации описанного задания. Наименования классов и прочий код уже написанный в предоставляемом проекте **изменять/удалять не нужно, необходимо их доработать**. Добавлять свои дополнительные классы в проект можно.
+
+Создание таблиц в БД и предзаполнение их требуемыми данными уже реализовано в заготовке при помощи liquibase.  
+
+
+## 🌐 Где необходимо разместить сервер
+
+Серверное приложение должно быть разработано и протестировано локально (не требуется размещать сервер удаленно и осуществлять его функционирование 24/7).
+
+
+
+## 📋 Технические требования к серверу и его ответам клиенту
+
+Для конфигурирования Вашего сервера (его хоста/IP адреса) используйте константы из файла `Constants.kt`.
+
+| **Тип запроса** | **Путь**              | **Параметры/Тело**                                                             | **Ответы**                                                                                                                                              |
+|------------------|-----------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **GET**          | `api/<LOGIN>/auth`   | `<LOGIN>` - никнейм/имя пользователя                                           | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - данный логин существует - можно пользоваться приложением            |
+| **GET**          | `api/<LOGIN>/info`   | `<LOGIN>` - никнейм/имя пользователя                                           | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - ОК<br>{<br> "id": 1,<br> "login": "pivanov",<br> "name": "Иванов Петр Федорович",<br> "photo": "https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg",<br> "position": "Разработчик",<br> "lastVisit": "2024-02-12T08:30:00"<br>} |
+| **PATCH**        | `api/<LOGIN>/open`   | `<LOGIN>` - никнейм/имя пользователя<br>Тело: `{“value”: <CODE>}`, где <br> `<CODE>` - это код, полученный из экрана сканирования QR кода | `400` - что-то пошло не так<br>`401` - логина не существует или неверный<br>`200` - дверь открылась                                                    |
+
+
+
+## 📊 Данные, которыми необходимо наполнить базу данных:
+
+
+
+| **id** | **login**  | **name**                        | **photo**                                                                                   | **position**     | **lastVisit**       |
+|--------|------------|---------------------------------|---------------------------------------------------------------------------------------------|------------------|---------------------|
+| 1      | pivanov    | Иванов Петр Федорович          | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg               | Разработчик      | 2024-02-12T08:30:00    |
+| 2      | ipetrov    | Петров Иван Константинович      | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg               | Аналитик         | 2024-02-30T08:35:00    |
+| 3      | asemenov   | Семенов Анатолий Анатольевич   | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg               | Разработчик      | 2024-02-31T08:31:00    |
+| 4      | afedorov   | Федоров Александр Сергеевич    | https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg               | Тестировщик      | 2024-02-30T08:36:00    |
+
+
+
+| **id** | **code**               |
+|--------|-------------------------|
+| 1      | 1234567890123456789     |
+| 2      | 9223372036854775807     |
+| 3      | 1122334455667788990     |
+| 4      | 998877665544332211      |
+| 5      | 5566778899001122334     |
+
+
+
+## 📝 Решение
+
+Необходимо загрузить свое решение в систему [по ссылке](https://innovationcampus.ru/lms/mod/quiz/view.php?id=2078).
+
+Отметим, что работу необходимо осуществлять в представленных проектах-заготовках (шаблонах).
+
+
+
+## ✅ Особенности оценивания
+
+Оценивание происходит с помощью автоматической системы тестирования, которая в автоматическом режиме находит элементы и взаимодействует с ними (именно для этого у каждого элемента указан уникальный идентификатор, по которому будет производится поиск). Каждый тест происходит с чистой установки приложения. В случае тестирования сервера на него поочередно отправляются команды, описанные в API и ожидаются определенные корректные ответы. Сервер и приложение тестируются независимо.

src/main/java/com/example/nto/App.java

@@ -0,0 +1,11 @@
+package com.example.nto;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class App {
+    public static void main(String[] args) {
+        SpringApplication.run(App.class, args);
+    }
+}

src/main/java/com/example/nto/controller/EmployeeController.java

@@ -0,0 +1,34 @@
+package com.example.nto.controller;
+
+import com.example.nto.entity.Code;
+import com.example.nto.entity.Employee;
+import com.example.nto.service.EmployeeService;
+import javassist.tools.web.BadHttpRequest;
+import lombok.AllArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequestMapping("/api")
+@AllArgsConstructor
+public class EmployeeController {
+    private final EmployeeService employeeService;
+
+    @GetMapping("{login}/auth")
+    @ResponseStatus(HttpStatus.OK)
+    public void auth(@PathVariable String login) {
+        employeeService.getEmployee(login);
+    }
+
+    @GetMapping("{login}/info")
+    @ResponseStatus(HttpStatus.OK)
+    public Employee info(@PathVariable String login) {
+        return employeeService.getEmployee(login);
+    }
+
+    @PatchMapping("{login}/open")
+    @ResponseStatus(HttpStatus.OK)
+    public void open(@PathVariable String login, @RequestBody Code code) {
+        employeeService.open(login, code);
+    }
+}

src/main/java/com/example/nto/entity/Code.java

@@ -0,0 +1,22 @@
+package com.example.nto.entity;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.persistence.*;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Table(name = "code")
+@Entity
+public class Code {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private long id;
+    @Column(name = "value")
+    private long value;
+}

src/main/java/com/example/nto/entity/Employee.java

@@ -0,0 +1,31 @@
+package com.example.nto.entity;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.persistence.*;
+import java.time.LocalDateTime;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Entity
+@Table(name = "employee")
+public class Employee {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private long id;
+    @Column(name = "login")
+    private String login;
+    @Column(name = "name")
+    private String name;
+    @Column(name = "photo")
+    private String photo;
+    @Column(name = "position")
+    private String position;
+    @Column(name = "lastVisit")
+    private LocalDateTime lastVisit;
+}

src/main/java/com/example/nto/exception/IncorrectBodyException.java

@@ -0,0 +1,7 @@
+package com.example.nto.exception;
+
+public class IncorrectBodyException extends RuntimeException {
+    public IncorrectBodyException(String message) {
+        super(message);
+    }
+}

src/main/java/com/example/nto/exception/NoSuchEmployeeException.java

@@ -0,0 +1,7 @@
+package com.example.nto.exception;
+
+public class NoSuchEmployeeException extends RuntimeException{
+    public NoSuchEmployeeException(String message) {
+        super(message);
+    }
+}

src/main/java/com/example/nto/exception/advice/GlobalExceptionHandler.java

@@ -0,0 +1,22 @@
+package com.example.nto.exception.advice;
+
+import com.example.nto.exception.IncorrectBodyException;
+import com.example.nto.exception.NoSuchEmployeeException;
+import javassist.tools.web.BadHttpRequest;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+@ControllerAdvice
+public class GlobalExceptionHandler {
+    @ExceptionHandler(NoSuchEmployeeException.class)
+    public ResponseEntity<String> handleNoSuchEmployeeException(NoSuchEmployeeException e) {
+        return new ResponseEntity<>(e.getMessage(), HttpStatus.UNAUTHORIZED);
+    }
+
+    @ExceptionHandler(IncorrectBodyException.class)
+    public ResponseEntity<String> handleIncorrectBodyException(IncorrectBodyException e) {
+        return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
+    }
+}

src/main/java/com/example/nto/repository/CodeRepository.java

@@ -0,0 +1,13 @@
+package com.example.nto.repository;
+
+import com.example.nto.entity.Code;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
+
+import java.util.List;
+
+public interface CodeRepository extends JpaRepository<Code, Long> {
+    @Query("SELECT c FROM Code c WHERE c.value = :code")
+    List<Code> findByCode(@Param("code") long code);
+}

src/main/java/com/example/nto/repository/EmployeeRepository.java

@@ -0,0 +1,13 @@
+package com.example.nto.repository;
+
+import com.example.nto.entity.Employee;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
+
+import java.util.List;
+
+public interface EmployeeRepository extends JpaRepository<Employee, Long> {
+    @Query("SELECT e FROM Employee e WHERE e.login = :login")
+    List<Employee> findByLogin(@Param("login") String login);
+}

src/main/java/com/example/nto/service/EmployeeService.java

@@ -0,0 +1,10 @@
+package com.example.nto.service;
+
+import com.example.nto.entity.Code;
+import com.example.nto.entity.Employee;
+import javassist.tools.web.BadHttpRequest;
+
+public interface EmployeeService {
+    Employee getEmployee(String login);
+    void open(String login, Code code);
+}

src/main/java/com/example/nto/service/impl/EmployeeServiceImpl.java

@@ -0,0 +1,44 @@
+package com.example.nto.service.impl;
+
+import com.example.nto.entity.Code;
+import com.example.nto.entity.Employee;
+import com.example.nto.exception.IncorrectBodyException;
+import com.example.nto.exception.NoSuchEmployeeException;
+import com.example.nto.repository.CodeRepository;
+import com.example.nto.repository.EmployeeRepository;
+import com.example.nto.service.EmployeeService;
+import javassist.tools.web.BadHttpRequest;
+import lombok.AllArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Service;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+import java.util.List;
+
+@Service
+@AllArgsConstructor
+public class EmployeeServiceImpl implements EmployeeService {
+    private final CodeRepository codeRepository;
+    private final EmployeeRepository employeeRepository;
+
+    @Override
+    public Employee getEmployee(String login) throws NoSuchEmployeeException {
+        List<Employee> employee = employeeRepository.findByLogin(login);
+        if (employee.isEmpty()) {
+            throw new NoSuchEmployeeException("логина не существует или неверный");
+        } else {
+            return employee.get(0);
+        }
+    }
+
+    @Override
+    public void open(String login, Code code) {
+        getEmployee(login);
+        List<Code> codeList = codeRepository.findByCode(code.getValue());
+
+        if (codeList.isEmpty()) {
+            throw new IncorrectBodyException("incorrect body");
+        }
+    }
+}

src/main/resources/application.yml

@@ -0,0 +1,28 @@
+spring:
+
+  datasource:
+    url: jdbc:h2:mem:testdb
+
+  h2:
+    console:
+      #enabled: false
+      enabled: true
+
+  jpa:
+    #generate-ddl: false
+    generate-ddl: true
+
+    hibernate:
+      #ddl-auto: none
+      ddl-auto: create-drop
+
+    # Показываем запросы
+    show-sql: true
+
+    # Своевременный запуск data.sql
+    defer-datasource-initialization: true
+
+  spring-doc:
+    swagger-ui:
+      path: /swagger-ui.html
+      operationsSorter: method

src/main/resources/data.sql

@@ -0,0 +1,14 @@
+INSERT INTO employee (id, login, name, photo, position, last_visit)
+VALUES
+(1, 'pivanov', 'Иванов Петр Федорович', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Разработчик', '2024-02-12T08:30'),
+(2, 'ipetrov', 'Петров Иван Константинович', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Аналитик', '2024-02-13T08:35'),
+(3, 'asemenov', 'Семенов Анатолий Анатольевич', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Разработчик', '2024-02-13T08:31'),
+(4, 'afedorov', 'Федоров Александр Сергеевич', 'https://funnyducks.ru/upload/iblock/0cd/0cdeb7ec3ed6fddda0f90fccee05557d.jpg', 'Тестировщик', '2024-02-12T08:36');
+
+INSERT INTO code (value)
+VALUES
+(1234567890123456789),
+(9223372036854775807),
+(1122334455667788990),
+(998877665544332211),
+(5566778899001122334);