Postal Address Manager

Overview

Front end

A web-based UI form that can capture a country-specific address format entered by an end user It should dynamically adjust to capture the address Validation of the address formats and related data Ability to select data from user interface elements (drop down lists , autocomplete ..so on ) Where possible, default values and constrained lists should be presented

API

search for a given address based on the country-specific format search across countries to find "matching" addresses and display them in the application API callable via HTTP (curl or postman) Documentation for the API, preferably available alongside the API itself (think swagger / OpenAPI)

Search Operation

address search should return a result to the end user in < 75ms should support at least 1000 concurrent requests (read, write, and search).

Database

DB should be seeded with a large number of addresses of various formats spread across the countries on a per-capita basis (or approximately based on number of residents in each country). writing the code that seeds your database or exercise your API to do so or if you want to "go around" your API and write the data in some other way.

NFR

• Validation must occur in a reasonable time for the user
• Deal with all countries Argentina | Australia | Austria | Belgium | Brazil | Britain | Canada | Channel Islands | Chile | China, People's Republic of | China, Republic of | Costa Rica | Crimea (Autonomous Republic of) | Czech Republic | Denmark | Estonia | Fiji | Finland | Formosa | France | Germany | Great Britain | Greenland | Hong Kong | Iceland | India | Indonesia | Ireland | Isle of Man | Israel | Italy | Japan | Korea | Latvia | Luxembourg | Malaysia | Mexico | Miscellaneous/Other | Netherlands | New Zealand | Northern Ireland | Norway | Oman | Pakistan | People's Republic of China | Poland | Portugal | Puerto Rico | Republic of China | Romania | Russia | Scotland | Singapore | South Africa | South Korea | Spain | Sweden | Switzerland | Taiwan | U.K. | Ukraine | United Kingdom | United States | Uruguay | Venezuela | Wales Maintainability and ease of deployment with CICD pipeline and dependency management
• Internalization / globalization

API endpoints

1. GET /address/{text} - search by hashmap of filters in query string.

Request Parameters can delay and faultPercent. The filters can be number,street,unit,city,postcode

Examples:

• [GET] http://server:7000/address?country=United%20States&city=Kennewick
• [GET] http://localhost:7000/address2?country=United%20States&city=Kennewick&number=222604

2. GET /address/street/{text} - Request Parameters can be country , delay and faultPercent

Example :

• [GET] http://server:7000/address/street/3a%20street
• [GET] http://server:7000/address/street/3a%20street?country=United%20Arab%20Emirates

3. GET /address/format/{country} - runs format search for countries and returns boolean response of true or false to dynamically adjust user interface

Example :

• [GET] http://server:7000/address/format/United%20Kingdom

Tools

Made with spring boot on spring framework

1. Java

> java -version
openjdk version "11.0.9.1" 2020-11-04
OpenJDK Runtime Environment (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04)
OpenJDK 64-Bit Server VM (build 11.0.9.1+1-Ubuntu-0ubuntu1.18.04, mixed mode, sharing)

2. Spring boot cli

wget https://repo.spring.io/release/org/springframework/boot/spring-boot-cli/2.4.3/spring-boot-cli-2.4.3-bin.tar.gz
tar -xvf spring-boot-cli-2.4.3-bin.tar.gz
cd spring-2.4.3/bin

https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started-installing-the-cli

Add to path

export PATH="$PATH:/home/altanai/Documents/architecture/spring-2.4.3/bin"

check for version

spring --version
Spring CLI v2.4.3

3. spring intializer

https://start.spring.io/

Spring fox swagger ui

Springfox suite of java libraries are all about automating the generation of specifications for JSON APIs

5. graddle

To install graddle SDKMAN is a recomemndation ( https://sdkman.io/) First install SDKMAN

curl -s "https://get.sdkman.io" | bash

once install clsoe , opena new window to install graddle

sdk install gradle 6.8.2

the build gradle wrapper for `gradlew'

gradle wrapper

6. Reactor

Implementation of the Reactive Programming paradigm

Reactor is a fully non-blocking reactive programming foundation for the JVM, with efficient demand management.

Offers composable asynchronous sequence API Flux (for [N] elements) and Mono (for [0|1] elements) and extensively implements the Reactive Streams specification.

Class Mono - A Reactive Streams Publisher with basic rx operators that emits at most one item via the onNext signal then terminates with an onComplete signal (successful Mono, with or without value), or only emits a single onError signal (failed Mono).

Flux - A Reactive Streams Publisher with basic flow operators. Has Static factories for source generation from arbitrary callbacks types. Instance methods allows operational building, materialized on each subscription (Flux#subscribe(), ...) or multicasting operations (such as Flux#publish and Flux#publishNext).

Swagger

URL for swagger UI - http://localhost:7000/swagger-ui/index.html

Swagger home and API verbs

POST request for submit address storage in self managed records

API Response types

Metrics to API calls

Seed the DB

Make sure the db sever is runing

mkdir db
mongod -port 27017  -dbpath "db"

Mongoimport and mongoDB manually

mongoimport -d "db" -c test --type json --file washington-addresses-county.geojson

Using script

cd dbpopulation 
sh setupdb.sh

To see the mongo db from cli

mongo --host localhost:27017
use address
db.us.findOne()
db.us.find().limit(5).pretty()

If ur using intellij u can add the mongo interface by connecting with DB and then import db

Run

run the application

$ ./gradlew build && ./gradlew :application:bootRun

test its running

$  curl -v localhost:7000/address/anh
Greetings from Spring Boot!

Login screen

Get the pass from logs and login

Results for API

Results when login is not provided

Results when api route doesnt exist

Health monitoring

http://localhost:7000/actuator/health/

{"status":"UP"}

Load Test POSTMAN

single call

1 thousand calls

Debug

Issue 1 Broken Spring Initializer for spring and/or intellij

Initializr service call failed using 'https://start.spring.io' - service returned  (unexpected 404 error)

Solution Run with gradelw , make sure gradle wrapper is build beforehand

Issue 2 Security addons throws error

Parameter 0 of method setSecurityWebFilterChains in org.springframework.security.config.annotation.web.reactive.WebFluxSecurityConfiguration required a bean of type 'org.springframework.security.oauth2.jwt.ReactiveJwtDecoder' that could not be found.

The following candidates were found but could not be injected:
	- Bean method 'jwtDecoder' in 'ReactiveOAuth2ResourceServerJwkConfiguration.JwtConfiguration' not loaded because @ConditionalOnProperty (spring.security.oauth2.resourceserver.jwt.jwk-set-uri) did not find property 'spring.security.oauth2.resourceserver.jwt.jwk-set-uri'
	- Bean method 'jwtDecoderByIssuerUri' in 'ReactiveOAuth2ResourceServerJwkConfiguration.JwtConfiguration' not loaded because OpenID Connect Issuer URI Condition did not find issuer-uri property
	- Bean method 'jwtDecoderByPublicKeyValue' in 'ReactiveOAuth2ResourceServerJwkConfiguration.JwtConfiguration' not loaded because Public Key Value Condition did not find public-key-location property

solution Remote the security addons if u see them , will inetgarete this via authrozation server in due time

**Issue 3 ** 401 on all http req

 curl -v user:pass@localhost:7000/address/anh
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to localhost (127.0.0.1) port 7000 (#0)
* Server auth using Basic with user 'user'
> GET /address/anh HTTP/1.1
> Host: localhost:7000
> Authorization: Basic dXNlcjpwYXNz
> User-Agent: curl/7.58.0
> Accept: */*
> 
< HTTP/1.1 401 Unauthorized
* Authentication problem. Ignoring this.
< WWW-Authenticate: Basic realm="Realm"
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: 0
< X-Content-Type-Options: nosniff
< X-Frame-Options: DENY
< X-XSS-Protection: 1 ; mode=block
< Referrer-Policy: no-referrer
< content-length: 0
< 
* Connection #0 to host localhost left intact

solution By default, the BasicAuthenticationEntryPoint provisioned by Spring Security returns a full page for a 401 Unauthorized response To fix this comment out the content in SecurityWebFilterChain till be setup aouth and JWT and replace with

http
    .authorizeExchange()
    .pathMatchers("/**").permitAll()
    .anyExchange().authenticated();

Reference Documentation

Gradle

• Official Gradle documentation
• Spring Boot Gradle Plugin Reference Guide
• Create an OCI image
• Gradle Build Scans – insights for your project's build

Spring

• Spring REST
• Spring Boot
• Spring MVC Annotations
• HTTP status

Lombok

• Autogeneration using Lombok

Reactor

• Reactor
• Reactor Repo

Swagger

• https://springfox.github.io/springfox/docs/snapshot/#springfox-swagger-ui

Contact

• abisht@seattleu.edu

License

GPL