Merge pull request #2 from webimpress/fixes

weierophinney · weierophinney · commit 8ca636b7ce3f · 2017-11-21T16:01:12.000-06:00
General fixes
diff --git a/.gitattributes b/.gitattributes
@@ -3,8 +3,8 @@
 /.gitignore export-ignore
 /.travis.yml export-ignore
 /composer.lock export-ignore
-/docs export-ignore
+/docs/ export-ignore
 /mkdocs.yml export-ignore
 /phpcs.xml export-ignore
 /phpunit.xml.dist export-ignore
-/test export-ignore
+/test/ export-ignore
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
-docs/html/
-vendor/
-zf-mkdoc-theme/
-clover.xml
-coveralls-upload.json
-phpunit.xml
-zf-mkdoc-theme.tgz
+/clover.xml
+/coveralls-upload.json
+/docs/html/
+/phpunit.xml
+/vendor/
+/zf-mkdoc-theme.tgz
+/zf-mkdoc-theme/
diff --git a/composer.json b/composer.json
@@ -1,23 +1,21 @@
 {
     "name": "zendframework/zend-expressive-authentication",
     "description": "Authentication middleware for Expressive and PSR-7 applications",
-    "homepage": "https://docs.zendframework.com/zend-expressive-authentication/",
-    "type": "library",
     "license": "BSD-3-Clause",
     "keywords": [
+        "zf",
+        "zendframework",
         "authentication",
         "http",
         "middleware",
         "zend-expressive",
         "psr-7"
     ],
-    "config": {
-        "sort-packages": true
-    },
     "support": {
         "docs": "https://docs.zendframework.com/zend-expressive-authentication/",
         "issues": "https://github.com/zendframework/zend-expressive-authentication/issues",
         "source": "https://github.com/zendframework/zend-expressive-authentication",
+        "rss": "https://github.com/zendframework/zend-expressive-authentication/releases.atom",
         "slack": "https://zendframework-slack.herokuapp.com",
         "forum": "https://discourse.zendframework.com/c/questions/expressive"
     },
@@ -51,16 +49,23 @@
             "ZendTest\\Expressive\\Authentication\\": "test/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    },
     "scripts": {
         "check": [
             "@cs-check",
             "@test"
         ],
-        "upload-coverage": "coveralls -v",
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
         "test": "phpunit --colors=always",
-        "test-coverage": "phpunit --coverage-clover clover.xml",
-        "license-check": "vendor/bin/docheader check src/ test/"
+        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
+        "upload-coverage": "coveralls -v"
     }
 }
diff --git a/src/AuthenticationInterface.php b/src/AuthenticationInterface.php
@@ -15,17 +15,11 @@ interface AuthenticationInterface
     /**
      * Authenticate the PSR-7 request and return a valid user
      * or null if not authenticated
-     *
-     * @param ServerRequestInterface $request
-     * @return UserInterface|null
      */
-    public function authenticate(ServerRequestInterface $request): ?UserInterface;
+    public function authenticate(ServerRequestInterface $request) : ?UserInterface;
 
     /**
      * Generate the unauthorized response
-     *
-     * @param ServerRequestInterface $request
-     * @return ResponseInterface
      */
-    public function unauthorizedResponse(ServerRequestInterface $request): ResponseInterface;
+    public function unauthorizedResponse(ServerRequestInterface $request) : ResponseInterface;
 }
diff --git a/src/AuthenticationMiddleware.php b/src/AuthenticationMiddleware.php
@@ -14,16 +14,10 @@
 class AuthenticationMiddleware implements ServerMiddlewareInterface
 {
     /**
-     * @var AuthentiationInterface
+     * @var AuthenticationInterface
      */
     protected $auth;
 
-    /**
-     * Constructor
-     *
-     * @param AuthenticationInterface $authentication
-     * @return void
-     */
     public function __construct(AuthenticationInterface $auth)
     {
         $this->auth = $auth;
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -2,7 +2,7 @@
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication for the canonical source repository
  * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   https://github.com/zendframework/zend-expressive-cache/blob/master/LICENSE.md New BSD License
+ * @license   https://github.com/zendframework/zend-expressive-authentication/blob/master/LICENSE.md New BSD License
  */
 
 namespace Zend\Expressive\Authentication\Exception;
diff --git a/src/Exception/InvalidConfigException.php b/src/Exception/InvalidConfigException.php
@@ -2,7 +2,7 @@
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication for the canonical source repository
  * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   https://github.com/zendframework/zend-expressive-cache/blob/master/LICENSE.md New BSD License
+ * @license   https://github.com/zendframework/zend-expressive-authentication/blob/master/LICENSE.md New BSD License
  */
 
 namespace Zend\Expressive\Authentication\Exception;
diff --git a/src/ResponsePrototypeTrait.php b/src/ResponsePrototypeTrait.php
@@ -15,11 +15,9 @@ trait ResponsePrototypeTrait
     /**
      * Return a ResponseInterface service if present or Zend\Diactoros\Response
      *
-     * @param ContainerInterface $container
      * @throws Exception\InvalidConfigException
-     * @return ResponseInterface
      */
-    protected function getResponsePrototype(ContainerInterface $container): ResponseInterface
+    protected function getResponsePrototype(ContainerInterface $container) : ResponseInterface
     {
         if (! $container->has(ResponseInterface::class)
             && ! class_exists(Response::class)
diff --git a/src/UserInterface.php b/src/UserInterface.php
@@ -10,15 +10,11 @@ interface UserInterface
 {
     /**
      * Get the username
-     *
-     * @return string
      */
-    public function getUsername(): string;
+    public function getUsername() : string;
 
     /**
      * Get the user role
-     *
-     * @return string
      */
-    public function getUserRole(): string;
+    public function getUserRole() : string;
 }
diff --git a/src/UserRepository/Htpasswd.php b/src/UserRepository/Htpasswd.php
@@ -20,15 +20,18 @@ class Htpasswd implements UserRepositoryInterface
     use UserTrait;
 
     /**
-     * Constructor
-     *
-     * @param string $filename
+     * @var string
+     */
+    private $filename;
+
+    /**
+     * @throws Exception\InvalidConfigException
      */
     public function __construct(string $filename)
     {
         if (! file_exists($filename)) {
             throw new Exception\InvalidConfigException(sprintf(
-                "I cannot access the htpasswd file %s",
+                'I cannot access the htpasswd file %s',
                 $filename
             ));
         }
@@ -38,9 +41,9 @@ public function __construct(string $filename)
     /**
      * {@inheritDoc}
      */
-    public function authenticate(string $credential, string $password = null): ?UserInterface
+    public function authenticate(string $credential, string $password = null) : ?UserInterface
     {
-        if (! $handle = fopen($this->filename, "r")) {
+        if (! $handle = fopen($this->filename, 'r')) {
             return null;
         }
         $found = false;
@@ -63,12 +66,11 @@ public function authenticate(string $credential, string $password = null): ?User
     /**
      * Check bcrypt usage for security reason
      *
-     * @param string $hash
-     * @return void
+     * @throws Exception\RuntimeException
      */
-    protected function checkBcryptHash(string $hash): void
+    protected function checkBcryptHash(string $hash) : void
     {
-        if ('$2y$' !== substr($hash, 0, 4)) {
+        if (0 !== strpos($hash, '$2y$')) {
             throw new Exception\RuntimeException(
                 'The htpasswd file uses not secure hash algorithm. Please use bcrypt.'
             );
diff --git a/src/UserRepository/HtpasswdFactory.php b/src/UserRepository/HtpasswdFactory.php
@@ -12,6 +12,9 @@
 
 class HtpasswdFactory
 {
+    /**
+     * @throws Exception\InvalidConfigException
+     */
     public function __invoke(ContainerInterface $container) : Htpasswd
     {
         $htpasswd = $container->get('config')['authentication']['htpasswd'] ?? null;
diff --git a/src/UserRepository/PdoDatabase.php b/src/UserRepository/PdoDatabase.php
@@ -20,11 +20,15 @@ class PdoDatabase implements UserRepositoryInterface
     use UserTrait;
 
     /**
-     * Constructor
-     *
-     * @param PDO $pdo
-     * @param array $config
+     * @var PDO
      */
+    private $pdo;
+
+    /**
+     * @var array
+     */
+    private $config;
+
     public function __construct(PDO $pdo, array $config)
     {
         $this->pdo = $pdo;
@@ -34,10 +38,10 @@ public function __construct(PDO $pdo, array $config)
     /**
      * {@inheritDoc}
      */
-    public function authenticate(string $credential, string $password = null): ?UserInterface
+    public function authenticate(string $credential, string $password = null) : ?UserInterface
     {
         $sql = sprintf(
-            "SELECT * FROM %s WHERE %s = :username",
+            'SELECT * FROM %s WHERE %s = :username',
             $this->config['table'],
             $this->config['field']['username']
         );
diff --git a/src/UserRepository/PdoDatabaseFactory.php b/src/UserRepository/PdoDatabaseFactory.php
@@ -13,6 +13,9 @@
 
 class PdoDatabaseFactory
 {
+    /**
+     * @throws Exception\InvalidConfigException
+     */
     public function __invoke(ContainerInterface $container) : PdoDatabase
     {
         $pdo = $container->get('config')['authentication']['pdo'] ?? null;
diff --git a/src/UserRepository/UserTrait.php b/src/UserRepository/UserTrait.php
@@ -13,26 +13,25 @@ trait UserTrait
 {
     /**
      * Generate a user from $username and $role
-     *
-     * @param string $username
-     * @param string $role
-     * @return UserInterface
      */
-    protected function generateUser(string $username, string $role): UserInterface
+    protected function generateUser(string $username, string $role) : UserInterface
     {
         return new class($username, $role) implements UserInterface {
+            private $username;
+            private $role;
+
             public function __construct($username, $role)
             {
                 $this->username = $username;
                 $this->role = $role;
             }
 
-            public function getUsername(): string
+            public function getUsername() : string
             {
                 return $this->username;
             }
 
-            public function getUserRole(): string
+            public function getUserRole() : string
             {
                 return $this->role;
             }
diff --git a/src/UserRepositoryInterface.php b/src/UserRepositoryInterface.php
@@ -14,8 +14,6 @@ interface UserRepositoryInterface
      * It returns the authenticated user or null.
      *
      * @param string $credential can be also a token
-     * @param string $password
-     * @return UserInterface|null
      */
-    public function authenticate(string $credential, string $password = null): ?UserInterface;
+    public function authenticate(string $credential, string $password = null) : ?UserInterface;
 }

Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,9 @@ trait ResponsePrototypeTrait`
`15`	`15`	`/**`
`16`	`16`	`* Return a ResponseInterface service if present or Zend\Diactoros\Response`
`17`	`17`	`*`
`18`		`- * @param ContainerInterface $container`
`19`	`18`	`* @throws Exception\InvalidConfigException`
`20`		`- * @return ResponseInterface`
`21`	`19`	`*/`
`22`		`- protected function getResponsePrototype(ContainerInterface $container): ResponseInterface`
	`20`	`+ protected function getResponsePrototype(ContainerInterface $container) : ResponseInterface`
`23`	`21`	`{`
`24`	`22`	`if (! $container->has(ResponseInterface::class)`
`25`	`23`	`&& ! class_exists(Response::class)`