Merge branch 'V5-WIP' into unify_examples

2025-05-31 14:12:07 +05:30 · 2016-03-08 21:47:02 +01:00
parent 2bd45f2a6b da53067e63
commit 9c66688d19
106 changed files with 3172 additions and 4122 deletions
--- a/examples/public/auth_code.php
+++ b/examples/public/auth_code.php
@@ -14,7 +14,7 @@ use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
 use Zend\Diactoros\Stream;

-include(__DIR__ . '/../vendor/autoload.php');
+include __DIR__ . '/../vendor/autoload.php';

 $app = new App([
    'settings'    => [
@@ -56,6 +56,22 @@ $app = new App([
    },
 ]);

+$app->any('/authorize', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
+    /* @var \League\OAuth2\Server\Server $server */
+    $server = $app->getContainer()->get(Server::class);
+
+    try {
+        return $server->respondToRequest($request, $response);
+    } catch (OAuthServerException $exception) {
+        return $exception->generateHttpResponse($response);
+    } catch (\Exception $exception) {
+        $body = new Stream('php://temp', 'r+');
+        $body->write($exception->getMessage());
+
+        return $response->withStatus(500)->withBody($body);
+    }
+});
+
 $app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
    /* @var \League\OAuth2\Server\Server $server */
    $server = $app->getContainer()->get(Server::class);
--- a/examples/public/client_credentials.php
+++ b/examples/public/client_credentials.php
@@ -11,7 +11,7 @@ use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
 use Zend\Diactoros\Stream;

-include(__DIR__ . '/../vendor/autoload.php');
+include __DIR__ . '/../vendor/autoload.php';

 $app = new App([
    'settings'    => [
@@ -42,7 +42,7 @@ $app = new App([
        );

        return $server;
-    }
+    },
 ]);

 $app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
--- a/examples/public/middleware_use.php
+++ b/examples/public/middleware_use.php
@@ -16,7 +16,7 @@ use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
 use Zend\Diactoros\Stream;

-include(__DIR__ . '/../vendor/autoload.php');
+include __DIR__ . '/../vendor/autoload.php';

 $app = new App([
    'settings'    => [
@@ -61,7 +61,7 @@ $app = new App([
        );

        return $server;
-    }
+    },
 ]);

 // Access token issuer
--- a/examples/public/password.php
+++ b/examples/public/password.php
@@ -13,7 +13,7 @@ use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
 use Zend\Diactoros\Stream;

-include(__DIR__ . '/../vendor/autoload.php');
+include __DIR__ . '/../vendor/autoload.php';

 $app = new App([
    'settings'    => [
@@ -46,7 +46,7 @@ $app = new App([
        );

        return $server;
-    }
+    },
 ]);

 $app->post('/access_token', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
--- a/examples/public/refresh_token.php
+++ b/examples/public/refresh_token.php
@@ -12,7 +12,7 @@ use Psr\Http\Message\ServerRequestInterface;
 use Slim\App;
 use Zend\Diactoros\Stream;

-include(__DIR__ . '/../vendor/autoload.php');
+include __DIR__ . '/../vendor/autoload.php';

 $app = new App([
    'settings'    => [
--- a/examples/public/secured_route.php
+++ b/examples/public/secured_route.php
@@ -1,72 +0,0 @@
-<?php
-
-use League\OAuth2\Server\Exception\OAuthServerException;
-use League\OAuth2\Server\Server;
-use OAuth2ServerExamples\Repositories\AccessTokenRepository;
-use OAuth2ServerExamples\Repositories\ClientRepository;
-use OAuth2ServerExamples\Repositories\ScopeRepository;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use Slim\App;
-use Zend\Diactoros\Stream;
-
-include(__DIR__ . '/../vendor/autoload.php');
-
-$app = new App([
-    'settings'    => [
-        'displayErrorDetails' => true,
-    ],
-    Server::class => function () {
-        // Init our repositories
-        $clientRepository = new ClientRepository();
-        $accessTokenRepository = new AccessTokenRepository();
-        $scopeRepository = new ScopeRepository();
-
-        $privateKeyPath = 'file://' . __DIR__ . '/../private.key';
-        $publicKeyPath = 'file://' . __DIR__ . '/../public.key';
-
-        // Setup the authorization server
-        return new Server(
-            $clientRepository,
-            $accessTokenRepository,
-            $scopeRepository,
-            $privateKeyPath,
-            $publicKeyPath
-        );
-    }
-]);
-
-$app->get('/user', function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
-    $server = $app->getContainer()->get(Server::class);
-    $body = new Stream('php://temp', 'r+');
-
-    try {
-        $request = $server->validateRequest($request);
-    } catch (OAuthServerException $exception) {
-        return $exception->generateHttpResponse($response);
-    } catch (\Exception $exception) {
-        $body->write($exception->getMessage());
-
-        return $response->withStatus(500)->withBody($body);
-    }
-
-    $params = [];
-
-    if (in_array('basic', $request->getAttribute('oauth_scopes', []))) {
-        $params = [
-            'id'   => 1,
-            'name' => 'Alex',
-            'city' => 'London'
-        ];
-    }
-
-    if (in_array('email', $request->getAttribute('oauth_scopes', []))) {
-        $params['email'] = 'alex@example.com';
-    }
-
-    $body->write(json_encode($params));
-
-    return $response->withBody($body);
-});
-
-$app->run();
--- a/examples/src/Entities/UserEntity.php
+++ b/examples/src/Entities/UserEntity.php
@@ -7,11 +7,12 @@ use League\OAuth2\Server\Entities\Interfaces\UserEntityInterface;
 class UserEntity implements UserEntityInterface
 {
    /**
-     * Return the user's identifier
+     * Return the user's identifier.
+     *
     * @return mixed
     */
    public function getIdentifier()
    {
        return 1;
    }
-}
+}
--- a/examples/src/Repositories/AccessTokenRepository.php
+++ b/examples/src/Repositories/AccessTokenRepository.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace OAuth2ServerExamples\Repositories;

 use League\OAuth2\Server\Entities\Interfaces\AccessTokenEntityInterface;
@@ -7,7 +8,7 @@ use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
 class AccessTokenRepository implements AccessTokenRepositoryInterface
 {
    /**
-     * Persists a new access token to permanent storage
+     * Persists a new access token to permanent storage.
     *
     * @param \League\OAuth2\Server\Entities\Interfaces\AccessTokenEntityInterface $accessTokenEntity
     */
@@ -17,7 +18,7 @@ class AccessTokenRepository implements AccessTokenRepositoryInterface
    }

    /**
-     * Revoke an access token
+     * Revoke an access token.
     *
     * @param string $tokenId
     */
@@ -27,7 +28,7 @@ class AccessTokenRepository implements AccessTokenRepositoryInterface
    }

    /**
-     * Check if the access token has been revoked
+     * Check if the access token has been revoked.
     *
     * @param string $tokenId
     *
--- a/examples/src/Repositories/AuthCodeRepository.php
+++ b/examples/src/Repositories/AuthCodeRepository.php
@@ -7,9 +7,8 @@ use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;

 class AuthCodeRepository implements AuthCodeRepositoryInterface
 {
-
    /**
-     * Persists a new auth code to permanent storage
+     * Persists a new auth code to permanent storage.
     *
     * @param \League\OAuth2\Server\Entities\Interfaces\AuthCodeEntityInterface $authCodeEntity
     */
@@ -19,7 +18,7 @@ class AuthCodeRepository implements AuthCodeRepositoryInterface
    }

    /**
-     * Revoke an auth code
+     * Revoke an auth code.
     *
     * @param string $codeId
     */
@@ -29,7 +28,7 @@ class AuthCodeRepository implements AuthCodeRepositoryInterface
    }

    /**
-     * Check if the auth code has been revoked
+     * Check if the auth code has been revoked.
     *
     * @param string $codeId
     *
@@ -39,4 +38,4 @@ class AuthCodeRepository implements AuthCodeRepositoryInterface
    {
        // TODO: Implement isAuthCodeRevoked() method.
    }
-}
+}
--- a/examples/src/Repositories/ClientRepository.php
+++ b/examples/src/Repositories/ClientRepository.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace OAuth2ServerExamples\Repositories;

 use League\OAuth2\Server\Entities\ClientEntity;
@@ -7,7 +8,7 @@ use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
 class ClientRepository implements ClientRepositoryInterface
 {
    /**
-     * @inheritdoc
+     * {@inheritdoc}
     */
    public function getClientEntity($clientIdentifier, $clientSecret = null, $redirectUri = null, $grantType = null)
    {
@@ -15,23 +16,23 @@ class ClientRepository implements ClientRepositoryInterface
            'myawesomeapp' => [
                'secret'       => password_hash('abc123', PASSWORD_BCRYPT),
                'name'         => 'My Awesome App',
-                'redirect_uri' => 'http://foo/bar'
-            ]
+                'redirect_uri' => 'http://foo/bar',
+            ],
        ];

        // Check if client is registered
        if (array_key_exists($clientIdentifier, $clients) === false) {
-            return null;
+            return;
        }

        // Check if client secret is valid
        if ($clientSecret !== null && password_verify($clientSecret, $clients[$clientIdentifier]['secret']) === false) {
-            return null;
+            return;
        }

        // Check if redirect URI is valid
        if ($redirectUri !== null && $redirectUri !== $clients[$clientIdentifier]['redirect_uri']) {
-            return null;
+            return;
        }

        $client = new ClientEntity();
--- a/examples/src/Repositories/RefreshTokenRepository.php
+++ b/examples/src/Repositories/RefreshTokenRepository.php
@@ -7,9 +7,8 @@ use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;

 class RefreshTokenRepository implements RefreshTokenRepositoryInterface
 {
-
    /**
-     * Create a new refresh token_name
+     * Create a new refresh token_name.
     *
     * @param \League\OAuth2\Server\Entities\Interfaces\RefreshTokenEntityInterface $refreshTokenEntityInterface
     */
@@ -19,7 +18,7 @@ class RefreshTokenRepository implements RefreshTokenRepositoryInterface
    }

    /**
-     * Revoke the refresh token
+     * Revoke the refresh token.
     *
     * @param string $tokenId
     */
@@ -29,7 +28,7 @@ class RefreshTokenRepository implements RefreshTokenRepositoryInterface
    }

    /**
-     * Check if the refresh token has been revoked
+     * Check if the refresh token has been revoked.
     *
     * @param string $tokenId
     *
--- a/examples/src/Repositories/ScopeRepository.php
+++ b/examples/src/Repositories/ScopeRepository.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace OAuth2ServerExamples\Repositories;

 use League\OAuth2\Server\Entities\ScopeEntity;
@@ -7,21 +8,21 @@ use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
 class ScopeRepository implements ScopeRepositoryInterface
 {
    /**
-     * @inheritdoc
+     * {@inheritdoc}
     */
    public function getScopeEntityByIdentifier($scopeIdentifier, $grantType, $clientId = null)
    {
        $scopes = [
            'basic' => [
-                'description' => 'Basic details about you'
+                'description' => 'Basic details about you',
            ],
            'email' => [
-                'description' => 'Your email address'
-            ]
+                'description' => 'Your email address',
+            ],
        ];

        if (array_key_exists($scopeIdentifier, $scopes) === false) {
-            return null;
+            return;
        }

        $scope = new ScopeEntity();
--- a/examples/src/Repositories/UserRepository.php
+++ b/examples/src/Repositories/UserRepository.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace OAuth2ServerExamples\Repositories;

 use League\OAuth2\Server\Repositories\UserRepositoryInterface;
@@ -7,7 +8,7 @@ use OAuth2ServerExamples\Entities\UserEntity;
 class UserRepository implements UserRepositoryInterface
 {
    /**
-     * Get a user entity
+     * Get a user entity.
     *
     * @param string $username
     * @param string $password
@@ -20,6 +21,6 @@ class UserRepository implements UserRepositoryInterface
            return new UserEntity();
        }

-        return null;
+        return;
    }
 }