Update documentation

Author: vcorre

README.md

@@ -1,4 +1,4 @@
-## LeezyPheanstalkBundle
+## PheanstalkBundle
 
 [![Packagist Version](https://img.shields.io/packagist/v/pyrowman/pheanstalk-bundle)](https://packagist.org/packages/pyrowman/pheanstalk-bundle)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/?branch=master)
@@ -7,12 +7,12 @@
 
 [EvQueue workqueue](http://www.evqueue.net/) clients for Symfony3.
 
-The Pyrowman\LeezyPheanstalkBundle is a fork from [LeezyPheanstalkBundle](https://github.com/armetiz/LeezyPheanstalkBundle) 
+The Pyrowman\PheanstalkBundle is a fork from [LeezyPheanstalkBundle](https://github.com/armetiz/LeezyPheanstalkBundle) 
 
-The Pyrowman\LeezyPheanstalkBundle is a Symfony3 Bundle that provides a [pheanstalk](https://github.com/pyrowman/pheanstalk) integration with the following features:
+The Pyrowman\PheanstalkBundle is a Symfony3 Bundle that provides a [pheanstalk](https://github.com/pyrowman/pheanstalk) integration with the following features:
 * Command Line Interface for manage the queues.
 * An integration to the Symfony3 event system.
-* An integration to the Symfony3 profiler system to monitor your beanstalk server.
+* An integration to the Symfony3 profiler system to monitor your evqueue server.
 * An integration to the Symfony3 logger system.
 * A proxy system to customize the command features.
 * Auto-wiring: `PheanstalkInterface`
@@ -24,8 +24,6 @@ Documentation :
 - [CLI Usage](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/3-cli.md)
 - [Events](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/4-events.md)
 - [Custom proxy](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/5-custom-proxy.md)
-- [Extra - Beanstalk Manager](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/6-extra-beanstalk-manager.md)
-- [Extra - Proxy to prefix tubes](https://github.com/h4cc/LeezyPheanstalkBundleExtra)
 
 ## Usage example
 
@@ -34,15 +32,20 @@ Documentation :
 
 namespace Acme\DemoBundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Pheanstalk\Structure\Schedule;
+use Pheanstalk\Structure\TimeSchedule;
+use Pyrowman\PheanstalkBundle\Proxy\PheanstalkProxy;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
-class HomeController extends Controller {
+class HomeController extends AbstractController 
+{
 
     public function indexAction() {
 
         $sc = $this->get('service_container');
         /** @var PheanstalkProxy $pheanstalk */
-        $pheanstalk = $sc->get("leezy.pheanstalk");
+        $pheanstalk = $sc->get("pheanstalk");
 
         // Create a simple Worflow with one task inside
 
@@ -59,8 +62,8 @@ class HomeController extends Controller {
 
         //-----------------------------------------
         // Add a scheduler for the job (by default in continous)
-        
-        $workflowSchedule = $pheanstalk->createSchedule($workflow, new TimeSchedule());
+        $schedule = new Schedule($workflow->getId(), new TimeSchedule());
+        $workflowSchedule = $pheanstalk->createSchedule($schedule);
 
         //-----------------------------------------
         // Edit a workflow
@@ -97,8 +100,21 @@ class HomeController extends Controller {
 ## Testing
 
 ```bash
-$ php composer.phar update
-$ phpunit
+# ensure you have Composer set up
+$ wget http://getcomposer.org/composer.phar
+$ php composer.phar install
+
+$ bin/phpunit 
+PHPUnit 7.1.2 by Sebastian Bergmann and contributors.
+
+..........................................................        58 / 58 (100%)
+
+Time: 11.36 seconds, Memory: 16.00 MB
+
+OK (58 tests, 98 assertions)
+
+Generating code coverage report in HTML format ... done
+
 ```
 
 ## License

phpunit.xml.dist

@@ -9,7 +9,7 @@
         <!--<log type="junit" target="build/logs/junit.xml"/>-->
     </logging>
     <testsuites>
-        <testsuite name="LeezyPheanstalkBundle test suite">
+        <testsuite name="PheanstalkBundle test suite">
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>

src/DependencyInjection/Configuration.php

@@ -39,7 +39,7 @@ public function getConfigTreeBuilder()
                         ->end()
                         ->scalarNode('port')
                             ->cannotBeEmpty()
-                            ->defaultValue('11300')
+                            ->defaultValue('5000')
                         ->end()
                         ->scalarNode('user')
                             ->cannotBeEmpty()

src/Resources/doc/1-installation.md

@@ -2,16 +2,16 @@
 
 Installation is a quick 3 step process:
 
-1. Download LeezyPheanstalkBundle using composer
+1. Download PheanstalkBundle using composer
 2. Enable the Bundle
 3. Configure your application's config.yml
 
-### Step 1: Require LeezyPheanstalkBundle
+### Step 1: Require PheanstalkBundle
 
 Tell composer to require this bundle by running:
 
 ``` bash
-$ composer require leezy/pheanstalk-bundle
+$ composer require pyrowman/pheanstalk-bundle
 ```
 
 ### Step 2: Enable the bundle
@@ -26,7 +26,7 @@ public function registerBundles()
 {
     $bundles = array(
         // ...
-        new Leezy\PheanstalkBundle\LeezyPheanstalkBundle(),
+        new Pyrowman\PheanstalkBundle\PheanstalkBundle(),
     );
 }
 ```
@@ -37,9 +37,11 @@ Finally, add the following to your config.yml
 
 ``` yaml
 # app/config/config.yml
-leezy_pheanstalk:
+pheanstalk:
     pheanstalks:
         primary:
-            server: beanstalkd.domain.tld
+            server: evqueue.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             default: true
 ```

src/Resources/doc/2-configuration.md

@@ -3,49 +3,57 @@
 This bundle can be configured, and this is the list of what you can do :
 * Create many pheanstalk client.
 * Define specific server / host for each connection.
-* Define specific port for each connection. This option is optional and default value is 11300.
+* Define specific port for each connection. This option is optional and default value is 5000.
 * Define specific timeout for each connection. Timeout refere to the connection timeout. This option is optional and default value is 60.
 * Use custom proxy for pheanstalk client.
 * Disable this bundle. This options is optional and default value is true.
 
 ``` yaml
 # app/config/config.yml
-leezy_pheanstalk:
+pheanstalk:
     pheanstalks:
         primary:
-            server: beanstalkd.domain.tld
+            server: evqueue.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             port: 11300
             timeout: 60
         secondary:
-            server: beanstalkd-2.domain.tld
+            server: evqueue-2.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             default: true
             proxy: acme.pheanstalk
     profiler:
         enabled: true
-        template: 'LeezyPheanstalkBundle:Profiler:pheanstalk.html.twig'
+        template: 'PheanstalkBundle:Profiler:pheanstalk.html.twig'
 ```
 
-*acme.pheanstalk* is a custom proxy which implements the *Leezy\PheanstalkBundle\Proxy\PheanstalkProxyInterface* interface.
+*acme.pheanstalk* is a custom proxy which implements the *PyRowMan\PheanstalkBundle\Proxy\PheanstalkProxyInterface* interface.
 
 **Note:**
 ```
-    You can retreive each pheanstalk using the container with "leezy.pheanstalk.[pheanstalk_name]".
-    When you define a "default" pheanstalk. You can have a direct access to it with "leezy.pheanstalk".
+    You can retreive each pheanstalk using the container with "pheanstalk.[pheanstalk_name]".
+    When you define a "default" pheanstalk. You can have a direct access to it with "pheanstalk".
 ```
 
-``` php
+```php
 <?php
 
 namespace Acme\DemoBundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Pheanstalk\Structure\Schedule;
+use Pheanstalk\Structure\TimeSchedule;
+use Pyrowman\PheanstalkBundle\Proxy\PheanstalkProxy;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
-class HomeController extends Controller
+class HomeController extends AbstractController 
 {
     public function indexAction()
     {
-        $pheanstalkPrimary = $this->get("leezy.pheanstalk.primary");
-        $pheanstalkSecondary = $this->get("leezy.pheanstalk");
+        $pheanstalkPrimary = $this->get("pheanstalk.primary");
+        $pheanstalkSecondary = $this->get("pheanstalk");
 
         // ----------------------------------------
         // producer (queues jobs) on beanstalk.domain.tld
@@ -68,7 +76,7 @@ class HomeController extends Controller
 
         // ----------------------------------------
         // on each defined pheanstalks
-        $pheanstalkLocator = $this->get("leezy.pheanstalk.pheanstalk_locator");
+        $pheanstalkLocator = $this->get("pheanstalk.pheanstalk_locator");
 
         foreach ($pheanstalkLocator->getPheanstalks() as $pheanstalk) {
             $pheanstalk

src/Resources/doc/3-cli.md

@@ -1,107 +1,19 @@
-## LeezyPheanstalkBundle Command Line Tools
+## PheanstalkBundle Command Line Tools
 
-The LeezyPheanstalkBundle provides a number of command line utilities. 
+The PheanstalkBundle provides a number of command line utilities. 
 Commands are available for the following tasks:
 
-1. Delete a job.
-2. Flush a tube.
-3. List available tubes.
-4. Pause a tube.
-5. Peek a tube to get the first ready/burried job and associated data.
-6. Peek a job and get associated data.
-7. Put a new job in a tube.
-8. Get statistics about beanstalkd server.
-9. Get statistics about a job.
-10. Get statistics about a tube.
-11. Get next ready job.
+1. Delete a workflow.
 
 **Note:**
 
 ```
-You must have correctly installed and configured the LeezyPheanstalkBundle before using 
+You must have correctly installed and configured the PheanstalkBundle before using 
 these commands.
 ```
 
-### Delete a job
+### Delete a workflow
 
 ``` bash
-$ php app/console leezy:pheanstalk:delete-job 42
+$ php app/console pyrowman:pheanstalk:delete-workflow testname testgroup
 ```
-
-### Flush a tube.
-
-``` bash
-$ php app/console leezy:pheanstalk:flush-tube your-tube
-```
-
-**Note:**
-
-```
-When you flush a tube, it will be removed from the beanstalkd server.
-```
-
-### List available tubes.
-
-``` bash
-$ php app/console leezy:pheanstalk:list-tube
-```
-
-**Note:**
-
-```
-Tubes that are display contains at least one job.
-```
-
-### Pause a tube.
-
-``` bash
-$ php app/console leezy:pheanstalk:pause-tube your-tube
-```
-
-### Peek a tube to get the first ready job and associated data.
-
-``` bash
-$ php app/console leezy:pheanstalk:peek-tube your-tube
-```
-
-### Peek a tube to get the first burried job and associated data.
-
-``` bash
-$ php app/console leezy:pheanstalk:peek-tube -b your-tube
-```
-
-### Peek a job and get associated data.
-
-``` bash
-$ php app/console leezy:pheanstalk:peek 42
-```
-
-### Put a new job in a tube.
-
-``` bash
-$ php app/console leezy:pheanstalk:put your-tube "Hello world - I am a job"
-```
-
-### Get statistics about beanstalkd server.
-
-``` bash
-$ php app/console leezy:pheanstalk:stats
-```
-
-### Get statistics about a job.
-
-``` bash
-$ php app/console leezy:pheanstalk:stats-job 42
-```
-
-### Get statistics about a tube.
-
-``` bash
-$ php app/console leezy:pheanstalk:stats-tube your-tube
-```
-
-### Get next ready job.
-
-``` bash
-$ php app/console leezy:pheanstalk:next-ready your-tube --details
-```