Sample web application used to retrieve the nearest pharmacies given a geo position.
Written in PHP, supported by Lumen Framework and a preconfigured Docker container
The application provides a JSON-RPC method named SearchNearestPharmacy over HTTP. The method accepts the following parameters:
- currentLocation, the location of the user, composed of:
- latitude, float value indicating the current latitude of the user (e.g. 40.97153496)
- longitude, float value indicating the current longitude of the user (e.g. 15.09370468)
- range, the maximum distance in meters (e.g. 5000)
- limit, the maximum number of entries to show (e.g. 2)
The response is a list of the nearest pharmacies including their name, position and distance, sorted by distance
During installation, the data of the pharmacies are imported from an external json file and stored in a database.
The application based on PHP7 and Lumen Framework, exposes, through API Rest, a service for the research of nearby pharmacies, present in a PostgreSQL relational database. The calculation of the distance between the geographic coordinates is carried out thanks to the Postgis extension.
The project is already prepared for the use of Docker (option A - see file docker-compose.yml, Dockerfile and the .docker folder). However, it can be executed locally by manually configuring the environment (option B).
To start the application via container you need:
- Docker
- Docker Compose
Setting up a local environment requires the installation of:
- Runtime PHP >= 7.2
- Webserver (Nginx, Apache or equivalent)
- PostgeSQL >= 10
- Postgis
- Composer
In both cases (option A or B) located in the working directory
$ cd <working directory>
$ git clone git@github.com:frasim/sample-json-rpc.git jsonrpc
----------------------------------------------------------------------
Clone in 'jsonrpc' in corso...
remote: Enumerating objects: 79, done.
remote: Counting objects: 100% (79/79), done.
remote: Compressing objects: 100% (59/59), done.
remote: Total 79 (delta 4), reused 79 (delta 4), pack-reused 0
Ricezione degli oggetti: 100% (79/79), 76.98 KiB | 895.00 KiB/s, fatto.
Risoluzione dei delta: 100% (4/4), fatto.
Move into project directory
$ cd jsonrpc
$ cp .env.example .env
you can change DB_DATABASE, DB_USERNAME and DB_PASSWORD or any other configuration key.
$ docker-compose build app
----------------------------------------------------------------------
Building app
Step 1/11 : FROM php:7.4-fpm
---> 1e915dc40edc
Step 2/11 : ARG user
---> Using cache
---> 4b7b6f683b9c
Step 3/11 : ARG uid
---> Using cache
---> f5380d1f550e
Step 4/11 : RUN apt-get update && apt-get install -y libpng-dev libonig-dev libpq-dev libxml2-dev git curl zip unzip postgresql postgresql-contrib
---> Using cache
---> 887811ae2d66
Step 5/11 : RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
---> Using cache
---> 6c66afacc0c1
Step 6/11 : RUN docker-php-ext-install pdo_pgsql exif pcntl bcmath gd
---> Using cache
---> b5e04391fcc4
Step 7/11 : COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
---> Using cache
---> 85c7d818ae23
Step 8/11 : RUN useradd -G www-data,root -u $uid -d /home/$user $user
---> Using cache
---> 47b8b143cc90
Step 9/11 : RUN mkdir -p /home/$user/.composer && chown -R $user:$user /home/$user
---> Using cache
---> 82a0a487201c
Step 10/11 : WORKDIR /var/www
---> Using cache
---> 49aee8203574
Step 11/11 : USER $user
---> Using cache
---> 5435a8087947
Successfully built 5435a8087947
Successfully tagged app:latest
$ docker-compose up -d
----------------------------------------------------------------------
Creating network "app-network" with driver "bridge"
Creating application-webserver ... done
Creating application ... done
Creating application-db ... done
$ docker ps
----------------------------------------------------------------------
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
390a083319ca kartoza/postgis:11.5-2.8 "/bin/sh -c /scripts…" 4 minutes ago Up 4 minutes 0.0.0.0:55432->5432/tcp application-db
1646a810ea45 app "docker-php-entrypoi…" 4 minutes ago Up 4 minutes 9000/tcp application
c7cd0a8ad504 nginx:alpine "/docker-entrypoint.…" 4 minutes ago Up 4 minutes 0.0.0.0:8000->80/tcp, 0.0.0.0:4443->443/tcp application-webserver
$ docker-compose exec app composer install
$ docker-compose exec app php artisan migrate
----------------------------------------------------------------------
Migration table created successfully.
Migrating: 2020_08_27_234550_create_pharmacies_table
Migrated: 2020_08_27_234550_create_pharmacies_table (0.08 seconds)
Migrating: 2020_08_27_235534_import_pharmacies
Migrated: 2020_08_27_235534_import_pharmacies (1.05 seconds)
The entry point of the application is public/index.php. Route requests from the webserver / virtual host to this resource.
$ composer install
Setting up database a user and related permissions according to .env keys
- DB_HOST
- DB_PORT
- DB_DATABASE
- DB_USERNAME
- DB_PASSWORD
$ php artisan migrate
The web application exposes the route "/" via POST method and receives calls according to the JSON-RPC 2.0 standard. The only accepted method is SearchNearestPharmacy, whose parameters are so structured:
- currentLocation, the location of the user, composed of:
- latitude required|float
- longitude required|float
- range required|min:0
- limit required|min:-1 (-1 = no limit)
REQUEST
--------------------------------------------------------------------------------
curl --header "Content-Type: application/json" \
--request POST \
--data '{"jsonrpc":"2.0","id":"1","method":"SearchNearestPharmacy","params":{"currentLocation":{"latitude":"41.10938993","longitude":"15.0321010"},"range":"5000","limit":"2"}}' \
http[s]://<host>:<port>/
RESPONSE
--------------------------------------------------------------------------------
{"id":"1","jsonrpc":"2.0","result":{"pharmacies":[{"name":"Belmonte Di Dott.sse Belmonte S. Ed E. Snc","latitude":"41.11","longitude":"15.03","distance":"39.99961698"}]}}
Using Docker, the web server is externally exposed by default on port 8000:
http://localhost:8000/
However, it is possible to change this setting by setting the key APP_BIND_PORT_HTTP (.env file).
You can also change the ports exposed on the https and postgres service respectively (.env file):
- APP_BIND_PORT_HTTPS
- APP_BIND_PORT_DB
The automated tests, made using PHPUnit, consist of 10 tests and 28 assertions and represent all possible use cases (including cases of failure) of the application.
| Name | Description | Status |
|---|---|---|
| Parse error | Invalid json parsing | PASSED |
| Invalid request | Json validation failed | PASSED |
| Method not found | Wrong method name | PASSED |
| Invalid params | Missed required keys in params | PASSED |
| Invalid params | Negative range | PASSED |
| Invalid params | Negative limit (< -1) | PASSED |
| Success 1 | PASSED | |
| Success 2 | PASSED | |
| Success 3 | PASSED |
These tests are summarized in the logtests file.
Start tests with Docker (A)
$ docker-compose exec app ./vendor/bin/phpunit
PHPUnit 8.5.8 by Sebastian Bergmann and contributors.
.......... 10 / 10 (100%)
Time: 274 ms, Memory: 10.00 MB
OK (10 tests, 28 assertions)
With local environment (B)
$ ./vendor/bin/phpunit
PHPUnit 8.5.8 by Sebastian Bergmann and contributors.
.......... 10 / 10 (100%)
Time: 274 ms, Memory: 10.00 MB
OK (10 tests, 28 assertions)