Merge branch 'hotfix/19-config-provider' into release-1.0.0

Close #19

Author: weierophinney

CHANGELOG.md

@@ -29,7 +29,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Removed
 
-- Nothing.
+- [#19](https://github.com/zendframework/zend-expressive-authorization/pull/19)
+  removes the file `config/authorization.php` and merges its contents into the
+  `Zend\Expressive\Authorization\ConfigProvider` class.
 
 ### Fixed
 

config/authorization.php

@@ -18,7 +18,46 @@ public function __invoke() : array
     {
         return [
             'dependencies'  => $this->getDependencies(),
-            'authorization' => include __DIR__ . '/../config/authorization.php'
+            'authorization' => $this->getAuthorizationConfig(),
+        ];
+    }
+
+    /**
+     * Returns the configuration for the AuthorizationInterface adapter
+     */
+    public function getAuthorizationConfig() : array
+    {
+        return [
+            /**
+             * Example using ZendAcl:
+             *
+             * 'roles' => [
+             *     // insert the role with parent (if any)
+             *     // e.g. 'editor' => ['admin'] (admin is parent of editor)
+             * ],
+             * 'resources' => [
+             *     // an array of resources, as string
+             * ],
+             * 'allow' => [
+             *     // for each role allow some resources
+             *     // e.g. 'admin' => ['admin.pages']
+             * ],
+             * 'deny' => [
+             *     // for each role deny some resources
+             *     // e.g. 'admin' => ['admin.pages']
+             * ],
+             *
+             * Example using ZendRbac:
+             *
+             * 'roles' => [
+             *     // insert the role with parent (if any)
+             *     // e.g. 'editor' => ['admin'] (admin is parent of editor)
+             * ],
+             * 'permissions' => [
+             *     // for each role insert one or more permissions
+             *     // e.g. 'admin' => ['admin.pages']
+             * ],
+             */
         ];
     }
 
@@ -28,8 +67,13 @@ public function __invoke() : array
     public function getDependencies() : array
     {
         return [
+            'aliases' => [
+                // Provide an alias for the AuthorizationInterface based on the adapter you are using.
+                // AuthorizationInterface::class => ZendAcl::class,
+                // AuthorizationInterface::class => ZendRbac::class,
+            ],
             'factories' => [
-                AuthorizationMiddleware::class => AuthorizationMiddlewareFactory::class
+                AuthorizationMiddleware::class => AuthorizationMiddlewareFactory::class,
             ],
         ];
     }

src/ConfigProvider.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive-authorization for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive-authorization/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace ZendTest\Expressive\Authorization;
+
+use PHPUnit\Framework\TestCase;
+use Zend\Expressive\Authorization\AuthorizationMiddleware;
+use Zend\Expressive\Authorization\ConfigProvider;
+
+class ConfigProviderTest extends TestCase
+{
+    /** @var ConfigProvider */
+    private $provider;
+
+    protected function setUp()
+    {
+        $this->provider = new ConfigProvider();
+    }
+
+    public function testProviderDefinesExpectedFactoryServices()
+    {
+        $config = $this->provider->getDependencies();
+        $factories = $config['factories'];
+
+        $this->assertArrayHasKey(AuthorizationMiddleware::class, $factories);
+    }
+
+    public function testInvocationReturnsArrayWithDependencies()
+    {
+        $config = ($this->provider)();
+
+        $this->assertInternalType('array', $config);
+        $this->assertArrayHasKey('authorization', $config);
+        $this->assertInternalType('array', $config['authorization']);
+
+        $this->assertArrayHasKey('dependencies', $config);
+        $this->assertInternalType('array', $config['dependencies']);
+        $this->assertArrayHasKey('aliases', $config['dependencies']);
+        $this->assertArrayHasKey('factories', $config['dependencies']);
+    }
+}