Merge pull request #26 from ADmad/analysis-qMEBvq

Applied fixes from StyleCI

Author: ADmad

src/Auth/JwtAuthenticate.php

@@ -6,7 +6,6 @@
 use Cake\Core\Configure;
 use Cake\Network\Request;
 use Cake\Network\Response;
-use Cake\ORM\TableRegistry;
 use Cake\Utility\Security;
 use Exception;
 use Firebase\JWT\JWT;
@@ -28,28 +27,28 @@
  *
  * @copyright 2015 ADmad
  * @license MIT
+ *
  * @see http://jwt.io
  * @see http://tools.ietf.org/html/draft-ietf-oauth-json-web-token
  */
 class JwtAuthenticate extends BaseAuthenticate
 {
-
     /**
-     * Parsed token
+     * Parsed token.
      *
      * @var string|null
      */
     protected $_token;
 
     /**
-     * Payload data
+     * Payload data.
      *
      * @var object|null
      */
     protected $_payload;
 
     /**
-     * Exception
+     * Exception.
      *
      * @var \Exception
      */
@@ -104,6 +103,7 @@ public function __construct(ComponentRegistry $registry, $config)
      *
      * @param \Cake\Network\Request $request The request object.
      * @param \Cake\Network\Response $response Response object.
+     *
      * @return bool|array User record array or false on failure.
      */
     public function authenticate(Request $request, Response $response)
@@ -115,6 +115,7 @@ public function authenticate(Request $request, Response $response)
      * Get user record based on info available in JWT.
      *
      * @param \Cake\Network\Request $request Request object.
+     *
      * @return bool|array User record array or false on failure.
      */
     public function getUser(Request $request)
@@ -135,13 +136,15 @@ public function getUser(Request $request)
         }
 
         unset($user[$this->_config['fields']['password']]);
+
         return $user;
     }
 
     /**
-     * Get payload data
+     * Get payload data.
      *
      * @param \Cake\Network\Request|null $request Request instance or null
+     *
      * @return object|null Payload object on success, null on failurec
      */
     public function getPayload($request = null)
@@ -164,6 +167,7 @@ public function getPayload($request = null)
      * Get token from header or query string.
      *
      * @param \Cake\Network\Request|null $request Request object.
+     *
      * @return string|null Token string if found else null.
      */
     public function getToken($request = null)
@@ -190,12 +194,14 @@ public function getToken($request = null)
      * Decode JWT token.
      *
      * @param string $token JWT token to decode.
+     *
      * @return object|null The JWT's payload as a PHP object, null on failure.
      */
     protected function _decode($token)
     {
         try {
             $payload = JWT::decode($token, Security::salt(), $this->_config['allowedAlgs']);
+
             return $payload;
         } catch (Exception $e) {
             if (Configure::read('debug')) {
@@ -212,9 +218,11 @@ protected function _decode($token)
      *
      * @param \Cake\Network\Request $request A request object.
      * @param \Cake\Network\Response $response A response object.
-     * @return void
+     *
      * @throws \Cake\Network\Exception\UnauthorizedException Or any other
      *   configured exception.
+     *
+     * @return void
      */
     public function unauthenticated(Request $request, Response $response)
     {

tests/Fixture/GroupsFixture.php

@@ -4,25 +4,23 @@
 use Cake\TestSuite\Fixture\TestFixture;
 
 /**
- * Class GroupsFixture
- *
+ * Class GroupsFixture.
  */
 class GroupsFixture extends TestFixture
 {
-
     /**
-     * fields property
+     * fields property.
      *
      * @var array
      */
     public $fields = [
         'id' => ['type' => 'integer'],
         'title' => ['type' => 'string'],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**
-     * records property
+     * records property.
      *
      * @var array
      */

tests/Fixture/UsersFixture.php

@@ -6,7 +6,7 @@
 class UsersFixture extends TestFixture
 {
     /**
-     * fields property
+     * fields property.
      *
      * @var array
      */
@@ -18,29 +18,29 @@ class UsersFixture extends TestFixture
         'password' => ['type' => 'string', 'null' => false],
         'created' => 'datetime',
         'updated' => 'datetime',
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**
-     * records property
+     * records property.
      *
      * @var array
      */
     public $records = [
         [
             'group_id' => 1, 'user_name' => 'admad',
             'email' => 'admad@example.com', 'password' => '5f4dcc3b5aa765d61d8327deb882cf99',
-            'created' => '2014-03-17 01:18:23', 'updated' => '2014-03-17 01:20:31'
+            'created' => '2014-03-17 01:18:23', 'updated' => '2014-03-17 01:20:31',
         ],
         [
             'group_id' => 2, 'user_name' => 'mark',
             'email' => 'mark@example.com', 'password' => '5f4dcc3b5aa765d61d8327deb882cf99',
-            'created' => '2014-03-17 01:16:23', 'updated' => '2014-03-17 01:18:31'
+            'created' => '2014-03-17 01:16:23', 'updated' => '2014-03-17 01:18:31',
         ],
         [
             'group_id' => 2, 'user_name' => 'jose',
             'email' => 'jose@example.com', 'password' => '5f4dcc3b5aa765d61d8327deb882cf99',
-            'created' => '2014-03-17 01:20:23', 'updated' => '2014-03-17 01:22:31'
+            'created' => '2014-03-17 01:20:23', 'updated' => '2014-03-17 01:22:31',
         ],
     ];
 }

tests/TestCase/Auth/JwtAuthenticateTest.php

@@ -2,8 +2,6 @@
 namespace ADmad\JwtAuth\Auth\Test\TestCase\Auth;
 
 use ADmad\JwtAuth\Auth\JwtAuthenticate;
-use Cake\Controller\Component\AuthComponent;
-use Cake\Controller\Controller;
 use Cake\Core\Configure;
 use Cake\I18n\Time;
 use Cake\Network\Request;
@@ -14,7 +12,7 @@
 use Firebase\JWT\JWT;
 
 /**
- * Test case for JwtAuthentication
+ * Test case for JwtAuthentication.
  */
 class JwtAuthenticateTest extends TestCase
 {
@@ -24,7 +22,7 @@ class JwtAuthenticateTest extends TestCase
     ];
 
     /**
-     * setup
+     * setup.
      *
      * @return void
      */
@@ -36,7 +34,7 @@ public function setUp()
 
         $this->Registry = $this->getMock('Cake\Controller\ComponentRegistry');
         $this->auth = new JwtAuthenticate($this->Registry, [
-            'userModel' => 'Users'
+            'userModel' => 'Users',
         ]);
 
         $this->token = JWT::encode(['sub' => 1], Security::salt());
@@ -45,7 +43,7 @@ public function setUp()
     }
 
     /**
-     * test authenticate token as query parameter
+     * test authenticate token as query parameter.
      *
      * @return void
      */
@@ -62,7 +60,7 @@ public function testAuthenticateTokenParameter()
             'user_name' => 'admad',
             'email' => 'admad@example.com',
             'created' => new Time('2014-03-17 01:18:23'),
-            'updated' => new Time('2014-03-17 01:20:31')
+            'updated' => new Time('2014-03-17 01:20:31'),
         ];
         $request = new Request('posts/index?token=' . $this->token);
         $result = $this->auth->getUser($request, $this->response);
@@ -75,7 +73,7 @@ public function testAuthenticateTokenParameter()
     }
 
     /**
-     * test authenticate token as request header
+     * test authenticate token as request header.
      *
      * @return void
      */
@@ -89,7 +87,7 @@ public function testAuthenticateTokenHeader()
             'user_name' => 'admad',
             'email' => 'admad@example.com',
             'created' => new Time('2014-03-17 01:18:23'),
-            'updated' => new Time('2014-03-17 01:20:31')
+            'updated' => new Time('2014-03-17 01:20:31'),
         ];
         $request->env('HTTP_AUTHORIZATION', 'Bearer ' . $this->token);
         $result = $this->auth->getUser($request, $this->response);
@@ -113,7 +111,7 @@ public function testQueryDatasourceFalse()
         $expected = [
             'id' => 99,
             'username' => 'ADmad',
-            'group' => ['name' => 'admin']
+            'group' => ['name' => 'admin'],
         ];
         $request->env(
             'HTTP_AUTHORIZATION',
@@ -125,7 +123,7 @@ public function testQueryDatasourceFalse()
     }
 
     /**
-     * test for valid token but no matching user found in db
+     * test for valid token but no matching user found in db.
      *
      * @return void
      */
@@ -140,7 +138,7 @@ public function testWithValidTokenButNoUserInDb()
     }
 
     /**
-     * test contain
+     * test contain.
      *
      * @return void
      */
@@ -157,8 +155,8 @@ public function testFindUserWithContain()
             'updated' => new Time('2014-03-17 01:20:31'),
             'group' => [
                 'id' => 1,
-                'title' => 'admin'
-            ]
+                'title' => 'admin',
+            ],
         ];
         $request->env('HTTP_AUTHORIZATION', 'Bearer ' . $this->token);
 
@@ -176,7 +174,7 @@ public function testFindUserWithContain()
     }
 
     /**
-     * Test that authenticated() always returns false
+     * Test that authenticated() always returns false.
      *
      * @return void
      */
@@ -187,7 +185,7 @@ public function testAuthenticated()
 
     /**
      * test that with debug off for invalid token exception from JWT::decode()
-     * is re-thrown
+     * is re-thrown.
      *
      * @expectedException DomainException
      */
@@ -213,7 +211,7 @@ public function testUnauthenticated()
 
     /**
      * test unauthenticated() doesn't throw exception is config `unauthenticatedException`
-     * is set to falsey value
+     * is set to falsey value.
      */
     public function testUnauthenticatedNoException()
     {
@@ -223,7 +221,7 @@ public function testUnauthenticatedNoException()
 
     /**
      * test that getUser() returns false instead of throwing exception with
-     * invalid token when debug is off
+     * invalid token when debug is off.
      *
      * @return void
      */

tests/bootstrap.php

@@ -1,7 +1,7 @@
 <?php
 use Cake\Core\Plugin;
 
-/**
+/*
  * Test suite bootstrap
  *
  * This function is used to find the location of CakePHP whether CakePHP
@@ -16,7 +16,7 @@
             return $root;
         }
     } while ($root !== $lastRoot);
-    throw new Exception("Cannot find the root of the application, unable to run tests");
+    throw new Exception('Cannot find the root of the application, unable to run tests');
 };
 $root = $findRoot(__FILE__);
 unset($findRoot);