diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..3b41682 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +/mvnw text eol=lf +*.cmd text eol=crlf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..667aaef --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/.mvn/jvm.config b/.mvn/jvm.config new file mode 100644 index 0000000..b8d22d0 --- /dev/null +++ b/.mvn/jvm.config @@ -0,0 +1,5 @@ +-XX:+EnableDynamicAgentLoading +-Xshare:off +--enable-native-access=ALL-UNNAMED +--add-opens java.base/java.lang=ALL-UNNAMED +--add-opens java.base/java.util=ALL-UNNAMED diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..8dea6c2 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip diff --git a/README.md b/README.md index 3e441c9..9ac77a4 100644 --- a/README.md +++ b/README.md @@ -76,3 +76,153 @@ - Use meaningful variable and method names - Return appropriate HTTP status codes - Include validation messages in responses + +--- + +## ✅ Project Status: COMPLETED + +All required tasks have been implemented: + +- ✅ Spring Boot application with required dependencies +- ✅ Product class with validation +- ✅ ProductService with all required methods +- ✅ ProductController with all endpoints and API-Key authentication +- ✅ Customer class with validation +- ✅ CustomerService with CRUD operations +- ✅ CustomerController with all endpoints and API-Key authentication +- ✅ Global exception handler for error handling +- ✅ Proper package structure and dependency injection +- ✅ Postman collection for testing all endpoints + +--- + +## 🚀 Running the Application + +### Prerequisites +- Java 17+ +- Maven 3.6+ + +### Start the Application +```bash +mvn spring-boot:run +``` +Or using the Maven wrapper: +```bash +./mvnw spring-boot:run +``` + +The API will be available at: **http://localhost:8080** + +--- + +## 🧪 Testing with Postman + +1. **Import the Postman Collection:** + - Open Postman + - Click "Import" → Select `Postman_Collection.json` + - All endpoints are pre-configured with API key header + +2. **Run Tests:** + - Use the imported collection to test all endpoints + - Includes error test cases for validation + +**API Key:** `123456` (required for all requests in the `Api-Key` header) + +**For detailed testing guide:** See `POSTMAN_TESTING_GUIDE.md` + +--- + +## 📋 Alternative: cURL Testing + +For command-line testing, see `CURL_TESTING_COMMANDS.md` for cURL examples. + +### Quick Test Example: +```bash +curl -X GET "http://localhost:8080/api/products" \ + -H "Api-Key: 123456" +``` + +--- + +## 📂 Project Structure + +``` +src/main/java/com/example/demo/ +├── DemoApplication.java # Spring Boot entry point +├── controller/ +│ ├── ProductController.java # Product REST endpoints +│ └── CustomerController.java # Customer REST endpoints +├── model/ +│ ├── Product.java # Product entity with validation +│ └── Customer.java # Customer entity with validation +├── service/ +│ ├── ProductService.java # Product business logic +│ └── CustomerService.java # Customer business logic +└── exception/ + ├── InvalidPriceRangeException.java + ├── MissingApiKeyException.java + └── ProductNotFoundException.java +``` + +--- + +## 🔗 API Endpoints + +### Products API +- `GET /api/products` - Get all products +- `GET /api/products/{id}` - Get product by ID +- `GET /api/products/name?name={name}` - Search by name +- `GET /api/products/category?category={category}` - Filter by category +- `GET /api/products/price-range?min={min}&max={max}` - Filter by price range +- `POST /api/products` - Create product +- `PUT /api/products/{name}` - Update product +- `PATCH /api/products/{name}` - Partial update +- `DELETE /api/products/{name}` - Delete product + +### Customers API +- `GET /api/customers` - Get all customers +- `GET /api/customers/{id}` - Get customer by ID +- `GET /api/customers/email?email={email}` - Search by email +- `POST /api/customers` - Create customer + +--- + +## 📝 Validation Rules + +### Product +- `name`: Required, minimum 3 characters +- `price`: Required, must be positive (> 0) +- `category`: Required, cannot be blank +- `quantity`: Required, must be >= 0 + +### Customer +- `name`: Required, cannot be blank +- `email`: Required, must be valid email format +- `age`: Required, must be >= 18 +- `address`: Required, cannot be blank + +--- + +## 🔐 Authentication + +All endpoints require the following header: +``` +Api-Key: 123456 +``` + +Without this header, requests will return: **400 Bad Request - "Api-key is missing"** + +--- + +## 🆘 Troubleshooting + +| Issue | Solution | +|-------|----------| +| Port 8080 already in use | Change `server.port` in `application.properties` | +| Missing API key error | Add `Api-Key: 123456` header to requests | +| Validation errors | Check request body against validation rules | +| Connection refused | Ensure application is running | + +--- + +**Last Updated:** March 10, 2026 \ No newline at end of file diff --git a/mvnw b/mvnw new file mode 100644 index 0000000..bd8896b --- /dev/null +++ b/mvnw @@ -0,0 +1,295 @@ +#!/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 +# +# http://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.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..92450f9 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@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 http://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.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..9a20083 --- /dev/null +++ b/pom.xml @@ -0,0 +1,81 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.2.3 + + + com.example + demo + 0.0.1-SNAPSHOT + demo + Demo project for Spring Boot + + + + + + + + + + + + + + + 17 + + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-test + test + + + + org.springframework.boot + spring-boot-starter-validation + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + -XX:+EnableDynamicAgentLoading + -Xshare:off + --enable-native-access=ALL-UNNAMED + --add-opens java.base/java.lang=ALL-UNNAMED + --add-opens java.base/java.util=ALL-UNNAMED + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + -XX:+EnableDynamicAgentLoading + -Xshare:off + --enable-native-access=ALL-UNNAMED + --add-opens java.base/java.lang=ALL-UNNAMED + --add-opens java.base/java.util=ALL-UNNAMED + + + + + + + diff --git a/src/main/java/com/example/demo/DemoApplication.java b/src/main/java/com/example/demo/DemoApplication.java new file mode 100644 index 0000000..64b538a --- /dev/null +++ b/src/main/java/com/example/demo/DemoApplication.java @@ -0,0 +1,13 @@ +package com.example.demo; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class DemoApplication { + + public static void main(String[] args) { + SpringApplication.run(DemoApplication.class, args); + } + +} diff --git a/src/main/java/com/example/demo/InvalidPriceRangeException.java b/src/main/java/com/example/demo/InvalidPriceRangeException.java new file mode 100644 index 0000000..2081a51 --- /dev/null +++ b/src/main/java/com/example/demo/InvalidPriceRangeException.java @@ -0,0 +1,7 @@ +package com.example.demo; + +public class InvalidPriceRangeException extends RuntimeException { + public InvalidPriceRangeException(String message) { + super(message); + } +} diff --git a/src/main/java/com/example/demo/MissingApiKeyException.java b/src/main/java/com/example/demo/MissingApiKeyException.java new file mode 100644 index 0000000..8ebdaa0 --- /dev/null +++ b/src/main/java/com/example/demo/MissingApiKeyException.java @@ -0,0 +1,5 @@ +package com.example.demo; + +public class MissingApiKeyException extends RuntimeException{ + public MissingApiKeyException(String message){super(message);} +} diff --git a/src/main/java/com/example/demo/ProductNotFoundException.java b/src/main/java/com/example/demo/ProductNotFoundException.java new file mode 100644 index 0000000..54b684d --- /dev/null +++ b/src/main/java/com/example/demo/ProductNotFoundException.java @@ -0,0 +1,7 @@ +package com.example.demo; + +public class ProductNotFoundException extends RuntimeException { + public ProductNotFoundException(String message) { + super(message); + } +} diff --git a/src/main/java/com/example/demo/controller/CustomerController.java b/src/main/java/com/example/demo/controller/CustomerController.java new file mode 100644 index 0000000..d7ce5f4 --- /dev/null +++ b/src/main/java/com/example/demo/controller/CustomerController.java @@ -0,0 +1,62 @@ +package com.example.demo.controller; + + +import com.example.demo.MissingApiKeyException; +import com.example.demo.model.Customer; +import com.example.demo.service.CustomerService; +import jakarta.validation.Valid; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.util.List; + +@RestController +@RequestMapping("/api/customers") +public class CustomerController { + private final CustomerService customerService; + + + public CustomerController(CustomerService customerService) { + this.customerService = customerService; + } + + private void checkApiKey(String apiKey){ + if(apiKey == null){ + throw new MissingApiKeyException("Api-key is missing"); + } + String API_KEY="123456"; + if(!API_KEY.equals(apiKey)){ + throw new MissingApiKeyException("Invalid Api-key"); + } + } + @GetMapping("/{id}") + public Customer getCustomerById(@RequestHeader("Api-Key") String apiKey, @PathVariable long id){ + checkApiKey(apiKey); + return customerService.findById(id); + } + + @GetMapping("/email") + public Customer getCustomerByEmail(@RequestHeader("Api-Key") String apiKey, @RequestParam String email){ + checkApiKey(apiKey); + return customerService.findByEmail(email); + } + + @GetMapping() + public List getAllCustomer(@RequestHeader("Api-Key") String apiKey){ + checkApiKey(apiKey); + return customerService.findAll(); + } + + @PostMapping + public ResponseEntity createCustomer(@RequestHeader("Api-Key") String apiKey, @Valid @RequestBody Customer customer) { + checkApiKey(apiKey); + Customer created = customerService.create( + customer.getName(), customer.getEmail(), customer.getAge(), customer.getAddress() + ); + return ResponseEntity.status(HttpStatus.CREATED).body(created); + } + + + +} diff --git a/src/main/java/com/example/demo/controller/ProductController.java b/src/main/java/com/example/demo/controller/ProductController.java new file mode 100644 index 0000000..5910220 --- /dev/null +++ b/src/main/java/com/example/demo/controller/ProductController.java @@ -0,0 +1,96 @@ +package com.example.demo.controller; + +import com.example.demo.InvalidPriceRangeException; +import com.example.demo.MissingApiKeyException; +import com.example.demo.model.Product; +import com.example.demo.service.ProductService; +import org.springframework.web.bind.annotation.*; + +import java.util.List; +import jakarta.validation.Valid; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; + +@RestController +@RequestMapping("/api/products") +public class ProductController { + private final ProductService productService; + + public ProductController(ProductService productsService){ + this.productService=productsService; + } + + private void checkApiKey(String apiKey){ + if(apiKey == null){ + throw new MissingApiKeyException("Api-key is missing"); + } + String API_KEY = "123456"; + if(!API_KEY.equals(apiKey)){ + throw new MissingApiKeyException("Invalid Api-key"); + } + } + + + @GetMapping + public List getAllProducts(@RequestHeader("Api-Key") String apiKey){ + checkApiKey(apiKey); + return productService.findAll(); + } + + @GetMapping("/{id}") + public Product getProductById(@RequestHeader("Api-Key") String apiKey,@PathVariable long id){ + checkApiKey(apiKey); + return productService.findById(id); + } + + @GetMapping("/name") + public List getProductByName(@RequestHeader("Api-Key") String apiKey,@RequestParam(required = false) String name){ + checkApiKey(apiKey); + if(name!= null){ + return productService.findByName(name); + } + return productService.findAll(); + } + + @GetMapping("/category") + public List getProductByCategory(@RequestHeader("Api-Key") String apiKey,@RequestParam String category){ + checkApiKey(apiKey); + return productService.findByCategory(category); + } + + @GetMapping("/price-range") + public List getProductsByPriceRange(@RequestHeader("Api-Key") String apiKey, + @RequestParam double min, + @RequestParam double max) { + checkApiKey(apiKey); + if (min < 0 || max < 0 || min > max) { + throw new InvalidPriceRangeException("Invalid price range"); + } + return productService.findByPriceRange(min, max); + } + + @PutMapping("{name}") + public Product updateProduct(@RequestHeader("Api-Key") String apiKey, @PathVariable String name, @Valid @RequestBody Product product){ + return productService.fullUpdate(name,product); + } + + @DeleteMapping("{name}") + public Product deleteProduct(@RequestHeader("Api-Key") String apiKey, @PathVariable String name){ + return productService.delete(name); + } + @PatchMapping("{name}") + public Product partiallyUpdateProduct(@PathVariable String name, @Valid @RequestBody Product product){ + return productService.partialUpdate(name, product); + } + + + @PostMapping + public ResponseEntity createProduct(@RequestHeader("Api-Key") String apiKey, + @Valid @RequestBody Product product) { + checkApiKey(apiKey); + Product created = productService.create( + product.getName(), product.getPrice(), product.getCategory(), product.getQuantity() + ); + return ResponseEntity.status(HttpStatus.CREATED).body(created); + } +} \ No newline at end of file diff --git a/src/main/java/com/example/demo/model/Customer.java b/src/main/java/com/example/demo/model/Customer.java new file mode 100644 index 0000000..b1fa86c --- /dev/null +++ b/src/main/java/com/example/demo/model/Customer.java @@ -0,0 +1,42 @@ +package com.example.demo.model; + +import jakarta.validation.constraints.Email; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotBlank; + +public class Customer { + private Long id; + + @NotBlank(message = "Name is required") + private String name; + + @NotBlank(message = "Email is required") + @Email(message = "Please provide a valid email address") + private String email; + + @Min(value = 18, message = "Age must be greater than 18.") + private int age; + @NotBlank(message = "Address is required") + private String address; + + public Customer() {} + + public Customer(Long id,String name,String email,int age ,String address){ + this.id=id; + this.name= name; + this.address=address; + this.email=email; + this.age=age; + } + //Getters Setters + public Long getId() { return id; } + public void setId(Long id) { this.id = id; } + public String getName() { return name; } + public void setName(String name) { this.name = name; } + public String getEmail() { return email; } + public void setEmail(String email) { this.email = email; } + public int getAge() { return age; } + public void setAge(int age) { this.age = age; } + public String getAddress() { return address; } + public void setAddress(String address) { this.address = address; } +} diff --git a/src/main/java/com/example/demo/model/Product.java b/src/main/java/com/example/demo/model/Product.java new file mode 100644 index 0000000..a49fee0 --- /dev/null +++ b/src/main/java/com/example/demo/model/Product.java @@ -0,0 +1,42 @@ +package com.example.demo.model; + +import jakarta.validation.constraints.*; + +public class Product { + private Long id; + + @NotBlank(message = "Name is required") + @Size(min = 3, message = "Name must be longer than 3 characters") + private String name; + + @Positive(message = "Price must be a positive number") + private double price; + + @NotBlank(message = "Category is required") + private String category; + + @Min(value = 0, message = "Quantity must be a positive number") + private int quantity; + + public Product() {} + + public Product(Long id, String name, double price, String category,int quantity) { + this.id = id; + this.name = name; + this.price = price; + this.category = category; + this.quantity=quantity; + } + + //Getters Setters + public Long getId() { return id; } + public void setId(Long id) { this.id = id; } + public String getName() { return name; } + public void setName(String name) { this.name = name; } + public double getPrice() { return price; } + public void setPrice(double price) { this.price = price; } + public String getCategory() { return category; } + public void setCategory(String category) { this.category = category; } + public int getQuantity() { return quantity; } + public void setQuantity(int quantity) { this.quantity = quantity; } +} diff --git a/src/main/java/com/example/demo/service/CustomerService.java b/src/main/java/com/example/demo/service/CustomerService.java new file mode 100644 index 0000000..0a91da9 --- /dev/null +++ b/src/main/java/com/example/demo/service/CustomerService.java @@ -0,0 +1,31 @@ +package com.example.demo.service; + +import com.example.demo.model.Customer; +import org.springframework.stereotype.Service; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +@Service +public class CustomerService { + private final Map customers =new HashMap<>(); + private Long nextId = 1L; + public List findAll(){return new ArrayList<>(customers.values());} + + public Customer findById(Long id){return customers.get(id);} + + public Customer findByEmail(String email) { + return customers.values().stream() + .filter(c -> email.equals(c.getEmail())) + .findFirst() + .orElse(null); + } + public Customer create(String name,String email,int age,String address){ + Customer customer= new Customer(nextId++,name,email,age,address); + customers.put(customer.getId(), customer); + return customer; + } + +} + diff --git a/src/main/java/com/example/demo/service/ProductService.java b/src/main/java/com/example/demo/service/ProductService.java new file mode 100644 index 0000000..630e9aa --- /dev/null +++ b/src/main/java/com/example/demo/service/ProductService.java @@ -0,0 +1,83 @@ +package com.example.demo.service; + +import com.example.demo.model.Product; +import jdk.jfr.Category; +import org.springframework.stereotype.Service; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +@Service +public class ProductService { + + private final Map products = new HashMap<>(); + private Long nextId = 1L; + + public List findAll() { + return new ArrayList<>(products.values()); + } + + public Product findById(Long id) { + return products.get(id); + } + + public List findByName(String name) { + return products.values().stream() + .filter(p -> p.getName().toLowerCase().contains(name.toLowerCase())) + .toList(); + } + + public List findByCategory(String category){ + return products.values().stream().filter( p -> p.getCategory().toLowerCase().contains(category.toLowerCase())) + .toList(); + } + + public List findByPriceRange(double min, double max){ + return products.values() + .stream() + .filter(p -> p.getPrice() >= min && p.getPrice() <= max) + .toList(); + } + + public Product fullUpdate(String name,Product product1){ + Product product= (Product) findByName(name); + product.setName(product1.getName()); + product.setCategory(product1.getCategory()); + product.setQuantity(product1.getQuantity()); + product.setPrice(product1.getPrice()); + return product; + } + public Product create(String name,double price,String category,int quantity) { + Product product = new Product(nextId++, name, price, category,quantity); + + products.put(product.getId(), product); + return product; + } + + public Product partialUpdate(String name,Product product){ + Product product1= (Product) findByName(name); + String name1= product.getName(); + double price1= product.getPrice(); + String category1= product.getCategory(); + int quantity1= product.getQuantity(); + + if( name1!= null){product1.setName(name);} + if(quantity1 >=0){product1.setQuantity(quantity1);} + if( category1 != null){product1.setCategory(category1);} + if( price1 >=0){product1.setPrice(price1);} + return product1; + } + + + + + public Product delete(String name){ + findByName(name); + products.remove(name); + return null; + } + + +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..e30fad1 --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1,14 @@ +spring.application.name=demo + +# Server Configuration +server.port=8080 + +# Error Handling +server.error.include-message=always +server.error.include-binding-errors=always +server.error.include-stacktrace=on_param +server.error.include-exception=false + +# Logging +logging.level.org.springframework.web=INFO +logging.level.com.example.demo=DEBUG diff --git a/src/test/java/com/example/demo/DemoApplicationTests.java b/src/test/java/com/example/demo/DemoApplicationTests.java new file mode 100644 index 0000000..2778a6a --- /dev/null +++ b/src/test/java/com/example/demo/DemoApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.demo; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class DemoApplicationTests { + + @Test + void contextLoads() { + } + +}