Merge pull request #20 from Sammyjo20/fix/no-more-has-query-params-trait

Removed requirement for HasQueryParams trait
saloonphp · Jan 28, 2022 · d5bbca4 · d5bbca4
2 parents 9ac3bca + 1d8ca97
commit d5bbca4
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 47 deletions.
diff --git a/src/Managers/RequestManager.php b/src/Managers/RequestManager.php
@@ -16,6 +16,7 @@
 use Sammyjo20\Saloon\Traits\ManagesFeatures;
 use Sammyjo20\Saloon\Traits\CollectsHandlers;
 use GuzzleHttp\Exception\BadResponseException;
+use Sammyjo20\Saloon\Traits\CollectsQueryParams;
 use Sammyjo20\Saloon\Traits\CollectsInterceptors;
 use Sammyjo20\Saloon\Exceptions\SaloonMultipleMockMethodsException;
 use Sammyjo20\Saloon\Exceptions\SaloonInvalidResponseClassException;
@@ -27,6 +28,7 @@ class RequestManager
         ManagesFeatures,
         CollectsHeaders,
         CollectsConfig,
+        CollectsQueryParams,
         CollectsHandlers,
         CollectsInterceptors;
 
@@ -89,6 +91,7 @@ public function __construct(SaloonRequest $request, MockClient $mockClient = nul
      *
      * @return void
      * @throws \ReflectionException
+     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
      */
     public function hydrate(): void
     {
@@ -111,10 +114,22 @@ public function hydrate(): void
 
         $this->mergeHeaders($this->connector->getHeaders(), $this->request->getHeaders());
 
+        // Merge in query params
+
+        $this->mergeQuery($this->connector->getQuery(), $this->request->getQuery());
+
         // Merge the config
 
         $this->mergeConfig($this->connector->getConfig(), $this->request->getConfig());
 
+        // Add the query parameters to the config
+
+        $query = $this->getQuery();
+
+        if (! empty($query)) {
+            $this->mergeConfig(['query' => $query]);
+        }
+
         // Merge in any handlers
 
         $this->mergeHandlers($this->connector->getHandlers(), $this->request->getHandlers());
@@ -149,15 +164,7 @@ public function send()
 
         // Build up the config!
 
-        $requestOptions = [
-            RequestOptions::HEADERS => $this->getHeaders(),
-        ];
-
-        // Recursively add config variables...
-
-        foreach ($this->getConfig() as $configVariable => $value) {
-            $requestOptions[$configVariable] = $value;
-        }
+        $requestOptions = $this->buildRequestOptions();
 
         // Boot up our Guzzle client... This will also boot up handlers...
 
@@ -268,6 +275,24 @@ private function bootMockClient(MockClient|null $mockClient): void
         $this->mockClient = $mockClient;
     }
 
+    /**
+     * Build up all the request options
+     *
+     * @return array
+     */
+    private function buildRequestOptions(): array
+    {
+        $requestOptions = [
+            RequestOptions::HEADERS => $this->getHeaders(),
+        ];
+
+        foreach ($this->getConfig() as $configVariable => $value) {
+            $requestOptions[$configVariable] = $value;
+        }
+
+        return $requestOptions;
+    }
+
     /**
      * Is the manager in mocking mode?
      *

diff --git a/src/Traits/CollectsQueryParams.php b/src/Traits/CollectsQueryParams.php
@@ -77,7 +77,7 @@ public function addQuery(string $query, $value): self
     }
 
     /**
-     * Get all query or filter with a key.
+     *  Get all query or filter with a key.
      *
      * @param string|null $key
      * @return mixed
@@ -109,18 +109,6 @@ public function getQuery(string $key = null): mixed
         return $queryBag;
     }
 
-    /**
-     * Get an individual query param
-     *
-     * @param string $key
-     * @return string
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
-     */
-    public function getQueryByKey(string $key): string
-    {
-        return $this->getQuery($key);
-    }
-
     /**
      * Should we ignore the default query when calling `->getQuery()`?
      *

diff --git a/src/Traits/Features/HasQueryParams.php b/src/Traits/Features/HasQueryParams.php
diff --git a/tests/Resources/Connectors/QueryParameterConnector.php b/tests/Resources/Connectors/QueryParameterConnector.php
@@ -4,12 +4,10 @@
 
 use Sammyjo20\Saloon\Http\SaloonConnector;
 use Sammyjo20\Saloon\Traits\Features\AcceptsJson;
-use Sammyjo20\Saloon\Traits\Features\HasQueryParams;
 
 class QueryParameterConnector extends SaloonConnector
 {
     use AcceptsJson;
-    use HasQueryParams;
 
     public function defineBaseUrl(): string
     {

diff --git a/tests/Resources/Requests/OverwrittenQueryParameterConnectorRequest.php b/tests/Resources/Requests/OverwrittenQueryParameterConnectorRequest.php
@@ -4,13 +4,10 @@
 
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
-use Sammyjo20\Saloon\Traits\Features\HasQueryParams;
 use Sammyjo20\Saloon\Tests\Resources\Connectors\QueryParameterConnector;
 
 class OverwrittenQueryParameterConnectorRequest extends SaloonRequest
 {
-    use HasQueryParams;
-
     /**
      * Define the method that the request will use.
      *

diff --git a/tests/Resources/Requests/QueryParameterConnectorBlankRequest.php b/tests/Resources/Requests/QueryParameterConnectorBlankRequest.php
@@ -4,13 +4,10 @@
 
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
-use Sammyjo20\Saloon\Traits\Features\HasQueryParams;
 use Sammyjo20\Saloon\Tests\Resources\Connectors\QueryParameterConnector;
 
 class QueryParameterConnectorBlankRequest extends SaloonRequest
 {
-    use HasQueryParams;
-
     /**
      * Define the method that the request will use.
      *

diff --git a/tests/Resources/Requests/QueryParameterConnectorRequest.php b/tests/Resources/Requests/QueryParameterConnectorRequest.php
@@ -4,13 +4,10 @@
 
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
-use Sammyjo20\Saloon\Traits\Features\HasQueryParams;
 use Sammyjo20\Saloon\Tests\Resources\Connectors\QueryParameterConnector;
 
 class QueryParameterConnectorRequest extends SaloonRequest
 {
-    use HasQueryParams;
-
     /**
      * Define the method that the request will use.
      *

diff --git a/tests/Resources/Requests/QueryParameterRequest.php b/tests/Resources/Requests/QueryParameterRequest.php
@@ -4,13 +4,10 @@
 
 use Sammyjo20\Saloon\Constants\Saloon;
 use Sammyjo20\Saloon\Http\SaloonRequest;
-use Sammyjo20\Saloon\Traits\Features\HasQueryParams;
 use Sammyjo20\Saloon\Tests\Resources\Connectors\TestConnector;
 
 class QueryParameterRequest extends SaloonRequest
 {
-    use HasQueryParams;
-
     /**
      * Define the method that the request will use.
      *

diff --git a/tests/Unit/Features/QueryParameterTest.php b/tests/Unit/Features/QueryParameterTest.php
@@ -1,6 +1,7 @@
 <?php
 
 use Sammyjo20\Saloon\Managers\RequestManager;
+use Sammyjo20\Saloon\Tests\Resources\Requests\UserRequest;
 use Sammyjo20\Saloon\Tests\Resources\Requests\QueryParameterRequest;
 use Sammyjo20\Saloon\Tests\Resources\Requests\QueryParameterConnectorRequest;
 use Sammyjo20\Saloon\Tests\Resources\Requests\QueryParameterConnectorBlankRequest;
@@ -95,3 +96,15 @@
     expect($config)->toHaveKey('query');
     expect($config['query'])->toEqual(['per_page' => 500]);
 });
+
+test('when not sending query parameters, the query option is not set', function () {
+    $request = new UserRequest();
+
+    $requestManager = new RequestManager($request);
+
+    $requestManager->hydrate();
+
+    $config = $requestManager->getConfig();
+
+    expect(isset($config['query']))->toBeFalse();
+});