Sources

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,30 @@
+{
+    "name": "php-middleware/block-robots",
+    "description": "Middleware to avoid search engine indexing with PSR-7",
+    "type": "library",
+    "keywords": [
+        "middleware",
+        "psr",
+        "psr-7",
+        "seo",
+        "robots"
+    ],
+    "require": {
+        "php": ">=5.5",
+        "psr/http-message": "^1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4.8.6",
+        "zendframework/zend-diactoros": "^1.1.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "PhpMiddleware\\BlockRobots\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "PhpMiddlewareTest\\BlockRobots\\": "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\\BlockRobots Tests">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/BlockRobotsMiddleware.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PhpMiddleware\BlockRobots;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+class BlockRobotsMiddleware
+{
+    const ROBOTS_HEADER = 'X-Robots-Tag';
+
+    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $out = null)
+    {
+        if ($request->getUri()->getPath() === '/robots.txt') {
+            $response->getBody()->write('Disallow: /');
+            return $response->withHeader('Content-Type', 'text/plain');
+        }
+        /* @var $out ResponseInterface */
+        $response = $out === null ? $response : $out($request, $response);
+
+        return $response->withHeader(self::ROBOTS_HEADER, 'noindex, nofollow');
+    }
+}

test/BlockRobotsMiddlewareTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace PhpMiddlewareTest\BlockRobots;
+
+use PhpMiddleware\BlockRobots\BlockRobotsMiddleware;
+use Psr\Http\Message\ResponseInterface;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\ServerRequest;
+
+class BlockRobotsMiddlewareTest extends \PHPUnit_Framework_TestCase
+{
+    protected $middleware;
+
+    protected function setUp()
+    {
+        $this->middleware = new BlockRobotsMiddleware();
+    }
+
+    public function testNoIndexHeader()
+    {
+        $request = new ServerRequest();
+        $response = new Response();
+        $calledOut = false;
+
+        $outFunction = function ($request, $response) use (&$calledOut) {
+            $calledOut = true;
+
+            return $response;
+        };
+
+        /* @var $result ResponseInterface */
+        $result = call_user_func($this->middleware, $request, $response, $outFunction);
+
+        $this->assertTrue($calledOut, 'Out was not called');
+        $this->assertNotSame($response, $result);
+        $this->assertEquals('noindex, nofollow', $result->getHeaderLine(BlockRobotsMiddleware::ROBOTS_HEADER));
+    }
+
+    public function testRobots()
+    {
+        $uri = new \Zend\Diactoros\Uri('http://foo/robots.txt');
+        $request = new ServerRequest();
+        $request = $request->withUri($uri);
+        $response = new Response();
+        $calledOut = false;
+
+        $outFunction = function ($request, $response) use (&$calledOut) {
+            $calledOut = true;
+
+            return $response;
+        };
+
+        /* @var $result ResponseInterface */
+        $result = call_user_func($this->middleware, $request, $response, $outFunction);
+
+        $this->assertFalse($calledOut, 'Out was called');
+        $this->assertNotSame($response, $result);
+        $this->assertFalse($result->hasHeader(BlockRobotsMiddleware::ROBOTS_HEADER));
+        $this->assertEquals('Disallow: /', (string) $result->getBody());
+        $this->assertEquals('text/plain', $result->getHeaderLine('Content-Type'));
+    }
+}