rexlabs/cuzzle

Get the cURL shell command from a Guzzle request

Maintainers

Details

github.com/rexlabsio/cuzzle

Source

Installs: 3 783

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 68

3.0.0 2023-07-19 13:45 UTC

This package is auto-updated.

Last update: 2024-10-19 16:29:54 UTC


README

This library let's you dump a Guzzle request to a cURL command for debug and log purpose.

Prerequisites

This library needs PHP 7.4+

It has been tested using PHP 7.4, 8.0, 8.1 and 8.2

Installation

You can install the library directly with composer:

composer require namshi/cuzzle

(Add --dev if you don't need it in production environment)

Usage

use Namshi\Cuzzle\Formatter\CurlFormatter;
use GuzzleHttp\Message\Request;

$request = new Request('GET', 'example.local');
$options = [];

echo (new CurlFormatter())->format($request, $options);

To log the cURL request generated from a Guzzle request, simply add CurlFormatterSubscriber to Guzzle:

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use Namshi\Cuzzle\Middleware\CurlFormatterMiddleware;
use Monolog\Logger;
use Monolog\Handler\TestHandler;

$logger = new Logger('guzzle.to.curl'); //initialize the logger
$testHandler = new TestHandler(); //test logger handler
$logger->pushHandler($testHandler);

$handler = HandlerStack::create();
$handler->after('cookies', new CurlFormatterMiddleware($logger)); //add the cURL formatter middleware
$client  = new Client(['handler' => $handler]); //initialize a Guzzle client

$response = $client->get('http://google.com'); //let's fire a request

var_dump($testHandler->getRecords()); //check the cURL request in the logs, 
//you should see something like: "curl 'http://google.com' -H 'User-Agent: Guzzle/4.2.1 curl/7.37.1 PHP/5.5.16"

Tests

You can run tests locally with

phpunit

Feedback

Add an issue, open a PR, drop us an email! We would love to hear from you!