Merge pull request dingo#280 from GrahamCampbell/cs

CS Fixes

Author: jasonlewis

.travis.yml

@@ -6,10 +6,10 @@ php:
   - 5.6
   - hhvm
 
-before_install:
-  - composer self-update
-  
+sudo: false
+
 install:
-  - composer install --prefer-source --no-interaction --dev
+  - travis_retry composer install --no-interaction --prefer-source
 
-script: phpunit
+script:
+  - vendor/bin/phpunit

phpunit.xml

@@ -7,12 +7,23 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
+         stopOnError="false"
          stopOnFailure="false"
-         syntaxCheck="false"
+         syntaxCheck="true"
+         strict="false"
+         verbose="true"
 >
     <testsuites>
-        <testsuite name="Package Test Suite">
-            <directory suffix=".php">./tests/</directory>
+        <testsuite name="API Test Suite">
+            <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+            <exclude>
+                <directory>./src/config</directory>
+            </exclude>
+        </whitelist>
+    </filter>
 </phpunit>

readme.md

@@ -10,4 +10,4 @@ Refer to the [Wiki](https://github.com/dingo/api/wiki) for installation instruct
 
 ## License
 
-This package is licensed under the [BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause).
+This package is licensed under the [BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause).

src/Auth/Authenticator.php

@@ -48,9 +48,10 @@ class Authenticator
     /**
      * Create a new authenticator instance.
      *
-     * @param  \Dingo\Api\Routing\Router  $router
-     * @param  \Illuminate\Container\Container  $container
-     * @param  array  $providers
+     * @param \Dingo\Api\Routing\Router       $router
+     * @param \Illuminate\Container\Container $container
+     * @param array                           $providers
+     *
      * @return void
      */
     public function __construct(Router $router, Container $container, array $providers)
@@ -63,9 +64,11 @@ public function __construct(Router $router, Container $container, array $provide
     /**
      * Authenticate the current request.
      *
-     * @param  array  $providers
-     * @return mixed
+     * @param array $providers
+     *
      * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
+     *
+     * @return mixed
      */
     public function authenticate(array $providers = [])
     {
@@ -96,9 +99,11 @@ public function authenticate(array $providers = [])
     /**
      * Throw the first exception from the exception stack.
      *
-     * @param  array  $exceptionStack
-     * @return void
+     * @param array $exceptionStack
+     *
      * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
+     *
+     * @return void
      */
     protected function throwUnauthorizedException(array $exceptionStack)
     {
@@ -114,7 +119,8 @@ protected function throwUnauthorizedException(array $exceptionStack)
     /**
      * Filter the requested providers from the available providers.
      *
-     * @param  array  $providers
+     * @param array $providers
+     *
      * @return array
      */
     protected function filterProviders(array $providers)
@@ -140,7 +146,7 @@ public function getUser()
         try {
             return $this->user = $this->authenticate();
         } catch (Exception $exception) {
-            return null;
+            return;
         }
     }
 
@@ -157,7 +163,8 @@ public function user()
     /**
      * Set the authenticated user.
      *
-     * @param  \Illuminate\Auth\GenericUser|\Illuminate\Database\Eloquent\Model  $user
+     * @param \Illuminate\Auth\GenericUser|\Illuminate\Database\Eloquent\Model $user
+     *
      * @return \Dingo\Api\Auth\Authenticator
      */
     public function setUser($user)
@@ -190,8 +197,9 @@ public function getProviderUsed()
     /**
      * Extend the authentication layer with a custom provider.
      *
-     * @param  string  $key
-     * @param  object|callable  $provider
+     * @param string          $key
+     * @param object|callable $provider
+     *
      * @return void
      */
     public function extend($key, $provider)

src/Auth/AuthorizationProvider.php

@@ -18,9 +18,11 @@ abstract class AuthorizationProvider implements ProviderInterface
     /**
      * Validate the requests authorization header for the provider.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @return bool
+     * @param \Illuminate\Http\Request $request
+     *
      * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
+     *
+     * @return bool
      */
     public function validateAuthorizationHeader(Request $request)
     {

src/Auth/BasicProvider.php

@@ -26,8 +26,9 @@ class BasicProvider extends AuthorizationProvider
     /**
      * Create a new basic provider instance.
      *
-     * @param  \Illuminate\Auth\AuthManager  $auth
-     * @param  string  $identifier
+     * @param \Illuminate\Auth\AuthManager $auth
+     * @param string                       $identifier
+     *
      * @return void
      */
     public function __construct(AuthManager $auth, $identifier = 'email')
@@ -39,8 +40,9 @@ public function __construct(AuthManager $auth, $identifier = 'email')
     /**
      * Authenticate request with Basic.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Illuminate\Routing\Route  $route
+     * @param \Illuminate\Http\Request  $request
+     * @param \Illuminate\Routing\Route $route
+     *
      * @return mixed
      */
     public function authenticate(Request $request, Route $route)

src/Auth/JWTProvider.php

@@ -12,7 +12,7 @@
 class JWTProvider extends AuthorizationProvider
 {
     /**
-     * The JWTAuth instance
+     * The JWTAuth instance.
      *
      * @var \Tymon\JWTAuth\JWTAuth
      */
@@ -21,7 +21,8 @@ class JWTProvider extends AuthorizationProvider
     /**
      * Create a new JWT provider instance.
      *
-     * @param  \Tymon\JWTAuth\JWTAuth $auth
+     * @param \Tymon\JWTAuth\JWTAuth $auth
+     *
      * @return void
      */
     public function __construct(JWTAuth $auth)
@@ -30,10 +31,11 @@ public function __construct(JWTAuth $auth)
     }
 
     /**
-     * Authenticate request with a JWT
+     * Authenticate request with a JWT.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Dingo\Api\Routing\Route $route
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Dingo\Api\Routing\Route  $route
      * @return mixed
      */
     public function authenticate(Request $request, Route $route)
@@ -48,9 +50,10 @@ public function authenticate(Request $request, Route $route)
     }
 
     /**
-     * Get the JWT from the request
+     * Get the JWT from the request.
+     *
+     * @param \Illuminate\Http\Request $request
      *
-     * @param  \Illuminate\Http\Request $request
      * @return string
      */
     protected function getToken(Request $request)
@@ -69,9 +72,10 @@ protected function getToken(Request $request)
     }
 
     /**
-     * Parse JWT from the authorization header
+     * Parse JWT from the authorization header.
+     *
+     * @param \Illuminate\Http\Request $request
      *
-     * @param  \Illuminate\Http\Request  $request
      * @return string
      */
     protected function parseAuthorizationHeader(Request $request)

src/Auth/LeagueOAuth2Provider.php

@@ -44,8 +44,9 @@ class LeagueOAuth2Provider extends AuthorizationProvider
     /**
      * Create a new OAuth 2.0 provider instance.
      *
-     * @param  \League\OAuth2\Server\ResourceServer  $resource
-     * @param  bool  $httpHeadersOnly
+     * @param \League\OAuth2\Server\ResourceServer $resource
+     * @param bool                                 $httpHeadersOnly
+     *
      * @return void
      */
     public function __construct(ResourceServer $resource, $httpHeadersOnly = false)
@@ -57,10 +58,12 @@ public function __construct(ResourceServer $resource, $httpHeadersOnly = false)
     /**
      * Authenticate request with the OAuth 2.0 resource server.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Illuminate\Routing\Route  $route
-     * @return mixed
+     * @param \Illuminate\Http\Request  $request
+     * @param \Illuminate\Routing\Route $route
+     *
      * @throws \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
+     *
+     * @return mixed
      */
     public function authenticate(Request $request, Route $route)
     {
@@ -86,7 +89,8 @@ public function authenticate(Request $request, Route $route)
     /**
      * Resolve the resource owner.
      *
-     * @param  \League\OAuth2\Server\Entity\AccessTokenEntity  $token
+     * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token
+     *
      * @return mixed
      */
     protected function resolveResourceOwner(AccessTokenEntity $token)
@@ -103,10 +107,12 @@ protected function resolveResourceOwner(AccessTokenEntity $token)
     /**
      * Validate a routes scopes.
      *
-     * @param  \League\OAuth2\Server\Entity\AccessTokenEntity  $token
-     * @param  \Dingo\Api\Routing\Route  $route
-     * @return bool
+     * @param \League\OAuth2\Server\Entity\AccessTokenEntity $token
+     * @param \Dingo\Api\Routing\Route                       $route
+     *
      * @throws \League\OAuth2\Server\Exception\InvalidScopeException
+     *
+     * @return bool
      */
     protected function validateRouteScopes(AccessTokenEntity $token, Route $route)
     {
@@ -128,7 +134,8 @@ protected function validateRouteScopes(AccessTokenEntity $token, Route $route)
     /**
      * Set the resolver to fetch a user.
      *
-     * @param  callable  $resolver
+     * @param callable $resolver
+     *
      * @return \Dingo\Api\Auth\LeagueOAuth2Provider
      */
     public function setUserResolver(callable $resolver)
@@ -141,7 +148,8 @@ public function setUserResolver(callable $resolver)
     /**
      * Set the resolver to fetch a client.
      *
-     * @param  callable  $resolver
+     * @param callable $resolver
+     *
      * @return \Dingo\Api\Auth\LeagueOAuth2Provider
      */
     public function setClientResolver(callable $resolver)

src/Auth/ProviderInterface.php

@@ -10,8 +10,9 @@ interface ProviderInterface
     /**
      * Authenticate the request and return the authenticated user instance.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Dingo\Api\Routing\Route  $route
+     * @param \Illuminate\Http\Request $request
+     * @param \Dingo\Api\Routing\Route $route
+     *
      * @return mixed
      */
     public function authenticate(Request $request, Route $route);

src/Config.php

@@ -42,11 +42,12 @@ class Config
     /**
      * Create a new config instance.
      *
-     * @param  string  $version
-     * @param  string  $prefix
-     * @param  string  $domain
-     * @param  string  $vendor
-     * @param  string  $format
+     * @param string $version
+     * @param string $prefix
+     * @param string $domain
+     * @param string $vendor
+     * @param string $format
+     *
      * @return void
      */
     public function __construct($version = 'v1', $prefix = null, $domain = null, $vendor = null, $format = 'json')
@@ -111,7 +112,8 @@ public function getFormat()
     /**
      * Set the API version.
      *
-     * @param  string  $version
+     * @param string $version
+     *
      * @return void
      */
     public function setVersion($version)
@@ -122,7 +124,8 @@ public function setVersion($version)
     /**
      * Set the API format.
      *
-     * @param  string  $format
+     * @param string $format
+     *
      * @return void
      */
     public function setFormat($format)
@@ -133,7 +136,8 @@ public function setFormat($format)
     /**
      * Set the API vendor.
      *
-     * @param  string  $vendor
+     * @param string $vendor
+     *
      * @return void
      */
     public function setVendor($vendor)
@@ -144,7 +148,8 @@ public function setVendor($vendor)
     /**
      * Set the API domain.
      *
-     * @param  string  $domain
+     * @param string $domain
+     *
      * @return void
      */
     public function setDomain($domain)
@@ -155,7 +160,8 @@ public function setDomain($domain)
     /**
      * Set the API prefix.
      *
-     * @param  string  $prefix
+     * @param string $prefix
+     *
      * @return void
      */
     public function setPrefix($prefix)