Merge pull request #1 from SergeyBel/add-readme

upgrade README

Author: SergeyBel

.travis.yml

@@ -2,10 +2,12 @@ language: php
 
 php:
   - 7.1
+  - 7.2
+  - 7.4
 
 before_script:
   - composer install
 
 script:
-  - vendor/bin/php-cs-fixer src --dry-run
+  - vendor/bin/php-cs-fixer fix src --dry-run
   - vendor/bin/phpunit tests --colors --coverage-clover=coverage.xml

README.md

@@ -1 +1,34 @@
-# curl-printer
+# curl-printer [![Build Status](https://travis-ci.com/SergeyBel/curl-printer.svg?branch=main)](https://travis-ci.com/SergeyBel/curl-printer)
+
+**curl-printer** is a library which allows you print php PSR-7 request as curl command line string. It is useful for logging and debugging
+
+## Usage
+
+```php
+use CurlPrinter\CurlPrinter;
+use GuzzleHttp\Psr7\Request;
+
+$request = new Request(
+    'POST',
+    'https://someapi.com/v2/user/create',
+     [
+       'Accept' => 'application/json',
+     ],
+     'user_id=12345'
+);
+$printer = new CurlPrinter();
+echo $printer->printRequest($request); 
+// curl -X POST https://someapi.com/v2/user/create -d 'user_id=12345' -H 'Accept: application/json'
+```
+
+## Guzzle middleware
+You can use **CurlPrinterMiddleware** for comfortable work with Guzzle (see [examples](https://github.com/SergeyBel/curl-printer/tree/main/examples)) 
+
+```php
+$logger = // some LoggerInterface
+
+$stack = // Guzzle handler stack
+$stack->push(new CurlPrinterMiddleware($logger));
+$client = new Client(['handler' => $stack]);
+$client->post(...);
+```

composer.json

@@ -13,10 +13,14 @@
         }
     },
 
+    "require": {
+        "php": ">=7.1"
+    },
+
     "require-dev": {
-        "guzzlehttp/guzzle": "7.0",
-        "monolog/monolog": "^2.1",
-        "phpunit/phpunit": "9",
+        "guzzlehttp/guzzle": ">=6.0",
+        "monolog/monolog": ">=1.1",
+        "phpunit/phpunit": ">=7",
         "friendsofphp/php-cs-fixer": "^2.16"
     }
 }

examples/get.php

@@ -8,7 +8,7 @@
 use \GuzzleHttp\HandlerStack;
 
 
-require_once '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 
 $logger = new Logger('example.logger');

examples/post_json.php

@@ -0,0 +1,33 @@
+<?php
+
+use CurlPrinter\CurlPrinterMiddleware;
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\CurlHandler;
+use \Monolog\Logger;
+use \Monolog\Handler\StreamHandler;
+use \GuzzleHttp\HandlerStack;
+
+
+require_once __DIR__ .  '/../vendor/autoload.php';
+
+
+$logger = new Logger('example.logger');
+$logger->pushHandler(new StreamHandler('php://stdout'));
+
+
+$stack = HandlerStack::create();
+$stack->setHandler(new CurlHandler());
+$stack->push(new CurlPrinterMiddleware($logger));
+$client = new Client(['handler' => $stack]);
+$client->post('https://www.google.com/',
+    [
+        'json' => [
+            "key" => "value",
+        ],
+        'headers' => [
+            'Content-type' => 'application/json; charset=utf-8',
+            'Accept' => 'application/json',
+        ],
+    ]
+);
+

src/CurlFormatter.php

@@ -1,7 +1,6 @@
 <?php
 namespace CurlPrinter;
 
-
 /**
  * Class CurlFormatter
  * Format CurlData to curl command line string
@@ -48,7 +47,7 @@ private function addBody(CurlData $curlData): void
     {
         $body = $curlData->getBody();
         if (!empty($body)) {
-            $this->addNamedOption(CurlOptions::OPTION_BODY, '"'.$curlData->getBody().'"');
+            $this->addNamedOption(CurlOptions::OPTION_BODY, "'".$curlData->getBody()."'");
         }
     }
 
@@ -58,7 +57,7 @@ private function addHeaders(CurlData $curlData): void
 
         foreach ($headers as $name => $header) {
             if (!in_array($name, $this->skippedHeaders)) {
-                $this->addNamedOption(CurlOptions::OPTION_HEADER, '"'.$name.': '.$header[0].'"');
+                $this->addNamedOption(CurlOptions::OPTION_HEADER, "'".$name.': '.$header[0]."'");
             }
         }
     }

tests/CurlPrinterTest.php

@@ -18,28 +18,28 @@ protected function setUp(): void
     public function testSimpleGet()
     {
         $request = $this->createRequest('GET');
-        $answer = 'curl http://test.tst';
+        $answer = "curl http://test.tst";
         $this->assertSame($answer, $this->printer->printRequest($request));
     }
 
     public function testGetWithParams()
     {
         $request = $this->createRequest('GET', [], '', 'http://test.tst?param1=value1');
-        $answer = 'curl http://test.tst?param1=value1';
+        $answer = "curl http://test.tst?param1=value1";
         $this->assertSame($answer, $this->printer->printRequest($request));
     }
 
     public function testSimplePost()
     {
         $request = $this->createRequest('Post');
-        $answer = 'curl -X POST http://test.tst';
+        $answer = "curl -X POST http://test.tst";
         $this->assertSame($answer, $this->printer->printRequest($request));
     }
 
     public function testPostWithBody()
     {
         $request = $this->createRequest('POST', [], 'param1=value1&param2=value2');
-        $answer = 'curl -X POST http://test.tst -d "param1=value1&param2=value2"';
+        $answer = "curl -X POST http://test.tst -d 'param1=value1&param2=value2'";
         $this->assertSame($answer, $this->printer->printRequest($request));
     }
 
@@ -51,7 +51,18 @@ public function testGetWithHeaders()
                 'Accept' => 'application/json',
                 'Content-Type' => 'application/xml'
             ]);
-        $answer = 'curl http://test.tst -H "Accept: application/json" -H "Content-Type: application/xml"';
+        $answer = "curl http://test.tst -H 'Accept: application/json' -H 'Content-Type: application/xml'";
+        $this->assertSame($answer, $this->printer->printRequest($request));
+    }
+
+    public function testPostJsonBody()
+    {
+        $request = $this->createRequest(
+            'POST',
+            [],
+            json_encode(['key' => 'value'])
+        );
+        $answer = "curl -X POST http://test.tst -d '{\"key\":\"value\"}'";
         $this->assertSame($answer, $this->printer->printRequest($request));
     }