diff --git a/README.md b/README.md new file mode 100644 index 0000000..e3f4ec7 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# Films API + +Це проєкт, що реалізує REST API для отримання та передачі інформації про фільми. АПІ надає можливість отримувати дані про фільми, акторський склад, рейтинги, відгуки користувачів, опис фільму та цікаві факти про них. + +## Діаграма класів +image + + +Film: Представляє фільм із всією відповідною інформацією, такою як назва, рейтинг, актори тощо. + +FilmService: Надає функціональність для операцій над фільмами, таких як додавання, редагування та видалення. + +FilmController: Обробляє HTTP-запити із використанням Spring Boot та взаємодіє з FilmService. + +FilmWriter: Забезпечує збереження та вичитку даних у форматі CSV. +Залежності проєкту + +### Проект побудований з використанням наступних технологій та бібліотек: + +**Java 17** + +**Spring Boot** + +**Lombok** + +**Maven** + +## Інструкції запуску + +Щоб запустити цей проект, виконайте наступні кроки: + +Клонуйте репозиторій проекту: +`git clone https://github.com/ledan404/coursework.git` + +Перейдіть до каталогу проекту: +`cd coursework` +Запустіть проект за допомогою Maven: +`mvn spring-boot:run` +Проект буде запущено на http://localhost:8080. + +## REST запити + +Проект надає наступні REST API для отримання та передачі даних про фільми: + +GET /films: Повертає всі фільми, що присутні в системі. + +GET /films/{id}: Повертає фільм із вказаним ідентифікатором. + +POST /films: Додає новий фільм. + +PUT /films/{id}: Оновлює фільм із вказаним ідентифікатором. + +DELETE /films/{id}: Видаляє фільм із вказаним ідентифікатором. + +## Тестування + + У проекті використовуються юніт-тести для перевірки логіки запису та пошуку файлів на файловій системі. Щоб запустити тести, виконайте наступну команду: + +`mvn test` + +## Перевірка якості коду + +Код проекту можна перевірити за допомогою інструментів Spotbugs та Checkstyle. Щоб запустити перевірку, виконайте наступні команди: + +`mvn spotbugs:check` + +`mvn checkstyle:check` diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml new file mode 100644 index 0000000..bc4aeaf --- /dev/null +++ b/checkstyle-suppressions.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..66df285 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..95ba6f5 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..9617b18 --- /dev/null +++ b/pom.xml @@ -0,0 +1,145 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.1.0 + + + ua.lviv.iot + Film + 0.0.1-SNAPSHOT + Film + REST API for Film + + 17 + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + org.springframework.boot + spring-boot-starter-hateoas + + + org.springframework.boot + spring-boot-starter-web + + + org.junit.jupiter + junit-jupiter-engine + 5.9.2 + test + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + org.springframework.restdocs + spring-restdocs-mockmvc + test + + + com.opencsv + opencsv + 5.3 + + + io.springfox + springfox-swagger2 + 3.0.0 + + + io.springfox + springfox-swagger-ui + 3.0.0 + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + 2.2.1 + + + generate-docs + prepare-package + + process-asciidoc + + + html + book + + + + + + org.springframework.restdocs + spring-restdocs-asciidoctor + ${spring-restdocs.version} + + + + + org.springframework.boot + spring-boot-maven-plugin + + true + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + + + + + com.github.spotbugs + spotbugs-maven-plugin + 4.7.3.3 + + + org.apache.maven.plugins + maven-pmd-plugin + 3.20.0 + + + /rulesets/java/braces.xml + /rulesets/java/naming.xml + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.1.2 + + + + \ No newline at end of file diff --git a/src/main/java/ua/lviv/iot/film/FilmApplication.java b/src/main/java/ua/lviv/iot/film/FilmApplication.java new file mode 100644 index 0000000..ec9319a --- /dev/null +++ b/src/main/java/ua/lviv/iot/film/FilmApplication.java @@ -0,0 +1,13 @@ +package ua.lviv.iot.film; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; + +@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class}) +public class FilmApplication { + + public static void main(final String[] args) { + SpringApplication.run(FilmApplication.class, args); + } +} diff --git a/src/main/java/ua/lviv/iot/film/controller/FilmController.java b/src/main/java/ua/lviv/iot/film/controller/FilmController.java new file mode 100644 index 0000000..6aff78a --- /dev/null +++ b/src/main/java/ua/lviv/iot/film/controller/FilmController.java @@ -0,0 +1,76 @@ +package ua.lviv.iot.film.controller; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.PutMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.DeleteMapping; + +import ua.lviv.iot.film.models.Film; +import ua.lviv.iot.film.service.FilmService; + +import java.io.IOException; +import java.util.List; + +@RestController +@RequestMapping("films") +public final class FilmController { + private final FilmService filmService; + + + @Autowired + public FilmController(final FilmService filmService) throws IOException { + this.filmService = new FilmService(filmService.getFilmWriter()); + } + + @GetMapping + public ResponseEntity> getAll() { + return ResponseEntity.ok(filmService.getAllFilm()); + } + + @GetMapping(path = "/{id}") + public ResponseEntity getById(@PathVariable final Integer id) { + Film film = filmService.getFilm(id); + if (film != null) { + return ResponseEntity.ok(film); + } else { + return ResponseEntity.notFound().build(); + } + } + + @PostMapping + public ResponseEntity create(@RequestBody final Film film) { + try { + filmService.postFilm(film); + return ResponseEntity.ok(film); + } catch (IOException e) { + return ResponseEntity.badRequest().build(); + } + } + + @PutMapping(path = "/{id}") + public ResponseEntity put(@RequestBody final Film film, + @PathVariable final Integer id) { + try { + filmService.putFilm(id, film); + return ResponseEntity.ok(film); + } catch (RuntimeException e) { + return ResponseEntity.notFound().build(); + } + } + + @DeleteMapping(path = "/{id}") + public ResponseEntity delete(@PathVariable final Integer id) { + if (!filmService.getFilmMap().containsKey(id)) { + return ResponseEntity.notFound().build(); + } + filmService.deleteFilm(id); + return ResponseEntity.ok().build(); + } + +} diff --git a/src/main/java/ua/lviv/iot/film/models/Film.java b/src/main/java/ua/lviv/iot/film/models/Film.java new file mode 100644 index 0000000..81f7e37 --- /dev/null +++ b/src/main/java/ua/lviv/iot/film/models/Film.java @@ -0,0 +1,81 @@ +package ua.lviv.iot.film.models; + +import jakarta.persistence.Id; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +@ToString +public final class Film { + private static final String + HEADER = "id, name, actor, rating, review, description, fact\n"; + @Id + private Integer id; + + private String name; + + private List actor; + + private double rating; + + private List review; + + private String description; + + private List fact; + + public Film(final Integer id, + final String name, + final List actor, + final double rating, + final List review, + final String description, + final List fact) { + this.id = id; + this.name = name; + this.actor = new ArrayList<>(actor); + this.rating = rating; + this.review = new ArrayList<>(review); + this.description = description; + this.fact = new ArrayList<>(fact); + } + + public List getActor() { + return new ArrayList<>(actor); + } + + public List getFact() { + return new ArrayList<>(fact); + } + + public List getReview() { + return new ArrayList<>(review); + } + + + public static String getHeaders() { + return HEADER; + } + + public String toCsv() { + return id + "," + name + "," + actor + "," + + rating + "," + review + "," + + description + "," + fact + "\n"; + } + public void setActor(final List actor) { + this.actor = new ArrayList<>(actor); + } + + public void setFact(final List fact) { + this.fact = new ArrayList<>(fact); + } + + public void setReview(final List review) { + this.review = new ArrayList<>(review); + } +} \ No newline at end of file diff --git a/src/main/java/ua/lviv/iot/film/service/FilmService.java b/src/main/java/ua/lviv/iot/film/service/FilmService.java new file mode 100644 index 0000000..8b37e2b --- /dev/null +++ b/src/main/java/ua/lviv/iot/film/service/FilmService.java @@ -0,0 +1,71 @@ +package ua.lviv.iot.film.service; + + +import lombok.Getter; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; +import ua.lviv.iot.film.models.Film; +import ua.lviv.iot.film.storage.FilmWriter; + +import java.io.IOException; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +@Service +@Getter +public final class FilmService { + + private final Map filmMap; + + private final FilmWriter filmWriter; + + private final AtomicInteger nextAvailable; + + @Autowired + public FilmService(final FilmWriter filmWriter) throws IOException { + this.filmWriter = filmWriter; + this.nextAvailable = new AtomicInteger(0); + this.filmMap = new HashMap<>(filmWriter.readFilmsFromCsv()); + } + + public Map getFilmMap() { + return new HashMap<>(filmMap); + } + + public int getNextAvailable() { + return nextAvailable.get(); + } + + + public Map getMap() { + return new HashMap<>(filmMap); + } + + public List getAllFilm() { + return new LinkedList<>(filmMap.values()); + } + + public Film getFilm(final Integer id) { + return filmMap.get(id); + } + + public void postFilm(final Film film) throws IOException { + film.setId(nextAvailable.incrementAndGet()); + filmMap.put(film.getId(), film); + filmWriter.getFilmsToCsv(filmMap); + } + + public void putFilm(final Integer id, final Film film) { + film.setId(id); + filmMap.replace(id, film); + filmWriter.getFilmsToCsv(filmMap); + } + + public void deleteFilm(final Integer id) { + filmMap.remove(id); + filmWriter.getFilmsToCsv(filmMap); + } +} diff --git a/src/main/java/ua/lviv/iot/film/storage/FilmWriter.java b/src/main/java/ua/lviv/iot/film/storage/FilmWriter.java new file mode 100644 index 0000000..82cc489 --- /dev/null +++ b/src/main/java/ua/lviv/iot/film/storage/FilmWriter.java @@ -0,0 +1,120 @@ +package ua.lviv.iot.film.storage; + + +import org.springframework.stereotype.Component; +import ua.lviv.iot.film.models.Film; + + +import java.io.File; +import java.io.Writer; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.nio.charset.StandardCharsets; +import java.text.SimpleDateFormat; +import java.util.Calendar; +import java.util.Date; +import java.util.Map; +import java.util.List; +import java.util.LinkedList; +import java.util.HashMap; +import java.util.Scanner; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +@Component +public final class FilmWriter { + + + private final SimpleDateFormat fileDateFormat = new SimpleDateFormat("'film-'yyyy-MM-dd'.csv'"); + + + private String getFileName() { + return fileDateFormat.format(new Date()); + } + + + public void getFilmsToCsv(final Map filmMap) { + try (Writer writer = new OutputStreamWriter(new FileOutputStream(getFileName()), StandardCharsets.UTF_8)) { + writer.write(Film.getHeaders()); + for (Film film : filmMap.values()) { +// writer.write(film.getHeaders()); + writer.write(film.toCsv()); + } + } catch (Exception e) { + e.printStackTrace(); + } + } + + public Map readFilmsFromCsv() throws IOException { + Map map = new HashMap<>(); + for (int i = Integer.parseInt(new SimpleDateFormat("dd").format(new Date())) - 1; i >= 0; i--) { + Date date = new Date(); + Calendar calendar = Calendar.getInstance(); + calendar.setTime(date); + calendar.add(Calendar.DATE, -i); + date = calendar.getTime(); + File file = new File(new SimpleDateFormat("'film-'yyyy-MM-").format(new Date()) + new SimpleDateFormat("dd").format(date) + ".csv"); + if (file.exists()) { + Scanner scanner = new Scanner(file, StandardCharsets.UTF_8); + scanner.nextLine(); + while (scanner.hasNext()) { + String text = scanner.nextLine(); +// System.out.println(text); + Integer id = 0; + String name = ""; + List actors = new LinkedList<>(); + double rating = 0; + List reviews = new LinkedList<>(); + String description = ""; + List facts = new LinkedList<>(); + int groupCounter = 0; + Pattern patternLists = Pattern.compile("\\[(.*?)\\]"); + Matcher matcherLists = patternLists.matcher(text); + while (matcherLists.find()) { + String listActors = ""; + String listReviews = ""; + String listFacts = ""; + if (groupCounter == 0) { + listActors = matcherLists.group(); + text = text.replace(listActors + ",", ""); + } + if (groupCounter == 1) { + listReviews = matcherLists.group(); + text = text.replace(listReviews + ",", ""); + } + if (groupCounter == 2) { + listFacts = matcherLists.group(); + text = text.replace(listFacts, ""); + } + groupCounter++; + Pattern patternArguments = Pattern.compile("[\\pL\\pM\\p{Nd}\\p{Nl}\\p{Pc}[\\p{InEnclosedAlphanumerics}&&\\p{So}]\\s]+"); + Matcher matcherArgumentsActors = patternArguments.matcher(listActors); + while (matcherArgumentsActors.find()) { + String argument = matcherArgumentsActors.group().trim(); + actors.add(argument); + } + Matcher matcherArgumentsReviews = patternArguments.matcher(listReviews); + while (matcherArgumentsReviews.find()) { + String argument = matcherArgumentsReviews.group().trim(); + reviews.add(argument); + } + Matcher matcherArgumentsFacts = patternArguments.matcher(listFacts); + while (matcherArgumentsFacts.find()) { + String argument = matcherArgumentsFacts.group().trim(); + facts.add(argument); + } + } + String[] words = text.split(","); + id = Integer.valueOf(words[0]); + name = words[1]; + rating = Double.parseDouble(words[2]); + description = words[3]; + Film film = new Film(id, name, actors, rating, reviews, description, facts); + map.put(id, film); + } + } + } + return map; + } +} diff --git a/src/test/java/ua/lviv/iot/film/storage/FilmWriterTest.java b/src/test/java/ua/lviv/iot/film/storage/FilmWriterTest.java new file mode 100644 index 0000000..1f2cc8f --- /dev/null +++ b/src/test/java/ua/lviv/iot/film/storage/FilmWriterTest.java @@ -0,0 +1,64 @@ +package ua.lviv.iot.film.storage; + +import org.junit.jupiter.api.Test; +import ua.lviv.iot.film.models.Film; +import ua.lviv.iot.film.service.FilmService; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.text.SimpleDateFormat; +import java.util.*; + +import static org.junit.jupiter.api.Assertions.*; + +class FilmWriterTest { + + @Test + void getFilmsToCsv() throws IOException { + FilmWriter filmWriter = new FilmWriter(); + FilmService filmService = new FilmService(filmWriter); + String expectedFileName = new SimpleDateFormat("'film-'yyyy-MM-dd'.csv'").format(new Date()); + + filmWriter.getFilmsToCsv(filmService.getMap()); + + File file = new File(expectedFileName); + assertTrue(file.exists()); + } + + @Test + void readFilmsFromCsv() throws IOException { + FilmWriter filmWriter = new FilmWriter(); + FilmService filmService = new FilmService(filmWriter); + + String testFileName = "test-film.csv"; + createTestCsvFile(testFileName); + + Map expectedFilmMap = new HashMap<>(); + Film film1 = new Film(1, "Movie Name2", Arrays.asList("Actor 1", "Actor 2"), 4.5, Arrays.asList("Review 1", "Review 2"), "Movie description", Arrays.asList("Fact 1", "Fact 2")); + expectedFilmMap.put(1, film1); + + Map actualFilmMap = filmService.getMap(); + + File testFile = new File(testFileName); + assertTrue(testFile.exists()); + assertEquals(expectedFilmMap.values().toString(), actualFilmMap.values().toString()); + testFile.delete(); + } + + private void createTestCsvFile(String fileName) { + try { + File testFile = new File(fileName); + testFile.createNewFile(); + + StringBuilder sb = new StringBuilder(); + sb.append("1,Movie Name2,[Actor 1, Actor 2],4.5,[Review 1, Review 2],Movie description,[Fact 1, Fact 2]\n"); + + FileWriter writer = new FileWriter(testFile); + writer.write(sb.toString()); + writer.close(); + } catch (IOException e) { + e.printStackTrace(); + } + } +} \ No newline at end of file