feat: implement OAuth2 client for Paymenter (#1400)

Author: damoun

monorepo-builder.yml

@@ -153,6 +153,7 @@ parameters:
     src/Orcid: 'git@github.com:SocialiteProviders/Orcid.git'
     src/Ovh: 'git@github.com:SocialiteProviders/Ovh.git'
     src/Patreon: 'git@github.com:SocialiteProviders/Patreon.git'
+    src/Paymenter: 'git@github.com:SocialiteProviders/Paymenter.git'
     src/PayPal: 'git@github.com:SocialiteProviders/PayPal.git'
     src/PayPalSandbox: 'git@github.com:SocialiteProviders/PayPal-Sandbox.git'
     src/Paymill: 'git@github.com:SocialiteProviders/Paymill.git'

src/Paymenter/PaymenterExtendSocialite.php

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

src/Paymenter/Provider.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace SocialiteProviders\Paymenter;
+
+use GuzzleHttp\RequestOptions;
+use InvalidArgumentException;
+use SocialiteProviders\Manager\OAuth2\AbstractProvider;
+use SocialiteProviders\Manager\OAuth2\User;
+
+class Provider extends AbstractProvider
+{
+    public const IDENTIFIER = 'PAYMENTER';
+
+    protected $scopes = ['profile'];
+
+    public static function additionalConfigKeys(): array
+    {
+        return ['base_url'];
+    }
+
+    protected function getBaseUrl()
+    {
+        $baseurl = $this->getConfig('base_url');
+        if ($baseurl === null) {
+            throw new InvalidArgumentException('Missing base_url');
+        }
+
+        return rtrim($baseurl, '/');
+    }
+
+    protected function getAuthUrl($state): string
+    {
+        return $this->buildAuthUrlFromBase($this->getBaseUrl().'/oauth/authorize', $state);
+    }
+
+    protected function getTokenUrl(): string
+    {
+        return $this->getBaseUrl().'/api/oauth/token';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getUserByToken($token)
+    {
+        $response = $this->getHttpClient()->get($this->getBaseUrl().'/api/oauth/me', [
+            RequestOptions::HEADERS => [
+                'Authorization' => 'Bearer '.$token,
+            ],
+        ]);
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function refreshToken($refreshToken)
+    {
+        $response = $this->getHttpClient()->post($this->getTokenUrl(), [
+            RequestOptions::FORM_PARAMS => [
+                'client_id'     => $this->clientId,
+                'client_secret' => $this->clientSecret,
+                'grant_type'    => 'refresh_token',
+                'refresh_token' => $refreshToken,
+            ],
+        ]);
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function mapUserToObject(array $user)
+    {
+        return (new User)->setRaw($user)->map([
+            'email'              => $user['email'],
+            'email_verified'     => !empty($user['email_verified_at']),
+            'name'               => $user['first_name'],
+            'family_name'        => $user['last_name'],
+            'groups'             => $user['role_id'],
+            'id'                 => $user['id'],
+        ]);
+    }
+}

src/Paymenter/README.md

@@ -0,0 +1,75 @@
+# Paymenter
+
+```bash
+composer require socialiteproviders/paymenter
+```
+
+## Installation & Basic Usage
+
+Please see the [Base Installation Guide](https://socialiteproviders.com/usage/),
+then follow the provider specific instructions below.
+
+### Prepare OAuth provider & application in Paymenter
+
+Create a new OAuth Client within Paymenter, according to the Paymenter
+Documentation (https://paymenter.org/development/OAuth)
+
+### Add configuration to `config/services.php`
+
+```php
+'paymenter' => [
+  'base_url' => env('PAYMENTER_BASE_URL'),
+  'client_id' => env('PAYMENTER_CLIENT_ID'),
+  'client_secret' => env('PAYMENTER_CLIENT_SECRET'),
+  'redirect' => env('PAYMENTER_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('paymenter', \SocialiteProviders\Paymenter\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\Paymenter\PaymenterExtendSocialite::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('paymenter')->redirect();
+```
+
+To redirect to the authentication, and then:
+
+```php
+$user = Socialite::driver('paymenter')->user()
+```
+
+In the return function. The user will contain a `name` and `email` field
+populated from the OAuth source.

src/Paymenter/composer.json

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