Add PocketID provider (#1379)

Author: brufdev

monorepo-builder.yml

@@ -159,6 +159,7 @@ parameters:
     src/Pipedrive: 'git@github.com:SocialiteProviders/Pipedrive.git'
     src/Pixnet: 'git@github.com:SocialiteProviders/Pixnet.git'
     src/PlanningCenter: 'git@github.com/SocialiteProviders/PlanningCenter.git'
+    src/PocketID: 'git@github.com:SocialiteProviders/PocketID.git'
     src/Podio: 'git@github.com:SocialiteProviders/Podio.git'
     src/Pr0gramm: 'git@github.com:SocialiteProviders/Pr0gramm.git'
     src/Procore: 'git@github.com:SocialiteProviders/Procore.git'

src/PocketID/PocketIDExtendSocialite.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SocialiteProviders\PocketID;
+
+use SocialiteProviders\Manager\SocialiteWasCalled;
+
+class PocketIDExtendSocialite
+{
+    public function handle(SocialiteWasCalled $socialiteWasCalled): void
+    {
+        $socialiteWasCalled->extendSocialite('pocketid', Provider::class);
+    }
+}

src/PocketID/Provider.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace SocialiteProviders\PocketID;
+
+use GuzzleHttp\RequestOptions;
+use InvalidArgumentException;
+use SocialiteProviders\Manager\OAuth2\AbstractProvider;
+use SocialiteProviders\Manager\OAuth2\User;
+
+class Provider extends AbstractProvider
+{
+    public const IDENTIFIER = 'POCKETID';
+
+    protected $scopes = ['openid', 'profile', 'email'];
+
+    protected $scopeSeparator = ' ';
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function additionalConfigKeys()
+    {
+        return ['base_url'];
+    }
+
+    protected function getBaseUrl()
+    {
+        $baseurl = $this->getConfig('base_url');
+
+        if ($baseurl === null) {
+            throw new InvalidArgumentException('Missing base_url');
+        }
+
+        return rtrim($baseurl, '/');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getAuthUrl($state)
+    {
+        return $this->buildAuthUrlFromBase($this->getBaseUrl().'/authorize', $state);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getTokenUrl()
+    {
+        return $this->getBaseUrl().'/api/oidc/token';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getUserByToken($token)
+    {
+        $response = $this->getHttpClient()->get($this->getBaseUrl().'/api/oidc/userinfo', [
+            RequestOptions::HEADERS => [
+                'Authorization' => 'Bearer '.$token,
+            ],
+        ]);
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function mapUserToObject(array $user)
+    {
+        return (new User())->setRaw($user)->map([
+            'id'                 => $user['sub'],
+            'name'               => $user['name'] ?? null,
+            'given_name'         => $user['given_name'] ?? null,
+            'family_name'        => $user['family_name'] ?? null,
+            'preferred_username' => $user['preferred_username'] ?? null,
+            'email'              => $user['email'] ?? null,
+            'email_verified'     => $user['email_verified'] ?? null,
+            'picture'            => $user['picture'] ?? null,
+        ]);
+    }
+}

src/PocketID/README.md

@@ -0,0 +1,69 @@
+# PocketID
+
+```bash
+composer require socialiteproviders/pocketid
+```
+
+## Installation & Basic Usage
+
+Please see the [Base Installation Guide](https://socialiteproviders.com/usage/), then follow the provider specific instructions below.
+
+### Add configuration to `config/services.php`
+
+```php
+'pocketid' => [
+  'client_id' => env('POCKETID_CLIENT_ID'),
+  'client_secret' => env('POCKETID_CLIENT_SECRET'),
+  'redirect' => env('POCKETID_REDIRECT_URI'),
+],
+```
+
+### Add provider event listener
+
+#### Laravel 11+
+
+In Laravel 11, the default `EventServiceProvider` provider was removed. Instead, add the listener using the `listen` method on the `Event` facade, in your `AppServiceProvider` `boot` method.
+
+* Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
+
+```php
+Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
+    $event->extendSocialite('pocketid', \SocialiteProviders\PocketID\Provider::class);
+});
+```
+<details>
+<summary>
+Laravel 10 or below
+</summary>
+Configure the package's listener to listen for `SocialiteWasCalled` events.
+
+Add the event to your `listen[]` array in `app/Providers/EventServiceProvider`. See the [Base Installation Guide](https://socialiteproviders.com/usage/) for detailed instructions.
+
+```php
+protected $listen = [
+    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
+        // ... other providers
+        \SocialiteProviders\PocketID\PocketIDExtendSocialite::class.'@handle',
+    ],
+];
+```
+</details>
+
+### Usage
+
+You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):
+
+```php
+return Socialite::driver('pocketid')->redirect();
+```
+
+### Returned User fields
+
+- ``id``
+- ``name``
+- ``given_name``
+- ``family_name``
+- ``preferred_username``
+- ``email``
+- ``email_verified``
+- ``picture``

src/PocketID/composer.json

@@ -0,0 +1,33 @@
+{
+    "name": "socialiteproviders/pocketid",
+    "description": "PocketID OAuth2 Provider for Laravel Socialite",
+    "license": "MIT",
+    "keywords": [
+        "pocketid",
+        "laravel",
+        "oauth",
+        "provider",
+        "socialite"
+    ],
+    "authors": [
+        {
+            "name": "brufdev",
+            "email": "brufdev@proton.me"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/socialiteproviders/providers/issues",
+        "source": "https://github.com/socialiteproviders/providers",
+        "docs": "https://socialiteproviders.com/pocketid"
+    },
+    "require": {
+        "php": "^8.0",
+        "ext-json": "*",
+        "socialiteproviders/manager": "^4.4"
+    },
+    "autoload": {
+        "psr-4": {
+            "SocialiteProviders\\PocketID\\": ""
+        }
+    }
+}