answear/overseas-bundle

Symfony bundle for Overseas api.

2.1.1 2024-03-01 07:05 UTC

Requires

• php: >=7.4|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.0 || ^7.0
• marc-mabe/php-enum: ^3.0|^4.3
• psr/log: ^1.0
• symfony/http-kernel: 5.4 - 6.2
• symfony/property-access: 5.4 - 6.2
• symfony/property-info: 5.4 - 6.2
• symfony/serializer: 5.4 - 6.2
• webmozart/assert: ^1.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• matthiasnoback/symfony-config-test: ^4.2
• phpro/grumphp: ^1.5.0
• phpstan/phpstan: ^1.4
• phpstan/phpstan-webmozart-assert: ^1.0
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-master
• symfony/phpunit-bridge: 6.1.*

MIT

README

Overseas integration for Symfony.
Documentation of the API can be found here: https://api.overseas.hr/apiinfo

Installation

• install with Composer

composer require [e-mail]:answear/overseas-bundle.git

Answear\OverseasBundle\AnswearOverseasBundle::class => ['all' => true],
should be added automatically to your config/bundles.php file by Symfony Flex.

Setup

• provide required config data: environment and apiKey

# config/packages/answear_overseas.yaml
answear_overseas:
    environment: test|prod
    apiKey: yourApiKey
    logger: yourCustomLoggerService #default: null

Logger service must implement Psr\Log\LoggerInterface interface.

Usage

Get ParcelShops

@see https://api.overseas.hr/apiinfo#parcelshops

/** @var \Answear\OverseasBundle\Service\ParcelShopsService $parcelShopService **/
$parcelShopService->get();

will return \Answear\OverseasBundle\Response\DTO\ParcelShop[] array.

Get Places

@see https://api.overseas.hr/apiinfo#places

$zipCode = 12345;
$name = 'name';
$approx = true;

/** @var \Answear\OverseasBundle\Service\PlacesService $placesService **/
$placesService->get($zipCode, $name, $approx);

will return \Answear\OverseasBundle\Response\DTO\Place[] array narrowed down to params. or simply

$placesService->get();

to get all places.

Error handling

• Answear\OverseasBundle\Exception\ServiceUnavailableException for all GuzzleException
• MalformedResponseException for partner other errors
• Answear\OverseasBundle\Exception\BadRequestException if validation failed or for error response

Final notes

Feel free to open pull requests with new features, improvements or bug fixes. The Answear team will be grateful for any comments.