tenantcloud/guzzle-helper

Guzzle helpers.

1.2.0 2022-02-28 12:27 UTC

This package is auto-updated.

Last update: 2022-06-28 13:26:46 UTC


README

Guzzle helpers. Add Header and Json obfuscators for guzzle middleware. Used for remove autorization headers and sensitive date from response logs.

Requirements

  • Guzzle >=7
  • PHP version >=7.4.1
  • Docker (optional)

Installation

In your composer.json, add this repository:

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/tenantcloud/guzzle-helpers"
    }
],

Then do composer require tenantcloud/guzzle-helpers to install the package.

Examples

	$stack = \GuzzleHttp\HandlerStack::create();

	// Return all response body.
	$stack->unshift(\TenantCloud\GuzzleHelper\GuzzleMiddleware\GuzzleMiddleware::fullErrorResponseBody());

	// Hide secret info from error responses (cut contactEmail, contactPhone keys).
	// Hide Authorization header
	$stack->unshift(\TenantCloud\GuzzleHelper\GuzzleMiddleware\GuzzleMiddleware::dumpRequestBody([
		new \TenantCloud\GuzzleHelper\GuzzleMiddleware\JsonObfuscator([
			'contactEmail',
			'contactPhone',
		]),
		new \TenantCloud\GuzzleHelper\GuzzleMiddleware\HeaderObfuscator(['Authorization']),
	]));

Commands

Install dependencies: docker run -it --rm -v $PWD:/app -w /app composer install

Run tests: docker run -it --rm -v $PWD:/app -w /app php:7.4-cli vendor/bin/phpunit

Run php-cs-fixer on self: docker run -it --rm -v $PWD:/app -w /app composer cs-fix