Added the true/false conversion to string for query parameters

Author: ezimuel

src/Traits/EndpointTrait.php

@@ -36,7 +36,7 @@ protected function addQueryString(string $url, array $params, array $keys): stri
         $queryParams = [];
         foreach ($keys as $k) {
             if (isset($params[$k])) {
-                $queryParams[$k] = $params[$k];
+                $queryParams[$k] = is_bool($params[$k]) ? ($params[$k] ? 'true' : 'false') : $params[$k];
             }
         }
         if (empty($queryParams)) {

tests/Integration/BasicTest.php

@@ -58,16 +58,15 @@ public function testIndexDocuments(string $date, string $open, string $high, str
     {
         $response = $this->client->index([
             'index' => 'stocks',
-            'refresh' => 'true',
+            'refresh' => true,
             'body' => [
                 'date'   => $date,
                 'open'   => $open,
                 'high'   => $high,
                 'low'    => $low,
                 'close'  => $close,
                 'volume' => $volume,
-                'name'   => $name,
-                'refresh' => 'true'
+                'name'   => $name
             ] 
         ]);
 

tests/Traits/EndpointTraitTest.php

@@ -0,0 +1,118 @@
+<?php
+/**
+ * Elasticsearch PHP Client
+ *
+ * @link      https://github.com/elastic/elasticsearch-php
+ * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
+ * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * Licensed to Elasticsearch B.V under one or more agreements.
+ * Elasticsearch B.V licenses this file to you under the MIT License.
+ * See the LICENSE file in the project root for more information.
+ */
+declare(strict_types = 1);
+
+namespace Elastic\Elasticsearch\Tests\Traits;
+
+use Elastic\Elasticsearch\Exception\ContentTypeException;
+use Elastic\Elasticsearch\Exception\MissingParameterException;
+use Elastic\Elasticsearch\Traits\EndpointTrait;
+use PHPUnit\Framework\TestCase;
+
+class EndpointTraitTest extends TestCase
+{
+    use EndpointTrait;
+
+    public function getQueryStrings(): array
+    {
+        return [
+            ['http://localhost:9200', ['refresh' => true], ['refresh'], 'http://localhost:9200?refresh=true'],
+            ['http://localhost:9200', ['refresh' => 'true'], ['refresh'], 'http://localhost:9200?refresh=true'],
+            ['http://localhost', ['refresh' => 'true'], ['refresh', 'pretty'], 'http://localhost?refresh=true'],
+            ['http://localhost', ['body' => [], 'foo' => 'bar'], ['refresh'], 'http://localhost']
+        ];
+    }
+
+    /**
+     * @dataProvider getQueryStrings
+     */
+    public function testAddQueryString(string $url, array $params, array $keys, string $expected)
+    {
+        $result = $this->addQueryString($url, $params, $keys);
+        $this->assertEquals($expected, $result);
+    }
+
+    public function getBodySerialized(): array
+    {
+        return [
+            [[ 'foo' => 'bar'], 'application/json', '{"foo":"bar"}'],
+            [[[ 'foo' => 'bar'], ['bar' => 'baz']], 'application/x-ndjson', "{\"foo\":\"bar\"}\n{\"bar\":\"baz\"}\n"]
+        ];
+    }
+
+    /**
+     * @dataProvider getBodySerialized
+     */
+    public function testBodySerialize(array $body, string $contentType, string $expected)
+    {
+        $result = $this->bodySerialize($body, $contentType);
+        $this->assertEquals($expected, $result);
+    }
+
+    public function testBodySerializeUnknownContentTypeThrowsException()
+    {
+        $this->expectException(ContentTypeException::class);
+        $this->bodySerialize(['foo' => 'bar'], 'Unknown-content-type');
+    }
+
+    public function getRequestParts(): array
+    {
+        return [
+            [ 'GET', 'http://localhost:9200', ['Foo' => 'bar', 'Content-Type' => 'application/json'], []],
+            [ 'GET', 'http://localhost', ['Foo' => 'bar', 'Content-Type' => 'application/json'], []],
+            [ 'POST', 'http://localhost:9200', ['Content-Type' => 'application/json'], ['foo' => 'bar']],
+            [ 'POST', 'http://localhost:9200', ['Content-Type' => 'application/x-ndjson'], [[ 'foo' => 'bar'], ['bar' => 'baz']]]
+        ];
+    }
+
+    /**
+     * @dataProvider getRequestParts
+     */
+    public function testCreateRequest(string $method, string $url, array $headers, array $body)
+    {
+        $request = $this->createRequest($method, $url, $headers, $body);
+        $this->assertEquals($method, $request->getMethod());
+        $this->assertEquals($url, (string) $request->getUri());
+        $host = parse_url($url, PHP_URL_HOST);
+        $port = parse_url($url, PHP_URL_PORT);
+        $this->assertEquals(empty($port) ? $host : $host . ':' . $port, $request->getHeader('Host')[0]);
+        foreach ($headers as $name => $value) {
+            $header = $request->getHeader($name);
+            $this->assertEquals($value, implode(',', $header));
+        }
+        if (!empty($body)) {
+            $this->assertEquals($this->bodySerialize($body, $headers['Content-Type']), (string) $request->getBody());
+        }
+    }
+
+    public function getRequiredParams(): array
+    {
+        return [
+            [['index'], ['index' => '1'], false],
+            [['index'], ['foo' => 'bar'], true]
+        ];
+    }
+
+    /**
+     * @dataProvider getRequiredParams
+     */
+    public function testCheckRequiredParameters(array $required, array $params, bool $exception)
+    {
+        if (!$exception) {
+            $this->assertNull($this->checkRequiredParameters($required, $params));
+        } else {
+            $this->expectException(MissingParameterException::class);
+            $this->checkRequiredParameters($required, $params);
+        }
+    }
+}