Header Plugin

Author: gsouf

spec/HeaderPluginSpec.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace spec\Http\Client\Plugin;
+
+use PhpSpec\Exception\Example\SkippingException;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamInterface;
+
+class HeaderPluginSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Plugin\HeaderPlugin');
+    }
+
+    public function it_is_a_plugin()
+    {
+        $this->shouldImplement('Http\Client\Plugin\Plugin');
+    }
+
+    public function it_sets_the_value(RequestInterface $request)
+    {
+        $request->hasHeader('foo')->shouldBeCalled()->willReturn(false);
+        $request->withHeader('foo', 'bar')->shouldBeCalled()->willReturn($request);
+
+        $this->withHeader('foo', 'bar');
+        $this->handleRequest($request, function () {
+        }, function () {
+        });
+    }
+
+    public function it_does_not_override_the_value(RequestInterface $request)
+    {
+        $request->hasHeader('foo')->shouldBeCalled()->willReturn(true);
+
+        $this->withHeader('foo', 'bar');
+        $this->handleRequest($request, function () {
+        }, function () {
+        });
+    }
+
+    public function it_overrides_the_value(RequestInterface $request)
+    {
+        $request->withHeader('foo', 'bar')->shouldBeCalled()->willReturn($request);
+
+        $this->withHeader('foo', 'bar', true);
+        $this->handleRequest($request, function () {
+        }, function () {
+        });
+    }
+
+    public function it_removes_the_value(RequestInterface $request)
+    {
+        $request->hasHeader('foo')->shouldBeCalled()->willReturn(true);
+        $request->withoutHeader('foo')->shouldBeCalled()->willReturn($request);
+
+        $this->withoutHeader('foo');
+        $this->handleRequest($request, function () {
+        }, function () {
+        });
+    }
+
+    public function it_does_not_remove_the_value(RequestInterface $request)
+    {
+        $request->hasHeader('foo')->shouldBeCalled()->willReturn(false);
+
+        $this->withoutHeader('foo');
+        $this->handleRequest($request, function () {
+        }, function () {
+        });
+    }
+}

src/HeaderPlugin.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Http\Client\Plugin;
+
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Manages http headers.
+ */
+class HeaderPlugin implements Plugin
+{
+    /**
+     * @var array headers that have fixed value
+     */
+    private $headers = [];
+    private $removedHeader = [];
+
+    /**
+     * Sets a header with the given value to every requests.
+     *
+     * @param string $name     name of the header
+     * @param string $value    value of the header
+     * @param bool $override   By default if the header is already set on the request the value wont be replaced
+     *                         pass $override to true to make the header value the same for every request
+     */
+    public function withHeader($name, $value, $override = false)
+    {
+        $this->headers[$name] = ['value' => $value, 'override' => $override];
+    }
+
+    /**
+     * Automatically removes the given header from the request.
+     *
+     * @param string $name name of the header to remove
+     */
+    public function withoutHeader($name)
+    {
+        $this->removedHeader[] = $name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first)
+    {
+        foreach ($this->headers as $header => $headerData) {
+            if ($headerData['override'] || !$request->hasHeader($header)) {
+                $request = $request->withHeader($header, $headerData['value']);
+            }
+        }
+        foreach ($this->removedHeader as $header) {
+            if ($request->hasHeader($header)) {
+                $request = $request->withoutHeader($header);
+            }
+        }
+
+        return $next($request);
+    }
+}