Merge pull request rackspace#609 from jamiehannaford/upload-dir-path

Adds ability for uploadDir to be nested in pseudo-directories

Author: Jamie Hannaford

composer.json

@@ -33,6 +33,7 @@
     },
     "require-dev" : {
         "phpunit/phpunit": "4.3.*",
+        "phpspec/prophecy": "~1.4",
         "satooshi/php-coveralls": "0.6.*@dev",
         "jakub-onderka/php-parallel-lint": "0.*",
         "fabpot/php-cs-fixer": "1.0.*@dev",

lib/OpenCloud/ObjectStore/Resource/Container.php

@@ -570,11 +570,12 @@ public function setupObjectTransfer(array $options = array())
     /**
      * Upload the contents of a local directory to a remote container, effectively syncing them.
      *
-     * @param $path The local path to the directory.
+     * @param string $path      The local path to the directory.
+     * @param string $targetDir The path (or pseudo-directory) that all files will be nested in.
      */
-    public function uploadDirectory($path)
+    public function uploadDirectory($path, $targetDir = null)
     {
-        $sync = DirectorySync::factory($path, $this);
+        $sync = DirectorySync::factory($path, $this, $targetDir);
         $sync->execute();
     }
 

lib/OpenCloud/ObjectStore/Upload/DirectorySync.php

@@ -31,32 +31,34 @@
  */
 class DirectorySync
 {
-    /**
-     * @var string The path to the directory you're syncing.
-     */
+    /** @var string The path to the directory you're syncing. */
     private $basePath;
-    /**
-     * @var ResourceIterator A collection of remote files in Swift.
-     */
+
+    /** @var ResourceIterator A collection of remote files in Swift. */
     private $remoteFiles;
-    /**
-     * @var AbstractContainer The Container object you are syncing.
-     */
+
+    /** @var AbstractContainer The Container object you are syncing. */
     private $container;
 
+    /** @var string */
+    private $targetDir;
+
     /**
      * Basic factory method to instantiate a new DirectorySync object with all the appropriate properties.
      *
-     * @param           $path      The local path
+     * @param string    $path      The local path
      * @param Container $container The container you're syncing
+     * @param string    $targetDir The path (or pseudo-directory) that the files will be nested in
+     *
      * @return DirectorySync
      */
-    public static function factory($path, Container $container)
+    public static function factory($path, Container $container, $targetDir = null)
     {
         $transfer = new self();
         $transfer->setBasePath($path);
         $transfer->setContainer($container);
         $transfer->setRemoteFiles($container->objectList());
+        $transfer->setTargetDir($targetDir);
 
         return $transfer;
     }
@@ -90,6 +92,14 @@ public function setContainer(Container $container)
         $this->container = $container;
     }
 
+    /**
+     * @param string $dir The target path that all files will be nested in. By default, the files will not be nested.
+     */
+    public function setTargetDir($dir)
+    {
+        $this->targetDir = rtrim($dir, '/');
+    }
+
     /**
      * Execute the sync process. This will collect all the remote files from the API and do a comparison. There are
      * four scenarios that need to be dealt with:
@@ -112,7 +122,9 @@ public function execute()
 
         // Handle PUT requests (create/update files)
         foreach ($localFiles as $filename) {
-            $callback = $this->getCallback($filename);
+            $remoteFilename = $this->targetDir ? $this->targetDir . '/' . $filename : $filename;
+
+            $callback = $this->getCallback($remoteFilename);
             $filePath = rtrim($this->basePath, '/') . '/' . $filename;
 
             if (!is_readable($filePath)) {
@@ -133,7 +145,7 @@ public function execute()
             } else {
                 // upload new file
                 $url = clone $this->container->getUrl();
-                $url->addPath($filename);
+                $url->addPath($remoteFilename);
 
                 $requests[] = $this->container->getClient()->put($url, array(), $entityBody);
             }

tests/OpenCloud/Tests/ObjectStore/Upload/DirectorySyncTest.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace OpenCloud\Tests\ObjectStore\Upload;
+
+use Guzzle\Http\Url;
+use OpenCloud\ObjectStore\Upload\DirectorySync;
+use OpenCloud\Tests\OpenCloudTestCase;
+use Prophecy\Argument;
+use Prophecy\Prophet;
+
+class DirectorySyncTest extends OpenCloudTestCase
+{
+    private $prophet;
+
+    public function setUp()
+    {
+        $this->prophet = new Prophet();
+    }
+
+    public function test_it_uploads_to_a_container()
+    {
+        $baseUrl = 'foo.com/bar';
+
+        $containerMock = $this->prophet->prophesize('OpenCloud\ObjectStore\Resource\Container');
+        $iteratorMock = $this->prophet->prophesize('OpenCloud\Common\Collection\PaginatedIterator');
+
+        $iteratorMock->rewind()->shouldBeCalled();
+        $iteratorMock->populateAll()->shouldBeCalled();
+        $iteratorMock->valid()->willReturn(false);
+        $iteratorMock->search(Argument::type('callable'))->willReturn(false);
+
+        $containerMock->getUrl()->willReturn(Url::factory($baseUrl));
+
+        $guzzleMock = $this->prophet->prophesize('Guzzle\Http\Client');
+
+        $guzzleMock->put($baseUrl . '/test1', [], Argument::type('Guzzle\Http\EntityBody'))->shouldBeCalled();
+        $guzzleMock->send(Argument::that(function ($array) { return count($array) === 1; }))->shouldBeCalled();
+
+        $containerMock->getClient()->willReturn($guzzleMock->reveal());
+
+        $sync = new DirectorySync();
+        $sync->setBasePath(__DIR__ . '/fixtures');
+        $sync->setContainer($containerMock->reveal());
+        $sync->setRemoteFiles($iteratorMock->reveal());
+
+        $sync->execute();
+    }
+
+    public function test_it_uploads_to_a_nested_sub_dir_in_a_container()
+    {
+        $baseUrl = 'foo.com/bar';
+
+        $containerMock = $this->prophet->prophesize('OpenCloud\ObjectStore\Resource\Container');
+        $iteratorMock = $this->prophet->prophesize('OpenCloud\Common\Collection\PaginatedIterator');
+
+        $iteratorMock->rewind()->shouldBeCalled();
+        $iteratorMock->populateAll()->shouldBeCalled();
+        $iteratorMock->valid()->willReturn(false);
+        $iteratorMock->search(Argument::type('callable'))->willReturn(false);
+
+        $containerMock->getUrl()->willReturn(Url::factory($baseUrl));
+
+        $guzzleMock = $this->prophet->prophesize('Guzzle\Http\Client');
+
+        $guzzleMock->put($baseUrl . '/sub-dir/test1', [], Argument::type('Guzzle\Http\EntityBody'))->shouldBeCalled();
+        $guzzleMock->send(Argument::that(function ($array) { return count($array) === 1; }))->shouldBeCalled();
+
+        $containerMock->getClient()->willReturn($guzzleMock->reveal());
+
+        $sync = new DirectorySync();
+        $sync->setBasePath(__DIR__ . '/fixtures');
+        $sync->setContainer($containerMock->reveal());
+        $sync->setRemoteFiles($iteratorMock->reveal());
+        $sync->setTargetDir('sub-dir');
+
+        $sync->execute();
+    }
+}