Merge pull request #8 from microsoftgraph/functional-tests

Functional tests

Author: Caitlin Bales (MSFT)

.gitignore

@@ -3,3 +3,4 @@ composer.lock
 /vendor/
 /coverage
 .idea/
+tests/Functional/TestConstants.php

.travis.yml

@@ -12,4 +12,4 @@ install:
     - composer install --prefer-source --no-interaction --dev
 
 script:
-    - vendor/bin/phpunit
+    - vendor/bin/phpunit --exclude-group functional

README.md

@@ -68,7 +68,14 @@ class UsageExample
 
 ### Run Tests
 
-Run ```vendor/bin/phpunit``` from the base directory.
+Run 
+```php
+vendor/bin/phpunit --exclude-group functional
+``` 
+from the base directory.
+
+*The set of functional tests are meant to be run against a test account. Currently, the 
+tests to do not restore state of the account.*
 
 
 ## Documentation and resources

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "microsoft/microsoft-graph",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"type": "library",
 	"description": "The Microsoft Graph SDK for PHP",
 	"homepage": "https://graph.microsoft.io/en-us/",
@@ -21,6 +21,8 @@
 					 "mikey179/vfsStream": "~1"
 				    },
 	"autoload": {
-		"psr-4": { "Microsoft\\Graph\\": "src/" }
+		"psr-4": { "Microsoft\\Graph\\": "src/",
+				   "Microsoft\\Graph\\Test\\": "tests/Functional/"
+			 	}
 	}
 }

phpunit.xml

@@ -8,10 +8,7 @@
 	<filter>
 		<whitelist addUncoveredFilesFromWhitelist="true">
 			<directory suffix=".php">src</directory>
-			<exclude>
-				<directory suffix=".php">src/Model</directory>
-				<directory suffix=".php">src/Core</directory>
-			</exclude>
+			<exclude><directory suffix=".php">src/Model</directory></exclude>
 		</whitelist>
 	</filter>
 	<logging>

src/Core/GraphConstants.php

@@ -24,7 +24,7 @@ class GraphConstants
     const REST_ENDPOINT = "https://graph.microsoft.com/";
 
     // Define HTTP request constants
-    const SDK_VERSION = "0.1.0";
+    const SDK_VERSION = "0.1.1";
 
     // Define error constants
     const MAX_PAGE_SIZE = 999;
@@ -34,7 +34,7 @@ class GraphConstants
     // Define error message constants
     const BASE_URL_MISSING = "Base URL cannot be null or empty.";
     const REQUEST_TIMED_OUT = "The request timed out.";
-    const UNABLE_TO_CREATE_INSTANCE_OF_TYPE = "Unable to create instance of type.";
+    const UNABLE_TO_CREATE_INSTANCE_OF_TYPE = "Unable to create instance of type";
 
     // Define user error constants
     const INVALID_FILE = "Unable to open file stream for the given path.";

src/Http/GraphCollectionRequest.php

@@ -37,11 +37,11 @@ class GraphCollectionRequest extends GraphRequest
     */
     protected $pageSize;
     /**
-    * The skip token to use in calling a new page of results
+    * The next link to use in calling a new page of results
     *
     * @var string
     */
-    protected $skipToken;
+    protected $nextLink;
     /**
     * True if the user has reached the end of the collection
     *
@@ -54,12 +54,6 @@ class GraphCollectionRequest extends GraphRequest
     * @var string
     */
     protected $originalEndpoint;
-    /**
-    * The return type that the user specified
-    *
-    * @var string
-    */
-    protected $originalReturnType;
 
     /**
     * Constructs a new GraphCollectionRequest object
@@ -107,7 +101,6 @@ public function count()
         /* The $count query parameter for the Graph API
            is available on several models but not all */
         trigger_error('Count unavailable for this collection');
-        return null;
     }
 
     /**
@@ -136,9 +129,9 @@ public function setPageSize($pageSize)
     *
     * @return array of objects of class $returnType
     */
-    public function getPage($prev = false)
+    public function getPage()
     {
-        $this->setPageCallInfo($prev);
+        $this->setPageCallInfo();
         $response = $this->execute();
 
         return $this->processPageCallReturn($response);
@@ -151,31 +144,28 @@ public function getPage($prev = false)
     *
     * @return GraphCollectionRequest
     */
-    public function setPageCallInfo($prev) 
+    public function setPageCallInfo() 
     {
         // Store these to add temporary query data to request
         $this->originalReturnType = $this->returnType;
-        $this->originalEndpoint = $this->endpoint;
 
         /* This allows processPageCallReturn to receive
            all of the response data, not just the objects */
         $this->returnType = null;
 
         if ($this->end) {
             trigger_error('Reached end of collection');
-            return null;
         }
 
-        // Build the page navigation query string
-        $query = '$top=' . $this->pageSize;
-        if ($this->skipToken) {
-            $query .='&$skiptoken=' . $this->skipToken;
+        if ($this->nextLink) {
+            $baseLength = strlen($this->baseUrl) + strlen($this->apiVersion);
+            $this->endpoint = substr($this->nextLink, $baseLength);
+        } else {
+            // This is the first request to the endpoint
+            if ($this->pageSize) {
+                $this->endpoint .= $this->getConcatenator() . '$top=' . $this->pageSize;
+            }
         }
-        if ($prev) {
-            $query .='&previous-page=true';
-        }
-
-        $this->endpoint = $this->endpoint . $this->getConcatenator() . $query;
         return $this;
     }
 
@@ -190,11 +180,11 @@ public function setPageCallInfo($prev)
     */
     public function processPageCallReturn($response)
     {
-        $this->skipToken = $response->getSkipToken();
+        $this->nextLink = $response->getNextLink();
 
         /* If no skip token is returned, we have reached the end
            of the collection */
-        if (!$this->skipToken) {
+        if (!$this->nextLink) {
             $this->end = true;
         }
 
@@ -206,23 +196,11 @@ public function processPageCallReturn($response)
         }
 
         // Restore user-defined parameters
-        $this->endpoint = $this->originalEndpoint;
         $this->returnType = $this->originalReturnType;
 
         return $result;
     }
 
-    /**
-    * Gets the previous page of results from the collection
-    *
-    * @return array of objects of class $returnType
-    */
-    public function getPrevPage()
-    {
-        $this->end = false;
-        return $this->getPage(true);
-    }
-
     /**
     * Gets whether the user has reached the end of the collection
     *

src/Http/GraphRequest.php

@@ -136,7 +136,7 @@ public function __construct($requestType, $endpoint, $accessToken, $baseUrl, $ap
     public function setReturnType($returnClass)
     {
         $this->returnType = $returnClass;
-        if (strcasecmp($this->returnType, 'stream') == 0) {
+        if ($this->returnType == "GuzzleHttp\Psr7\Stream") {
             $this->returnsStream  = true;
         } else {
             $this->returnsStream = false;
@@ -181,16 +181,7 @@ public function attachBody($obj)
         if (is_string($obj) || is_a($obj, 'GuzzleHttp\\Psr7\\Stream')) {
             $this->requestBody = $obj;
         } 
-        // JSON-encode the model object's property dictionary
-        else if (method_exists($obj, 'getProperties')) {
-            $class = get_class($obj);
-            $class = explode("\\", $class);
-            $model = strtolower(end($class));
-            
-            $body = $this->flattenDictionary($obj->getProperties());
-            $this->requestBody = "{" . $model . ":" . json_encode($body) . "}";
-        } 
-        // By default, JSON-encode (i.e. arrays)
+        // By default, JSON-encode
         else {
             $this->requestBody = json_encode($obj);
         }
@@ -246,15 +237,10 @@ public function execute($client = null)
             ]
         );
 
-        //Send back the bare response
-        if ($this->returnsStream) {
-            return $result;
-        }
-
         // Wrap response in GraphResponse layer
         $response = new GraphResponse(
             $this, 
-            $result->getBody()->getContents(), 
+            $result->getBody(), 
             $result->getStatusCode(), 
             $result->getHeaders()
         );
@@ -295,7 +281,7 @@ public function executeAsync($client = null)
             function ($result) {
                 $response = new GraphResponse(
                     $this, 
-                    $result->getBody()->getContents(), 
+                    $result->getBody(), 
                     $result->getStatusCode(), 
                     $result->getHeaders()
                 );
@@ -443,28 +429,4 @@ protected function createGuzzleClient()
         );
         return $client;
     }
-
-    /**
-    * Flattens the property dictionaries into 
-    * JSON-friendly arrays
-    *
-    * @param mixed $obj the object to flatten
-    *
-    * @return array flattened object
-    */
-    protected function flattenDictionary($obj) {
-        foreach ($obj as $arrayKey => $arrayValue) {
-            if (method_exists($arrayValue, 'getProperties')) {
-                $data = $arrayValue->getProperties();
-                $obj[$arrayKey] = $data;
-            } else {
-                $data = $arrayValue;
-            }
-            if (is_array($data)) {
-                $newItem = $this->flattenDictionary($data);
-                $obj[$arrayKey] = $newItem;
-            }
-        }
-        return $obj;
-    }
 }

src/Http/GraphResponse.php

@@ -17,6 +17,9 @@
 
 namespace Microsoft\Graph\Http;
 
+use Microsoft\Graph\Exception\GraphException;
+use Microsoft\Graph\Core\GraphConstants;
+
 /**
  * Class GraphResponse
  *
@@ -61,7 +64,7 @@ class GraphResponse
     * @param string $httpStatusCode The returned status code
     * @param array  $headers        The returned headers
     */
-    public function __construct($request, $body = null, $httpStatusCode = null, $headers = array())
+    public function __construct($request, $body = null, $httpStatusCode = null, $headers = null)
     {
         $this->_request = $request;
         $this->_body = $body;
@@ -136,11 +139,22 @@ public function getResponseAsObject($returnType)
         $class = $returnType;
         $result = $this->getBody();
 
+        if ($returnType == "GuzzleHttp\Psr7\Stream") {
+              return $this->_body;  
+        }
+
         //If more than one object is returned
         if (array_key_exists('value', $result)) {
             $objArray = array();
-            foreach ($result['value'] as $obj) {
-                $objArray[] = new $class($obj);
+            $values = $result['value'];
+
+            //Check that this is an object array instead of a value called "value"
+            if ($values && is_array($values)) {
+                foreach ($values as $obj) {
+                    $objArray[] = new $class($obj);
+                }
+            } else {
+                return new $class($result);
             }
             return $objArray;
         } else {
@@ -149,21 +163,16 @@ public function getResponseAsObject($returnType)
     }
 
     /**
-    * Gets the skip token of a response object from OData
+    * Gets the next link of a response object from OData
+    * If the nextLink is null, there are no more pages
     *
-    * @return string skip token, if provided
+    * @return string nextLink, if provided
     */
-    public function getSkipToken()
+    public function getNextLink()
     {
         if (array_key_exists("@odata.nextLink", $this->getBody())) {
             $nextLink = $this->getBody()['@odata.nextLink'];
-            if (stripos($nextLink, "?") !== FALSE) {
-                $url = explode("?", $nextLink)[1];
-                if (stripos($url, "skiptoken=") !== FALSE) {
-                    $url = explode("skiptoken=", $url);
-                    return $url[1];
-                }
-            }
+            return $nextLink;
         }
         return null;
     }

src/Model/ActivityDomain.php

@@ -0,0 +1,37 @@
+<?php
+/**
+* Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
+* 
+* ActivityDomain File
+* PHP version 7
+*
+* @category  Library
+* @package   Microsoft.Graph
+* @copyright 2016 Microsoft Corporation
+* @license   https://opensource.org/licenses/MIT MIT License
+* @version   GIT: 0.1.0
+* @link      https://graph.microsoft.io/
+*/
+namespace Microsoft\Graph\Model;
+
+use Microsoft\Graph\Core\Enum;
+
+/**
+* ActivityDomain class
+*
+* @category  Model
+* @package   Microsoft.Graph
+* @copyright 2016 Microsoft Corporation
+* @license   https://opensource.org/licenses/MIT MIT License
+* @version   Release: 0.1.0
+* @link      https://graph.microsoft.io/
+*/
+class ActivityDomain extends Enum
+{
+    /**
+    * The Enum ActivityDomain
+    */
+    const UNKNOWN = "0";
+    const WORK = "1";
+    const PERSONAL = "2";
+}