Continued changes to decouple core lib from http interface. Added met…

…adata support on object.
basho · Sep 14, 2015 · b501542 · b501542
1 parent cb6b6ae
commit b501542
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 48 deletions.
diff --git a/src/Riak/Api/Http.php b/src/Riak/Api/Http.php
@@ -18,7 +18,7 @@
 namespace Basho\Riak\Api;
 
 use Basho\Riak\Api;
-use Basho\Riak\Api\Http\Translators\SecondaryIndexHeaderTranslator;
+use Basho\Riak\Api\Http\Translators\SecondaryIndexTranslator;
 use Basho\Riak\ApiInterface;
 use Basho\Riak\Bucket;
 use Basho\Riak\Command;
@@ -36,6 +36,7 @@ class Http extends Api implements ApiInterface
     // Header keys
     const VCLOCK_KEY = 'X-Riak-Vclock';
     const CONTENT_TYPE_KEY = 'Content-Type';
+    const METADATA_PREFIX = 'X-Riak-Meta-';
 
     /**
      * cURL connection handle
@@ -146,6 +147,10 @@ protected function buildPath()
             case 'Basho\Riak\Command\Object\Fetch':
             case 'Basho\Riak\Command\Object\Store':
             case 'Basho\Riak\Command\Object\Delete':
+                // to allow siblings
+                if ($this->command->getMethod() == 'GET') {
+                    $this->headers['Accept'] = 'multipart/mixed, */*';
+                }
                 $this->path = sprintf('/types/%s/buckets/%s/keys/%s', $bucket->getType(), $bucket->getName(), $key);
                 break;
             case 'Basho\Riak\Command\DataType\Counter\Fetch':
@@ -361,11 +366,16 @@ protected function prepareRequestHeaders()
             }
 
             // setup index headers
-            $translator = new SecondaryIndexHeaderTranslator();
+            $translator = new SecondaryIndexTranslator();
             $indexHeaders = $translator->createHeadersFromIndexes($object->getIndexes());
             foreach ($indexHeaders as $value) {
                 $curl_headers[] = sprintf('%s: %s', $value[0], $value[1]);
             }
+
+            // setup metadata headers
+            foreach($object->getMetaData() as $key => $value) {
+                $curl_headers[] = sprintf('%s%s: %s', self::METADATA_PREFIX, $key, $value);
+            }
         }
 
         // set the request headers on the connection

diff --git a/src/Riak/Api/Http/Translators/SecondaryIndexTranslator.php b/src/Riak/Api/Http/Translators/SecondaryIndexTranslator.php
@@ -20,7 +20,7 @@
 /**
  * @author Alex Moore <amoore at basho d0t com>
  */
-class SecondaryIndexHeaderTranslator
+class SecondaryIndexTranslator
 {
     const INT_INDEX_SUFFIX = '_int';
     const STR_IDX_SUFFIX = '_bin';

diff --git a/src/Riak/Command.php b/src/Riak/Command.php
@@ -65,7 +65,6 @@ public function __construct(Builder $builder)
     {
         $this->riak = $builder->getConnection();
         $this->parameters = $builder->getParameters();
-        $this->headers = $builder->getHeaders();
         $this->verbose = $builder->getVerbose();
     }
 

diff --git a/src/Riak/Command/Builder.php b/src/Riak/Command/Builder.php
@@ -92,20 +92,6 @@ public function withParameters($parameters = [])
         return $this;
     }
 
-    public function withHeader($key, $value = true)
-    {
-        $this->headers[$key] = $value;
-
-        return $this;
-    }
-
-    public function withHeaders($headers = [])
-    {
-        $this->headers = $headers;
-
-        return $this;
-    }
-
     public function withVerboseMode($verbose = true)
     {
         $this->verbose = $verbose;
@@ -118,11 +104,6 @@ public function getParameters()
         return $this->parameters;
     }
 
-    public function getHeaders()
-    {
-        return $this->headers;
-    }
-
     public function getConnection()
     {
         return $this->riak;

diff --git a/src/Riak/Command/Builder/FetchObject.php b/src/Riak/Command/Builder/FetchObject.php
@@ -49,8 +49,6 @@ class FetchObject extends Command\Builder implements Command\BuilderInterface
     public function __construct(Riak $riak)
     {
         parent::__construct($riak);
-
-        $this->headers['Accept'] = 'multipart/mixed, */*';
     }
 
     /**

diff --git a/src/Riak/Command/Builder/ObjectTrait.php b/src/Riak/Command/Builder/ObjectTrait.php
@@ -31,6 +31,9 @@ trait ObjectTrait
      */
     protected $object = NULL;
 
+    /**
+     * @return Object|null
+     */
     public function getObject()
     {
         return $this->object;
@@ -78,4 +81,4 @@ public function buildJsonObject($data)
 
         return $this;
     }
-}
+}
diff --git a/src/Riak/Command/Object/Store.php b/src/Riak/Command/Object/Store.php
@@ -28,6 +28,11 @@
  */
 class Store extends Command\Object implements CommandInterface
 {
+    /**
+     * Type of operation
+     *
+     * @var string
+     */
     protected $method = 'POST';
 
     public function __construct(Command\Builder\StoreObject $builder)
@@ -42,4 +47,4 @@ public function __construct(Command\Builder\StoreObject $builder)
             $this->method = 'PUT';
         }
     }
-}
+}
diff --git a/src/Riak/Object.php b/src/Riak/Object.php
@@ -18,7 +18,7 @@
 namespace Basho\Riak;
 
 use Basho\Riak;
-use Basho\Riak\Api\Http\Translators\SecondaryIndexHeaderTranslator;
+use Basho\Riak\Api\Http\Translators\SecondaryIndexTranslator;
 
 /**
  * Main class for data objects in Riak
@@ -44,6 +44,8 @@ class Object
 
     protected $charset = 'utf-8';
 
+    protected $metadata = [];
+
     /**
      * @param mixed|null $data
      * @param array|null $headers DEPRECATED
@@ -56,7 +58,7 @@ public function __construct($data = null, $headers = [])
             return;
         }
 
-        $translator = new SecondaryIndexHeaderTranslator();
+        $translator = new SecondaryIndexTranslator();
         $this->indexes = $translator->extractIndexesFromHeaders($headers);
 
         // to prevent breaking the interface, parse $headers and place important stuff in new home
@@ -74,6 +76,13 @@ public function __construct($data = null, $headers = [])
         if (!empty($headers[Riak\Api\Http::VCLOCK_KEY])) {
             $this->content_type = $headers[Riak\Api\Http::VCLOCK_KEY];
         }
+
+        // pull out metadata headers
+        foreach($headers as $key => $value) {
+            if (strpos($key, Riak\Api\Http::METADATA_PREFIX) !== false) {
+                $this->metadata[substr($key, strlen(Riak\Api\Http::METADATA_PREFIX))] = $value;
+            }
+        }
     }
 
     public function getData()
@@ -176,8 +185,8 @@ private function validateIndexNameAndValue($indexName, $value)
                 "'index. Expecting '*_int' for an integer index, or '*_bin' for a string index.");
         }
 
-        $isIntIndex = SecondaryIndexHeaderTranslator::isIntIndex($indexName);
-        $isStringIndex = SecondaryIndexHeaderTranslator::isStringIndex($indexName);
+        $isIntIndex = SecondaryIndexTranslator::isIntIndex($indexName);
+        $isStringIndex = SecondaryIndexTranslator::isStringIndex($indexName);
 
         if (!$isIntIndex && !$isStringIndex) {
             throw new \InvalidArgumentException("Invalid index type for '" . $indexName .
@@ -213,4 +222,26 @@ public function removeValueFromIndex($indexName, $value)
 
         return $this;
     }
+
+    public function setMetaDataValue($key, $value = '')
+    {
+        $this->metadata[$key] = $value;
+        return $this;
+    }
+
+    public function getMetaDataValue($key)
+    {
+        return $this->metadata[$key];
+    }
+
+    public function removeMetaDataValue($key)
+    {
+        unset($this->metadata[$key]);
+        return $this;
+    }
+
+    public function getMetaData()
+    {
+        return $this->metadata;
+    }
 }
diff --git a/tests/unit/Riak/Api/Translators/SecondaryIndexHeaderTest.php b/tests/unit/Riak/Api/Translators/SecondaryIndexHeaderTest.php
@@ -30,7 +30,7 @@ class SecondaryIndexHeaderTest extends TestCase
     public function testExtractIndexes()
     {
         $headers = ['My-Header' => 'cats', 'x-riak-index-foo_bin' => 'bar, baz', 'x-riak-index-foo_int' => '42, 50'];
-        $translator = new Api\Http\Translators\SecondaryIndexHeaderTranslator();
+        $translator = new Api\Http\Translators\SecondaryIndexTranslator();
 
         $indexes = $translator->extractIndexesFromHeaders($headers);
 
@@ -47,7 +47,7 @@ public function testExtractIndexes()
     public function testExtractIndexesNoHeaders()
     {
         $headers = [];
-        $translator = new Api\Http\Translators\SecondaryIndexHeaderTranslator();
+        $translator = new Api\Http\Translators\SecondaryIndexTranslator();
         $indexes = $translator->extractIndexesFromHeaders($headers);
 
         // Check that we get an empty array back.
@@ -58,7 +58,7 @@ public function testExtractIndexesNoHeaders()
     public function testCreateHeaders()
     {
         $indexes = ['foo_bin' => ['bar', 'baz'], 'foo_int' => [42, 50]];
-        $translator = new Api\Http\Translators\SecondaryIndexHeaderTranslator();
+        $translator = new Api\Http\Translators\SecondaryIndexTranslator();
 
         $headers = $translator->createHeadersFromIndexes($indexes);
 

diff --git a/tests/unit/Riak/Command/Builder/FetchObjectTest.php b/tests/unit/Riak/Command/Builder/FetchObjectTest.php
@@ -52,10 +52,6 @@ public function testFetch($riak)
         $command = $builder->build();
 
         $this->assertEquals('some_type', $command->getBucket()->getType());
-
-        $headers = $builder->getHeaders();
-        $this->assertTrue(isset($headers['Accept']));
-        $this->assertEquals('multipart/mixed, */*', $headers['Accept']);
     }
 
     /**
@@ -73,4 +69,4 @@ public function testValidateLocation($riak)
         $builder->buildBucket('some_bucket');
         $builder->build();
     }
-}
+}
diff --git a/tests/unit/Riak/Command/Builder/StoreObjectTest.php b/tests/unit/Riak/Command/Builder/StoreObjectTest.php
@@ -17,6 +17,7 @@
 
 namespace Basho\Tests\Riak\Command\Builder;
 
+use Basho\Riak\Api\Http;
 use Basho\Riak\Command;
 use Basho\Tests\TestCase;
 
@@ -112,22 +113,21 @@ public function testValidateBucket($riak)
      */
     public function testStoreObjectWithIndexGeneratesHeaders($riak)
     {
-        $inputHeaders = ['My-Header' => 'cats', 'x-riak-index-foo_bin' => 'bar, baz', 'x-riak-index-foo_int' => '42, 50'];
+        $inputHeaders = [Http::METADATA_PREFIX . 'My-Header' => 'cats', 'x-riak-index-foo_bin' => 'bar, baz', 'x-riak-index-foo_int' => '42, 50'];
         $builder = new Command\Builder\StoreObject($riak);
         $builder->buildObject('some_data', $inputHeaders);
         $builder->buildBucket('some_bucket');
         $command = $builder->build();
 
         $this->assertInstanceOf('Basho\Riak\Command\Object\Store', $command);
-        $headers = $command->getHeaders();
 
-        $this->assertNotNull($headers);
-        $this->assertEquals(5, count($headers));
-        $this->assertEquals(['My-Header', 'cats'], $headers[0]);
-        $this->assertEquals(['x-riak-index-foo_bin', 'bar'], $headers[1]);
-        $this->assertEquals(['x-riak-index-foo_bin', 'baz'], $headers[2]);
-        $this->assertEquals(['x-riak-index-foo_int', '42'], $headers[3]);
-        $this->assertEquals(['x-riak-index-foo_int', '50'], $headers[4]);
+        $this->assertArrayHasKey('My-Header', $command->getObject()->getMetaData());
+        $this->assertEquals($command->getObject()->getMetaData()['My-Header'], 'cats');
 
+        $this->assertArrayHasKey('foo_bin', $command->getObject()->getIndexes());
+        $this->assertCount(2, $command->getObject()->getIndex('foo_bin'));
+
+        $this->assertArrayHasKey('foo_int', $command->getObject()->getIndexes());
+        $this->assertCount(2, $command->getObject()->getIndex('foo_int'));
     }
 }