Merge pull request #299 from chapa/master

Allow users to provide Guzzle options object requests

Author: haphan

doc/services/object-store/v1/objects.rst

@@ -32,6 +32,9 @@ Download an object
 As you will notice, a Stream_ object is returned by this call. For more information about dealing with streams, please
 consult `Guzzle's docs`_.
 
+By default, the whole body of the object is fetched before the function returns, set the ``'requestOptions'`` key of
+parameter ``$data`` to ``['stream' => true]`` to get the stream before the end of download.
+
 .. _Stream: https://github.com/guzzle/streams/blob/master/src/Stream.php
 .. _Guzzle's docs: https://guzzle.readthedocs.org/en/5.3/streams.html
 

samples/objectstore/v1/objects/download_stream.php

@@ -0,0 +1,19 @@
+<?php
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+/** @var \GuzzleHttp\Stream\Stream $stream */
+$stream = $openstack->objectStoreV1()
+                    ->getContainer('{containerName}')
+                    ->getObject('{objectName}')
+                    ->download(['requestOptions' => ['stream' => true]]);

src/Common/Api/OperatorTrait.php

@@ -112,6 +112,10 @@ protected function sendRequest(Operation $operation, array $userValues = [], boo
 
         $uri     = Utils::uri_template($operation->getPath(), $userValues);
 
+        if (array_key_exists('requestOptions', $userValues)) {
+            $options += $userValues['requestOptions'];
+        }
+
         return $this->client->$method($operation->getMethod(), $uri, $options);
     }
 

src/ObjectStore/v1/Models/StorageObject.php

@@ -133,8 +133,9 @@ public function retrieve()
     /**
      * This call will perform a `GET` HTTP request for the given object and return back its content in the form of a
      * Guzzle Stream object. Downloading an object will transfer all of the content for an object, and is therefore
-     * distinct from fetching its metadata (a `HEAD` request). The body of an object is not fetched by default to
-     * improve performance when handling large objects.
+     * distinct from fetching its metadata (a `HEAD` request). The whole body of the object is fetched before the
+     * function returns, set the `'requestOptions'` key of {@param $data} to `['stream' => true]` to get the stream
+     * before the end of download.
      *
      * @param array $data {@see \OpenStack\ObjectStore\v1\Api::getObject}
      */

tests/integration/ObjectStore/v1/CoreTest.php

@@ -153,6 +153,17 @@ public function objects()
         $this->assertInstanceOf(StreamInterface::class, $stream);
         $this->assertEquals(1000, $stream->getSize());
 
+        $this->logStep('Downloading object using streaming');
+        /** @var StreamInterface $stream */
+        require_once $this->sampleFile($replacements, 'objects/download_stream.php');
+        $this->assertInstanceOf(StreamInterface::class, $stream);
+
+        $body = '';
+        while (!$stream->eof()) {
+            $body .= $stream->read(64);
+        }
+        $this->assertEquals(1000, strlen($body));
+
         $this->logStep('Get object');
         require_once $this->sampleFile($replacements, 'objects/get.php');
 

tests/unit/Common/Api/OperatorTraitTest.php

@@ -105,6 +105,17 @@ public function test_it_populates_models_from_arrays()
         $data = ['flavor' => [], 'image' => []];
         $this->assertInstanceOf(ResourceInterface::class, $this->operator->model(TestResource::class, $data));
     }
+
+    public function test_guzzle_options_are_forwarded()
+    {
+        $this->client->request('GET', 'test', ['headers' => [], 'stream' => true])->willReturn(new Response());
+
+        $this->operator->execute($this->def, [
+            'requestOptions' => ['stream' => true]
+        ]);
+
+        $this->addToAssertionCount(1);
+    }
 }
 
 class TestResource extends AbstractResource