Add tarantool/client support (#9)

* Add "tarantool/client" support
* Update tests, extend Travis build matrix
* Update the "Data types" README section

Author: rybakit

.travis.yml

@@ -1,22 +1,27 @@
 sudo: required
 
-language: bash
+language: php
 
 services:
   - docker
 
 env:
-  - PHP_RUNTIME='php:5.4-cli'
-  - PHP_RUNTIME='php:5.5-cli'
-  - PHP_RUNTIME='php:5.6-cli' PHPUNIT_OPTS='--coverage-clover=coverage.clover'
+  - IMAGE='php:5.4-cli' TNT_CLIENT=pecl
+  - IMAGE='php:5.5-cli' TNT_CLIENT=pecl
+  - IMAGE='php:5.6-cli' TNT_CLIENT=pecl
+  - IMAGE='php:7.0-cli' TNT_CLIENT=pecl
+  - IMAGE='php:7.1-cli' TNT_CLIENT=pecl
+  - IMAGE='php:5.6-cli' TNT_CLIENT=pure
+  - IMAGE='php:7.0-cli' TNT_CLIENT=pure
+  - IMAGE='php:7.1-cli' TNT_CLIENT=pure PHPUNIT_OPTS='--coverage-clover=coverage.clover'
 
 install:
-  - docker build -t tarantool/tarantool github.com/tarantool/tarantool-docker#:1.7
   - ./dockerfile.sh | tee /dev/tty | docker build -t queue -
 
 script:
-  - docker run -d --name tarantool -v $(pwd):/queue tarantool/tarantool /queue/tests/Integration/queues.lua
-  - docker run --rm --name queue --link tarantool -v $(pwd):/queue -w /queue -e PHPUNIT_OPTS="$PHPUNIT_OPTS" queue
+  - docker network create tarantool-php
+  - docker run -d --net=tarantool-php --name=tarantool -v `pwd`:/queue tarantool/tarantool:1.7 tarantool /queue/tests/Integration/queues.lua
+  - docker run --rm --net=tarantool-php --name=queue -v `pwd`:/queue -w /queue -e PHPUNIT_OPTS="$PHPUNIT_OPTS" queue
 
 after_script:
   - if [[ -f coverage.clover ]]; then

README.md

@@ -53,25 +53,34 @@ in the Lua script:
 ```php
 use Tarantool\Queue\Queue;
 
-$tarantool = new Tarantool();
-$queue = new Queue($tarantool, 'foobar');
+...
+
+$queue = new Queue($client, 'foobar');
 ```
 
+where `$client` is either an instance of the Tarantool class from the [pecl extension](https://github.com/tarantool/tarantool-php) 
+or an instance of `Tarantool\Client\Client` from the [pure PHP package](https://github.com/tarantool-php/client).
+
 
 ### Data types
 
 Under the hood Tarantool uses [MessagePack](http://msgpack.org/) binary format to serialize/deserialize
-data being stored in a queue. This means that it's safe to use such data types as `null`, `bool`, `int`,
-`float`, `string`, `binary string` and `array` without any manual pre- or post-processing:
+data being stored in a queue. It can handle most of the PHP data types (except resources and closures) without 
+any manual pre- or post-processing:
 
 ```php
 $queue->put('foo');
 $queue->put(true);
 $queue->put(42);
 $queue->put(4.2);
 $queue->put(['foo' => ['bar' => ['baz' => null]]]);
+$queue->put(new MyObject());
 ```
 
+> *Note*
+>
+> Object serialization is only supported when [tarantool/client](https://github.com/tarantool-php/client) is used.
+
 
 ### Tasks
 
@@ -230,21 +239,22 @@ $ ./dockerfile.sh | docker build -t queue -
 Then run Tarantool instance (needed for integration tests):
 
 ```sh
-$ docker run -d --name tarantool -v $(pwd):/queue tarantool/tarantool \
-    /queue/tests/Integration/queues.lua
+$ docker network create tarantool-php
+$ docker run -d --net=tarantool-php --name=tarantool -v `pwd`:/queue \
+    tarantool/tarantool:1.7 tarantool /queue/tests/Integration/queues.lua
 ```
 
 And then run both unit and integration tests:
 
 ```sh
-$ docker run --rm --name queue --link tarantool -v $(pwd):/queue -w /queue queue
+$ docker run --rm --net=tarantool-php --name=queue -v `pwd`:/queue -w /queue queue
 ```
 
 To run only integration or unit tests, set the `PHPUNIT_OPTS` environment variable
 to either `--testsuite Integration` or `--testsuite Unit` respectively, e.g.:
 
 ```sh
-$ docker run --rm --name queue -v $(pwd):/queue -w /queue \
+$ docker run --rm --net=tarantool-php --name=queue -v `pwd`:/queue -w /queue \
     -e PHPUNIT_OPTS='--testsuite Unit' queue
 ```
 

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "tarantool/queue",
     "description": "PHP bindings for Tarantool Queue.",
-    "keywords": ["queue", "schedule", "delayed", "priority", "ttl", "ttr", "task", "job", "worker", "tarantool"],
+    "keywords": ["queue", "schedule", "delayed", "priority", "ttl", "ttr", "task", "job", "worker", "tarantool", "nosql"],
     "type": "library",
     "license": "MIT",
     "authors": [
@@ -11,8 +11,15 @@
         }
     ],
     "require": {
-        "php": "^5.4|^7.0",
-        "ext-tarantool": "*"
+        "php": "^5.4|^7.0"
+    },
+    "require-dev": {
+        "rybakit/msgpack": "@dev",
+        "tarantool/client": "@dev"
+    },
+    "suggest": {
+        "ext-tarantool": "For using pecl extension",
+        "tarantool/client": "For using pure client"
     },
     "autoload": {
         "psr-4": {
@@ -23,10 +30,5 @@
         "psr-4": {
             "Tarantool\\Queue\\Tests\\": "tests/"
         }
-    },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "1.0.x-dev"
-        }
     }
 }

dockerfile.sh

@@ -1,28 +1,38 @@
 #!/usr/bin/env bash
 
-if [[ -z "$PHP_RUNTIME" ]] ; then
-    PHP_RUNTIME='php:5.6-cli'
+if [[ -z "$IMAGE" ]] ; then
+    IMAGE='php:7.1-cli'
+fi
+
+if [[ -z "$TNT_CLIENT" ]] ; then
+    TNT_CLIENT='pure'
 fi
 
 RUN_CMDS=''
+RUN_POST_CMDS=''
 
-if [[ $PHP_RUNTIME == php* ]]; then
+if [[ $IMAGE == php* ]]; then
     RUN_CMDS="$RUN_CMDS && \\\\\n    docker-php-ext-install zip"
-    RUN_CMDS="$RUN_CMDS && \\\\\n    git clone https://github.com/tarantool/tarantool-php.git /usr/src/php/ext/tarantool"
-    RUN_CMDS="$RUN_CMDS && \\\\\n    echo tarantool >> /usr/src/php-available-exts && docker-php-ext-install tarantool"
+    if [[ $TNT_CLIENT == pure ]]; then
+        RUN_POST_CMDS="$RUN_POST_CMDS && \\\\\n    composer require tarantool/client:@dev"
+    else
+        RUN_CMDS="$RUN_CMDS && \\\\\n    git clone https://github.com/tarantool/tarantool-php.git /usr/src/php/ext/tarantool"
+        if [[ $IMAGE == php:7* ]]; then RUN_CMDS="$RUN_CMDS && \\\\\n    git --git-dir=/usr/src/php/ext/tarantool/.git --work-tree=/usr/src/php/ext/tarantool checkout php7-v2"; fi
+        RUN_CMDS="$RUN_CMDS && \\\\\n    echo tarantool >> /usr/src/php-available-exts && docker-php-ext-install tarantool"
+    fi
 fi
 
 if [[ $PHPUNIT_OPTS =~ (^|[[:space:]])--coverage-[[:alpha:]] ]]; then
     RUN_CMDS="$RUN_CMDS && \\\\\n    pecl install xdebug && docker-php-ext-enable xdebug"
 fi
 
 echo -e "
-FROM $PHP_RUNTIME
+FROM $IMAGE
 
 RUN apt-get update && \\
     apt-get install -y git curl zlib1g-dev${RUN_CMDS} && \\
     curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer && \\
-    composer global require 'phpunit/phpunit:^4.8|^5.0'
+    composer global require 'phpunit/phpunit:^4.8|^5.0|^6.0'${RUN_POST_CMDS}
 
 ENV PATH=~/.composer/vendor/bin:\$PATH
 ENV TARANTOOL_HOST=tarantool TARANTOOL_PORT=3301

phpunit.xml.dist

@@ -10,7 +10,7 @@
      stopOnFailure="false"
      syntaxCheck="false"
      verbose="true"
-     bootstrap="vendor/autoload.php"
+     bootstrap="tests/bootstrap.php"
 >
     <php>
         <ini name="date.timezone" value="UTC" />

src/ClientAdapter.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Tarantool Queue package.
+ *
+ * (c) Eugene Leonovich <gen.work@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tarantool\Queue;
+
+use Tarantool\Client\Client;
+
+class ClientAdapter
+{
+    private $client;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    public function call($funcName, array $args = [])
+    {
+        $result = $this->client->call($funcName, $args);
+
+        return isset($result->getData()[0][0]) ? $result->getData() : [$result->getData()];
+    }
+}

src/Queue.php

@@ -11,29 +11,44 @@
 
 namespace Tarantool\Queue;
 
+use Tarantool\Client\Client;
+
 class Queue
 {
     private $client;
     private $tubeName;
-    private $prefix;
 
-    public function __construct(\Tarantool $client, $tubeName)
+    /**
+     * @param \Tarantool|\Tarantool\Client\Client $client
+     * @param string $tubeName
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function __construct($client, $tubeName)
     {
+        if ($client instanceof Client) {
+            $client = new ClientAdapter($client);
+        } else if (!$client instanceof \Tarantool) {
+            throw new \InvalidArgumentException(sprintf(
+                '%s() expects parameter 1 to be Tarantool or Tarantool\Client\Client, %s given.',
+                __METHOD__, is_object($client) ? get_class($client) : gettype($client)
+            ));
+        }
+
         $this->client = $client;
         $this->tubeName = $tubeName;
-        $this->prefix = "queue.tube.$tubeName:";
     }
 
     /**
-     * @param mixed      $data
-     * @param array|null $options
+     * @param mixed $data
+     * @param array $options
      *
      * @return Task
      */
-    public function put($data, array $options = null)
+    public function put($data, array $options = [])
     {
         $args = $options ? [$data, $options] : [$data];
-        $result = $this->client->call($this->prefix.'put', $args);
+        $result = $this->client->call("queue.tube.$this->tubeName:put", $args);
 
         return Task::createFromTuple($result[0]);
     }
@@ -46,7 +61,7 @@ public function put($data, array $options = null)
     public function take($timeout = null)
     {
         $args = null === $timeout ? [] : [$timeout];
-        $result = $this->client->call($this->prefix.'take', $args);
+        $result = $this->client->call("queue.tube.$this->tubeName:take", $args);
 
         return empty($result[0]) ? null : Task::createFromTuple($result[0]);
     }
@@ -58,21 +73,21 @@ public function take($timeout = null)
      */
     public function ack($taskId)
     {
-        $result = $this->client->call($this->prefix.'ack', [$taskId]);
+        $result = $this->client->call("queue.tube.$this->tubeName:ack", [$taskId]);
 
         return Task::createFromTuple($result[0]);
     }
 
     /**
-     * @param int        $taskId
-     * @param array|null $options
+     * @param int $taskId
+     * @param array $options
      *
      * @return Task
      */
-    public function release($taskId, array $options = null)
+    public function release($taskId, array $options = [])
     {
         $args = $options ? [$taskId, $options] : [$taskId];
-        $result = $this->client->call($this->prefix.'release', $args);
+        $result = $this->client->call("queue.tube.$this->tubeName:release", $args);
 
         return Task::createFromTuple($result[0]);
     }
@@ -84,7 +99,7 @@ public function release($taskId, array $options = null)
      */
     public function peek($taskId)
     {
-        $result = $this->client->call($this->prefix.'peek', [$taskId]);
+        $result = $this->client->call("queue.tube.$this->tubeName:peek", [$taskId]);
 
         return Task::createFromTuple($result[0]);
     }
@@ -96,7 +111,7 @@ public function peek($taskId)
      */
     public function bury($taskId)
     {
-        $result = $this->client->call($this->prefix.'bury', [$taskId]);
+        $result = $this->client->call("queue.tube.$this->tubeName:bury", [$taskId]);
 
         return Task::createFromTuple($result[0]);
     }
@@ -108,7 +123,7 @@ public function bury($taskId)
      */
     public function kick($count)
     {
-        $result = $this->client->call($this->prefix.'kick', [$count]);
+        $result = $this->client->call("queue.tube.$this->tubeName:kick", [$count]);
 
         return $result[0][0];
     }
@@ -120,14 +135,14 @@ public function kick($count)
      */
     public function delete($taskId)
     {
-        $result = $this->client->call($this->prefix.'delete', [$taskId]);
+        $result = $this->client->call("queue.tube.$this->tubeName:delete", [$taskId]);
 
         return Task::createFromTuple($result[0]);
     }
 
     public function truncate()
     {
-        $this->client->call($this->prefix.'truncate');
+        $this->client->call("queue.tube.$this->tubeName:truncate");
     }
 
     /**