Merge pull request #612 from vkublytskyi/master

Add support of GraphQL variables

Author: acrobat

CHANGELOG.md

@@ -4,6 +4,10 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 ## 2.6.0 (unreleased)
 
+### Added
+
+- Support for graphql api [variables](https://developer.github.com/v4/guides/forming-calls/#working-with-variables) (#612)
+
 ## 2.5.0
 
 ### Added

doc/graphql.md

@@ -8,3 +8,25 @@ Wraps [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/).
 ```php
 $rateLimits = $client->api('graphql')->execute($query);
 ```
+
+#### Use variables
+
+[Variables](https://developer.github.com/v4/guides/forming-calls/#working-with-variables) allow specifying of requested data without dynamical change of a query on a client side.
+
+```php
+$query = <<<'QUERY'
+query showOrganizationInfo (
+  $organizationLogin: String!
+) {
+  organization(login: $organizationLogin) {
+    name
+    url
+  }
+}
+QUERY;
+$variables = [
+    'organizationLogin' => 'KnpLabs'
+];
+
+$orgInfo = $client->api('graphql')->execute($query, $variables);
+```

lib/Github/Api/GraphQL.php

@@ -16,15 +16,19 @@ class GraphQL extends AbstractApi
 
     /**
      * @param string $query
+     * @param array $variables
      *
      * @return array
      */
-    public function execute($query)
+    public function execute($query, array $variables = array())
     {
         $this->acceptHeaderValue = 'application/vnd.github.v4+json';
         $params = array(
             'query' => $query
         );
+        if (!empty($variables)) {
+            $params['variables'] = json_encode($variables);
+        }
 
         return $this->post('/graphql', $params);
     }

test/Github/Tests/Api/GraphQLTest.php

@@ -21,6 +21,35 @@ public function shouldTestGraphQL()
         $this->assertEquals('foo', $result);
     }
 
+    /**
+     * @test
+     */
+    public function shouldSupportGraphQLVariables()
+    {
+        $api = $this->getApiMock();
+
+        $api->method('post')
+            ->with('/graphql', $this->arrayHasKey('variables'));
+
+        $api->execute('bar', ['variable' => 'foo']);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldJSONEncodeGraphQLVariables()
+    {
+        $api = $this->getApiMock();
+
+        $api->method('post')
+            ->with('/graphql', $this->equalTo([
+                'query'=>'bar',
+                'variables' => '{"variable":"foo"}'
+            ]));
+
+        $api->execute('bar', ['variable' => 'foo']);
+    }
+
     protected function getApiClass()
     {
         return \Github\Api\GraphQL::class;