commit 0f2095870ffcf4219431c4727476a1cd06386849 Author: John Thompson Date: Sun May 26 15:30:24 2019 -0400 intial project add diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..73efe74 --- /dev/null +++ b/.gitignore @@ -0,0 +1,142 @@ +###################### +# Project Specific +###################### +/build/www/** +/src/test/javascript/coverage/ +/src/test/javascript/PhantomJS*/ + +###################### +# Node +###################### +/node/ +node_tmp/ +node_modules/ +npm-debug.log.* + +###################### +# SASS +###################### +.sass-cache/ + +###################### +# Eclipse +###################### +*.pydevproject +.project +.metadata +tmp/ +tmp/**/* +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath +.factorypath +/src/main/resources/rebel.xml + +# External tool builders +.externalToolBuilders/** + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + +###################### +# Intellij +###################### +.idea/ +*.iml +*.iws +*.ipr +*.ids +*.orig + +###################### +# Visual Studio Code +###################### +.vscode/ + +###################### +# Maven +###################### +/log/ +*/target/** +###################### +# Gradle +###################### +.gradle/ +/build/ + +###################### +# Package Files +###################### +*.jar +*.war +*.ear +*.db + +###################### +# Windows +###################### +# Windows image file caches +Thumbs.db + +# Folder config file +Desktop.ini + +###################### +# Mac OSX +###################### +.DS_Store +.svn + +# Thumbnails +._* + +# Files that might appear on external disk +.Spotlight-V100 +.Trashes + +###################### +# Directories +###################### +/bin/ +/deploy/ + +###################### +# Logs +###################### +*.log + +###################### +# Others +###################### +*.class +*.*~ +*~ +.merge_file* + +###################### +# Gradle Wrapper +###################### +!gradle/wrapper/gradle-wrapper.jar + +###################### +# Maven Wrapper +###################### +!.mvn/wrapper/maven-wrapper.jar + +###################### +# ESLint +###################### +.eslintcache +/.idea/ + diff --git a/.mvn/wrapper/MavenWrapperDownloader.java b/.mvn/wrapper/MavenWrapperDownloader.java new file mode 100644 index 0000000..7f91a56 --- /dev/null +++ b/.mvn/wrapper/MavenWrapperDownloader.java @@ -0,0 +1,114 @@ +/* +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. +*/ + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.net.URL; +import java.nio.channels.Channels; +import java.nio.channels.ReadableByteChannel; +import java.util.Properties; + +public class MavenWrapperDownloader { + + /** + * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. + */ + private static final String DEFAULT_DOWNLOAD_URL = + "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"; + + /** + * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to + * use instead of the default one. + */ + private static final String MAVEN_WRAPPER_PROPERTIES_PATH = + ".mvn/wrapper/maven-wrapper.properties"; + + /** + * Path where the maven-wrapper.jar will be saved to. + */ + private static final String MAVEN_WRAPPER_JAR_PATH = + ".mvn/wrapper/maven-wrapper.jar"; + + /** + * Name of the property which should be used to override the default download url for the wrapper. + */ + private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; + + public static void main(String args[]) { + System.out.println("- Downloader started"); + File baseDirectory = new File(args[0]); + System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); + + // If the maven-wrapper.properties exists, read it and check if it contains a custom + // wrapperUrl parameter. + File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); + String url = DEFAULT_DOWNLOAD_URL; + if (mavenWrapperPropertyFile.exists()) { + FileInputStream mavenWrapperPropertyFileInputStream = null; + try { + mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); + Properties mavenWrapperProperties = new Properties(); + mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); + url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); + } catch (IOException e) { + System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); + } finally { + try { + if (mavenWrapperPropertyFileInputStream != null) { + mavenWrapperPropertyFileInputStream.close(); + } + } catch (IOException e) { + // Ignore ... + } + } + } + System.out.println("- Downloading from: : " + url); + + File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); + if (!outputFile.getParentFile().exists()) { + if (!outputFile.getParentFile().mkdirs()) { + System.out.println( + "- ERROR creating output direcrory '" + outputFile.getParentFile().getAbsolutePath() + "'"); + } + } + System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); + try { + downloadFileFromURL(url, outputFile); + System.out.println("Done"); + System.exit(0); + } catch (Throwable e) { + System.out.println("- Error downloading"); + e.printStackTrace(); + System.exit(1); + } + } + + private static void downloadFileFromURL(String urlString, File destination) throws Exception { + URL website = new URL(urlString); + ReadableByteChannel rbc; + rbc = Channels.newChannel(website.openStream()); + FileOutputStream fos = new FileOutputStream(destination); + fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); + fos.close(); + rbc.close(); + } + +} diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..01e6799 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..cd0d451 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.0/apache-maven-3.6.0-bin.zip diff --git a/README.md b/README.md new file mode 100644 index 0000000..cfa0d3d --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# SFG Spring REST Docs Example + +This repository contains source code examples used to support my on-line courses about the Spring Framework. + +You can learn more about the courses here: +* [Spring Framework 5: Beginner to Guru](https://www.udemy.com/course/spring-framework-5-beginner-to-guru/?couponCode=GITHUB_SFGPETCLINIC) +* [Testing Spring Boot: Beginner to Guru](https://www.udemy.com/testing-spring-boot-beginner-to-guru/?couponCode=GITHUB_REPO_SF5B2G) \ No newline at end of file diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..8b9da3b --- /dev/null +++ b/mvnw @@ -0,0 +1,286 @@ +#!/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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven2 Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# 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 /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 + export JAVA_HOME="`/usr/libexec/java_home`" + else + export JAVA_HOME="/Library/Java/Home" + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -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 "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" + # TODO classpath? +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="`which 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 + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# 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/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# 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. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + wget "$jarUrl" -O "$wrapperJarPath" + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + curl -o "$wrapperJarPath" "$jarUrl" + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +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 "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -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 + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..fef5a8f --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,161 @@ +@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 Maven2 Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@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 key stroke 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 my 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 "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\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 DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" +FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_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% ( + echo Found %WRAPPER_JAR% +) else ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_URL% + powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" + echo Finished downloading %WRAPPER_JAR% +) +@REM End of extension + +%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 "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\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% + +exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..f74e056 --- /dev/null +++ b/pom.xml @@ -0,0 +1,127 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 2.1.5.RELEASE + + + guru.springframework + sfg-restdocs-example + 0.0.1-SNAPSHOT + sfg-restdocs-example + Spring REST Docs example project + + + UTF-8 + UTF-8 + 11 + 2.3.0 + ${java.version} + ${java.version} + 1.3.0.Final + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-data-jpa + + + com.h2database + h2 + runtime + + + javax.xml.bind + jaxb-api + ${jaxb.version} + + + com.sun.xml.bind + jaxb-core + ${jaxb.version} + + + com.sun.xml.bind + jaxb-impl + ${jaxb.version} + + + org.projectlombok + lombok + true + + + org.mapstruct + mapstruct + ${org.mapstruct.version} + + + org.springframework.boot + spring-boot-starter-test + test + + + junit + junit + + + + + org.junit.jupiter + junit-jupiter-api + test + + + org.junit.jupiter + junit-jupiter-engine + test + + + org.mockito + mockito-junit-jupiter + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.0 + + + + org.mapstruct + mapstruct-processor + ${org.mapstruct.version} + + + org.projectlombok + lombok + ${lombok.version} + + + + + -Amapstruct.defaultComponentModel=spring + + + + + + + + diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplication.java b/src/main/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplication.java new file mode 100644 index 0000000..169ff22 --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplication.java @@ -0,0 +1,13 @@ +package guru.springframework.sfgrestdocsexample; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SfgRestdocsExampleApplication { + + public static void main(String[] args) { + SpringApplication.run(SfgRestdocsExampleApplication.class, args); + } + +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/bootstrap/BeerLoader.java b/src/main/java/guru/springframework/sfgrestdocsexample/bootstrap/BeerLoader.java new file mode 100644 index 0000000..b4f9ff7 --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/bootstrap/BeerLoader.java @@ -0,0 +1,49 @@ +package guru.springframework.sfgrestdocsexample.bootstrap; + +import guru.springframework.sfgrestdocsexample.domain.Beer; +import guru.springframework.sfgrestdocsexample.repositories.BeerRepository; +import org.springframework.boot.CommandLineRunner; +import org.springframework.stereotype.Component; + +import java.math.BigDecimal; + +/** + * Created by jt on 2019-05-17. + */ +@Component +public class BeerLoader implements CommandLineRunner { + + private final BeerRepository beerRepository; + + public BeerLoader(BeerRepository beerRepository) { + this.beerRepository = beerRepository; + } + + @Override + public void run(String... args) throws Exception { + loadBeerObjects(); + } + + private void loadBeerObjects() { + if(beerRepository.count() == 0){ + + beerRepository.save(Beer.builder() + .beerName("Mango Bobs") + .beerStyle("IPA") + .quantityToBrew(200) + .minOnHand(12) + .upc(337010000001L) + .price(new BigDecimal("12.95")) + .build()); + + beerRepository.save(Beer.builder() + .beerName("Galaxy Cat") + .beerStyle("PALE_ALE") + .quantityToBrew(200) + .minOnHand(12) + .upc(337010000002L) + .price(new BigDecimal("11.95")) + .build()); + } + } +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/domain/Beer.java b/src/main/java/guru/springframework/sfgrestdocsexample/domain/Beer.java new file mode 100644 index 0000000..7e8f36c --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/domain/Beer.java @@ -0,0 +1,52 @@ +package guru.springframework.sfgrestdocsexample.domain; + +import lombok.*; +import org.hibernate.annotations.CreationTimestamp; +import org.hibernate.annotations.GenericGenerator; +import org.hibernate.annotations.UpdateTimestamp; + +import javax.persistence.*; +import java.math.BigDecimal; +import java.sql.Timestamp; +import java.util.UUID; + +/** + * Created by jt on 2019-05-17. + */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@Builder +@Entity +public class Beer { + + @Id + @GeneratedValue(generator = "UUID") + @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator") + @Column(length = 36, columnDefinition = "varchar", updatable = false, nullable = false) + private UUID id; + + @Version + private Long version; + + @CreationTimestamp + @Column(updatable = false) + private Timestamp createdDate; + + @UpdateTimestamp + private Timestamp lastModifiedDate; + + private String beerName; + private String beerStyle; + + @Column(unique = true) + private Long upc; + + private BigDecimal price; + + private Integer minOnHand; + private Integer quantityToBrew; + + +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/repositories/BeerRepository.java b/src/main/java/guru/springframework/sfgrestdocsexample/repositories/BeerRepository.java new file mode 100644 index 0000000..0bdfe85 --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/repositories/BeerRepository.java @@ -0,0 +1,12 @@ +package guru.springframework.sfgrestdocsexample.repositories; + +import guru.springframework.sfgrestdocsexample.domain.Beer; +import org.springframework.data.repository.PagingAndSortingRepository; + +import java.util.UUID; + +/** + * Created by jt on 2019-05-17. + */ +public interface BeerRepository extends PagingAndSortingRepository { +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/BeerController.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/BeerController.java new file mode 100644 index 0000000..ae6626c --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/BeerController.java @@ -0,0 +1,40 @@ +package guru.springframework.sfgrestdocsexample.web.controller; + +import guru.springframework.sfgrestdocsexample.web.model.BeerDto; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.*; + +import java.util.UUID; + +/** + * Created by jt on 2019-05-12. + */ +@RequestMapping("/api/v1/beer") +@RestController +public class BeerController { + + + @GetMapping("/{beerId}") + public ResponseEntity getBeerById(@PathVariable("beerId") UUID beerId){ + + //todo impl + return new ResponseEntity<>(BeerDto.builder().build(), HttpStatus.OK); + } + + @PostMapping + public ResponseEntity saveNewBeer(@RequestBody @Validated BeerDto beerDto){ + + //todo impl + return new ResponseEntity(HttpStatus.CREATED); + } + + @PutMapping("/{beerId}") + public ResponseEntity updateBeerById(@PathVariable("beerId") UUID beerId, @RequestBody @Validated BeerDto beerDto){ + + //todo impl + return new ResponseEntity(HttpStatus.NO_CONTENT); + } + +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/MvcExceptionHandler.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/MvcExceptionHandler.java new file mode 100644 index 0000000..99b8184 --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/controller/MvcExceptionHandler.java @@ -0,0 +1,27 @@ +package guru.springframework.sfgrestdocsexample.web.controller; + +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; + +import javax.validation.ConstraintViolationException; +import java.util.ArrayList; +import java.util.List; + +/** + * Created by jt on 2019-05-25. + */ +@ControllerAdvice +public class MvcExceptionHandler { + + @ExceptionHandler(ConstraintViolationException.class) + public ResponseEntity validationErrorHandler(ConstraintViolationException ex){ + List errorsList = new ArrayList<>(ex.getConstraintViolations().size()); + + ex.getConstraintViolations().forEach(error -> errorsList.add(error.toString())); + + return new ResponseEntity<>(errorsList, HttpStatus.BAD_REQUEST); + } + +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/BeerMapper.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/BeerMapper.java new file mode 100644 index 0000000..f8dad1e --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/BeerMapper.java @@ -0,0 +1,16 @@ +package guru.springframework.sfgrestdocsexample.web.mappers; + +import guru.springframework.sfgrestdocsexample.domain.Beer; +import guru.springframework.sfgrestdocsexample.web.model.BeerDto; +import org.mapstruct.Mapper; + +/** + * Created by jt on 2019-05-25. + */ +@Mapper(uses = {DateMapper.class}) +public interface BeerMapper { + + BeerDto BeerToBeerDto(Beer beer); + + Beer BeerDtoToBeer(BeerDto dto); +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/DateMapper.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/DateMapper.java new file mode 100644 index 0000000..581cafb --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/mappers/DateMapper.java @@ -0,0 +1,31 @@ +package guru.springframework.sfgrestdocsexample.web.mappers; + +import org.springframework.stereotype.Component; + +import java.sql.Timestamp; +import java.time.OffsetDateTime; +import java.time.ZoneOffset; + +/** + * Created by jt on 2019-05-25. + */ +@Component +public class DateMapper { + public OffsetDateTime asOffsetDateTime(Timestamp ts){ + if (ts != null){ + return OffsetDateTime.of(ts.toLocalDateTime().getYear(), ts.toLocalDateTime().getMonthValue(), + ts.toLocalDateTime().getDayOfMonth(), ts.toLocalDateTime().getHour(), ts.toLocalDateTime().getMinute(), + ts.toLocalDateTime().getSecond(), ts.toLocalDateTime().getNano(), ZoneOffset.UTC); + } else { + return null; + } + } + + public Timestamp asTimestamp(OffsetDateTime offsetDateTime){ + if(offsetDateTime != null) { + return Timestamp.valueOf(offsetDateTime.atZoneSameInstant(ZoneOffset.UTC).toLocalDateTime()); + } else { + return null; + } + } +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerDto.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerDto.java new file mode 100644 index 0000000..d2f1eac --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerDto.java @@ -0,0 +1,54 @@ +package guru.springframework.sfgrestdocsexample.web.model; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import javax.validation.constraints.NotBlank; +import javax.validation.constraints.NotNull; +import javax.validation.constraints.Null; +import javax.validation.constraints.Positive; +import java.math.BigDecimal; +import java.time.OffsetDateTime; +import java.util.UUID; + +/** + * Created by jt on 2019-05-12. + */ + +@Data +@NoArgsConstructor +@AllArgsConstructor +@Builder +public class BeerDto { + + @Null + private UUID id; + + @Null + private Integer version; + + @Null + private OffsetDateTime createdDate; + + @Null + private OffsetDateTime lastModifiedDate; + + @NotBlank + private String beerName; + + @NotNull + private BeerStyleEnum beerStyle; + + @Positive + @NotNull + private Long upc; + + @Positive + @NotNull + private BigDecimal price; + + private Integer quantityOnHand; + +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerPagedList.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerPagedList.java new file mode 100644 index 0000000..a1c9dca --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerPagedList.java @@ -0,0 +1,21 @@ +package guru.springframework.sfgrestdocsexample.web.model; + + +import org.springframework.data.domain.PageImpl; +import org.springframework.data.domain.Pageable; + +import java.util.List; + +/** + * Created by jt on 2019-05-12. + */ +public class BeerPagedList extends PageImpl { + + public BeerPagedList(List content, Pageable pageable, long total) { + super(content, pageable, total); + } + + public BeerPagedList(List content) { + super(content); + } +} diff --git a/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerStyleEnum.java b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerStyleEnum.java new file mode 100644 index 0000000..3b8c81e --- /dev/null +++ b/src/main/java/guru/springframework/sfgrestdocsexample/web/model/BeerStyleEnum.java @@ -0,0 +1,8 @@ +package guru.springframework.sfgrestdocsexample.web.model; + +/** + * Created by jt on 2019-05-12. + */ +public enum BeerStyleEnum { + LAGER, PILSNER, STOUT, GOSE, PORTER, ALE, WHEAT, IPA, PALE_ALE, SAISON +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1 @@ + diff --git a/src/test/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplicationTests.java b/src/test/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplicationTests.java new file mode 100644 index 0000000..1d6b64c --- /dev/null +++ b/src/test/java/guru/springframework/sfgrestdocsexample/SfgRestdocsExampleApplicationTests.java @@ -0,0 +1,14 @@ +package guru.springframework.sfgrestdocsexample; + + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +public class SfgRestdocsExampleApplicationTests { + + @Test + public void contextLoads() { + } + +} diff --git a/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java b/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java new file mode 100644 index 0000000..aea37a7 --- /dev/null +++ b/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java @@ -0,0 +1,65 @@ +package guru.springframework.sfgrestdocsexample.web.controller; + +import com.fasterxml.jackson.databind.ObjectMapper; +import guru.springframework.sfgrestdocsexample.web.model.BeerDto; +import guru.springframework.sfgrestdocsexample.web.model.BeerStyleEnum; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; + +import java.math.BigDecimal; +import java.util.UUID; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@WebMvcTest(BeerController.class) +class BeerControllerTest { + + @Autowired + MockMvc mockMvc; + + @Autowired + ObjectMapper objectMapper; + + @Test + void getBeerById() throws Exception { + mockMvc.perform(get("/api/v1/beer/" + UUID.randomUUID().toString()).accept(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()); + } + + @Test + void saveNewBeer() throws Exception { + BeerDto beerDto = getValidBeerDto(); + String beerDtoJson = objectMapper.writeValueAsString(beerDto); + + mockMvc.perform(post("/api/v1/beer/") + .contentType(MediaType.APPLICATION_JSON) + .content(beerDtoJson)) + .andExpect(status().isCreated()); + } + + @Test + void updateBeerById() throws Exception { + BeerDto beerDto = getValidBeerDto(); + String beerDtoJson = objectMapper.writeValueAsString(beerDto); + + mockMvc.perform(put("/api/v1/beer/" + UUID.randomUUID().toString()) + .contentType(MediaType.APPLICATION_JSON) + .content(beerDtoJson)) + .andExpect(status().isNoContent()); + } + + BeerDto getValidBeerDto(){ + return BeerDto.builder() + .beerName("Nice Ale") + .beerStyle(BeerStyleEnum.ALE) + .price(new BigDecimal("9.99")) + .upc(123123123123L) + .build(); + + } + +} \ No newline at end of file