[8.x] Adds a collect method to the HTTP Client response. (#36331)

* Adds a `collect` method to the HTTP client response.

* Formatting change

* Allows passing a key to the `collect` method that will return a subset of the json response before wrapping it in the collection.

* Update Response.php

* Update Response.php

Co-authored-by: Taylor Otwell <taylor@laravel.com>

src/Illuminate/Http/Client/Response.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Http\Client;
 
 use ArrayAccess;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\Macroable;
 use LogicException;
 
@@ -77,6 +78,17 @@ public function object()
         return json_decode($this->body(), false);
     }
 
+    /**
+     * Get the JSON decoded body of the response as a collection.
+     *
+     * @param  string|null  $key
+     * @return \Illuminate\Support\Collection
+     */
+    public function collect($key = null)
+    {
+        return Collection::make($this->json($key));
+    }
+
     /**
      * Get a header from the response.
      *

tests/Http/HttpClientTest.php

@@ -7,6 +7,7 @@
 use Illuminate\Http\Client\Request;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Http\Client\Response;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use OutOfBoundsException;
 use PHPUnit\Framework\TestCase;
@@ -54,6 +55,21 @@ public function testResponseBodyCasting()
         $this->assertSame('bar', $response->object()->result->foo);
     }
 
+    public function testResponseCanBeReturnedAsCollection()
+    {
+        $this->factory->fake([
+            '*' => ['result' => ['foo' => 'bar']],
+        ]);
+
+        $response = $this->factory->get('http://foo.com/api');
+
+        $this->assertInstanceOf(Collection::class, $response->collect());
+        $this->assertEquals(collect(['result' => ['foo' => 'bar']]), $response->collect());
+        $this->assertEquals(collect(['foo' => 'bar']), $response->collect('result'));
+        $this->assertEquals(collect(['bar']), $response->collect('result.foo'));
+        $this->assertEquals(collect(), $response->collect('missing_key'));
+    }
+
     public function testUrlsCanBeStubbedByPath()
     {
         $this->factory->fake([