Add Graphql support (#32)

* Add Graphql support

* use withHeaders instead of withHeader

* Formatting

---------

Co-authored-by: Vincent Boon <[email protected]>

Author: indykoning

README.md

@@ -164,7 +164,7 @@ public function __construct(
 $client = app(\JustBetter\MagentoClient\Client\Magento::class);
 ```
 
-After you got an instance you can use the `get`, `post`, `put` and `patch` methods to use the Magento API.
+After you got an instance you can use the `graphql`, `get`, `post`, `put` and `patch` methods to use the Magento API.
 
 ### SearchCriteria / Filtering
 
@@ -198,6 +198,30 @@ $client->connection('connection_one')->get('products');
 $client->connection('connection_two')->get('products');
 ```
 
+### GraphQL
+
+You can run authenticated GraphQL queries using the `graphql` method on the client.
+
+```php
+/** @var \JustBetter\MagentoClient\Client\Magento $client */
+$client = app(\JustBetter\MagentoClient\Client\Magento::class);
+
+$client->graphql(
+    'query searchProducts($search: String) {
+        products(
+            search: $search
+        ) {
+            items {
+            sku
+            }
+        }
+    }',
+    [
+        'search' => 'test'
+    ]
+);
+```
+
 ### More Examples
 
 You can view the tests for more examples.

config/magento.php

@@ -12,6 +12,9 @@
             /* Base path, only modify if your API is not at /rest */
             'base_path' => env('MAGENTO_BASE_PATH', 'rest'),
 
+            /* Graphql path, only modify if your API is not at /graphql */
+            'graphql_path' => env('MAGENTO_GRAPHQL_PATH', 'graphql'),
+
             /* Store code, modify if you want to set a store by default. */
             'store_code' => env('MAGENTO_STORE_CODE', 'all'),
 

src/Client/Magento.php

@@ -3,6 +3,7 @@
 namespace JustBetter\MagentoClient\Client;
 
 use Generator;
+use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Http\Client\Response;
 use Illuminate\Support\Enumerable;
 use Illuminate\Support\LazyCollection;
@@ -35,6 +36,22 @@ public function store(?string $store = null): static
         return $this;
     }
 
+    public function graphql(string $query, array $variables = []): Response
+    {
+        /** @var string $endpoint */
+        $endpoint = config("magento.connections.{$this->connection}.graphql_path");
+
+        /** @var Response $response */
+        $response = $this->request->build($this->connection)
+            ->when($this->storeCode !== null, fn (PendingRequest $request): PendingRequest => $request->withHeaders(['Store' => $this->storeCode]))
+            ->post($endpoint, [
+                'query' => $query,
+                'variables' => $variables,
+            ]);
+
+        return $response;
+    }
+
     public function get(string $path, array $data = []): Response
     {
         /** @var Response $response */
@@ -195,6 +212,7 @@ public static function fake(): void
         config()->set('magento.connections.default', [
             'base_url' => 'magento',
             'base_path' => 'rest',
+            'graphql_path' => 'graphql',
             'store_code' => 'all',
             'version' => 'V1',
             'access_token' => '::token::',

tests/Client/ClientTest.php

@@ -10,6 +10,35 @@
 
 class ClientTest extends TestCase
 {
+    public function test_it_can_make_a_graphql_call(): void
+    {
+        Http::fake([
+            'graphql' => Http::response([
+                'data' => [
+                    'currency' => [
+                        'base_currency_code' => 'EUR',
+                    ],
+                ],
+            ]),
+        ]);
+
+        /** @var Magento $magento */
+        $magento = app(Magento::class);
+
+        $response = $magento->store('default')->graphql('query { currency { base_currency_code } }', ['testing']);
+
+        $this->assertTrue($response->ok());
+        $this->assertEquals('EUR', $response->json('data.currency.base_currency_code'));
+
+        Http::assertSent(function (Request $request): bool {
+
+            return $request->method() === 'POST'
+                && $request->url() === 'magento/graphql'
+                && $request->body() === '{"query":"query { currency { base_currency_code } }","variables":["testing"]}'
+                && $request->header('Store') === ['default'];
+        });
+    }
+
     public function test_it_can_make_a_get_call(): void
     {
         Http::fake([