Merge branch 'feature/fix-tests'

CakeDC · Feb 6, 2016 · dbe0823 · dbe0823
2 parents 574dbe2 + 7e593c9
commit dbe0823
Show file tree

Hide file tree

Showing 39 changed files with 198 additions and 150 deletions.
diff --git a/Docs/Documentation/Configuration.md b/Docs/Documentation/Configuration.md
@@ -10,9 +10,11 @@ config/bootstrap.php
 ```
 Configure::write('Users.config', ['users']);
 Plugin::load('CakeDC/Users', ['routes' => true, 'bootstrap' => true]);
+Configure::write('Users.Social.login', true); //to enable social login
 ```
 
 Then in your config/users.php
+
 ```
 'Opauth.providers' => [
         'facebook' => [
@@ -102,7 +104,7 @@ NOTE: SOME keys were hidden in this doc page, please refer to `vendor/cakedc/use
         ],
         'Social' => [
             //enable social login
-            'login' => true,
+            'login' => false,
         ],
         //Avatar placeholder
         'Avatar' => ['placeholder' => 'CakeDC/Users.avatar_placeholder.png'],

diff --git a/Docs/Documentation/Installation.md b/Docs/Documentation/Installation.md
@@ -5,7 +5,7 @@ Composer
 ------
 
 ```
-composer require cakedc/users:3.1.*
+composer require cakedc/users
 ```
 
 if you want to use social login features...
@@ -16,7 +16,13 @@ composer require league/oauth2-facebook:*
 composer require league/oauth2-instagram:*
 composer require league/oauth2-google:*
 composer require league/oauth2-linkedin:*
+```
+
+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.
 
+```
+Configure::write('Users.Social.login', true); //to enable social login
 ```
 
 Creating Required Tables
@@ -47,6 +53,7 @@ config/bootstrap.php
 ```
 Configure::write('Users.config', ['users']);
 Plugin::load('CakeDC/Users', ['routes' => true, 'bootstrap' => true]);
+Configure::write('Users.Social.login', true); //to enable social login
 ```
 
 Then in your config/users.php

diff --git a/Docs/Documentation/SocialAuthenticate.md b/Docs/Documentation/SocialAuthenticate.md
@@ -27,7 +27,7 @@ Configure::write('Users', [
     ],
     'Social' => [
         //enable social login
-        'login' => true,
+        'login' => false,
     ],
     'Key' => [
         'Session' => [

diff --git a/README.md b/README.md
@@ -44,8 +44,8 @@ Another decision made was limiting the plugin dependencies on other packages as
 Requirements
 ------------
 
-* CakePHP 3.1.*
-* PHP 5.4.16+
+* CakePHP 3.1+
+* PHP 5.4.16+ Note CakePHP 3.2 requires PHP 5.5 so 5.4 compatibility would be dropped sooner than later...
 
 Documentation
 -------------
@@ -55,11 +55,14 @@ For documentation, as well as tutorials, see the [Docs](Docs/Home.md) directory
 Roadmap
 ------
 
+
+* 3.1.4 << you are here
+  * SocialAuthenticate refactored to drop Opauth in favor of Muffin/OAuth2 and league/oauth2
+* 3.1.3
+  * UserHelper improvements
 * 3.1.2
-  * Add Google authentication
-  * Add Instagram authentication
-  * Improve unit test coverage
-* YOU ARE HERE > 3.1.0 Migration to CakePHP 3.0
+  * Fixes in RBAC permission matchers
+* 3.1.0 Migration to CakePHP 3.0
   * Unit test coverage improvements
   * Refactor UsersTable to Behavior
   * Add google authentication

diff --git a/composer.json b/composer.json
@@ -4,11 +4,13 @@
     "type": "cakephp-plugin",
     "require": {
         "php": ">=5.4.16",
-        "cakephp/cakephp": "~3.1"
+        "cakephp/cakephp": "~3.1",
+        "muffin/oauth2": "dev-master",
+        "league/oauth1-client": "@stable"
     },
     "require-dev": {
         "phpunit/phpunit": "*",
-        "muffin/oauth2": "dev-master"
+        "cakephp/cakephp-codesniffer": "^2.0"
     },
     "suggest": {
         "league/oauth2-facebook": "Provide Social Authentication with Facebook",

diff --git a/config/users.php b/config/users.php
@@ -39,7 +39,7 @@
         ],
         'Social' => [
             //enable social login
-            'login' => true,
+            'login' => false,
         ],
         'Profile' => [
             //Allow view other users profiles

diff --git a/src/Auth/SimpleRbacAuthorize.php b/src/Auth/SimpleRbacAuthorize.php
@@ -168,7 +168,7 @@ public function authorize($user, Request $request)
      * @param array $user current user array
      * @param string $role effective role for the current user
      * @param Request $request request
-     * @return bool true if there is a match in permissisons
+     * @return bool true if there is a match in permissions
      */
     protected function _checkRules(array $user, $role, Request $request)
     {

diff --git a/src/Auth/Social/Mapper/AbstractMapper.php b/src/Auth/Social/Mapper/AbstractMapper.php
@@ -1,15 +1,22 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/16/15
- * Time: 7:02 AM
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
 
 use Cake\Utility\Hash;
 
+/**
+ * AbstractMapper
+ *
+ */
 abstract class AbstractMapper
 {
     /**
@@ -46,8 +53,8 @@ abstract class AbstractMapper
     /**
      * Constructor
      *
-     * @param $rawData
-     * @param null $mapFields
+     * @param mixed $rawData raw data
+     * @param mixed $mapFields map fields
      */
     public function __construct($rawData, $mapFields = null)
     {
@@ -59,6 +66,8 @@ public function __construct($rawData, $mapFields = null)
     }
     /**
      * Invoke method
+     *
+     * @return mixed
      */
     public function __invoke()
     {
@@ -67,6 +76,7 @@ public function __invoke()
 
     /**
      * If email is present the user is validated
+     *
      * @return bool
      */
     protected function _validated()

diff --git a/src/Auth/Social/Mapper/Facebook.php b/src/Auth/Social/Mapper/Facebook.php
@@ -1,9 +1,22 @@
 <?php
+/**
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
 
 use Cake\Utility\Hash;
 
+/**
+ * Facebook Mapper
+ *
+ */
 class Facebook extends AbstractMapper
 {
 

diff --git a/src/Auth/Social/Mapper/Google.php b/src/Auth/Social/Mapper/Google.php
@@ -1,13 +1,20 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/16/15
- * Time: 7:02 AM
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
 
+/**
+ * Google Mapper
+ *
+ */
 class Google extends AbstractMapper
 {
     /**

diff --git a/src/Auth/Social/Mapper/Instagram.php b/src/Auth/Social/Mapper/Instagram.php
@@ -1,15 +1,22 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/16/15
- * Time: 7:02 AM
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
 
 use Cake\Utility\Hash;
 
+/**
+ * Instagram Mapper
+ *
+ */
 class Instagram extends AbstractMapper
 {
     /**

diff --git a/src/Auth/Social/Mapper/LinkedIn.php b/src/Auth/Social/Mapper/LinkedIn.php
@@ -1,9 +1,12 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/16/15
- * Time: 7:02 AM
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
@@ -22,4 +25,4 @@ class LinkedIn extends AbstractMapper
         'bio' => 'headline',
         'link' => 'publicProfileUrl'
     ];
-}
+}
diff --git a/src/Auth/Social/Mapper/Twitter.php b/src/Auth/Social/Mapper/Twitter.php
@@ -1,16 +1,22 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/16/15
- * Time: 7:02 AM
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
 namespace CakeDC\Users\Auth\Social\Mapper;
 
-
 use Cake\Utility\Hash;
 
+/**
+ * Twitter Mapper
+ *
+ */
 class Twitter extends AbstractMapper
 {
 
@@ -42,4 +48,4 @@ protected function _link()
     {
         return self::TWITTER_BASE_URL . Hash::get($this->_rawData, $this->_mapFields['username']);
     }
-}
+}
diff --git a/src/Auth/Social/Util/SocialUtils.php b/src/Auth/Social/Util/SocialUtils.php
@@ -1,25 +1,34 @@
 <?php
+/**
+ * Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright Copyright 2010 - 2015, Cake Development Corporation (http://cakedc.com)
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+
 namespace CakeDC\Users\Auth\Social\Util;
 
 use League\OAuth2\Client\Provider\AbstractProvider;
 use ReflectionClass;
 
 /**
- * Created by PhpStorm.
- * User: ajibarra
- * Date: 10/17/15
- * Time: 3:45 PM
+ * Social Utils
+ *
  */
 class SocialUtils
 {
     /**
      * Get provider from classname
-     * @param AbstractProvider $provider
+     *
+     * @param AbstractProvider $provider provider
      * @return string
      */
     public static function getProvider(AbstractProvider $provider)
     {
         $reflect = new ReflectionClass($provider);
         return $reflect->getShortName();
     }
-}
+}