Initial commit

Author: Eugene Leonovich

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml

.travis.yml

@@ -0,0 +1,47 @@
+language: php
+
+php:
+    - 5.4
+    - 5.5
+    - 5.6
+
+before_install:
+    - curl http://tarantool.org/dist/public.key | sudo apt-key add -
+    - echo "deb http://tarantool.org/dist/master/ubuntu `lsb_release -c -s` main" | sudo tee -a /etc/apt/sources.list.d/tarantool.list
+    - sudo apt-get update
+
+install:
+    - sudo apt-get -y install tarantool php5-tarantool luarocks
+
+    - mkdir ~/.luarocks
+    - echo "rocks_servers = {[[http://rocks.tarantool.org/]]}" >> ~/.luarocks/config.lua
+    - luarocks install queue
+
+    - composer install
+
+before_script:
+    - sudo cp ./tests/Integration/instance.lua /etc/tarantool/instances.enabled
+    - sudo tarantoolctl start instance
+    - >
+        for i in `seq 1 10`; do
+            if sudo tarantoolctl status instance; then
+                break;
+            fi;
+            sleep 1;
+        done
+
+script:
+    - >
+        bash -c 'if [[ 5.6 == $TRAVIS_PHP_VERSION ]]; then
+            phpunit -v --coverage-clover coverage.clover;
+        else
+            phpunit -v;
+        fi;'
+
+after_script:
+    # code-coverage for scrutinizer-ci
+    - >
+        bash -c 'if [[ 5.6 == $TRAVIS_PHP_VERSION ]]; then
+            wget https://scrutinizer-ci.com/ocular.phar;
+            php ocular.phar code-coverage:upload --format=php-clover coverage.clover;
+        fi;'

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eugene Leonovich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# Tarantool Queue
+
+[![Build Status](https://travis-ci.org/tarantool-php/queue.svg?branch=master)](https://travis-ci.org/tarantool-php/queue)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tarantool-php/queue/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tarantool-php/queue/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/tarantool-php/queue/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/tarantool-php/queue/?branch=master)
+
+
+## Installation
+
+The recommended way to install the library is through [Composer](http://getcomposer.org):
+
+```sh
+$ composer require tarantool/queue:~1.0@dev
+```
+
+
+## Usage example
+
+```php
+use Tarantool\Queue\Queue;
+
+$tarantool = new Tarantool();
+$queue = new Queue($tarantool, 'my_queue');
+
+$task = $queue->put('foo');
+$task = $queue->take(.1);
+
+$data = $task->getData();
+
+$task = $queue->ack($task->getId());
+```
+
+
+## Tests
+
+To run unit tests:
+
+```sh
+$ phpunit --testsuite Unit
+```
+
+To run integration tests:
+
+```sh
+$ phpunit --testsuite Integration
+```
+
+To run all tests:
+
+```sh
+$ phpunit
+
+```
+
+## License
+
+The library is released under the MIT License. See the bundled [LICENSE](LICENSE) file for details.

composer.json

@@ -0,0 +1,32 @@
+{
+    "name": "tarantool/queue",
+    "description": "PHP bindings for Tarantool Queue.",
+    "keywords": ["queue", "schedule", "delayed", "priority", "ttl", "ttr", "task", "job", "tarantool"],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Eugene Leonovich",
+            "email": "gen.work@gmail.com"
+        }
+    ],
+    "require": {
+        "php": ">=5.4.0",
+        "ext-tarantool": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "Tarantool\\Queue\\": "src/"
+        }
+    },
+    "autoload-dev" : {
+        "psr-4": {
+            "Tarantool\\Queue\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+     backupStaticAttributes="false"
+     colors="true"
+     convertErrorsToExceptions="true"
+     convertNoticesToExceptions="true"
+     convertWarningsToExceptions="true"
+     processIsolation="false"
+     stopOnFailure="false"
+     syntaxCheck="false"
+     verbose="true"
+     bootstrap="vendor/autoload.php"
+>
+    <php>
+        <ini name="date.timezone" value="UTC" />
+
+        <env name="TNT_HOST" value="127.0.0.1" />
+        <env name="TNT_PORT" value="3301" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>tests/Unit</directory>
+        </testsuite>
+
+        <testsuite name="Integration">
+            <directory>tests/Integration</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Queue.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Tarantool\Queue;
+
+class Queue
+{
+    private $client;
+    private $prefix;
+
+    public function __construct(\Tarantool $client, $tubeName)
+    {
+        $this->client = $client;
+        $this->prefix = "queue.tube.$tubeName:";
+    }
+
+    /**
+     * @param mixed      $data
+     * @param array|null $options
+     *
+     * @return Task
+     */
+    public function put($data, array $options = null)
+    {
+        $result = $this->client->call($this->prefix.'put', [$data, (array) $options]);
+
+        return Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int|null $timeout
+     *
+     * @return Task|null
+     */
+    public function take($timeout = null)
+    {
+        $options = null === $timeout ? [] : [(float) $timeout];
+        $result = $this->client->call($this->prefix.'take', $options);
+
+        return empty($result[0]) ? null : Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int $taskId
+     *
+     * @return Task
+     */
+    public function ack($taskId)
+    {
+        $result = $this->client->call($this->prefix.'ack', [$taskId]);
+
+        return Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int        $taskId
+     * @param array|null $options
+     *
+     * @return Task
+     */
+    public function release($taskId, array $options = null)
+    {
+        $result = $this->client->call($this->prefix.'release', [$taskId, (array) $options]);
+
+        return Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int $taskId
+     *
+     * @return Task
+     */
+    public function peek($taskId)
+    {
+        $result = $this->client->call($this->prefix.'peek', [$taskId]);
+
+        return Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int $taskId
+     *
+     * @return Task
+     */
+    public function bury($taskId)
+    {
+        $result = $this->client->call($this->prefix.'bury', [$taskId]);
+
+        return Task::createFromTuple($result[0]);
+    }
+
+    /**
+     * @param int $count
+     *
+     * @return int
+     */
+    public function kick($count)
+    {
+        $result = $this->client->call($this->prefix.'kick', [$count]);
+
+        return $result[0][0];
+    }
+
+    /**
+     * @param int $taskId
+     *
+     * @return Task
+     */
+    public function delete($taskId)
+    {
+        $result = $this->client->call($this->prefix.'delete', [$taskId]);
+
+        return Task::createFromTuple($result[0]);
+    }
+}

src/States.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Tarantool\Queue;
+
+abstract class States
+{
+    const READY = 'r';
+    const TAKEN = 't';
+    const DONE = '-';
+    const BURIED = '!';
+    const DELAYED = '~';
+}

src/Task.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Tarantool\Queue;
+
+final class Task
+{
+    private $id;
+    private $type;
+    private $data;
+
+    private function __construct($id, $type, $data = null)
+    {
+        $this->id = $id;
+        $this->type = $type;
+        $this->data = $data;
+    }
+
+    public static function createFromTuple(array $tuple)
+    {
+        list($id, $state, $data) = $tuple + [2 => null];
+
+        return new self($id, $state, $data);
+    }
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    public function getData()
+    {
+        return $this->data;
+    }
+
+    public function isReady()
+    {
+        return States::READY === $this->type;
+    }
+
+    public function isTaken()
+    {
+        return States::TAKEN === $this->type;
+    }
+
+    public function isDone()
+    {
+        return States::DONE === $this->type;
+    }
+
+    public function isBuried()
+    {
+        return States::BURIED === $this->type;
+    }
+
+    public function isDelayed()
+    {
+        return States::DELAYED === $this->type;
+    }
+}