From d74b76da3e5edab75ee35984b32d1be97792ebd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Tue, 10 Jul 2018 21:55:47 +0200 Subject: [PATCH] fixing up the authenticator to allow identiy chaining --- app/SocialLogin/Authenticator.php | 76 ------------- app/SocialLogin/EloquentIdentityStore.php | 28 ----- app/SocialLogin/Facades/OAuth.php | 11 -- app/SocialLogin/IdentityStore.php | 9 -- app/SocialLogin/OAuthIdentity.php | 26 ----- app/SocialLogin/OAuthManager.php | 37 ------- app/SocialLogin/Session.php | 23 ---- app/SocialLogin/UserStore.php | 27 ----- composer.json | 4 +- composer.lock | 12 +-- config/services.php | 7 ++ .../2014_10_12_000000_create_users_table.php | 2 +- resources/views/auth/login.blade.php | 10 +- routes/web.php | 62 ++++++----- .../src/EloquentOAuthServiceProvider.php | 3 +- .../eloquent-oauth/src/Authenticator.php | 55 ++++++---- .../src/EloquentIdentityStore.php | 42 ++++++-- .../eloquent-oauth/src/IdentityStore.php | 12 ++- .../eloquent-oauth/src/OAuthIdentity.php | 13 ++- .../eloquent-oauth/src/OAuthManager.php | 18 +++- .../adamwathan/eloquent-oauth/src/Session.php | 13 ++- .../eloquent-oauth/src/UserStore.php | 22 ++-- .../facebook/src/FacebookProvider.php | 1 + .../socialnorm/google/src/GoogleProvider.php | 4 +- .../socialnorm/socialnorm/src/Provider.php | 4 +- .../socialnorm/src/ProviderRegistry.php | 7 +- .../src/{User.php => ProviderUser.php} | 8 +- .../src/Providers/OAuth2Provider.php | 10 +- .../socialnorm/socialnorm/src/SocialNorm.php | 12 ++- .../socialnorm/src/StateGenerator.php | 2 +- sideload/socialnorm/stackoverflow/.gitignore | 4 + sideload/socialnorm/stackoverflow/.travis.yml | 11 ++ .../socialnorm/stackoverflow/composer.json | 29 +++++ sideload/socialnorm/stackoverflow/phpunit.xml | 18 ++++ sideload/socialnorm/stackoverflow/readme.md | 3 + .../src/StackOverflowProvider.php | 100 ++++++++++++++++++ .../socialnorm/stackoverflow/tests/.gitkeep | 0 .../tests/GoogleProviderTest.php | 75 +++++++++++++ .../stackoverflow/tests/TestCase.php | 12 +++ .../tests/_fixtures/google_accesstoken.php | 24 +++++ .../tests/_fixtures/google_user.php | 23 ++++ 41 files changed, 513 insertions(+), 346 deletions(-) delete mode 100644 app/SocialLogin/Authenticator.php delete mode 100644 app/SocialLogin/EloquentIdentityStore.php delete mode 100644 app/SocialLogin/Facades/OAuth.php delete mode 100644 app/SocialLogin/IdentityStore.php delete mode 100644 app/SocialLogin/OAuthIdentity.php delete mode 100644 app/SocialLogin/OAuthManager.php delete mode 100644 app/SocialLogin/Session.php delete mode 100644 app/SocialLogin/UserStore.php rename sideload/socialnorm/socialnorm/src/{User.php => ProviderUser.php} (88%) create mode 100644 sideload/socialnorm/stackoverflow/.gitignore create mode 100644 sideload/socialnorm/stackoverflow/.travis.yml create mode 100644 sideload/socialnorm/stackoverflow/composer.json create mode 100644 sideload/socialnorm/stackoverflow/phpunit.xml create mode 100644 sideload/socialnorm/stackoverflow/readme.md create mode 100644 sideload/socialnorm/stackoverflow/src/StackOverflowProvider.php create mode 100644 sideload/socialnorm/stackoverflow/tests/.gitkeep create mode 100644 sideload/socialnorm/stackoverflow/tests/GoogleProviderTest.php create mode 100644 sideload/socialnorm/stackoverflow/tests/TestCase.php create mode 100644 sideload/socialnorm/stackoverflow/tests/_fixtures/google_accesstoken.php create mode 100644 sideload/socialnorm/stackoverflow/tests/_fixtures/google_user.php diff --git a/app/SocialLogin/Authenticator.php b/app/SocialLogin/Authenticator.php deleted file mode 100644 index df06677..0000000 --- a/app/SocialLogin/Authenticator.php +++ /dev/null @@ -1,76 +0,0 @@ -auth = $auth; - $this->users = $users; - $this->identities = $identities; - } - - public function login($providerAlias, $userDetails, $callback = null, $remember = false) - { - $user = $this->getUser($providerAlias, $userDetails); - $user = $this->runCallback($callback, $user, $userDetails); - $this->updateUser($user, $providerAlias, $userDetails); - $this->auth->login($user, $remember); - } - - protected function getUser($providerAlias, $details) - { - if ($this->identities->userExists($providerAlias, $details)) { - return $this->getExistingUser($providerAlias, $details); - } - return $this->users->create(); - } - - protected function runCallback($callback, $user, $userDetails) - { - $callback = $callback ?: function () {}; - $callbackUser = $callback($user, $userDetails); - return $callbackUser ?: $user; - } - - protected function updateUser($user, $providerAlias, $details) - { - $this->users->store($user); - $this->storeProviderIdentity($user, $providerAlias, $details); - } - - protected function getExistingUser($providerAlias, $details) - { - $identity = $this->identities->getByProvider($providerAlias, $details); - return $this->users->findByIdentity($identity); - } - - protected function storeProviderIdentity($user, $providerAlias, $details) - { - if ($this->identities->userExists($providerAlias, $details)) { - $this->updateProviderIdentity($providerAlias, $details); - } else { - $this->addProviderIdentity($user, $providerAlias, $details); - } - } - - protected function updateProviderIdentity($providerAlias, $details) - { - $identity = $this->identities->getByProvider($providerAlias, $details); - $identity->access_token = $details->access_token; - $this->identities->store($identity); - } - - protected function addProviderIdentity($user, $providerAlias, $details) - { - $identity = new OAuthIdentity; - $identity->user_id = $user->getKey(); - $identity->provider = $providerAlias; - $identity->provider_user_id = $details->id; - $identity->access_token = $details->access_token; - $this->identities->store($identity); - } -} diff --git a/app/SocialLogin/EloquentIdentityStore.php b/app/SocialLogin/EloquentIdentityStore.php deleted file mode 100644 index abca964..0000000 --- a/app/SocialLogin/EloquentIdentityStore.php +++ /dev/null @@ -1,28 +0,0 @@ -where('provider_user_id', $providerUser->id) - ->first(); - } - - public function flush($user, $provider) - { - OAuthIdentity::where('user_id', $user->getKey()) - ->where('provider', $provider) - ->delete(); - } - - public function store($identity) - { - $identity->save(); - } - - public function userExists($provider, $providerUser) - { - return (bool) $this->getByProvider($provider, $providerUser); - } -} diff --git a/app/SocialLogin/Facades/OAuth.php b/app/SocialLogin/Facades/OAuth.php deleted file mode 100644 index 4496850..0000000 --- a/app/SocialLogin/Facades/OAuth.php +++ /dev/null @@ -1,11 +0,0 @@ -redirect = $redirect; - $this->authenticator = $authenticator; - $this->socialnorm = $socialnorm; - } - - public function authorize($providerAlias) - { - return $this->redirect->to($this->socialnorm->authorize($providerAlias)); - } - - public function login($providerAlias, $callback = null) - { - $details = $this->socialnorm->getUser($providerAlias); - return $this->authenticator->login($providerAlias, $details, $callback, $remember = false); - } - - public function loginForever($providerAlias, $callback = null) - { - $details = $this->socialnorm->getUser($providerAlias); - return $this->authenticator->login($providerAlias, $details, $callback, $remember = true); - } - - public function registerProvider($alias, $provider) - { - $this->socialnorm->registerProvider($alias, $provider); - } -} diff --git a/app/SocialLogin/Session.php b/app/SocialLogin/Session.php deleted file mode 100644 index 5264629..0000000 --- a/app/SocialLogin/Session.php +++ /dev/null @@ -1,23 +0,0 @@ -store = $store; - } - - public function get($key) - { - return $this->store->get($key); - } - - public function put($key, $value) - { - return $this->store->put($key, $value); - } -} diff --git a/app/SocialLogin/UserStore.php b/app/SocialLogin/UserStore.php deleted file mode 100644 index fd6e9d5..0000000 --- a/app/SocialLogin/UserStore.php +++ /dev/null @@ -1,27 +0,0 @@ -model = $model; - } - - public function create() - { - $user = new $this->model; - return $user; - } - - public function store($user) - { - return $user->save(); - } - - public function findByIdentity($identity) - { - return $identity->belongsTo($this->model, 'user_id')->firstOrFail(); - } -} diff --git a/composer.json b/composer.json index 09a28ce..741a0ec 100644 --- a/composer.json +++ b/composer.json @@ -15,7 +15,8 @@ "laravel/framework": "5.6.*", "laravel/socialite": "^3.0", "laravel/tinker": "^1.0", - "phpoffice/phpspreadsheet": "^1.3" + "phpoffice/phpspreadsheet": "^1.3", + "guzzlehttp/guzzle": "^6.0" }, "require-dev": { "filp/whoops": "^2.0", @@ -37,6 +38,7 @@ "SocialNorm\\Facebook\\": "sideload/socialnorm/facebook/src", "SocialNorm\\GitHub\\": "sideload/socialnorm/github/src", "SocialNorm\\Google\\": "sideload/socialnorm/google/src", + "SocialNorm\\StackOverflow\\": "sideload/socialnorm/stackoverflow/src", "SocialNorm\\": "sideload/socialnorm/socialnorm/src" }, "files": [ diff --git a/composer.lock b/composer.lock index cb08add..2f930d9 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "44870bae9f6db81ba961bf49ae2f64ad", + "content-hash": "cdb2e12195da014433178600b1a1899f", "packages": [ { "name": "barryvdh/laravel-ide-helper", @@ -1115,16 +1115,16 @@ }, { "name": "laravel/framework", - "version": "v5.6.26", + "version": "v5.6.27", "source": { "type": "git", "url": "https://github.com/laravel/framework.git", - "reference": "7047df295e77cecb6a2f84736a732af66cc6789c" + "reference": "2fe661f2444410a576aa40054ad9b7fe0bb5cee5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laravel/framework/zipball/7047df295e77cecb6a2f84736a732af66cc6789c", - "reference": "7047df295e77cecb6a2f84736a732af66cc6789c", + "url": "https://api.github.com/repos/laravel/framework/zipball/2fe661f2444410a576aa40054ad9b7fe0bb5cee5", + "reference": "2fe661f2444410a576aa40054ad9b7fe0bb5cee5", "shasum": "" }, "require": { @@ -1250,7 +1250,7 @@ "framework", "laravel" ], - "time": "2018-06-20T14:21:11+00:00" + "time": "2018-07-10T13:47:01+00:00" }, { "name": "laravel/socialite", diff --git a/config/services.php b/config/services.php index 136eb40..6aa4239 100644 --- a/config/services.php +++ b/config/services.php @@ -54,5 +54,12 @@ return [ 'redirect_uri' => env('OAUTH_GITHUB_REDIRECT'), 'scope' => [], ], + 'stack' => [ + 'client_id' => env('OAUTH_STACK_ID'), + 'client_secret' => env('OAUTH_STACK_SECRET'), + 'redirect_uri' => env('OAUTH_STACK_REDIRECT'), + 'key' => env('OAUTH_STACK_KEY'), + 'scope' => [], + ], ], ]; diff --git a/database/migrations/2014_10_12_000000_create_users_table.php b/database/migrations/2014_10_12_000000_create_users_table.php index 1220646..f98c88a 100644 --- a/database/migrations/2014_10_12_000000_create_users_table.php +++ b/database/migrations/2014_10_12_000000_create_users_table.php @@ -17,7 +17,7 @@ class CreateUsersTable extends Migration $table->increments('id'); $table->timestamps(); $table->string('name'); - $table->string('email')->unique(); + $table->string('email')->unique()->nullable(); $table->string('password')->nullable(); $table->rememberToken(); }); diff --git a/resources/views/auth/login.blade.php b/resources/views/auth/login.blade.php index 2f8282b..c266525 100644 --- a/resources/views/auth/login.blade.php +++ b/resources/views/auth/login.blade.php @@ -65,15 +65,21 @@
- {{ __('Log in with') }} + {{ __('Log in with') }} -
+
@set('services.oauth_providers.github.client_id') {{ __('GitHub') }} @endset + @set('services.oauth_providers.stack.client_id') + + {{ __('StackOverflow') }} + + @endset + @set('services.oauth_providers.google.client_id') {{ __('Google') }} diff --git a/routes/web.php b/routes/web.php index 963f90f..5bf699c 100644 --- a/routes/web.php +++ b/routes/web.php @@ -1,6 +1,7 @@ name('home'); // ----------------- SOCIAL LOGIN -------------------- +function _loginVia($method) { + try { + SocialAuth::login($method, function (\App\Models\User $user, ProviderUser $details) { + // update user name first time user logs in + if (!$user->exists) { + $user->name = $details->nickname ?: ($details->full_name ?: $details->email); + } + + // set e-mail from provider data, only if user e-mail is empty + if ("$user->email" === "") { + $user->email = $details->email; + } + }); + } catch (ApplicationRejectedException $e) { + abort(401, $e->getMessage()); + } catch (InvalidAuthorizationCodeException $e) { + abort(401, $e->getMessage()); + } + return Redirect::intended(); +}; + + Route::get('/auth/github/authorize', function() { return SocialAuth::authorize('github'); })->name('oauth-github-authorize'); Route::get('/auth/github/callback', function() { - try { - SocialAuth::login('github'); - } catch (ApplicationRejectedException $e) { - abort(401, $e->getMessage()); - } catch (InvalidAuthorizationCodeException $e) { - abort(401, $e->getMessage()); - } - return Redirect::intended(); + return _loginVia('github'); })->name('oauth-github-callback'); - Route::get('/auth/google/authorize', function() { return SocialAuth::authorize('google'); })->name('oauth-google-authorize'); Route::get('/auth/google/callback', function() { - try { - SocialAuth::login('google'); - } catch (ApplicationRejectedException $e) { - abort(401); - } catch (InvalidAuthorizationCodeException $e) { - abort(401); - } - return Redirect::intended(); + return _loginVia('google'); })->name('oauth-google-callback'); - - Route::get('/auth/facebook/authorize', function() { return SocialAuth::authorize('facebook'); })->name('oauth-facebook-authorize'); Route::get('/auth/facebook/callback', function() { - try { - SocialAuth::login('facebook'); - } catch (ApplicationRejectedException $e) { - abort(401); - } catch (InvalidAuthorizationCodeException $e) { - abort(401); - } - return Redirect::intended(); + return _loginVia('facebook'); })->name('oauth-facebook-callback'); + + +Route::get('/auth/stack/authorize', function() { + return SocialAuth::authorize('stack'); +})->name('oauth-stack-authorize'); + +Route::get('/auth/stack/callback', function() { + return _loginVia('stack'); +})->name('oauth-stack-callback'); diff --git a/sideload/adamwathan/eloquent-oauth-l5/src/EloquentOAuthServiceProvider.php b/sideload/adamwathan/eloquent-oauth-l5/src/EloquentOAuthServiceProvider.php index a30283a..89df780 100644 --- a/sideload/adamwathan/eloquent-oauth-l5/src/EloquentOAuthServiceProvider.php +++ b/sideload/adamwathan/eloquent-oauth-l5/src/EloquentOAuthServiceProvider.php @@ -20,6 +20,7 @@ class EloquentOAuthServiceProvider extends ServiceProvider { 'facebook' => 'SocialNorm\Facebook\FacebookProvider', 'github' => 'SocialNorm\GitHub\GitHubProvider', 'google' => 'SocialNorm\Google\GoogleProvider', + 'stack' => 'SocialNorm\StackOverflow\StackOverflowProvider', ]; /** @@ -74,7 +75,7 @@ class EloquentOAuthServiceProvider extends ServiceProvider { }); } - protected function registerProviders($socialnorm, $request) + protected function registerProviders(SocialNorm $socialnorm, $request) { if (! $providerAliases = $this->app['config']['services.oauth_providers']) { return; diff --git a/sideload/adamwathan/eloquent-oauth/src/Authenticator.php b/sideload/adamwathan/eloquent-oauth/src/Authenticator.php index 7c716d5..3b04afd 100644 --- a/sideload/adamwathan/eloquent-oauth/src/Authenticator.php +++ b/sideload/adamwathan/eloquent-oauth/src/Authenticator.php @@ -1,77 +1,92 @@ auth = $auth; + $this->guard = $auth; $this->users = $users; $this->identities = $identities; } - public function login($providerAlias, $userDetails, $callback = null) + public function login($providerAlias, ProviderUser $userDetails, $callback = null) { + /** @var Model|Authenticatable $user */ $user = $this->getUser($providerAlias, $userDetails); $user = $this->runCallback($callback, $user, $userDetails); $this->updateUser($user, $providerAlias, $userDetails); - $this->auth->login($user); + $this->guard->login($user); } - protected function getUser($providerAlias, \SocialNorm\User $details) + protected function getUser($providerAlias, ProviderUser $details) // returns User { - if ($this->identities->userExists($providerAlias, $details)) { + if ($this->identities->userExists($providerAlias, $details, false)) { return $this->getExistingUser($providerAlias, $details); } - /** @var \App\Models\User $newuser */ - $newuser = $this->users->create(); - $newuser->name = $details->nickname ?: ($details->full_name ?: $details->email); - $newuser->email = $details->email; - return $newuser; + // this is potentially unsafe - allows user to attach a social identity to an + // existing account just my matching the e-mail. + + // we have to assume the providers are trustworthy. + if ($details->email && $this->identities->userExists($providerAlias, $details, true)) { + return $this->users->findByEmail($details->email); + } + + return $this->users->create(); } - protected function runCallback($callback, $user, $userDetails) + protected function runCallback($callback, Model $user, ProviderUser $userDetails) { $callback = $callback ?: function () {}; $callbackUser = $callback($user, $userDetails); return $callbackUser ?: $user; } - protected function updateUser($user, $providerAlias, $details) + protected function updateUser(Model $user, $providerAlias, ProviderUser $details) { $this->users->store($user); $this->storeProviderIdentity($user, $providerAlias, $details); } - protected function getExistingUser($providerAlias, $details) + protected function getExistingUser($providerAlias, ProviderUser $details) { $identity = $this->identities->getByProvider($providerAlias, $details); return $this->users->findByIdentity($identity); } - protected function storeProviderIdentity($user, $providerAlias, $details) + protected function storeProviderIdentity(Model $user, string $providerAlias, ProviderUser $details) { - if ($this->identities->userExists($providerAlias, $details)) { + if ($this->identities->userExists($providerAlias, $details, false)) { $this->updateProviderIdentity($providerAlias, $details); } else { $this->addProviderIdentity($user, $providerAlias, $details); } } - protected function updateProviderIdentity($providerAlias, $details) + protected function updateProviderIdentity(string $providerAlias, ProviderUser $details) { $identity = $this->identities->getByProvider($providerAlias, $details); $identity->access_token = $details->access_token; $this->identities->store($identity); } - protected function addProviderIdentity($user, $providerAlias, $details) + /** + * @param Model $user + * @param $providerAlias + * @param $details + */ + protected function addProviderIdentity(Model $user, string $providerAlias, ProviderUser $details) { $identity = new OAuthIdentity; $identity->user_id = $user->getKey(); diff --git a/sideload/adamwathan/eloquent-oauth/src/EloquentIdentityStore.php b/sideload/adamwathan/eloquent-oauth/src/EloquentIdentityStore.php index abca964..1f22924 100644 --- a/sideload/adamwathan/eloquent-oauth/src/EloquentIdentityStore.php +++ b/sideload/adamwathan/eloquent-oauth/src/EloquentIdentityStore.php @@ -1,28 +1,58 @@ -where('provider_user_id', $providerUser->id) ->first(); } - public function flush($user, $provider) + /** + * Try to retrieve user by their e-mail + * (!!! this is coupled to the application code !!!) + * + * @param ProviderUser $providerUser + * @return User|Model|null|object + */ + public function getByEmail(ProviderUser $providerUser) + { + $first = User::where('email', $providerUser->email)->first(); + + if($first->email) return $first; + return null; + } + + public function flush(Model $user, string $provider) { OAuthIdentity::where('user_id', $user->getKey()) ->where('provider', $provider) ->delete(); } - public function store($identity) + public function store(OAuthIdentity $identity) { $identity->save(); } - public function userExists($provider, $providerUser) + public function userExists(string $provider, ProviderUser $providerUser, bool $allowByEmail) { - return (bool) $this->getByProvider($provider, $providerUser); + $byProvider = (bool) $this->getByProvider($provider, $providerUser); + if ($byProvider) return true; + + if (!$allowByEmail) return false; + + if ($providerUser->email) { + $byEmail = $this->getByEmail($providerUser); + if ($byEmail) return true; + } + + return false; } } diff --git a/sideload/adamwathan/eloquent-oauth/src/IdentityStore.php b/sideload/adamwathan/eloquent-oauth/src/IdentityStore.php index 414965a..a6d67ac 100644 --- a/sideload/adamwathan/eloquent-oauth/src/IdentityStore.php +++ b/sideload/adamwathan/eloquent-oauth/src/IdentityStore.php @@ -1,9 +1,13 @@ redirect = $redirect; $this->authenticator = $authenticator; $this->socialnorm = $socialnorm; } - public function authorize($providerAlias) + public function authorize(string $providerAlias) { return $this->redirect->to($this->socialnorm->authorize($providerAlias)); } - public function login($providerAlias, $callback = null) + /** + * @param $providerAlias + * @param \Closure|null $callback + */ + public function login(string $providerAlias, $callback = null) { $details = $this->socialnorm->getUser($providerAlias); return $this->authenticator->login($providerAlias, $details, $callback); } - public function registerProvider($alias, $provider) + public function registerProvider(string $alias, Provider $provider) { $this->socialnorm->registerProvider($alias, $provider); } diff --git a/sideload/adamwathan/eloquent-oauth/src/Session.php b/sideload/adamwathan/eloquent-oauth/src/Session.php index 5264629..1a60ca0 100644 --- a/sideload/adamwathan/eloquent-oauth/src/Session.php +++ b/sideload/adamwathan/eloquent-oauth/src/Session.php @@ -4,20 +4,29 @@ use SocialNorm\Session as SocialNormSession; class Session implements SocialNormSession { + /** @var \Illuminate\Session\SessionManager */ private $store; - public function __construct($store) + public function __construct(\Illuminate\Session\SessionManager $store) { $this->store = $store; } + /** + * @param string $key + * @return mixed + */ public function get($key) { return $this->store->get($key); } + /** + * @param string $key + * @param mixed|null $value + */ public function put($key, $value) { - return $this->store->put($key, $value); + $this->store->put($key, $value); } } diff --git a/sideload/adamwathan/eloquent-oauth/src/UserStore.php b/sideload/adamwathan/eloquent-oauth/src/UserStore.php index fd6e9d5..e9b53fc 100644 --- a/sideload/adamwathan/eloquent-oauth/src/UserStore.php +++ b/sideload/adamwathan/eloquent-oauth/src/UserStore.php @@ -1,27 +1,35 @@ model = $model; + $this->modelClass = $modelClass; } public function create() { - $user = new $this->model; + $user = new $this->modelClass; return $user; } - public function store($user) + public function store(Model $user) { return $user->save(); } - public function findByIdentity($identity) + public function findByIdentity(OAuthIdentity $identity) + { + return $identity->belongsTo($this->modelClass, 'user_id')->firstOrFail(); + } + + public function findByEmail(string $email) { - return $identity->belongsTo($this->model, 'user_id')->firstOrFail(); + return $this->modelClass::where('email', $email)->firstOrFail(); } } diff --git a/sideload/socialnorm/facebook/src/FacebookProvider.php b/sideload/socialnorm/facebook/src/FacebookProvider.php index 0e33614..cab093e 100644 --- a/sideload/socialnorm/facebook/src/FacebookProvider.php +++ b/sideload/socialnorm/facebook/src/FacebookProvider.php @@ -1,5 +1,6 @@ getProviderUserData('email'); + return $this->getProviderUserData('given_name'); } protected function fullName() { - return $this->getProviderUserData('given_name') . ' ' . $this->getProviderUserData('family_name'); + return $this->getProviderUserData('name'); // this is the full name } protected function avatar() diff --git a/sideload/socialnorm/socialnorm/src/Provider.php b/sideload/socialnorm/socialnorm/src/Provider.php index e29b9c7..7471590 100644 --- a/sideload/socialnorm/socialnorm/src/Provider.php +++ b/sideload/socialnorm/socialnorm/src/Provider.php @@ -2,6 +2,6 @@ interface Provider { - public function authorizeUrl($state); - public function getUser(); + public function authorizeUrl(string $state) : string; + public function getUser() : ProviderUser; } diff --git a/sideload/socialnorm/socialnorm/src/ProviderRegistry.php b/sideload/socialnorm/socialnorm/src/ProviderRegistry.php index fc40219..89e707d 100644 --- a/sideload/socialnorm/socialnorm/src/ProviderRegistry.php +++ b/sideload/socialnorm/socialnorm/src/ProviderRegistry.php @@ -4,14 +4,15 @@ use SocialNorm\Exceptions\ProviderNotRegisteredException; class ProviderRegistry { + /** @var Provider[] */ private $providers = []; - public function registerProvider($alias, Provider $provider) + public function registerProvider(string $alias, Provider $provider) { $this->providers[$alias] = $provider; } - public function getProvider($providerAlias) + public function getProvider(string $providerAlias) { if (! $this->hasProvider($providerAlias)) { throw new ProviderNotRegisteredException("No provider has been registered under the alias '{$providerAlias}'"); @@ -19,7 +20,7 @@ class ProviderRegistry return $this->providers[$providerAlias]; } - protected function hasProvider($alias) + protected function hasProvider(string $alias) { return isset($this->providers[$alias]); } diff --git a/sideload/socialnorm/socialnorm/src/User.php b/sideload/socialnorm/socialnorm/src/ProviderUser.php similarity index 88% rename from sideload/socialnorm/socialnorm/src/User.php rename to sideload/socialnorm/socialnorm/src/ProviderUser.php index d1e9c88..109a99f 100644 --- a/sideload/socialnorm/socialnorm/src/User.php +++ b/sideload/socialnorm/socialnorm/src/ProviderUser.php @@ -1,14 +1,16 @@ httpClient = $httpClient; $this->request = $request; @@ -44,7 +44,7 @@ abstract class OAuth2Provider implements Provider return $this->redirectUri; } - public function authorizeUrl($state) + public function authorizeUrl(string $state) : string { $url = $this->getAuthorizeUrl(); $url .= '?' . $this->buildAuthorizeQueryString($state); @@ -66,11 +66,11 @@ abstract class OAuth2Provider implements Provider return implode(',', $this->scope); } - public function getUser() + public function getUser() : ProviderUser { $this->accessToken = $this->requestAccessToken(); $this->providerUserData = $this->requestUserData(); - return new User([ + return new ProviderUser([ 'access_token' => $this->accessToken, 'id' => $this->userId(), 'nickname' => $this->nickname(), diff --git a/sideload/socialnorm/socialnorm/src/SocialNorm.php b/sideload/socialnorm/socialnorm/src/SocialNorm.php index 8607fd5..1f034dd 100644 --- a/sideload/socialnorm/socialnorm/src/SocialNorm.php +++ b/sideload/socialnorm/socialnorm/src/SocialNorm.php @@ -4,9 +4,13 @@ use SocialNorm\Exceptions\InvalidAuthorizationCodeException; class SocialNorm { + /** @var ProviderRegistry */ protected $providers; + /** @var Session */ protected $session; + /** @var Request */ protected $request; + /** @var StateGenerator */ protected $stateGenerator; public function __construct( @@ -22,12 +26,12 @@ class SocialNorm $this->stateGenerator = $stateGenerator; } - public function registerProvider($alias, Provider $provider) + public function registerProvider(string $alias, Provider $provider) { $this->providers->registerProvider($alias, $provider); } - public function authorize($providerAlias) + public function authorize(string $providerAlias) { $state = $this->stateGenerator->generate(); @@ -36,13 +40,13 @@ class SocialNorm return $this->getProvider($providerAlias)->authorizeUrl($state); } - public function getUser($providerAlias) + public function getUser(string $providerAlias) { $this->verifyState(); return $this->getProvider($providerAlias)->getUser(); } - protected function getProvider($providerAlias) + protected function getProvider(string $providerAlias) { return $this->providers->getProvider($providerAlias); } diff --git a/sideload/socialnorm/socialnorm/src/StateGenerator.php b/sideload/socialnorm/socialnorm/src/StateGenerator.php index 404edd6..9178bc8 100644 --- a/sideload/socialnorm/socialnorm/src/StateGenerator.php +++ b/sideload/socialnorm/socialnorm/src/StateGenerator.php @@ -2,7 +2,7 @@ class StateGenerator { - public function generate($length = 32) + public function generate(int $length = 32) { $pool = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; return substr(str_shuffle(str_repeat($pool, $length)), 0, $length); diff --git a/sideload/socialnorm/stackoverflow/.gitignore b/sideload/socialnorm/stackoverflow/.gitignore new file mode 100644 index 0000000..2c1fc0c --- /dev/null +++ b/sideload/socialnorm/stackoverflow/.gitignore @@ -0,0 +1,4 @@ +/vendor +composer.phar +composer.lock +.DS_Store \ No newline at end of file diff --git a/sideload/socialnorm/stackoverflow/.travis.yml b/sideload/socialnorm/stackoverflow/.travis.yml new file mode 100644 index 0000000..27e355f --- /dev/null +++ b/sideload/socialnorm/stackoverflow/.travis.yml @@ -0,0 +1,11 @@ +language: php + +php: + - 5.5 + - 5.6 + +before_script: + - curl -s http://getcomposer.org/installer | php + - php composer.phar install --dev + +script: phpunit diff --git a/sideload/socialnorm/stackoverflow/composer.json b/sideload/socialnorm/stackoverflow/composer.json new file mode 100644 index 0000000..f2471dd --- /dev/null +++ b/sideload/socialnorm/stackoverflow/composer.json @@ -0,0 +1,29 @@ +{ + "name": "socialnorm/stackoverflow", + "description": "StackOverflow provider for SocialNorm", + "authors": [ + { + "name": "MightyPork" + } + ], + "license": "MIT", + "require": { + "php": ">=5.5.0", + "guzzlehttp/guzzle": "^6.0", + "socialnorm/socialnorm": "^0.2" + }, + "require-dev": { + "mockery/mockery": "~0.8", + "phpunit/phpunit": "^4.8" + }, + "autoload": { + "psr-4": { + "SocialNorm\\StackOverflow\\": "src/" + } + }, + "autoload-dev": { + "files": [ + "tests/TestCase.php" + ] + } +} diff --git a/sideload/socialnorm/stackoverflow/phpunit.xml b/sideload/socialnorm/stackoverflow/phpunit.xml new file mode 100644 index 0000000..60eb54f --- /dev/null +++ b/sideload/socialnorm/stackoverflow/phpunit.xml @@ -0,0 +1,18 @@ + + + + + ./tests/ + + + diff --git a/sideload/socialnorm/stackoverflow/readme.md b/sideload/socialnorm/stackoverflow/readme.md new file mode 100644 index 0000000..2d39514 --- /dev/null +++ b/sideload/socialnorm/stackoverflow/readme.md @@ -0,0 +1,3 @@ +## SocialNorm Google Provider + +@todo: Add docs :) diff --git a/sideload/socialnorm/stackoverflow/src/StackOverflowProvider.php b/sideload/socialnorm/stackoverflow/src/StackOverflowProvider.php new file mode 100644 index 0000000..e23403d --- /dev/null +++ b/sideload/socialnorm/stackoverflow/src/StackOverflowProvider.php @@ -0,0 +1,100 @@ + [], + 'access_token' => [ + 'Content-Type' => 'application/x-www-form-urlencoded' + ], + 'user_details' => [], + ]; + + public function __construct(array $config, HttpClient $httpClient, Request $request) + { + parent::__construct($config, $httpClient, $request); + $this->key = $config['key']; + } + + protected function compileScopes() + { + return implode(' ', $this->scope); + } + + protected function getAuthorizeUrl() + { + return $this->authorizeUrl; + } + + protected function getAccessTokenBaseUrl() + { + return $this->accessTokenUrl; + } + + protected function getUserDataUrl() + { + return $this->userDataUrl; + } + + protected function buildUserDataUrl() + { + $url = $this->getUserDataUrl(); + + $url .= "?access_token=".$this->accessToken + . "&site=stackoverflow" + . "&key=".$this->key; + + return $url; + } + + protected function parseTokenResponse($response) + { + return $this->parseJsonTokenResponse($response); + } + + protected function parseUserDataResponse($response) + { + return json_decode($response, true); + } + + protected function userId() + { + return array_get($this->providerUserData, 'items.0.account_id'); + } + + protected function nickname() + { + return array_get($this->providerUserData, 'items.0.display_name'); + } + + protected function fullName() + { + return array_get($this->providerUserData, 'items.0.display_name'); + } + + protected function avatar() + { + return array_get($this->providerUserData, 'items.0.profile_image'); + } + + protected function email() + { + return null; + } +} diff --git a/sideload/socialnorm/stackoverflow/tests/.gitkeep b/sideload/socialnorm/stackoverflow/tests/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sideload/socialnorm/stackoverflow/tests/GoogleProviderTest.php b/sideload/socialnorm/stackoverflow/tests/GoogleProviderTest.php new file mode 100644 index 0000000..3f00f33 --- /dev/null +++ b/sideload/socialnorm/stackoverflow/tests/GoogleProviderTest.php @@ -0,0 +1,75 @@ +createResponses($fixtures)); + $handler = HandlerStack::create($mock); + return new HttpClient(['handler' => $handler]); + } + + private function createResponses($fixtures) + { + $responses = []; + foreach ($fixtures as $fixture) { + $response = require $fixture; + $responses[] = new Response($response['status'], $response['headers'], $response['body']); + } + + return $responses; + } + + /** @test */ + public function it_can_retrieve_a_normalized_user() + { + $client = $this->getStubbedHttpClient([ + __DIR__ . '/_fixtures/google_accesstoken.php', + __DIR__ . '/_fixtures/google_user.php', + ]); + + $provider = new GoogleProvider([ + 'client_id' => 'abcdefgh', + 'client_secret' => '12345678', + 'redirect_uri' => 'http://example.com/login', + ], $client, new Request(['code' => 'abc123'])); + + $user = $provider->getUser(); + + $this->assertEquals('103904294571447333816', $user->id); + $this->assertEquals('adam.wathan@example.com', $user->nickname); + $this->assertEquals('Adam Wathan', $user->full_name); + $this->assertEquals('adam.wathan@example.com', $user->email); + $this->assertEquals('https://lh3.googleusercontent.com/-w0_RpDnsIE4/AAAAAAAAAAI/AAAAAAAAAKM/NEiV3jig1HA/photo.jpg', $user->avatar); + $this->assertEquals('ya29.8xFOTYpQK48RgPH8KjQpSu9SrcANcOQx9JtRnEu52dNsXqai8VD4iY3nFzUBURWnAPeTPtPeIBNjIF', $user->access_token); + } + + /** + * @test + * @expectedException SocialNorm\Exceptions\ApplicationRejectedException + */ + public function it_fails_to_retrieve_a_user_when_the_authorization_code_is_omitted() + { + $client = $this->getStubbedHttpClient([ + __DIR__ . '/_fixtures/google_accesstoken.php', + __DIR__ . '/_fixtures/google_user.php', + ]); + + $provider = new GoogleProvider([ + 'client_id' => 'abcdefgh', + 'client_secret' => '12345678', + 'redirect_uri' => 'http://example.com/login', + ], $client, new Request([])); + + $user = $provider->getUser(); + } +} diff --git a/sideload/socialnorm/stackoverflow/tests/TestCase.php b/sideload/socialnorm/stackoverflow/tests/TestCase.php new file mode 100644 index 0000000..e619738 --- /dev/null +++ b/sideload/socialnorm/stackoverflow/tests/TestCase.php @@ -0,0 +1,12 @@ + 200, + 'headers' => [ + 'Content-Type' => 'application/json; charset=utf-8', + 'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate', + 'Pragma' => 'no-cache', + 'Expires' => 'Fri, 01 Jan 1990 00:00:00 GMT', + 'Date' => 'Thu, 19 Mar 2015 13:14:56 GMT', + 'Content-Disposition' => 'attachment; filename="json.txt"; filename*=UTF-8\'\'json.txt', + 'X-Content-Type-Options' => 'nosniff', + 'X-Frame-Options' => 'SAMEORIGIN', + 'X-XSS-Protection' => '1; mode=block', + 'Server' => 'GSE', + 'Alternate-Protocol' => '443:quic,p=0.5', + 'Accept-Ranges' => 'none', + 'Vary' => 'Accept-Encoding', + 'Transfer-Encoding' => 'chunked' + ], + 'body' => '{"access_token" :"ya29.8xFOTYpQK48RgPH8KjQpSu9SrcANcOQx9JtRnEu52dNsXqai8VD4iY3nFzUBURWnAPeTPtPeIBNjIF","token_type" :"Bearer","expires_in" :3600,"id_token" :"6XFIidpthpu8iFNhyo5xjcGa9bUdiTL1zKnZz2dN-35IFzlCJ_IcmHYcA1i03iA5YVMOM1nLGiAbRaLTaMoWM5X_j0MyFBknwGMs3MM2WmdiIhdC7uNiXY2US8mWvCiVNwMnchpkJJUGIMbTNNPQd5_08XQvNi3TINiYOwZLxOIJ6X3pi9hNVY0dNNtUYwYdiNgwIW3ClRNNY1jiZxciXSckj18jb2jbSMMYujDKbw9ipMOIUxlnm5zIzEjNLV1BcMFMbjQWBnhjFUW4li-QTjcSnfj5iMdUIkjlGvkWcoLQ3pNNOwMhwjZFhdv0G3DTyT2nyOIR3eejckDXGWGw4l2Ni3izRwMYctNF1I_VstkDwn1idZoMOdR3b-zEO5C9ItMzl0TyNJjeb73VFrQIwXpHcTTQMgym2o3mijwJTn2ypu9NP0jjM1lcjd0Euh0OLJYxIYTIfbBC5WuCDcDMZxCbcz7oYLMl2yYDmI0akcuiVZyDO2I1aS2DAIUip.oTuI0HnAbtiA5y.Tnywh3VU0JTZ2Iu9OhJnYkvYmhzOm2AYbu5P9Q71UQObK2tLNcYQmBDmZGsQNIMwh1tQtl0sDTXj9WTVETuYAx4WK9hoOzcOVEY8iNHcl"}' +]; + + diff --git a/sideload/socialnorm/stackoverflow/tests/_fixtures/google_user.php b/sideload/socialnorm/stackoverflow/tests/_fixtures/google_user.php new file mode 100644 index 0000000..60117ca --- /dev/null +++ b/sideload/socialnorm/stackoverflow/tests/_fixtures/google_user.php @@ -0,0 +1,23 @@ + 200, + 'headers' => [ + 'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate', + 'Pragma' => 'no-cache', + 'Expires' => 'Fri, 01 Jan 1990 00:00:00 GMT', + 'Date' => 'Thu, 19 Mar 2015 13:15:29 GMT', + 'Vary' => 'X-Origin, Origin,Accept-Encoding', + 'Content-Type' => 'application/json; charset=UTF-8', + 'X-Content-Type-Options' => 'nosniff', + 'X-Frame-Options' => 'SAMEORIGIN', + 'X-XSS-Protection' => '1; mode=block', + 'Server' => 'GSE', + 'Alternate-Protocol' => '443:quic,p=0.5', + 'Accept-Ranges' => 'none', + 'Transfer-Encoding' => 'chunked' + ], + 'body' => '{"id":"103904294571447333816","email":"adam.wathan@example.com","verified_email":true,"name":"Adam Wathan","given_name":"Adam","family_name":"Wathan","link":"https://plus.google.com/103904294571447333816","picture":"https://lh3.googleusercontent.com/-w0_RpDnsIE4/AAAAAAAAAAI/AAAAAAAAAKM/NEiV3jig1HA/photo.jpg","gender":"male","locale":"en"}' +]; + +