Refactor to use formatter

Author: Witold Wasiczko

.gitignore

@@ -1,2 +1,2 @@
 /vendor/
-composer.lock
+composer.lock

README.md

@@ -1,5 +1,5 @@
 # log-http-messages middleware [![Build Status](https://travis-ci.org/php-middleware/log-http-messages.svg)](https://travis-ci.org/php-middleware/log-http-messages)
-Request and response middleware logger with PSR-7 and PSR-3
+Middleware for log PSR-7 HTTP messages using PSR-3 logger
 
 This middleware provide framework-agnostic possibility to log request and response messages to PSR-3 logger.
 
@@ -8,25 +8,32 @@ This middleware provide framework-agnostic possibility to log request and respon
 ```json
 {
     "require": {
-        "php-middleware/log-http-messages": "^1.0.0"
+        "php-middleware/log-http-messages": "^2.0.0"
     }
 }
 ```
 
-To log any request you need pass into `LogRequestMiddleware` instance `Psr\Log\LoggerInterface` and add middleware to your middleware runner. To log response use `LogResponseMiddleware`.
+To log http messages you need pass into `LogRequestMiddleware` implementation of `PhpMiddleware\LogHttpMessages\Formatter\HttpMessagesFormatter`,
+instance `Psr\Log\LoggerInterface` and add middleware to your middleware runner.
+Third parameter is log level and it's optional (`Psr\Log\LogLevel::INFO` as default).
+
+There are tree implementation of `PhpMiddleware\LogHttpMessages\Formatter\HttpMessagesFormatter`:
+
+* `PhpMiddleware\LogHttpMessages\Formatter\RequestFormatter` to log request message,
+* `PhpMiddleware\LogHttpMessages\Formatter\ResponseFormatter` to log response message,
+* `PhpMiddleware\LogHttpMessages\Formatter\BothFormatter` to log request and response message.
 
 ```php
-$logRequestMiddleware = new PhpMiddleware\LogHttpMessages\LogRequestMiddleware($logger);
-$logResponseMiddleware = new PhpMiddleware\LogHttpMessages\LogResponseMiddleware($logger);
+$requestFormatter = PhpMiddleware\LogHttpMessages\Formatter\RequestFormatter();
+$responseFormatter = PhpMiddleware\LogHttpMessages\Formatter\ResponseFormatter();
+$formatter = new PhpMiddleware\LogHttpMessages\Formatter\BothFormatter(requestFormatter, responseFormatter);
+$logMiddleware = new PhpMiddleware\LogHttpMessages\LogMiddleware(formatter, $logger);
 
 $app = new MiddlewareRunner();
-$app->add($logRequestMiddleware);
-$app->add($logResponseMiddleware);
+$app->add($logMiddleware);
 $app->run($request, $response);
 ```
 
-Middlewares have optional second parameter in constructor with log level (default `Psr\Log\LogLevel::INFO`).
-
 ## It's just works with any modern php framework and logger!
 
 Middleware tested on:

src/AbstractLogMiddleware.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+final class BothFormatter implements HttpMessagesFormatter
+{
+    private $requestFormatter;
+    private $responseFormatter;
+
+    /**
+     * @param RequestFormatter $requestFormatter
+     * @param ResponseFormatter $responseFormatter
+     */
+    public function __construct(RequestFormatter $requestFormatter, ResponseFormatter $responseFormatter)
+    {
+        $this->requestFormatter = $requestFormatter;
+        $this->responseFormatter = $responseFormatter;
+    }
+
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return string
+     */
+    public function format(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        $requestString = $this->requestFormatter->format($request, $response);
+        $reponseString = $this->responseFormatter->format($request, $response);
+
+        return sprintf('Request: %s; Response %s', $requestString, $reponseString);
+    }
+}

src/Formatter/BothFormatter.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+interface HttpMessagesFormatter
+{
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return string
+     */
+    public function format(ServerRequestInterface $request, ResponseInterface $response);
+}

src/Formatter/HttpMessagesFormatter.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Request\Serializer;
+
+final class RequestFormatter implements HttpMessagesFormatter
+{
+    public function format(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        return Serializer::toString($request);
+    }
+}

src/Formatter/RequestFormatter.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Response\Serializer;
+
+final class ResponseFormatter implements HttpMessagesFormatter
+{
+    public function format(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        return Serializer::toString($response);
+    }
+}

src/Formatter/ResponseFormatter.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages;
+
+use PhpMiddleware\LogHttpMessages\Formatter\HttpMessagesFormatter;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as ServerRequest;
+use Psr\Log\LoggerInterface as Logger;
+use Psr\Log\LogLevel;
+
+class LogMiddleware
+{
+    /**
+     * @var Logger
+     */
+    protected $logger;
+
+    /**
+     * @var int
+     */
+    protected $level;
+
+    /**
+     * @var HttpMessagesFormatter
+     */
+    protected $formatter;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param int $level
+     */
+    public function __construct(HttpMessagesFormatter $formatter, Logger $logger, $level = LogLevel::INFO)
+    {
+        $this->formatter = $formatter;
+        $this->logger = $logger;
+        $this->level = $level;
+    }
+
+    /**
+     * @param ServerRequest $request
+     * @param Response $response
+     * @param callable $next
+     *
+     * @return ResponseInterface
+     */
+    public function __invoke(ServerRequest $request, Response $response, callable $next)
+    {
+        $outResponse = $next($request, $response);
+
+        $messages = $this->formatter->format($request, $response);
+
+        if (!is_string($messages)) {
+            throw new \UnexpectedValueException(sprintf('%s must return string', HttpMessagesFormatter::class));
+        }
+
+        $this->logger->log($this->level, $messages);
+
+        return $outResponse;
+    }
+}

src/LogMiddleware.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace PhpMiddlewareTest\LogHttpMessages\Formatter;
+
+use PhpMiddleware\LogHttpMessages\Formatter\BothFormatter;
+use PhpMiddleware\LogHttpMessages\Formatter\RequestFormatter;
+use PhpMiddleware\LogHttpMessages\Formatter\ResponseFormatter;
+use PHPUnit_Framework_TestCase;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\ServerRequest;
+
+class BothFormatterTest extends PHPUnit_Framework_TestCase
+{
+    protected $formatter;
+
+    protected function setUp()
+    {
+        $requestFormatter = new RequestFormatter();
+        $responseFormatter = new ResponseFormatter();
+
+        $this->formatter = new BothFormatter($requestFormatter, $responseFormatter);
+    }
+
+    public function testFormatter()
+    {
+        $request = new ServerRequest([], [], 'https://github.com/php-middleware/log-http-messages', 'GET', 'php://input', ['Accept' => 'text/html']);
+        $response = new Response('php://memory', 500, ['Content-Type' => 'text/html']);
+
+        $result = $this->formatter->format($request, $response);
+
+        $this->assertSame("Request: GET /php-middleware/log-http-messages HTTP/1.1\r\nAccept: text/html; Response HTTP/1.1 500 Internal Server Error\r\nContent-Type: text/html", $result);
+    }
+}