Merge pull request #94 from /issues/91

RiakStorage upgrade

Author: EmanueleMinotto

.travis.yml

@@ -11,7 +11,23 @@ php:
   - 7.2
   - 7.3
 
+addons:
+    apt:
+        sources:
+            -
+                key_url: 'https://packagecloud.io/gpg.key'
+                sourceline: 'deb https://packagecloud.io/basho/riak/ubuntu/ trusty main'
+            -
+                key_url: 'https://packagecloud.io/gpg.key'
+                sourceline: 'deb-src https://packagecloud.io/basho/riak/ubuntu/ trusty main'
+        update: true
+
+cache:
+    apt: true
+
 before_install:
+  - sudo apt-get install -y --allow-unauthenticated riak
+  - sudo service riak start
   - pecl install --force mongodb
   - if [[ ${TRAVIS_PHP_VERSION:0:1} != "7" ]]; then sh ./tests/travis.sh; fi
   - composer self-update

composer.json

@@ -9,14 +9,13 @@
         "doctrine/couchdb": "^1.0.0-beta4",
         "phpunit/phpunit": "^4.8|^5.0",
         "aws/aws-sdk-php": "^3.8",
-        "riak/riak-client": "dev-master",
+        "php-riak/riak-client": "^1.0@alpha",
         "mongodb/mongodb": "^1.4"
     },
     "suggest": {
         "aws/aws-sdk-php": "to use the DynamoDB storage",
         "doctrine/couchdb": "to use the CouchDB storage",
-        "ext-couchbase": "to use the Couchbase storage",
-        "riak/riak-client": "to use the Riak storage"
+        "ext-couchbase": "to use the Couchbase storage"
     },
     "description": "Simple Key-Value Store Abstraction Layer that maps to PHP objects, allowing for many backends.",
     "license": "MIT",

docs/reference/configuration.rst

@@ -242,15 +242,17 @@ instance.
 Riak
 ----
 
-Riak support is provided through the library `riak/riak-client <https://github.com/nacmartin/riak-client>`_ :
+Riak support is provided through the library `php-riak/riak-client <https://github.com/php-riak/riak-client>`_ :
 
 .. code-block:: php
 
     <?php
 
     use Doctrine\KeyValueStore\Storage\RiakStorage;
-    use Riak\Client;
+    use Riak\Client\RiakClientBuilder;
 
-    $conn = new Riak(/* connection parameters */);
+    $conn = (new RiakClientBuilder())
+        ->withNodeUri(/* connection DNS */)
+        ->build();
 
     $storage = new RiakStorage($conn);

lib/Doctrine/KeyValueStore/Storage/RiakStorage.php

@@ -21,25 +21,26 @@
 namespace Doctrine\KeyValueStore\Storage;
 
 use Doctrine\KeyValueStore\NotFoundException;
-use Riak\Client;
+use Riak\Client\Command\Kv\DeleteValue;
+use Riak\Client\Command\Kv\FetchValue;
+use Riak\Client\Command\Kv\StoreValue;
+use Riak\Client\Core\Query\RiakLocation;
+use Riak\Client\Core\Query\RiakNamespace;
+use Riak\Client\Core\Query\RiakObject;
+use Riak\Client\RiakClient;
+use Riak\Client\RiakException;
 
 /**
  * @author Markus Bachmann <markus.bachmann@bachi.biz>
  */
 class RiakStorage implements Storage
 {
     /**
-     * @var \Riak\Client
+     * @var RiakClient
      */
-    protected $client;
+    private $client;
 
-    /**
-     * Constructor
-     *
-     * @param \Riak\Client $riak
-     * @param string       $bucketName
-     */
-    public function __construct(Client $riak)
+    public function __construct(RiakClient $riak)
     {
         $this->client = $riak;
     }
@@ -68,62 +69,79 @@ public function requiresCompositePrimaryKeys()
         return false;
     }
 
+    private function store($storageName, $key, array $data)
+    {
+        $location = $this->getRiakLocation($storageName, $key);
+
+        $riakObject = new RiakObject();
+        $riakObject->setContentType('application/json');
+        $riakObject->setValue(json_encode($data));
+
+        $store = StoreValue::builder($location, $riakObject)->build();
+
+        $this->client->execute($store);
+    }
+
     /**
      * {@inheritDoc}
      */
     public function insert($storageName, $key, array $data)
     {
-        $bucket = $this->client->bucket($storageName);
-        $object = $bucket->newObject($key, $data);
-        $object->store();
+        $this->store($storageName, $key, $data);
     }
 
     /**
      * {@inheritDoc}
      */
     public function update($storageName, $key, array $data)
     {
-        $bucket = $this->client->bucket($storageName);
-        /** @var $object \Riak\Object */
-        $object = $bucket->get($key);
-
-        $object->setData($data);
-        $object->store();
+        $this->store($storageName, $key, $data);
     }
 
     /**
      * {@inheritDoc}
      */
     public function delete($storageName, $key)
     {
-        $bucket = $this->client->bucket($storageName);
+        $location = $this->getRiakLocation($storageName, $key);
 
-        /** @var $object \Riak\Object */
-        $object = $bucket->get($key);
+        $delete = DeleteValue::builder($location)->build();
 
-        if (! $object->exists()) {
-            // object does not exist, do nothing
-            return;
+        try {
+            $this->client->execute($delete);
+        } catch (RiakException $exception) {
+            // deletion can fail silent
         }
-
-        $object->delete();
     }
 
     /**
      * {@inheritDoc}
      */
     public function find($storageName, $key)
     {
-        $bucket = $this->client->bucket($storageName);
+        $location = $this->getRiakLocation($storageName, $key);
 
-        /** @var $object \Riak\Object */
-        $object = $bucket->get($key);
+        // fetch object
+        $fetch = FetchValue::builder($location)->build();
 
-        if (! $object->exists()) {
-            throw new NotFoundException;
+        try {
+            $result = $this->client->execute($fetch);
+        } catch (RiakException $exception) {
+            throw new NotFoundException();
         }
 
-        return $object->getData();
+        $json = (string) $result
+            ->getValue()
+            ->getValue();
+
+        return json_decode($json, true);
+    }
+
+    private function getRiakLocation($storageName, $key)
+    {
+        $namespace = new RiakNamespace('default', $storageName);
+
+        return new RiakLocation($namespace, $key);
     }
 
     /**

phpunit.xml.dist

@@ -16,5 +16,6 @@
         <var name="DOCTRINE_KEYVALUE_AZURE_AUTHSCHEMA" value="sharedlite" />
         <var name="DOCTRINE_KEYVALUE_AZURE_NAME" value="" />
         <var name="DOCTRINE_KEYVALUE_AZURE_KEY" value="" />
+        <env name="RIAK_DNS" value="" />
     </php>
 </phpunit>