feat: add request method as client construct argument (mghoneimy#40)

Add support for sending requests with other HTTP methods than POST

Author: t-heuser

src/Client.php

@@ -6,10 +6,10 @@
 use GraphQL\QueryBuilder\QueryBuilderInterface;
 use GraphQL\Util\GuzzleAdapter;
 use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Psr7;
 use GuzzleHttp\Psr7\Request;
 use Psr\Http\Client\ClientInterface;
 use TypeError;
-use GuzzleHttp\Psr7;
 
 /**
  * Class Client
@@ -33,16 +33,27 @@ class Client
      */
     protected $httpHeaders;
 
+    /**
+     * @var string
+     */
+    protected $requestMethod;
+
     /**
      * Client constructor.
      *
      * @param string $endpointUrl
      * @param array $authorizationHeaders
      * @param array $httpOptions
      * @param ClientInterface $httpClient
+     * @param string $requestMethod
      */
-    public function __construct(string $endpointUrl, array $authorizationHeaders = [], array $httpOptions = [], ClientInterface $httpClient = null)
-    {
+    public function __construct(
+        string $endpointUrl,
+        array $authorizationHeaders = [],
+        array $httpOptions = [],
+        ClientInterface $httpClient = null,
+        string $requestMethod = 'POST'
+    ) {
         $headers = array_merge(
             $authorizationHeaders,
             $httpOptions['headers'] ?? [],
@@ -59,6 +70,7 @@ public function __construct(string $endpointUrl, array $authorizationHeaders = [
         $this->endpointUrl          = $endpointUrl;
         $this->httpClient           = $httpClient ?? new GuzzleAdapter(new \GuzzleHttp\Client($httpOptions));
         $this->httpHeaders          = $headers;
+        $this->requestMethod        = $requestMethod;
     }
 
     /**
@@ -93,7 +105,7 @@ public function runQuery($query, bool $resultsAsArray = false, array $variables
      */
     public function runRawQuery(string $queryString, $resultsAsArray = false, array $variables = []): Results
     {
-        $request = new Request('POST', $this->endpointUrl);
+        $request = new Request($this->requestMethod, $this->endpointUrl);
 
         foreach($this->httpHeaders as $header => $value) {
             $request = $request->withHeader($header, $value);
@@ -122,4 +134,4 @@ public function runRawQuery(string $queryString, $resultsAsArray = false, array
         // Parse response to extract results
         return new Results($response, $resultsAsArray);
     }
-}
+}

tests/ClientTest.php

@@ -6,7 +6,6 @@
 use GraphQL\Exception\QueryError;
 use GraphQL\QueryBuilder\QueryBuilder;
 use GraphQL\RawObject;
-use GraphQL\Util\GuzzleAdapter;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Exception\ConnectException;
 use GuzzleHttp\Exception\ServerException;
@@ -61,6 +60,7 @@ public function testConstructClient()
         $mockHandler->append(new Response(200));
         $mockHandler->append(new Response(200));
         $mockHandler->append(new Response(200));
+        $mockHandler->append(new Response(200));
 
         $client = new Client('', [], ['handler' => $handler]);
         $client->runRawQuery('query_string');
@@ -74,9 +74,13 @@ public function testConstructClient()
         $client = new Client('', ['Authorization' => 'Basic xyz'], ['handler' => $handler, 'headers' => [ 'Authorization' => 'Basic zyx', 'User-Agent' => 'test' ]]);
         $client->runRawQuery('query_string');
 
+        $client = new Client('', ['Authorization' => 'Basic xyz'], ['handler' => $handler, 'headers' => [ 'Authorization' => 'Basic zyx', 'User-Agent' => 'test' ]], null, 'GET');
+        $client->runRawQuery('query_string');
+
         /** @var Request $firstRequest */
         $firstRequest = $container[0]['request'];
         $this->assertEquals('{"query":"query_string","variables":{}}', $firstRequest->getBody()->getContents());
+        $this->assertSame('POST', $firstRequest->getMethod());
 
         /** @var Request $thirdRequest */
         $thirdRequest = $container[1]['request'];
@@ -96,6 +100,10 @@ public function testConstructClient()
         $this->assertNotEmpty($fourthRequest->getHeader('User-Agent'));
         $this->assertEquals(['Basic zyx'], $fourthRequest->getHeader('Authorization'));
         $this->assertEquals(['test'], $fourthRequest->getHeader('User-Agent'));
+
+        /** @var Request $fifthRequest */
+        $fifthRequest = $container[4]['request'];
+        $this->assertSame('GET', $fifthRequest->getMethod());
     }
 
     /**
@@ -255,4 +263,4 @@ public function testConnectTimeoutResponse()
         $this->expectException(ConnectException::class);
         $this->client->runRawQuery('');
     }
-}
+}