logipro/datamaps-php

A PHP component to use Datamaps API within your PHP project.

v1.0.3 2024-03-06 20:30 UTC

Requires

• php: >=8.1
• symfony/http-client: ^7.0

Requires (Dev)

• infection/extension-installer: 0.1.2
• infection/infection: ^0.27
• phpstan/phpdoc-parser: ^1.20
• phpstan/phpstan: 1.10.15
• phpunit/phpunit: ^10
• squizlabs/php_codesniffer: 3.*

MIT

• Alban Bernard

• map
• datamaps

README

A PHP component to use Datamaps' API within your PHP project.

DatamapsClient allows you to

• get a specific map via its ID,
• search the last maps created,
• create a new map.

A map is defined by 4 values :

• string $mapId is the id of the map.
• string $createdAt is the creation date and time of the map, with format ATOM.
• [[float, float], [float, float]] $bounds sets the limit of the map.
• Layer[] $layers contains every layer. Each of them has a string $name and an array of Marker (storing a geographic point [float, float] $point, a string $description and a string $color).

Check DatamapsClient factories to obtain mocked versions of DatamapsClient for your tests.

Usage

In source files

DatamapsClient contains 3 public methods :

• get(string $mapId) to retrieve a specific map of id mapId. Returns a Map.
• search(int $amount) to retrieve the amount last created maps. Returns an array of Map.
• create(Map $map) to create and save a new map. Only bounds and layers will be persisted, mapId and createdAt will be generated on creation by Datamaps. Returns a Map.

In test files

SucceedingDatamapsClientMockFactory allows to test DatamapsClient if everything goes right.

• make() creates a mock of DatamapsClient that will never respond with failures.
• getExpectedResponseFromGet(string $mapId) returns the map the mocked version of the get($mapId) method will return.
• getExpectedResponseFromSearch(int $amount) returns the map the mocked version of the search($amount) method will return.
• getExpectedResponseFromCreate(Map $map) returns the map the mocked version of the create($map) method will return.

FailingDatamapsClientMockFactory allows to test DatamapsClient if everything goes wrong.

• make() creates a mock of DatamapsClient that will always respond with failures.
• get($mapId) will always result on Error on request to Datamaps. Map with mapId $mapId not found.
• search($amount) will always result on Error on request to Datamaps. Can't retrieve data from an empty repository.
• create($map) will always result on Error on request to Datamaps. /bounds: Array should have at least 2 items, 1 found.

Install

composer require logipro/datamaps-php

To contribute to Datamaps PHP

Requirements:

• docker
• git

Unit tests

bin/phpunit

Integration tests

bin/phpunit-integration

Quality

Some indicators:

• phpcs PSR12
• phpstan level 9
• coverage >= 100%
• infection MSI >= 100%

Quick check with:

./codecheck

Check coverage with:

bin/phpunit --coverage-html var

and view 'var/index.html' in your browser

Check infection with:

bin/infection

and view 'var/infection.html' in your browser