Added QueryDefaultsPlugin

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.5.0 - Unreleased
+
+### Added
+
+- `QueryDefaultsPlugin` to add default query parameters. 
 
 ## 1.4.2 - 2017-03-18
 

spec/Plugin/QueryDefaultsPluginSpec.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace spec\Http\Client\Common\Plugin;
+
+use PhpSpec\Exception\Example\SkippingException;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Psr\Http\Message\UriInterface;
+
+class QueryDefaultsPluginSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->beConstructedWith([]);
+        $this->shouldHaveType('Http\Client\Common\Plugin\QueryDefaultsPlugin');
+    }
+
+    public function it_is_a_plugin()
+    {
+        $this->beConstructedWith([]);
+        $this->shouldImplement('Http\Client\Common\Plugin');
+    }
+
+    public function it_sets_the_default_header(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith([
+            'foo' => 'bar',
+        ]);
+
+        $request->getUri()->shouldBeCalled()->willReturn($uri);
+        $uri->getQuery()->shouldBeCalled()->willReturn('test=true');
+        $uri->withQuery('test=true&foo=bar')->shouldBeCalled()->willReturn($uri);
+        $request->withUri($uri)->shouldBeCalled()->willReturn($request);
+
+        $this->handleRequest($request, function () {}, function () {});
+    }
+}

src/Plugin/HeaderAppendPlugin.php

@@ -12,7 +12,7 @@
  *
  * This only makes sense for headers that can have multiple values like 'Forwarded'
  *
- * @link https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
+ * @see https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
  *
  * @author Soufiane Ghzal <[email protected]>
  */

src/Plugin/QueryDefaultsPlugin.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Http\Client\Common\Plugin;
+
+use Http\Client\Common\Plugin;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Set query to default value if it does not exist.
+ *
+ * If a given query parameter already exists the value wont be replaced and the request wont be changed.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+final class QueryDefaultsPlugin implements Plugin
+{
+    /**
+     * @var array
+     */
+    private $queryParams = [];
+
+    /**
+     * @param array $queryParams Hashmap of query name to query value
+     */
+    public function __construct(array $queryParams)
+    {
+        $this->queryParams = $queryParams;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first)
+    {
+        foreach ($this->queryParams as $name => $value) {
+            $uri = $request->getUri();
+            $array = [];
+            parse_str($uri->getQuery(), $array);
+
+            // If query value is not found
+            if (!isset($array[$name])) {
+                $array[$name] = $value;
+
+                // Create a new request with the new URI with the added query param
+                $request = $request->withUri(
+                    $uri->withQuery(http_build_query($array))
+                );
+            }
+        }
+
+        return $next($request);
+    }
+}