asisteam / adol
Implemenation of communication with ADOL API endpoints
Requires
- php: >= 7.1
- ext-json: *
- guzzlehttp/guzzle: ^6.3
- nette/di: ^2.4
Requires (Dev)
- mockery/mockery: ^1.2
- ninjify/nunjuck: ^0.2.0
- ninjify/qa: ^0.8.0
This package is auto-updated.
Last update: 2024-10-26 10:05:49 UTC
README
Credits
The development is under AsisTeam s.r.o.. Feel free to use and contribute.
Install
composer require asisteam/adol
Versions
Overview
This package communicates with following ADOL APIs:
- Watchdog (to be used for assigning watchdog items (insolvencies and estates) to watchdog and checking changes made on these items.)
- Property (to be used for retrieving detail information about property entities (lands/buildings/building units/persons))
Note: In order to communicate with ADOL APIs you must have your own private token
string. This token
is provided by ADOL.
Basic principles
For every provided API a separate client class is created (please see Client/WatchDog/...
, Client/Property/...
).
In order to create the client, you must instantiate it by passing at least a valid token
string to it's constructor.
Or you can replace the default GuzzleHttp client with your custom http client that implements ClientInterface.
If using GuzzleHttp client you can also pass a third optional constructor parameter, that is a request options array that will be appended to every request made by the http client.
By using this options array, you can set client timeouts etc. for all client calls. Please see available Guzzle options at http://docs.guzzlephp.org/en/stable/request-options.html.
When doing a call two exceptions can be thrown.
- The
RequestException
is being thrown if request is invalid. The request will not be performed. - The
ResponseException
is thrown whenever request has been sent and response from ADOL server contains invalid status or misses some data.
How to run tests and check code
Code quality assurance: composer qa
Code PHPSTAN: composer phpstan
Unit and Integration tests: composer tests
Note: As you are charged for all request performed to real API, integration tests are skipped by default. In order to run integration tests edit tests/Cases/Integration/AbstractTestCase
and fill your private token
and delete Environment::skip
line in setUp() method.
Nette bridge
You can configure clients as Nette Framework DI services and you will be able to use following services:
Watchdog API
- adol.watchdog.insolvency
- adol.watchdog.property
Property API
- adol.property.land
- adol.property.building
- adol.property.building_unit
- adol.property.person
extensions:
adol: AsisTeam\ADOL\Bridges\Nette\DI\AdolExtension
adol:
token: "your dedicated adol token"
options: [
timeout: 20
]