Implementing Acquire, Release, and CAS endpionts for KV

- "KVClient::put" bugfix

Author: dcarbone

README.md

@@ -12,7 +12,7 @@ Require Entry:
 
 ```json
 {
-  "dcarbone/php-consul-api": "0.2.*"
+  "dcarbone/php-consul-api": "0.3.*"
 }
 ```
 

src/HttpRequest.php

@@ -37,6 +37,9 @@ class HttpRequest
     /** @var string */
     public $url;
 
+    /** @var string */
+    private $_compiledBody = null;
+
     /** @var array */
     private $_curlOpts = array();
     /** @var array */
@@ -124,6 +127,41 @@ public function setWriteOptions(WriteOptions $writeOptions = null)
             $this->params['token'] = $token;
     }
 
+    /**
+     * @return string
+     */
+    public function getCompiledBody()
+    {
+        if (!isset($this->_compiledBody))
+        {
+            switch(gettype($this->body))
+            {
+                case 'integer':
+                case 'double':
+                    $this->_compiledBody = (string)$this->body;
+                    break;
+
+                case 'string':
+                    $this->_compiledBody = $this->body;
+                    break;
+
+                case 'object':
+                case 'array':
+                    $this->_compiledBody = json_encode($this->body);
+                    break;
+
+                case 'boolean':
+                    $this->_compiledBody = $this->body ? 'true' : 'false';
+                    break;
+
+                default:
+                    $this->_compiledBody = '';
+            }
+        }
+
+        return $this->_compiledBody;
+    }
+
     /**
      * @return array(
      *  @type HttpResponse|null response or null on error
@@ -150,7 +188,12 @@ public function execute()
             );
         }
 
-        Logger::debug('Executing '.$this->method.' request '.$this->url.($this->body ? ' with body "'.$this->body.'"':''));
+        Logger::debug(sprintf(
+            'Executing %s request %s%s',
+            $this->method,
+            $this->url,
+            $this->body ? sprintf(' with body "%s"', $this->getCompiledBody()) : ''
+        ));
 
         switch($this->method)
         {
@@ -208,38 +251,12 @@ public function execute()
     private function _preparePUT()
     {
         $this->_curlOpts[CURLOPT_CUSTOMREQUEST] = 'PUT';
-        $this->_curlOpts[CURLOPT_POSTFIELDS] = $this->_compileBody();
+        $this->_curlOpts[CURLOPT_POSTFIELDS] = $this->getCompiledBody();
     }
 
     private function _prepareDELETE()
     {
         $this->_curlOpts[CURLOPT_CUSTOMREQUEST] = 'DELETE';
-        $this->_curlOpts[CURLOPT_POSTFIELDS] = $this->_compileBody();
-    }
-
-    /**
-     * @return string
-     */
-    private function _compileBody()
-    {
-        switch(gettype($this->body))
-        {
-            case 'integer':
-            case 'double':
-                return (string)$this->body;
-
-            case 'string':
-                return $this->body;
-
-            case 'object':
-            case 'array':
-                return json_encode($this->body);
-
-            case 'boolean':
-                return $this->body ? 'true' : 'false';
-
-            default:
-                return '';
-        }
+        $this->_curlOpts[CURLOPT_POSTFIELDS] = $this->getCompiledBody();
     }
 }

src/KV/KVClient.php

@@ -162,18 +162,20 @@ public function keys($prefix = null, QueryOptions $queryOptions = null)
     }
 
     /**
-     * @param KVPair $KVPair
+     * @param KVPair $p
      * @param WriteOptions $writeOptions
      * @return array(
      *  @type \DCarbone\PHPConsulAPI\WriteMeta write metadata
      *  @type \DCarbone\PHPConsulAPI\Error|null error, if any
      * )
      */
-    public function put(KVPair $KVPair, WriteOptions $writeOptions = null)
+    public function put(KVPair $p, WriteOptions $writeOptions = null)
     {
-        $r = new HttpRequest('put', sprintf('v1/kv/%s', $KVPair->Key), $this->_Config);
+        $r = new HttpRequest('put', sprintf('v1/kv/%s', $p->Key), $this->_Config);
         $r->setWriteOptions($writeOptions);
-        $r->body = ($KVPair);
+        $r->body = $p->Value;
+        if (0 !== $p->Flags)
+            $r->params->set('flags', $p->Flags);
 
         list($duration, $_, $err) = $this->requireOK($this->doRequest($r));
         $wm = $this->buildWriteMeta($duration);
@@ -200,6 +202,72 @@ public function delete($key, WriteOptions $writeOptions = null)
         return [$wm, $err];
     }
 
+    /**
+     * @param KVPair $p
+     * @param WriteOptions $writeOptions
+     * @return array(
+     *  @type \DCarbone\PHPConsulAPI\WriteMeta write metadata
+     *  @type \DCarbone\PHPConsulAPI\Error|null error, if any
+     * )
+     */
+    public function cas(KVPair $p, WriteOptions $writeOptions = null)
+    {
+        $r = new HttpRequest('put', sprintf('v1/kv/%s', $p->Key), $this->_Config);
+        $r->setWriteOptions($writeOptions);
+        $r->params->set('cas', $p->ModifyIndex);
+        if (0 !== $p->Flags)
+            $r->params->set('flags', $p->Flags);
+
+        list($duration, $_, $err) = $this->requireOK($this->doRequest($r));
+        $wm = $this->buildWriteMeta($duration);
+
+        return [$wm, $err];
+    }
+
+    /**
+     * @param KVPair $p
+     * @param WriteOptions $writeOptions
+     * @return array(
+     *  @type \DCarbone\PHPConsulAPI\WriteMeta write metadata
+     *  @type \DCarbone\PHPConsulAPI\Error|null error, if any
+     * )
+     */
+    public function acquire(KVPair $p, WriteOptions $writeOptions = null)
+    {
+        $r = new HttpRequest('put', sprintf('v1/kv/%s', $p->Key), $this->_Config);
+        $r->setWriteOptions($writeOptions);
+        $r->params->set('acquire', $p->Session);
+        if (0 !== $p->Flags)
+            $r->params->set('flags', $p->Flags);
+
+        list($duration, $_, $err) = $this->requireOK($this->doRequest($r));
+        $wm = $this->buildWriteMeta($duration);
+
+        return [$wm, $err];
+    }
+
+    /**
+     * @param KVPair $p
+     * @param WriteOptions $writeOptions
+     * @return array(
+     *  @type \DCarbone\PHPConsulAPI\WriteMeta write metadata
+     *  @type \DCarbone\PHPConsulAPI\Error|null error, if any
+     * )
+     */
+    public function release(KVPair $p, WriteOptions $writeOptions = null)
+    {
+        $r = new HttpRequest('put', sprintf('v1/kv/%s', $p->Key), $this->_Config);
+        $r->setWriteOptions($writeOptions);
+        $r->params->set('release', $p->Session);
+        if (0 !== $p->Flags)
+            $r->params->set('flags', $p->Flags);
+
+        list($duration, $_, $err) = $this->requireOK($this->doRequest($r));
+        $wm = $this->buildWriteMeta($duration);
+
+        return [$wm, $err];
+    }
+
     /**
      * @param null|string $prefix
      * @param QueryOptions $queryOptions