Merge pull request #10 from TheDragonCode/1.x

Added `withLogger` macro for Request

Author: andrey-helldar

README.md

@@ -68,6 +68,9 @@ Http::get()->toData(...); // will be method not found exception
 
 ### Available Methods
 
+#### Request
+
+- [withLogger](#withlogger)
 
 #### Response
 
@@ -76,6 +79,43 @@ Http::get()->toData(...); // will be method not found exception
 
 ### Method Listing
 
+#### withLogger()
+
+Adds the ability to log HTTP requests and responses.
+
+```php
+use Illuminate\Support\Facades\Http;
+
+Http::withLogger('some_channel')->get();
+```
+
+This method will log HTTP requests and responses.
+
+It is also possible to use your own handler, message formatting and path to the log file.
+To do this, you need to specify the desired channel name from the log file and define the necessary parameters in it.
+
+For example:
+
+```php
+// config/logging.php
+return [
+    // ...
+    
+    'channels' => [
+        'some' => [
+            'driver' => 'single',
+            'level' => env('LOG_LEVEL', 'debug'),
+            'path' => storage_path('logs/some.log'),
+            'handler' => \App\Logging\SomeHandlerStack::class,
+            'formatter' => \App\Logging\MessageFormatter::class,
+        ],
+    ],
+];
+
+// Usage
+return Http::withLogger('some')->...
+```
+
 #### toData()
 
 The class instance will be returned.

config/http.php

@@ -2,12 +2,15 @@
 
 declare(strict_types=1);
 
+use DragonCode\LaravelHttpMacros\Macros\Requests\WithLoggerMacro;
 use DragonCode\LaravelHttpMacros\Macros\Responses\ToDataCollectionMacro;
 use DragonCode\LaravelHttpMacros\Macros\Responses\ToDataMacro;
 
 return [
     'macros' => [
         'request' => [
+            WithLoggerMacro::class,
+
             // CustomMacro::class,
             // 'toFoo' => CustomMacro::class,
         ],

ide.json

@@ -0,0 +1,27 @@
+{
+    "$schema": "https://laravel-ide.com/schema/laravel-ide-v2.json",
+    "completions": [
+        {
+            "complete": "configKey",
+            "options": {
+                "prefix": "logging.channels"
+            },
+            "condition": [
+                {
+                    "methodNames": [
+                        "withLogger"
+                    ],
+                    "classFqn": [
+                        "\\Illuminate\\Http\\Client\\Factory",
+                        "\\Illuminate\\Http\\Client\\PendingRequest",
+                        "\\Illuminate\\Http\\Client\\Request",
+                        "\\Illuminate\\Support\\Facades\\Http"
+                    ],
+                    "parameters": [
+                        1
+                    ]
+                }
+            ]
+        }
+    ]
+}

src/Macros/Requests/WithLoggerMacro.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelHttpMacros\Macros\Requests;
+
+use Closure;
+use DragonCode\LaravelHttpMacros\Macros\Macro;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\MessageFormatter;
+use GuzzleHttp\Middleware;
+use Illuminate\Http\Client\PendingRequest;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
+
+use function call_user_func;
+use function config;
+use function storage_path;
+
+/**
+ * Adds the ability to log HTTP requests and responses.
+ */
+class WithLoggerMacro extends Macro
+{
+    public static function callback(): Closure
+    {
+        return function (string $channel): PendingRequest {
+            $config = config('logging.channels.' . $channel);
+
+            $handler   = call_user_func([$config['handler'] ?? HandlerStack::class, 'create']);
+            $formatter = $config['formatter'] ?? MessageFormatter::class;
+
+            $path = $config['path'] ?? storage_path('logs/laravel.log');
+
+            $logger = (new Logger($channel))->pushHandler(
+                new StreamHandler($path)
+            );
+
+            $handler->push(
+                Middleware::log($logger, new $formatter())
+            );
+
+            return $this->setHandler($handler);
+        };
+    }
+
+    public static function name(): string
+    {
+        return 'withLogger';
+    }
+}

src/ServiceProvider.php

@@ -6,7 +6,7 @@
 
 use DragonCode\LaravelHttpMacros\Commands\GenerateHelperCommand;
 use DragonCode\LaravelHttpMacros\Macros\Macro;
-use Illuminate\Http\Client\Request;
+use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Http\Client\Response;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
@@ -42,7 +42,7 @@ protected function bootCommands(): void
     protected function bootRequestMacros(): void
     {
         foreach ($this->requestMacros() as $name => $macro) {
-            Request::macro($this->resolveName($name, $macro), $macro::callback());
+            PendingRequest::macro($this->resolveName($name, $macro), $macro::callback());
         }
     }
 

tests/Fixtures/Logging/MessageFormater.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Logging;
+
+use GuzzleHttp\MessageFormatterInterface;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Throwable;
+
+class MessageFormater implements MessageFormatterInterface
+{
+    public function __construct(
+        protected string $template = 'REQUEST: {request} RESPONSE: {response}'
+    ) {}
+
+    public function format(
+        RequestInterface $request,
+        ?ResponseInterface $response = null,
+        ?Throwable $error = null
+    ): string {
+        return str_replace(['{request}', '{response}'], [
+            $request->getUri(),
+            $response->getBody()->getContents(),
+        ], $this->template);
+    }
+}

tests/Helpers/fake.php

@@ -3,10 +3,11 @@
 declare(strict_types=1);
 
 use Illuminate\Http\Client\Factory;
+use Illuminate\Support\Facades\Http;
 
 function fakeRequest(): Factory
 {
-    return (new Factory())->fake([
+    return Http::fake([
         'simple' => [
             'id'    => 1,
             'title' => 'Qwerty 1',

tests/TestCase.php

@@ -8,6 +8,7 @@
 use Illuminate\Config\Repository;
 use Orchestra\Testbench\TestCase as BaseTestCase;
 use Spatie\LaravelData\LaravelDataServiceProvider;
+use Tests\Fixtures\Logging\MessageFormater;
 
 abstract class TestCase extends BaseTestCase
 {
@@ -28,6 +29,17 @@ protected function defineEnvironment($app): void
 
                 'toFoo' => ToDataMacro::class,
             ]);
+
+            $config->set('logging.channels.foo', [
+                'driver' => 'single',
+                'path'   => storage_path('logs/foo.log'),
+            ]);
+
+            $config->set('logging.channels.bar', [
+                'driver'    => 'single',
+                'path'      => storage_path('logs/bar.log'),
+                'formatter' => MessageFormater::class,
+            ]);
         });
     }
 }