Init

Author: snapshotpl

.gitignore

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

.travis.yml

@@ -0,0 +1,19 @@
+language: php
+
+matrix:
+  fast_finish: true
+  include:
+    - php: 5.5
+    - php: 5.6
+    - php: 7
+    - php: hhvm
+  allow_failures:
+    - php: 7
+    - php: hhvm
+
+install:
+  - travis_retry composer install --no-interaction --ignore-platform-reqs --prefer-source
+  - composer info -i
+
+script:
+  - ./vendor/bin/phpunit

composer.json

@@ -0,0 +1,33 @@
+{
+    "name": "php-middleware/log-http-messages",
+    "description": "Request and response middleware logger with PSR-7 and PSR-3",
+    "type": "library",
+    "keywords": [
+        "debug",
+        "middleware",
+        "psr",
+        "psr-7",
+        "log",
+        "logger",
+        "psr-3"
+    ],
+    "require": {
+        "php": ">=5.5",
+        "psr/log": "^1.0.0",
+        "psr/http-message": "^1.0",
+        "zendframework/zend-diactoros": "^1.1.3"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4.8.6"
+    },
+    "autoload": {
+        "psr-4": {
+            "PhpMiddleware\\LogHttpMessages\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "PhpMiddlewareTest\\LogHttpMessages\\": "test/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="./vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="PhpMiddleware\\LogHttpMessages Tests">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/AbstractLogMiddleware.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+
+abstract class AbstractLogMiddleware
+{
+    /**
+     * @var LoggerInterface
+     */
+    protected $logger;
+
+    /**
+     * @var int
+     */
+    protected $level;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param int $level
+     */
+    public function __construct(LoggerInterface $logger, $level = LogLevel::INFO)
+    {
+        $this->logger = $logger;
+        $this->level = $level;
+    }
+
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     * @param callable $out
+     *
+     * @return ResponseInterface
+     */
+    final public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $out = null)
+    {
+        $outResponse = $out($request, $response);
+
+        $contentToLog = $this->getContentToLog($request, $outResponse);
+
+        $this->logger->log($this->level, $contentToLog);
+
+        return $outResponse;
+    }
+
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return mixed
+     */
+    abstract protected function getContentToLog(ServerRequestInterface $request, ResponseInterface $response);
+}

src/LogRequestMiddleware.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Request\Serializer;
+
+class LogRequestMiddleware extends AbstractLogMiddleware
+{
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return mixed
+     */
+    protected function getContentToLog(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        return Serializer::toString($request);
+    }
+}

src/LogResponseMiddleware.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace PhpMiddleware\LogHttpMessages;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Response\Serializer;
+
+class LogResponseMiddleware extends AbstractLogMiddleware
+{
+    /**
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface $response
+     *
+     * @return mixed
+     */
+    protected function getContentToLog(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        return Serializer::toString($response);
+    }
+}

test/LogRequestMiddlewareTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace PhpMiddlewareTest\LogHttpMessages;
+
+use PhpMiddleware\LogHttpMessages\LogRequestMiddleware;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\ServerRequest;
+
+class LogRequestMiddlewareTest extends \PHPUnit_Framework_TestCase
+{
+    protected $logger;
+    protected $middleware;
+
+    protected function setUp()
+    {
+        $this->logger = $this->getMockForAbstractClass(LoggerInterface::class);
+        $this->middleware = new LogRequestMiddleware($this->logger);
+    }
+
+    public function testLogRequest()
+    {
+        $request = new ServerRequest([], [], 'https://github.com/php-middleware/log-http-messages', 'GET', 'php://input', ['Accept' => 'text/html']);
+        $response = new Response();
+        $calledOut = false;
+        $outFunction = function ($request, $response) use (&$calledOut) {
+            $calledOut = true;
+            return $response;
+        };
+
+        $this->logger->expects($this->once())->method('log')->willReturnCallback(function ($level, $content) {
+            $this->assertEquals(LogLevel::INFO, $level);
+            $this->assertSame("GET /php-middleware/log-http-messages HTTP/1.1\r\nAccept: text/html", $content);
+        });
+
+        $result = call_user_func($this->middleware, $request, $response, $outFunction);
+
+        $this->assertTrue($calledOut, 'Out is not called');
+        $this->assertSame($response, $result);
+    }
+}

test/LogResponseMiddlewareTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace PhpMiddlewareTest\LogHttpMessages;
+
+use PhpMiddleware\LogHttpMessages\LogResponseMiddleware;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\ServerRequest;
+
+class LogResponseMiddlewareTest extends \PHPUnit_Framework_TestCase
+{
+    protected $logger;
+    protected $middleware;
+
+    protected function setUp()
+    {
+        $this->logger = $this->getMockForAbstractClass(LoggerInterface::class);
+        $this->middleware = new LogResponseMiddleware($this->logger);
+    }
+
+    public function testLogResponse()
+    {
+        $request = new ServerRequest();
+        $response = new Response('php://memory', 500, ['Content-Type' => 'text/html']);
+        $calledOut = false;
+        $outFunction = function ($request, $response) use (&$calledOut) {
+            $calledOut = true;
+            return $response;
+        };
+
+        $this->logger->expects($this->once())->method('log')->willReturnCallback(function ($level, $content) {
+            $this->assertEquals(LogLevel::INFO, $level);
+            $this->assertSame("HTTP/1.1 500 Internal Server Error\r\nContent-Type: text/html", $content);
+        });
+
+        $result = call_user_func($this->middleware, $request, $response, $outFunction);
+
+        $this->assertTrue($calledOut, 'Out is not called');
+        $this->assertSame($response, $result);
+    }
+}