Merge pull request #530 from CakeDC/develop

Upgrade to CakePHP 3.4

Author: steinkel

Diff for: .semver

@@ -1,5 +1,5 @@
 ---
-:major: 4
-:minor: 1
-:patch: 3
+:major: 5
+:minor: 0
+:patch: 0
 :special: ''

Diff for: CHANGELOG.md

@@ -4,6 +4,16 @@ Changelog
 Releases for CakePHP 3
 -------------
 
+* 5.0.0
+  * Some Auth objects refactored into https://github.com/CakeDC/auth
+  * Upgrade to CakePHP 3.4
+
+* 4.2.1
+  * Improvements in unit tests
+
+* 4.2.0
+  * New configuration param `Users.Registration.defaultRole` to set the default role on user registration or addUser Shell action
+
 * 4.1.3
   * Configurable rememberMe checkbox status
   * Update brazilian portuguese translations

Diff for: CONTRIBUTING.md

@@ -1,4 +1,4 @@
 Contributing
 ============
 
-This repository follows the [CakeDC Plugin Standard](http://cakedc.com/plugin-standard). If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our [Contribution Guidelines](http://cakedc.com/contribution-guidelines) for detailed instructions.
+This repository follows the [CakeDC Plugin Standard](https://www.cakedc.com/plugin-standard). If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our [Contribution Guidelines](https://www.cakedc.com/contribution-guidelines) for detailed instructions.

Diff for: Docs/Documentation/ApiKeyAuthenticate.md

@@ -69,40 +69,44 @@ NOTE: SOME keys were hidden in this doc page, please refer to `vendor/cakedc/use
 
 ```
     'Users' => [
-        //Table used to manage users
+        // Table used to manage users
         'table' => 'CakeDC/Users.Users',
-        //configure Auth component
+        // Controller used to manage users plugin features & actions
+        'controller' => 'CakeDC/Users.Users',
+        // configure Auth component
         'auth' => true,
         'Email' => [
-            //determines if the user should include email
+            // determines if the user should include email
             'required' => true,
-            //determines if registration workflow includes email validation
+            // determines if registration workflow includes email validation
             'validate' => true,
         ],
         'Registration' => [
-            //determines if the register is enabled
+            // determines if the register is enabled
             'active' => true,
-            //determines if the reCaptcha is enabled for registration
+            // determines if the reCaptcha is enabled for registration
             'reCaptcha' => true,
             //ensure user is active (confirmed email) to reset his password
-            'ensureActive' => false
+            'ensureActive' => false,
+            // default role name used in registration
+            'defaultRole' => 'user',
         ],
         'Tos' => [
-            //determines if the user should include tos accepted
+            // determines if the user should include tos accepted
             'required' => true,
         ],
         'Social' => [
-            //enable social login
+            // enable social login
             'login' => false,
         ],
-        //Avatar placeholder
+        // Avatar placeholder
         'Avatar' => ['placeholder' => 'CakeDC/Users.avatar_placeholder.png'],
         'RememberMe' => [
-            //configure Remember Me component
+            // configure Remember Me component
             'active' => true,
         ],
     ],
-//default configuration used to auto-load the Auth Component, override to change the way Auth works
+// default configuration used to auto-load the Auth Component, override to change the way Auth works
     'Auth' => [
         'authenticate' => [
             'all' => [
@@ -112,8 +116,8 @@ NOTE: SOME keys were hidden in this doc page, please refer to `vendor/cakedc/use
             'Form',
         ],
         'authorize' => [
-            'CakeDC/Users.Superuser',
-            'CakeDC/Users.SimpleRbac',
+            'CakeDC/Auth.Superuser',
+            'CakeDC/Auth.SimpleRbac',
         ],
     ],
 ];
@@ -126,11 +130,12 @@ Default Authenticate and Authorize Objects used
 Using the UsersAuthComponent default initialization, the component will load the following objects into AuthComponent:
 * Authenticate
   * 'Form'
-  * 'Social' check [SocialAuthenticate](SocialAuthenticate.md) for configuration options
-  * 'RememberMe' check [SocialAuthenticate](RememberMeAuthenticate.md) for configuration options
+  * 'CakeDC/Users.Social' check [SocialAuthenticate](SocialAuthenticate.md) for configuration options
+  * 'CakeDC/Auth.RememberMe' check [RememberMeAuthenticate](https://github.com/CakeDC/auth/blob/master/src/RememberMeAuthenticate.php) for configuration options
 * Authorize
-  * 'Users.Superuser' check [SuperuserAuthorize](SuperuserAuthorize.md) for configuration options
-  * 'Users.SimpleRbac' check [SimpleRbacAuthorize](SimpleRbacAuthorize.md) for configuration options
+  * 'CakeDC/Auth.Superuser' check [SuperuserAuthorize](https://github.com/CakeDC/auth/blob/master/Docs/Documentation/SuperuserAuthorize.md) for configuration options
+  * 'CakeDC/Auth.SimpleRbac' check [SimpleRbacAuthorize](https://github.com/CakeDC/auth/blob/master/Docs/Documentation/SimpleRbacAuthorize.md) for configuration options
+  * 'CakeDC/Auth.ApiKey' check [ApiKeyAuthenticate](https://github.com/CakeDC/auth/blob/master/Docs/Documentation/ApiKeyAuthenticate.md) for configuration options
 
 ## Using the user's email to login
 
@@ -141,12 +146,12 @@ You need to configure 2 things:
 Configure::write('Auth.authenticate.Form.fields.username', 'email');
 ```
 
-* Override the login.ctp template to change the Form->input to "email". Add (or copy from the https://github.com/CakeDC/users/blob/master/src/Template/Users/login.ctp) the file login.ctp to path /src/Template/Plugin/CakeDC/Users/Users/login.ctp and ensure it has the following content
+* Override the login.ctp template to change the Form->control to "email". Add (or copy from the https://github.com/CakeDC/users/blob/master/src/Template/Users/login.ctp) the file login.ctp to path /src/Template/Plugin/CakeDC/Users/Users/login.ctp and ensure it has the following content
 
 ```php
         // ... inside the Form
-        <?= $this->Form->input('email', ['required' => true]) ?>
-        <?= $this->Form->input('password', ['required' => true]) ?>
+        <?= $this->Form->control('email', ['required' => true]) ?>
+        <?= $this->Form->control('password', ['required' => true]) ?>
         // ... rest of your login.ctp code
 ```
 

Diff for: Docs/Documentation/Configuration.md

@@ -83,6 +83,8 @@ Extending the Controller
 You want to use one of your controllers to handle all the users features in your app, and keep the
 login/register/etc actions from Users Plugin,
 
+First create a new controller class:
+
 ```php
 <?php
 namespace App\Controller;
@@ -103,6 +105,16 @@ class MyUsersController extends AppController
 }
 ```
 
+Don't forget to update the `Users.controller` configuration in `users.php`
+
+```php
+    'Users' => [
+        // ...
+        // Controller used to manage users plugin features & actions
+        'controller' => 'MyUsers',
+        // ...
+```
+
 Note you'll need to **copy the Plugin templates** you need into your project src/Template/MyUsers/[action].ctp
 
 Extending the Features in your controller

Diff for: Docs/Documentation/Extending-the-Plugin.md

@@ -19,7 +19,7 @@ composer require league/oauth1-client:@stable
 ```
 
 NOTE: you'll need to enable social login in your bootstrap.php file if you want to use it, social
-login is disabled by default. Check the [Configuration](Configuration.md) page for more details.
+login is disabled by default. Check the [Configuration](Configuration.md#configuration-for-social-login) page for more details.
 
 ```
 Configure::write('Users.Social.login', true); //to enable social login

Diff for: Docs/Documentation/Installation.md

@@ -0,0 +1,41 @@
+Migration 4.1.x to 5.0
+======================
+
+5.0 is compatible with CakePHP ^3.4 and refactored some Auth objects into a new plugin
+* Fix your Users configuration file for Auth object references
+
+in `users.php`
+
+```php
+$config = [
+    // ...
+    'Auth' => [
+        // ...
+        'authenticate' => [
+            'all' => [
+                'finder' => 'auth',
+            ],
+            'CakeDC/Auth.ApiKey',
+            'CakeDC/Auth.RememberMe',
+            'Form',
+        ],
+        'authorize' => [
+            'CakeDC/Auth.Superuser',
+            'CakeDC/Auth.SimpleRbac',
+        ],
+        // ...
+```
+
+* Add a new configuration key to specify the controller name you are using to handle auth in your project
+
+in `users.php`
+
+```php
+$config = [
+    'Users' => [
+        // ...
+        // Controller used to manage users plugin features & actions
+        'controller' => 'CakeDC/Users.Users',
+        // ...
+```
+