Add HttpClientFactory and update Graph client to use it

.editorconfig

@@ -1,27 +1,27 @@
-# top-most EditorConfig file
-root = true
-
-# All PHP files MUST use the Unix LF (linefeed) line ending.
-# Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting.
-# All PHP files MUST end with a single blank line.
-# There MUST NOT be trailing whitespace at the end of non-blank lines.
-[*]
-charset = utf-8
-end_of_line = crlf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-# PHP-Files, Composer.json, MD-Files
-[{*.php,composer.json,*.md}]
-indent_style = space
-indent_size = 4
-
-# HTML-Files LESS-Files SASS-Files CSS-Files JS-Files JSON-Files
-[{*.html,*.less,*.sass,*.css,*.js,*.json}]
-indent_style = tab
-indent_size = 4
-
-# Gitlab-CI, Travis-CI
-[*.yml]
-indent_style = space
-indent_size = 2
+# top-most EditorConfig file
+root = true
+
+# All PHP files MUST use the Unix LF (linefeed) line ending.
+# Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting.
+# All PHP files MUST end with a single blank line.
+# There MUST NOT be trailing whitespace at the end of non-blank lines.
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# PHP-Files, Composer.json, MD-Files
+[{*.php,composer.json,*.md}]
+indent_style = space
+indent_size = 4
+
+# HTML-Files LESS-Files SASS-Files CSS-Files JS-Files JSON-Files
+[{*.html,*.less,*.sass,*.css,*.js,*.json}]
+indent_style = tab
+indent_size = 4
+
+# Gitlab-CI, Travis-CI
+[*.yml]
+indent_style = space
+indent_size = 2

composer.json

@@ -1,36 +1,38 @@
-{
-	"name": "microsoft/microsoft-graph-core",
-	"type": "library",
-	"description": "The Microsoft Graph SDK for PHP",
-	"homepage": "https://developer.microsoft.com/en-us/graph",
-	"license": "MIT",
-	"authors": [
-		{
-			"name": "Microsoft Graph Client Tooling",
-			"email": "graphtooling@service.microsoft.com",
-			"role": "Developer"
-		}
-	],
-	"require": {
-		"php": "^8.0 || ^7.3",
-		"guzzlehttp/guzzle": "^6.0 || ^7.0",
-		"ext-json": "*"
-	},
-	"require-dev": {
-		"phpunit/phpunit": "^8.0 || ^9.0",
-		"mikey179/vfsstream": "^1.2",
-		"vimeo/psalm": "^4.8",
-		"microsoft/microsoft-graph": "^1.34"
-	},
-	"autoload": {
-		"psr-4": {
-			"Microsoft\\Graph\\": "src/"
-		}
-	},
-	"autoload-dev": {
-		"psr-4": {
-			"Microsoft\\Graph\\Test\\": "tests/Functional/",
-			"Microsoft\\Graph\\Http\\Test\\": "tests/Http/"
-		}
-	}
-}
+{
+	"name": "microsoft/microsoft-graph-core",
+	"type": "library",
+	"description": "The Microsoft Graph SDK for PHP",
+	"homepage": "https://developer.microsoft.com/en-us/graph",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Microsoft Graph Client Tooling",
+			"email": "graphtooling@service.microsoft.com",
+			"role": "Developer"
+		}
+	],
+	"require": {
+		"php": "^8.0 || ^7.3",
+		"guzzlehttp/guzzle": "^7.0",
+		"php-http/httplug": "^2.2.0",
+		"php-http/guzzle7-adapter": "^1.0.0",
+		"ext-json": "*"
+	},
+	"require-dev": {
+		"phpunit/phpunit": "^8.0 || ^9.0",
+		"mikey179/vfsstream": "^1.2",
+		"vimeo/psalm": "^4.8",
+		"microsoft/microsoft-graph": "^1.34"
+	},
+	"autoload": {
+		"psr-4": {
+			"Microsoft\\Graph\\": "src/"
+		}
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"Microsoft\\Graph\\Test\\": "tests/Functional/",
+			"Microsoft\\Graph\\Http\\Test\\": "tests/Http/"
+		}
+	}
+}

src/Core/Enum.php

@@ -101,4 +101,4 @@ public function value()
     {
         return $this->_value;
     }
-}
+}

src/Core/NationalCloud.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright (c) Microsoft Corporation.  All Rights Reserved.
+ * Licensed under the MIT License.  See License in the project root
+ * for license information.
+ */
+
+namespace Microsoft\Graph\Core;
+
+/**
+ * Class NationalCloud
+ *
+ * Defines Graph hosts for the various national clouds
+ *
+ * @package Microsoft\Graph\Core
+ * @copyright 2021 Microsoft Corporation
+ * @license https://opensource.org/licenses/MIT MIT License
+ * @link https://developer.microsoft.com/graph
+ */
+final class NationalCloud
+{
+    const GLOBAL = "https://graph.microsoft.com";
+    const US_GOV = "https://graph.microsoft.us";
+    const US_DOD = "https://dod-graph.microsoft.us";
+    const GERMANY = "https://graph.microsoft.de";
+    const CHINA = "https://microsoftgraph.chinacloudapi.cn";
+
+    /**
+     * Stores all enum values as list
+     * Prevents having to do reflection for each call to getValues()
+     *
+     * @var array
+     */
+    private static $values = [];
+
+    /**
+     * Returns a list of the constant values
+     *
+     * @return array
+     */
+    public static function getValues(): array {
+        if (!self::$values) {
+            $reflectedClass = new \ReflectionClass(__CLASS__);
+            self::$values = array_values($reflectedClass->getConstants());
+        }
+        return self::$values;
+    }
+}

src/Exception/ClientInitialisationException.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright (c) Microsoft Corporation.  All Rights Reserved.
+ * Licensed under the MIT License.  See License in the project root
+ * for license information.
+ */
+
+namespace Microsoft\Graph\Exception;
+
+/**
+ * Class ClientInitialisationException
+ *
+ * @package Microsoft\Graph\Exception
+ * @copyright 2021 Microsoft Corporation
+ * @license https://opensource.org/licenses/MIT MIT License
+ * @link https://developer.microsoft.com/graph
+ */
+class ClientInitialisationException extends GraphException
+{
+
+}

src/Graph.php

@@ -18,8 +18,12 @@
 namespace Microsoft\Graph;
 
 use Microsoft\Graph\Core\GraphConstants;
+use Microsoft\Graph\Core\NationalCloud;
+use Microsoft\Graph\Exception\ClientInitialisationException;
 use Microsoft\Graph\Http\GraphCollectionRequest;
 use Microsoft\Graph\Http\GraphRequest;
+use Microsoft\Graph\Http\HttpClientFactory;
+use Microsoft\Graph\Http\HttpClientInterface;
 
 /**
  * Class Graph
@@ -38,68 +42,51 @@ class Graph
     * @var string
     */
     private $_accessToken;
+
     /**
     * The api version to use ("v1.0", "beta")
     * Default is "v1.0"
     *
     * @var string
     */
-    private $_apiVersion;
-    /**
-    * The base url to call
-    * Default is "https://graph.microsoft.com"
-    *
-    * @var string
-    */
-    private $_baseUrl;
-    /**
-    * The port to use for proxy requests
-    * Null disables port forwarding
-    *
-    * @var string
-    */
-    private $_proxyPort;
+    private $_apiVersion = GraphConstants::API_VERSION;
 
     /**
-     * Whether SSL verification should be used for proxy requests
-     *
-     * @var bool
+     * Host to use as the base URL and for authentication
+     * @var string
      */
-    private $_proxyVerifySSL;
+    private $_nationalCloud = NationalCloud::GLOBAL;
 
     /**
-    * Creates a new Graph object, which is used to call the Graph API
-    */
-    public function __construct()
-    {
-        $this->_apiVersion = GraphConstants::API_VERSION;
-        $this->_baseUrl = GraphConstants::REST_ENDPOINT;
-    }
+     * HttpClient to use for requests
+     * @var HttpClientInterface
+     */
+    private $_httpClient;
 
-    /**
-    * Sets the Base URL to call (defaults to https://graph.microsoft.com)
-    *
-    * @param string $baseUrl The URL to call
-    *
-    * @return Graph object
-    */
-    public function setBaseUrl($baseUrl)
-    {
-        $this->_baseUrl = $baseUrl;
-        return $this;
-    }
 
     /**
-    * Sets the API version to use, e.g. "beta" (defaults to v1.0)
-    *
-    * @param string $apiVersion The API version to use
-    *
-    * @return Graph object
-    */
-    public function setApiVersion($apiVersion)
+     * Graph constructor.
+     *
+     * Creates a Graph client object used to make requests to the Graph API
+     * Setting $httpClient to null will create a default Guzzle client.
+     * @param string $apiVersion
+     * @param string $nationalCloud
+     * @param HttpClientInterface|null $httpClient
+     * @throws ClientInitialisationException
+     */
+    public function __construct(string $apiVersion = GraphConstants::API_VERSION,
+                                string $nationalCloud = NationalCloud::GLOBAL,
+                                HttpClientInterface  $httpClient = null)
     {
+        if (!$apiVersion) {
+            throw new \InvalidArgumentException("Api version string cannot be empty");
+        }
+        if (!in_array($nationalCloud, NationalCloud::getValues())) {
+            throw new \InvalidArgumentException("Invalid national cloud passed. See NationalCloud constants");
+        }
         $this->_apiVersion = $apiVersion;
-        return $this;
+        $this->_nationalCloud = $nationalCloud;
+        $this->_httpClient = ($httpClient) ?: HttpClientFactory::nationalCloud($nationalCloud)::createAdapter();
     }
 
     /**
@@ -117,24 +104,6 @@ public function setAccessToken($accessToken)
         return $this;
     }
 
-    /**
-    * Sets the proxy port. This allows you
-    * to use tools such as Fiddler to view
-    * requests and responses made with Guzzle
-    *
-    * @param string port The port number to use
-    * @param bool $verifySSL Whether SSL verification should be enabled
-    *
-    * @return Graph object
-    */
-    public function setProxyPort($port, $verifySSL = false)
-    {
-        $this->_proxyPort = $port;
-        $this->_proxyVerifySSL = $verifySSL;
-
-        return $this;
-    }
-
 	/**
 	 * Creates a new request object with the given Graph information
 	 *
@@ -151,10 +120,9 @@ public function createRequest($requestType, $endpoint)
             $requestType,
             $endpoint,
             $this->_accessToken,
-            $this->_baseUrl,
+            $this->_nationalCloud,
             $this->_apiVersion,
-            $this->_proxyPort,
-            $this->_proxyVerifySSL
+            $this->_httpClient
         );
     }
 
@@ -175,10 +143,9 @@ public function createCollectionRequest($requestType, $endpoint)
             $requestType,
             $endpoint,
             $this->_accessToken,
-            $this->_baseUrl,
+            $this->_nationalCloud,
             $this->_apiVersion,
-            $this->_proxyPort,
-            $this->_proxyVerifySSL
+            $this->_httpClient
         );
     }
 }