Merge pull request #111 from basho/2.1.x

Preflist support. Thanks @lukebakken!

Author: christophermancini

src/Riak/Api/Http.php

@@ -132,7 +132,7 @@ protected function buildPath()
             case 'Basho\Riak\Command\DataType\Set\Store':
             case 'Basho\Riak\Command\DataType\Map\Fetch':
             case 'Basho\Riak\Command\DataType\Map\Store':
-            $this->path = sprintf('/types/%s/buckets/%s/datatypes/%s', $bucket->getType(), $bucket->getName(),
+                $this->path = sprintf('/types/%s/buckets/%s/datatypes/%s', $bucket->getType(), $bucket->getName(),
                 $key);
                 break;
             case 'Basho\Riak\Command\Search\Index\Fetch':
@@ -159,6 +159,9 @@ protected function buildPath()
             case 'Basho\Riak\Command\Stats':
                 $this->path = '/stats';
                 break;
+            case 'Basho\Riak\Command\Object\FetchPreflist':
+                $this->path = sprintf('/types/%s/buckets/%s/keys/%s/preflist', $bucket->getType(), $bucket->getName(), $key);
+                break;
             default:
                 $this->path = '';
         }
@@ -294,7 +297,7 @@ protected function prepareRequestData()
     protected function prepareRequestUrl()
     {
         $protocol = $this->node->useTls() ? 'https' : 'http';
-        $url = sprintf('%s://%s%s?%s', $protocol, $this->node->getUri(), $this->path, $this->query);
+        $url = sprintf('%s://%s%s%s', $protocol, $this->node->getUri(), $this->path, $this->query);
 
         // set the built request URL on the connection
         $this->options[CURLOPT_URL] = $url;
@@ -311,7 +314,7 @@ protected function prepareRequestParameters()
     {
         if ($this->command->hasParameters()) {
             // build query using RFC 3986 (spaces become %20 instead of '+')
-            $this->query = http_build_query($this->command->getParameters(), '', '&', PHP_QUERY_RFC3986);
+            $this->query = '?' . http_build_query($this->command->getParameters(), '', '&', PHP_QUERY_RFC3986);
         }
 
         return $this;

src/Riak/Command/Builder/FetchPreflist.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+Copyright 2014 Basho Technologies, Inc.
+
+Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations under the License.
+*/
+
+namespace Basho\Riak\Command\Builder;
+
+use Basho\Riak\Command;
+
+/**
+ * Used to fetch map objects from Riak
+ *
+ * <code>
+ * $command = (new Command\Builder\FetchPreflist($riak))
+ *   ->buildLocation($order_id, 'online_orders', 'sales')
+ *   ->build();
+ *
+ * $response = $command->execute($command);
+ *
+ * $map = $response->getMap();
+ * </code>
+ *
+ * @author Christopher Mancini <cmancini at basho d0t com>
+ */
+class FetchPreflist extends Command\Builder implements Command\BuilderInterface
+{
+    use LocationTrait;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return Command\Object\FetchPreflist;
+     */
+    public function build()
+    {
+        $this->validate();
+
+        return new Command\Object\FetchPreflist($this);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validate()
+    {
+        $this->required('Location');
+    }
+}

src/Riak/Command/Object/FetchPreflist.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+Copyright 2014 Basho Technologies, Inc.
+
+Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations under the License.
+*/
+
+namespace Basho\Riak\Command\Object;
+
+use Basho\Riak\Command;
+use Basho\Riak\CommandInterface;
+
+/**
+ * Fetches the Preflist for a Riak Kv Object
+ *
+ * @author Christopher Mancini <cmancini at basho d0t com>
+ */
+class FetchPreflist extends Command\Object implements CommandInterface
+{
+    public function __construct(Command\Builder\FetchPreflist $builder)
+    {
+        parent::__construct($builder);
+
+        $this->bucket = $builder->getBucket();
+        $this->location = $builder->getLocation();
+    }
+
+    public function setResponse($statusCode, $responseHeaders = [], $responseBody = '')
+    {
+        $this->response = new Response($statusCode, $responseHeaders, $responseBody);
+
+        return $this;
+    }
+}

tests/functional/PreflistTest.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+Copyright 2015 Basho Technologies, Inc.
+
+Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations under the License.
+*/
+
+namespace Basho\Tests;
+
+use Basho\Riak\Command;
+
+/**
+ * Class PreflistTest
+ *
+ * Functional tests related to Riak Preference lists
+ *
+ * @author Christopher Mancini <cmancini at basho d0t com>
+ */
+class PreflistTest extends TestCase
+{
+    /**
+     * @dataProvider getLocalNodeConnection
+     *
+     * @param $riak \Basho\Riak
+     */
+    public function testFetch($riak)
+    {
+        // build a store object comand, get the location of the newly minted object
+        $location = (new Command\Builder\StoreObject($riak))
+            ->buildObject('some_data')
+            ->buildBucket('users')
+            ->build()
+            ->execute()
+            ->getLocation();
+
+        // build a fetch command
+        $command = (new Command\Builder\FetchPreflist($riak))
+            ->atLocation($location)
+            ->build();
+
+        $response = $command->execute();
+
+        $this->assertEquals('200', $response->getStatusCode(), $response->getBody());
+        $this->assertJson($response->getBody());
+        $this->assertNotEmpty($response->getObject()->getData()->preflist);
+        $this->assertObjectHasAttribute("partition", $response->getObject()->getData()->preflist[0]);
+        $this->assertObjectHasAttribute("node", $response->getObject()->getData()->preflist[0]);
+        $this->assertObjectHasAttribute("primary", $response->getObject()->getData()->preflist[0]);
+    }
+}