Add Online Scout Manager (OSM) provider (#1418)

Author: Addy010

monorepo-builder.yml

@@ -144,6 +144,7 @@ parameters:
     src/Notion: 'git@github.com:SocialiteProviders/Notion.git'
     src/Nuvemshop: 'git@github.com:SocialiteProviders/Nuvemshop.git'
     src/OAuthgen: 'git@github.com:SocialiteProviders/OAuthgen.git'
+    src/OnlineScoutManager: 'git@github.com:SocialiteProviders/OnlineScoutManager.git'
     src/OSChina: 'git@github.com:SocialiteProviders/OSChina.git'
     src/Odnoklassniki: 'git@github.com:SocialiteProviders/Odnoklassniki.git'
     src/Okta: 'git@github.com:SocialiteProviders/Okta.git'

src/OnlineScoutManager/OnlineScoutManagerExtendSocialite.php

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

src/OnlineScoutManager/Provider.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace SocialiteProviders\OnlineScoutManager;
+
+use GuzzleHttp\RequestOptions;
+use SocialiteProviders\Manager\OAuth2\AbstractProvider;
+use SocialiteProviders\Manager\OAuth2\User;
+
+class Provider extends AbstractProvider
+{
+    public const IDENTIFIER = 'ONLINESCOUTMANAGER';
+
+    public const URL = 'https://www.onlinescoutmanager.co.uk';
+
+    protected $scopes = [
+        'section:badge:read',
+        'section:event:read',
+        'section:programme:read',
+    ];
+
+    protected $scopeSeparator = ' ';
+
+    protected function getAuthUrl($state): string
+    {
+        return $this->buildAuthUrlFromBase(self::URL.'/oauth/authorize', $state);
+    }
+
+    protected function getTokenUrl(): string
+    {
+        return self::URL.'/oauth/token';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getUserByToken($token)
+    {
+        $response = $this->getHttpClient()->get(self::URL.'/oauth/resource', [
+            RequestOptions::HEADERS => [
+                'Authorization' => 'Bearer '.$token,
+            ],
+        ]);
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function mapUserToObject(array $user)
+    {
+        $user_data = $user['data'];
+
+        return (new User)->setRaw($user)->map([
+            'id'        => $user_data['user_id'],
+            'name'      => $user_data['full_name'],
+            'email'     => $user_data['email'],
+            'avatar'    => $user_data['profile_picture_url'] ?? null,
+            'is_leader' => $user_data['has_section_access'] ?? false
+        ]);
+    }
+}

src/OnlineScoutManager/README.md

@@ -0,0 +1,66 @@
+# Online Scout Manager
+
+```bash
+composer require socialiteproviders/onlinescoutmanager
+```
+
+## 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
+'onlinescoutmanager' => [
+  'client_id' => env('OSM_CLIENT_ID'),
+  'client_secret' => env('OSM_CLIENT_SECRET'),
+  'redirect' => env('OSM_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('onlinescoutmanager', \SocialiteProviders\OnlineScoutManager\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\OnlineScoutManager\OnlineScoutManagerExtendSocialite::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('onlinescoutmanager')->redirect();
+```
+
+### Returned User fields
+
+- ``id``
+- ``name``
+- ``email``
+- ``avatar``
+- ``is_leader``

src/OnlineScoutManager/composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "socialiteproviders/onlinescoutmanager",
+    "description": "OnlineScoutManager OAuth2 Provider for Laravel Socialite",
+    "license": "MIT",
+    "keywords": [
+        "laravel",
+        "oauth",
+        "oauth2",
+        "provider",
+        "socialite",
+        "onlinescoutmanager"
+    ],
+    "authors": [
+        {
+            "name": "Adam Francis",
+            "email": "me@adamfrancis.dev"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/socialiteproviders/providers/issues",
+        "source": "https://github.com/socialiteproviders/providers",
+        "docs": "https://socialiteproviders.com/onlinescoutmanager"
+    },
+    "require": {
+        "php": "^8.4",
+        "ext-json": "*",
+        "socialiteproviders/manager": "^4.4"
+    },
+    "autoload": {
+        "psr-4": {
+            "SocialiteProviders\\OnlineScoutManager\\": ""
+        }
+    }
+}