Commit 3d5e5b4a authored by p.pavlovskiy's avatar p.pavlovskiy

basic functionality

parent 7538f151
Pipeline #317 failed with stages
# CovidApp
# Covid project.
CovidApp
\ No newline at end of file
## How to Build and Install
To run application on Windows
```
gradlew clean bootRun
```
## API Documentation
You can find API documentation here
- http://localhost:8080/swagger-ui.html#
\ No newline at end of file
plugins {
id 'org.springframework.boot' version '2.3.3.RELEASE'
id 'io.spring.dependency-management' version '1.0.8.RELEASE'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
// tag::actuator[]
implementation 'org.springframework.boot:spring-boot-starter-actuator'
// end::actuator[]
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'com.squareup.okhttp3:okhttp'
implementation 'com.fasterxml.jackson.core:jackson-databind'
implementation 'io.springfox:springfox-boot-starter:3.0.0'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'
// tag::tests[]
testImplementation('org.springframework.boot:spring-boot-starter-test') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
// end::tests[]
}
test {
useJUnitPlatform()
}
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# Licensed 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.
#
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
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
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
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
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem 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, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
rootProject.name = 'covidapp'
package com.covid.app;
import io.swagger.annotations.ApiModelProperty;
import java.util.Map;
/**
* @author pavlovskypv
*
* Api response class
*/
public class ApiResult {
/**
* Result data of response
*/
@ApiModelProperty("Result covid data ")
private Map result;
/**
* Error message
*/
@ApiModelProperty("Message in case of error")
private String error;
/**
* Success status in response
*/
@ApiModelProperty("Result status")
private boolean success;
public Map getResult() {
return result;
}
public void setResult(Map result) {
this.result = result;
}
public String getError() {
return error;
}
public void setError(String error) {
this.error = error;
}
public boolean isSuccess() {
return success;
}
public void setSuccess(boolean success) {
this.success = success;
}
public static Builder newBuilder() {
return new ApiResult().new Builder();
}
class Builder{
public Builder setSuccess(boolean success){
ApiResult.this.success = success;
return this;
}
public Builder setError(String error){
ApiResult.this.error = error;
ApiResult.this.success = false;
return this;
}
public Builder setResult(Map result){
ApiResult.this.result = result;
ApiResult.this.success = true;
return this;
}
public ApiResult build(){
return ApiResult.this;
}
}
}
package com.covid.app;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@PropertySource("classpath:application.properties")
@EnableSwagger2
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.covid.app"))
.paths(PathSelectors.any())
.build();
}
}
package com.covid.app;
import com.covid.app.service.CovidApiException;
import com.covid.app.service.CovidApiService;
import com.covid.app.service.DataNotFoundException;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.time.LocalDate;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Covid data api controller
*/
@RestController
public class CovidApiController implements ErrorController {
Logger logger = LoggerFactory.getLogger(CovidApiController.class);
private final CovidApiService covidApiService;
@Autowired
public CovidApiController(CovidApiService covidApiService) {
this.covidApiService = covidApiService;
}
@ApiOperation("Get maximum and minimum confirmed cases of covid for countries on period")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Covid information is got",
response = ApiResult.class),
@ApiResponse(code = 500, message = "Some server error")}
)
@RequestMapping(value = "/covid-data", method = RequestMethod.GET)
public ResponseEntity<ApiResult> data(
@ApiParam(name = "from", value = "From date in format (YYYY-MM-DD)", defaultValue = "")
@RequestParam(name = "from")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
LocalDate from,
@ApiParam(name = "to", value = "To date in format (YYYY-MM-DD)", defaultValue = "")
@RequestParam(name = "to")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
LocalDate to,
@ApiParam(name = "country", value = "List of countries", defaultValue = "")
@RequestParam(name = "country")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
List<String> countries
) {
ApiResult.Builder builder = ApiResult.newBuilder();
if (from.isAfter(to)) {
ApiResult apiResult = builder.setError("param from [" + from + "] must be before to [" + to + "]").build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
}
try {
Map covidData = covidApiService.getCovidData(from, to, countries);
ApiResult apiResult = builder.setResult(covidData).build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (DataNotFoundException e) {
logger.error("error",e);
ApiResult apiResult = builder.setError("Data not found for such parameters").build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (CovidApiException e) {
logger.error("error",e);
ApiResult apiResult = builder.setError(e.getMessage()).build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (Exception e) {
logger.error("error",e);
return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}
}
@ApiOperation("Get maximum and minimum confirmed cases of covid for countries on one date")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Covid information is got",
response = ApiResult.class),
@ApiResponse(code = 500, message = "Some server error")}
)
@RequestMapping(value = "/covid-data-day", method = RequestMethod.GET)
public ResponseEntity<ApiResult> dataForDay(
@ApiParam(name = "date", value = "Date in format (YYYY-MM-DD)", defaultValue = "")
@RequestParam(name = "date")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
LocalDate date,
@ApiParam(name = "country", value = "List of countries", defaultValue = "")
@RequestParam(name = "country")
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
List<String> countries
) {
ApiResult.Builder builder = ApiResult.newBuilder();
try {
Map covidData = covidApiService.getCovidDataOneDay( date, countries);
ApiResult apiResult = builder.setResult(covidData).build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (DataNotFoundException e) {
logger.error("error",e);
ApiResult apiResult = builder.setError("Data not found for such parameters").build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (CovidApiException e) {
logger.error("error",e);
ApiResult apiResult = builder.setError(e.getMessage()).build();
return new ResponseEntity<>(apiResult, HttpStatus.OK);
} catch (Exception e) {
logger.error("error",e);
return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}
}
@Override
public String getErrorPath() {
return "/error";
}
@ApiOperation(value="handleErrorWithRedirect",hidden = true)
@RequestMapping("/error")
public void handleErrorWithRedirect(HttpServletResponse response) throws IOException {
response.sendRedirect("/swagger-ui.html");
}
@ApiOperation(value="redirect",hidden = true)
@RequestMapping(value = "/")
public void redirect(HttpServletResponse response) throws IOException {
response.sendRedirect("/swagger-ui.html");
}
}
package com.covid.app;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import java.time.LocalDate;
import java.util.Objects;
/**
* @author pavlovskypv
* Covid data class
*/
@JsonIgnoreProperties(ignoreUnknown = true)
public class CovidInfo implements Comparable<CovidInfo>{
@JsonProperty(value="Date")
@JsonDeserialize(using = LocalDateDeserializer.class)
@JsonSerialize(using = LocalDateSerializer.class)
private LocalDate date;
@JsonProperty(value="Cases")
private int cases;
@JsonProperty(value="Country",access = JsonProperty.Access.WRITE_ONLY)
private String country;
public LocalDate getDate() {
return date;
}
public void setDate(LocalDate date) {
this.date = date;
}
public int getCases() {
return cases;