Add GraphQL support (#39)

Author: mbabker

Tests/Package/GraphqlTest.php

@@ -0,0 +1,116 @@
+<?php
+/**
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\Github\Tests;
+
+use Joomla\Github\Package\Graphql;
+use Joomla\Github\Tests\Stub\GitHubTestCase;
+
+/**
+ * Test class for Graphql.
+ *
+ * @since  1.0
+ */
+class GraphqlTest extends GitHubTestCase
+{
+	/**
+	 * @var Graphql
+	 */
+	protected $object;
+
+	/**
+	 * Sets up the fixture, for example, opens a network connection.
+	 * This method is called before a test is executed.
+	 *
+	 * @access protected
+	 *
+	 * @return void
+	 */
+	protected function setUp()
+	{
+		parent::setUp();
+
+		$this->object = new Graphql($this->options, $this->client);
+	}
+
+	/**
+	 * Tests the create method
+	 *
+	 * @return void
+	 */
+	public function testCreate()
+	{
+		$this->response->code = 201;
+		$this->response->body = $this->sampleString;
+
+		// Build the query.
+		$query = 'foo';
+
+		// Build the request data.
+		$data = array(
+			'query' => $query,
+		);
+
+		// Build the headers.
+		$headers = array(
+			'Accept' => 'application/vnd.github.v4+json',
+		);
+
+		$this->client->expects($this->once())
+			->method('post')
+			->with('/graphql', $data, $headers)
+			->will($this->returnValue($this->response));
+
+		$this->assertThat(
+			$this->object->execute($query),
+			$this->equalTo(json_decode($this->sampleString))
+		);
+	}
+
+	/**
+	 * Tests the create method
+	 *
+	 * @return void
+	 */
+	public function testCreateFailure()
+	{
+		$exception = false;
+
+		$this->response->code = 500;
+		$this->response->body = $this->errorString;
+
+		// Build the query.
+		$query = 'foo';
+
+		// Build the request data.
+		$data = array(
+			'query' => $query,
+		);
+
+		// Build the headers.
+		$headers = array(
+			'Accept' => 'application/vnd.github.v4+json',
+		);
+
+		$this->client->expects($this->once())
+			->method('post')
+			->with('/graphql', $data, $headers)
+			->will($this->returnValue($this->response));
+
+		try
+		{
+			$this->object->execute($query);
+			$this->fail('Exception not thrown');
+		}
+		catch (\DomainException $e)
+		{
+			$this->assertThat(
+				$e->getMessage(),
+				$this->equalTo(json_decode($this->errorString)->message)
+			);
+		}
+	}
+}

src/Github.php

@@ -19,6 +19,7 @@
  * @property-read  Package\Emojis         $emojis         GitHub API object for the emojis package.
  * @property-read  Package\Gists          $gists          GitHub API object for the gists package.
  * @property-read  Package\Gitignore      $gitignore      GitHub API object for the gitignore package.
+ * @property-read  Package\Graphql        $graphql        GitHub API object for the GraphQL v4 API.
  * @property-read  Package\Issues         $issues         GitHub API object for the issues package.
  * @property-read  Package\Markdown       $markdown       GitHub API object for the markdown package.
  * @property-read  Package\Meta           $meta           GitHub API object for the meta package.

src/Package/Graphql.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Part of the Joomla Framework Github Package
+ *
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\Github\Package;
+
+use Joomla\Github\AbstractPackage;
+
+/**
+ * GitHub API GraphQL class for the Joomla Framework.
+ *
+ * @since  __DEPLOY_VERSION__
+ *
+ * @documentation  https://developer.github.com/v4/
+ */
+class Graphql extends AbstractPackage
+{
+	/**
+	 * Execute a query against the GraphQL API.
+	 *
+	 * @param   string  $query  The query to perform.
+	 *
+	 * @return  string
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function execute($query)
+	{
+		// Build the request path.
+		$path = '/graphql';
+
+		$headers = array(
+			'Accept' => 'application/vnd.github.v4+json',
+		);
+
+		$data = array(
+			'query' => $query,
+		);
+
+		// Send the request.
+		return $this->processResponse(
+			$this->client->post($this->fetchUrl($path), $data, $headers),
+			201
+		);
+	}
+}