liveintent/sdk-php

LiveIntent SDK PHP

v0.4.1 2023-07-27 20:41 UTC

Requires

• php: ^8.0|^8.1
• guzzlehttp/guzzle: ^7.3
• illuminate/collections: ^9.2
• illuminate/contracts: ^9.2
• illuminate/http: ^9.2
• illuminate/support: ^9.2
• nesbot/carbon: ^2.46

Requires (Dev)

• liveintent/php-cs-fixer: ^3.0
• nunomaduro/collision: ^6.2
• phpunit/phpunit: ^9.5
• ramsey/conventional-commits: ^1.1
• symfony/finder: ^6.0
• symfony/var-dumper: ^6.0
• vimeo/psalm: ^4.7
• vlucas/phpdotenv: ^5.3

MIT

• php
• sdk
• liveintent

README

The LiveIntent PHP SDK provides a convenient way to interact with the LiveIntent API in PHP applications.

This document describes how to develop the SDK itself. For usage documentation and examples see usage.

Getting started

First clone the repository. Then, run cp .env.example .env to create the env file.

Finally install the dependencies via:

composer install

Testing

To run the unit tests

composer test

Mocking

When testing you often want to mock external api calls, but you also want to be confident that those api calls will work in the real world.

To solve this, you may instruct the client to record the request/response pairs it makes. This allows you to run your tests against a live version of the api when necessary, and to reuse those same responses when mocking is acceptable for faster, more predictable and reliable tests.

Test in record mode

To run the tests against a live api connection and record the results run:

composer test-record

By default recordings will be saved in the file tests/__snapshots__/snapshot.

Test using recorded responses

To run the tests against a live api connection and record the results run:

composer test

Alternative methods of mocking

The LiveIntent client inherits from Laravel's Http Client. Therefore, all the methods available to that client are also be available.

For detailed documentation see here.

Linting

The installed linter will auto-format your code to comply with our agreed php coding standard.

To run the linter

composer lint