add zdt feature toggle on/off (#4)

Allows a user to quickly enable/disable a feature from the ZDT

Author: tonivdv

README.md

@@ -47,7 +47,7 @@ return [
 
 To retrieve the rollout service from a zend controller:
 
-```
+```php
 <?php
 
 $rollout = $this->getServiceLocator()->get('zf2_rollout');
@@ -57,6 +57,38 @@ Refer to the documentation of [opensoft/rollout](https://github.com/opensoft/rol
 
 ## Zend Developer Toolbar
 
-The module comes with support for the zend developer toolbar. Currently the toolbar only shows the list of features and enable status for a given user.
+The module comes with support for the zend developer toolbar.
 
 ![zf2-adlogix-rollout zend developer tools](docs/rollout-zdt.png)
+
+:warning: The ZDT rollout comes with a quick toggling action, allowing the user to quickly enable/disable a feature by clicking on one of the listed feature elements in the toolbar. Make sure to only authorise these actions in development mode. :warning:
+
+An example of enabling the end points with BjyAuthorize:
+
+```php
+<?php
+
+// config/autoload/authorization.development.php
+
+use Adlogix\Zf2Rollout\Service\Controller\RolloutController;
+
+return [
+    'bjyauthorize' => [
+
+        'guards' => [
+
+            // Add this if you are adding guards on controllers
+            'BjyAuthorize\Guard\Controller' => [
+                ['controller' => RolloutController::class, 'roles' => ['guest','user']],
+            ],
+
+            // Add this if you are adding guards on routes
+            'BjyAuthorize\Guard\Route' => [
+                ['route' => 'rollout_feature_toggle', 'roles' => ['guest','user']],
+            ],
+        ],
+
+    ],
+];
+
+```

composer.json

@@ -29,23 +29,19 @@
     "zendframework/zend-mvc": "~2.7",
     "zendframework/zend-serializer": "~2.9",
     "zendframework/zend-servicemanager": "~2.7",
+    "zendframework/zend-stdlib": "~2.7",
+    "zendframework/zend-test": "~2.6",
     "doctrine/orm": "~2.5",
     "phpunit/phpunit": "~5.0"
   },
   "autoload": {
     "psr-4": {
       "Adlogix\\Zf2Rollout\\": "src/"
-    },
-    "classmap": [
-      "./"
-    ]
+    }
   },
   "autoload-dev": {
     "psr-4": {
       "Adlogix\\Zf2Rollout\\Test\\": "tests/"
-    },
-    "classmap": [
-      "./"
-    ]
+    }
   }
 }

config/module.config.php

@@ -8,6 +8,9 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
+use Adlogix\Zf2Rollout\Service\Controller\RolloutController;
+
 return [
 
     'rollout' => [
@@ -25,6 +28,21 @@
         ]
     ],
 
+    'router' => array(
+        'routes' => array(
+            'rollout_feature_toggle' => array(
+                'type' => \Zend\Mvc\Router\Http\Segment::class,
+                'options' => array(
+                    'route' => '/_rollout_toggle/:feature[/]',
+                    'defaults' => array(
+                        'controller' => RolloutController::class,
+                        'action'     => 'toggleFeature',
+                    ),
+                ),
+            ),
+        ),
+    ),
+
     'view_manager' => [
         'template_path_stack' => [
             __DIR__ . '/../view',
@@ -34,6 +52,15 @@
         ],
     ],
 
+    'controllers' => [
+
+        'factories' => [
+
+            RolloutController::class => \Adlogix\Zf2Rollout\Service\Factory\RolloutControllerFactory::class
+        ]
+
+    ],
+
     'service_manager' => [
 
         'invokables' => [
@@ -50,6 +77,7 @@
             'zf2_rollout_storage_doctrine' => Adlogix\Zf2Rollout\Service\Factory\DoctrineORMStorageFactory::class,
 
             'zf2_rollout' => Adlogix\Zf2Rollout\Service\Factory\RolloutFactory::class,
+            'zf2_rollout_user' => \Adlogix\Zf2Rollout\Service\Factory\RolloutUserFactory::class,
 
             'zf2_rollout.toolbar.collector' => \Adlogix\Zf2Rollout\Service\Factory\RolloutCollectorFactory::class
 

docs/rollout-zdt.png

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Collector;
+namespace Adlogix\Zf2Rollout\Collector;
 
 
 use Opensoft\Rollout\Rollout;

src/Collector/RolloutCollector.php

@@ -18,14 +18,14 @@
 use Zend\ModuleManager\Feature\ViewHelperProviderInterface;
 use Zend\ServiceManager\AbstractPluginManager;
 
-class Module implements ConfigProviderInterface, ViewHelperProviderInterface
+final class Module implements ConfigProviderInterface, ViewHelperProviderInterface
 {
     /**
      * {@inheritdoc}
      */
     public function getConfig()
     {
-        return include __DIR__ . '/config/module.config.php';
+        return include __DIR__ . '/../config/module.config.php';
     }
 
     /**

Module.php renamed to src/Module.php

@@ -0,0 +1,75 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\Zf2Rollout\Service\Controller;
+
+use Opensoft\Rollout\Rollout;
+use Opensoft\Rollout\RolloutUserInterface;
+use Zend\Http\Header\Referer;
+use Zend\Http\Request;
+use Zend\Mvc\Controller\AbstractActionController;
+
+/**
+ * @author Toni Van de Voorde <[email protected]>
+ */
+final class RolloutController extends AbstractActionController
+{
+    /**
+     * @var Rollout
+     */
+    private $rollout;
+
+    /**
+     * @var RolloutUserInterface
+     */
+    private $rolloutUser;
+
+    /**
+     * @param Rollout              $rollout
+     * @param RolloutUserInterface $rolloutUser
+     */
+    public function __construct(
+        Rollout $rollout,
+        RolloutUserInterface $rolloutUser
+    ) {
+        $this->rollout = $rollout;
+        $this->rolloutUser = $rolloutUser;
+    }
+
+    /**
+     * @return \Zend\Http\Response
+     */
+    public function toggleFeatureAction()
+    {
+        $feature = $this->params()->fromRoute('feature');
+
+        if ($this->rollout->isActive($feature, $this->rolloutUser)) {
+            $this->rollout->deactivateUser($feature, $this->rolloutUser);
+        } else {
+            $this->rollout->activateUser($feature, $this->rolloutUser);
+        }
+
+        return $this->redirect()->toUrl($this->getRefererUri());
+    }
+
+    /**
+     * @return string The referer URI (if not available returns '/' )
+     */
+    protected function getRefererUri()
+    {
+        /** @var Request $request */
+        $request = $this->getRequest();
+
+        $headers = $request->getHeader('Referer', '/');
+
+        return $headers instanceof Referer ? $headers->getUri() : (string)$headers;
+    }
+}

src/Service/Controller/RolloutController.php

@@ -11,11 +11,10 @@
 
 namespace Adlogix\Zf2Rollout\Service\Factory;
 
-use Collector\RolloutCollector;
+use Adlogix\Zf2Rollout\Collector\RolloutCollector;
 use Interop\Container\ContainerInterface;
 use Opensoft\Rollout\Rollout;
 use Opensoft\Rollout\RolloutUserInterface;
-use Zend\ServiceManager\Exception\ServiceNotCreatedException;
 use Zend\ServiceManager\FactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -38,26 +37,12 @@ public function createService(ServiceLocatorInterface $serviceLocator)
      */
     public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
-        /** @var array $config */
-        $config = $container->get('zf2_rollout_config');
-
 
         /** @var Rollout $rollout */
         $rollout = $container->get('zf2_rollout');
 
-        $rolloutUserServiceId = $config['user_service'];
-
-        if (!isset($rolloutUserServiceId)) {
-            throw new ServiceNotCreatedException(sprintf('You must define a service for rollout user_service.'));
-        }
-
-        if (!$container->has($rolloutUserServiceId)) {
-            throw new ServiceNotCreatedException(sprintf('Defined rollout user_service \'%s\' is not configured!',
-                $rolloutUserServiceId));
-        }
-
         /** @var RolloutUserInterface $rolloutUser */
-        $rolloutUser = $container->get($rolloutUserServiceId);
+        $rolloutUser = $container->get('zf2_rollout_user');
 
         return new RolloutCollector($rollout, $rolloutUser);
     }

src/Service/Factory/RolloutCollectorFactory.php

@@ -0,0 +1,54 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\Zf2Rollout\Service\Factory;
+
+
+use Adlogix\Zf2Rollout\Service\Controller\RolloutController;
+use Interop\Container\ContainerInterface;
+use Opensoft\Rollout\Rollout;
+use Opensoft\Rollout\RolloutUserInterface;
+use Zend\Mvc\Controller\ControllerManager;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+/**
+ * @author Toni Van de Voorde <[email protected]>
+ */
+final class RolloutControllerFactory implements FactoryInterface
+{
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        return $this($serviceLocator, null);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        if ($container instanceof ControllerManager) {
+            $container = $container->getServiceLocator();
+        }
+
+        /** @var Rollout $rollout */
+        $rollout = $container->get('zf2_rollout');
+
+        /** @var RolloutUserInterface $rolloutUser */
+        $rolloutUser = $container->get('zf2_rollout_user');
+
+        return new RolloutController($rollout, $rolloutUser);
+    }
+}

src/Service/Factory/RolloutControllerFactory.php

@@ -0,0 +1,57 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\Zf2Rollout\Service\Factory;
+
+
+use Interop\Container\ContainerInterface;
+use Opensoft\Rollout\RolloutUserInterface;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+/**
+ * @author Toni Van de Voorde <[email protected]>
+ */
+final class RolloutUserFactory implements FactoryInterface
+{
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        return $this($serviceLocator, null);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        /** @var array $config */
+        $config = $container->get('zf2_rollout_config');
+
+        $rolloutUserServiceId = $config['user_service'];
+
+        if (!isset($rolloutUserServiceId)) {
+            throw new ServiceNotCreatedException(sprintf('You must define a service for rollout user_service.'));
+        }
+
+        if (!$container->has($rolloutUserServiceId)) {
+            throw new ServiceNotCreatedException(sprintf('Defined rollout user_service \'%s\' is not configured!',
+                $rolloutUserServiceId));
+        }
+
+        /** @var RolloutUserInterface $rolloutUser */
+        return $container->get($rolloutUserServiceId);
+    }
+}