Changes based on peer review

Author: chadicus

.github/CONTRIBUTING.md

@@ -18,6 +18,6 @@ And there are not coding standard violations by running
 ```
 
 ## Builds
-Our [Travis build](https://travis-ci.org/traderinteractive/util-file-php) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
+Our [Travis build](https://travis-ci.org/traderinteractive/tol-api-php) executes [PHPUnit](http://www.phpunit.de) and uses [Coveralls](https://coveralls.io/) to enforce code coverage.
 While the build does not strictly enforce 100% code coverage, it will not allow coverage to drop below its current percentage.
 [Scrutinizer](https://scrutinizer-ci.com/) is used to ensure code quality and enforce the [coding standard](http://www.php-fig.org/psr/psr-2/).

src/Authentication.php

@@ -33,10 +33,11 @@ private function __construct(callable $getTokenRequestFunc)
     /**
      * Creates a new instance of Authentication for Client Credentials grant type
      *
-     * @param string $clientId The oauth client id
-     * @param string $clientSecret The oauth client secret
-     * @param string $refreshResource The refresh token resource of the API
-     *     Only needed since apigee doesnt use the token resource that is in the oauth2 spec
+     * @param string $clientId        The oauth client id
+     * @param string $clientSecret    The oauth client secret
+     * @param string $refreshResource The refresh token resource of the API Only needed since apigee doesnt use the
+     *                                token resource that is in the oauth2 spec
+     * @param string $tokenResource   The access token resource of the API
      *
      * @return Authentication
      */
@@ -80,12 +81,13 @@ public static function createClientCredentials(
     /**
      * Creates a new instance of Authentication for Owner Credentials grant type
      *
-     * @param string $clientId The oauth client id
-     * @param string $clientSecret The oauth client secret
-     * @param string $username The oauth username
-     * @param string $password The oauth password
-     * @param string $refreshResource The refresh token resource of the API
-     *     Only needed since apigee doesnt use the token resource that is in the oauth2 spec
+     * @param string $clientId        The oauth client id
+     * @param string $clientSecret    The oauth client secret
+     * @param string $username        The oauth username
+     * @param string $password        The oauth password
+     * @param string $refreshResource The refresh token resource of the API. Only needed since apigee doesnt use the
+     *                                token resource that is in the oauth2 spec
+     * @param string $tokenResource   The access token resource of the API
      *
      * @return Authentication
      */

src/Client.php

@@ -8,6 +8,7 @@
 use TraderInteractive\Util\Http;
 use GuzzleHttp\Psr7\Request;
 use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\RequestInterface;
 use Psr\SimpleCache\CacheInterface;
 
 /**
@@ -62,50 +63,36 @@ final class Client implements ClientInterface
     ];
 
     /**
-     * Base url of the API server
-     *
      * @var string
      */
     private $baseUrl;
 
     /**
-     * HTTP Adapter for sending request to the api
-     *
      * @var AdapterInterface
      */
     private $adapter;
 
     /**
-     * Oauth authentication implementation
-     *
      * @var Authentication
      */
     private $authentication;
 
     /**
-     * API access token
-     *
      * @var string
      */
     private $accessToken;
 
     /**
-     * API refresh token
-     *
      * @var string
      */
     private $refreshToken;
 
     /**
-     * Storage for cached API responses
-     *
      * @var CacheInterface
      */
     private $cache;
 
     /**
-     * Strategy for caching
-     *
      * @var int
      */
     private $cacheMode;
@@ -127,13 +114,13 @@ final class Client implements ClientInterface
     /**
      * Create a new instance of Client
      *
-     * @param AdapterInterface $adapter
-     * @param Authentication $authentication
-     * @param string $baseUrl
-     * @param int $cacheMode
-     * @param Cache $cache
-     * @param string $accessToken
-     * @param string $refreshToken
+     * @param AdapterInterface $adapter        HTTP Adapter for sending request to the api
+     * @param Authentication   $authentication Oauth authentication implementation
+     * @param string           $baseUrl        Base url of the API server
+     * @param int              $cacheMode      Strategy for caching
+     * @param CacheInterface   $cache          Storage for cached API responses
+     * @param string           $accessToken    API access token
+     * @param string           $refreshToken   API refresh token
      *
      * @throws \InvalidArgumentException Thrown if $baseUrl is not a non-empty string
      * @throws \InvalidArgumentException Thrown if $cacheMode is not one of the cache mode constants
@@ -463,7 +450,7 @@ private function start(string $url, string $method, string $body = null, array $
         return $key;
     }
 
-    private function getCacheKey(Request $request) : string
+    private function getCacheKey(RequestInterface $request) : string
     {
         return CacheHelper::getCacheKey($request);
     }

src/ClientInterface.php

@@ -1,8 +1,6 @@
 <?php
 namespace TraderInteractive\Api;
 
-use Psr\Http\Message\RequestInterface;
-
 /**
  * Client for apis
  */

src/Collection.php

@@ -68,9 +68,9 @@ final class Collection implements \Iterator, \Countable
     /**
      * Create a new collection
      *
-     * @param Client $client client connection to the API
-     * @param string $resource name of API resource to request
-     * @param array $filters key value pair array of search filters
+     * @param ClientInterface $client   Configured client connection to the API.
+     * @param string          $resource The name of API resource to request.
+     * @param array           $filters  A key value pair array of search filters.
      */
     public function __construct(ClientInterface $client, string $resource, array $filters = [])
     {

src/GuzzleAdapter.php

@@ -73,10 +73,9 @@ public function end(string $endHandle) : ResponseInterface
         $results = $this->fulfillPromises($this->promises, $this->exceptions);
         foreach ($results as $handle => $response) {
             try {
-                $body = []; //default to empty body
                 $contents = (string)$response->getBody();
                 if (trim($contents) !== '') {
-                    $body = json_decode($contents, true);
+                    json_decode($contents, true);
                     Util::ensure(
                         JSON_ERROR_NONE,
                         json_last_error(),

src/Response.php

@@ -76,7 +76,7 @@ public function getResponseHeaders() : array
         return $this->headers;
     }
 
-    public static function fromPsr7Response(ResponseInterface $response)
+    public static function fromPsr7Response(ResponseInterface $response) : Response
     {
         return new self(
             $response->getStatusCode(),