Merge pull request #32 from kamermans/stream_for-deprecation

Avoid deprecations, update test platform

Author: kamermans

.travis.yml

@@ -1,6 +1,6 @@
 language: php
 
-dist: trusty
+dist: bionic
 
 php:
     - 5.4

README.md

@@ -1,6 +1,5 @@
 # Guzzle OAuth 2.0 Subscriber
 
-> [![Build Status](https://travis-ci.org/kamermans/guzzle-oauth2-subscriber.svg?branch=master)](https://travis-ci.org/kamermans/guzzle-oauth2-subscriber)
 > Tested with Guzzle 4, 5, 6, 7 and PHP 5.4, 5.5, 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4.
 
 This is an OAuth 2.0 client for Guzzle which aims to be 100% compatible with Guzzle 4, 5, 6, 7 and all future versions within a single package.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "kamermans/guzzle-oauth2-subscriber",
-    "description": "OAuth 2.0 client for Guzzle 4, 5 and 6+",
+    "description": "OAuth 2.0 client for Guzzle 4, 5, 6 and 7+",
     "keywords": ["oauth", "guzzle"],
     "license": "MIT",
     "authors": [

guzzle_environments/run_tests_docker.sh

@@ -14,7 +14,7 @@ function run_tests()
     echo "# Running tests against Guzzle $GUZZLE_VER"
     echo "###############################################"
 
-    docker run -ti --rm \
+    docker run --rm \
         -v $DIR/../:/test \
         --workdir=/test/guzzle_environments/$GUZZLE_VER \
         --entrypoint=/bin/sh \

src/GrantType/AuthorizationCode.php

@@ -71,7 +71,7 @@ public function getRawData(SignerInterface $clientCredentialsSigner, $refreshTok
     }
 
     /**
-     * @return PostBody
+     * @return PostBody|\Psr\Http\Message\StreamInterface
      */
     protected function getPostBody()
     {
@@ -89,7 +89,7 @@ protected function getPostBody()
                 $data['redirect_uri'] = $this->config['redirect_uri'];
             }
 
-            return \GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&'));
+            return Helper::streamFor(http_build_query($data, '', '&'));
         }
 
         $postBody = new PostBody();

src/GrantType/ClientCredentials.php

@@ -73,7 +73,7 @@ public function getRawData(SignerInterface $clientCredentialsSigner, $refreshTok
     }
 
     /**
-     * @return PostBody
+     * @return PostBody|\Psr\Http\Message\StreamInterface
      */
     protected function getPostBody()
     {
@@ -90,7 +90,7 @@ protected function getPostBody()
                 $data['audience'] = $this->config['audience'];
             }
 
-            return \GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&'));
+            return Helper::streamFor(http_build_query($data, '', '&'));
         }
 
         $postBody = new PostBody();

src/GrantType/PasswordCredentials.php

@@ -71,8 +71,8 @@ public function getRawData(SignerInterface $clientCredentialsSigner, $refreshTok
     }
 
     /**
-    * @return PostBody
-    */
+     * @return PostBody|\Psr\Http\Message\StreamInterface
+     */
     protected function getPostBody()
     {
         if (Helper::guzzleIs('>=', '6')) {
@@ -86,7 +86,7 @@ protected function getPostBody()
                 $data['scope'] = $this->config['scope'];
             }
 
-            return \GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&'));
+            return Helper::streamFor(http_build_query($data, '', '&'));
         }
 
         $postBody = new PostBody();

src/GrantType/RefreshToken.php

@@ -70,8 +70,8 @@ public function getRawData(SignerInterface $clientCredentialsSigner, $refreshTok
     }
 
     /**
-    * @return PostBody
-    */
+     * @return PostBody|\Psr\Http\Message\StreamInterface
+     */
     protected function getPostBody($refreshToken)
     {
         if (Helper::guzzleIs('>=', '6')) {
@@ -86,7 +86,7 @@ protected function getPostBody($refreshToken)
                 $data['scope'] = $this->config['scope'];
             }
 
-            return \GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&'));
+            return Helper::streamFor(http_build_query($data, '', '&'));
         }
 
         $postBody = new PostBody();

src/GrantType/Specific/GithubApplication.php

@@ -127,7 +127,7 @@ protected function getPostBody()
 
         $postBody = json_encode($postBody);
 
-        return Helper::guzzleIs('<', 6)? Stream::factory($postBody): \GuzzleHttp\Psr7\stream_for($postBody);
+        return Helper::guzzleIs('<', 6)? Stream::factory($postBody): Helper::streamFor($postBody);
     }
 
     /**

src/Signer/ClientCredentials/PostFormData.php

@@ -27,7 +27,7 @@ public function sign($request, $clientId, $clientSecret)
             $data[$this->clientIdField] = $clientId;
             $data[$this->clientSecretField] = $clientSecret;
 
-            $body_stream = \GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&'));
+            $body_stream = Helper::streamFor(http_build_query($data, '', '&'));
             return $request->withBody($body_stream);
         }
 

src/Utils/Helper.php

@@ -6,6 +6,29 @@
 
 class Helper
 {
+    /**
+     * Create a new stream based on the input type.
+     *
+     * Options is an associative array that can contain the following keys:
+     * - metadata: Array of custom metadata.
+     * - size: Size of the stream.
+     *
+     * @param resource|string|null|int|float|bool|StreamInterface|callable|\Iterator $resource Entity body data
+     * @param array                                                                  $options  Additional options
+     *
+     * @return StreamInterface
+     * @throws \InvalidArgumentException if the $resource arg is not valid.
+     */
+    public static function streamFor($resource = '', array $options = [])
+    {
+        // stream_for was used until GuzzleHttp\Psr7 v1.7.0
+        if (function_exists('GuzzleHttp\Psr7\stream_for')) {
+            return \GuzzleHttp\Psr7\stream_for($resource, $options);
+        }
+
+        return \GuzzleHttp\Psr7\Utils::streamFor($resource, $options);
+    }
+
     public static function guzzleIs($operator, $version, $guzzle_version=null)
     {
         if ($guzzle_version === null) {

tests/BaseTestCase.php

@@ -67,7 +67,7 @@ protected function parseQueryString($query_string)
     protected function setPostBody($request, array $data=[])
     {
         if (Helper::guzzleIs('>=', 6)) {
-            return $request->withBody(\GuzzleHttp\Psr7\stream_for(http_build_query($data, '', '&')));
+            return $request->withBody(Helper::streamFor(http_build_query($data, '', '&')));
         }
 
         $request->setBody(new PostBody($data));

tests/OAuth2MiddlewareTest.php

@@ -568,31 +568,4 @@ public function testOnErrorDoesNotLoop()
         $this->assertSame(401, $container[0]['response']->getStatusCode());
         $this->assertSame(401, $container[1]['response']->getStatusCode());
     }
-
-    public function __DISABLED__testOnErrorDoesNotLoop()
-    {
-        // Setup Grant Type
-        $grant = $this->getMockBuilder('\kamermans\OAuth2\GrantType\ClientCredentials')
-            ->setMethods(['getRawData'])
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $grant->expects($this->exactly(0))
-            ->method('getRawData');
-
-        // Setup OAuth2Middleware
-        $sub = new OAuth2Middleware($grant);
-
-        $client = new Client();
-        $request = new Request('GET', '/', [], null, ['auth' => 'oauth']);
-        // This header keeps the subscriber from trying to reauth a reauth request (infinte loop)
-        $request->setHeader('X-Guzzle-Retry', 1);
-        $response = new Response(401);
-        $transaction = $this->getTransaction($client, $request);
-        $except = new RequestException('foo', $request, $response);
-        $event = new ErrorEvent($transaction, $except);
-
-        // Force an onError event, which triggers the signer and grant data processor
-        $sub->onError($event);
-    }
 }