feat: Add Trovo provider (#1427)

Author: notwonderful

monorepo-builder.yml

@@ -226,6 +226,7 @@ parameters:
     src/TwentyThreeAndMe: 'git@github.com:SocialiteProviders/23andme.git'
     src/TwitCasting: 'git@github.com:SocialiteProviders/TwitCasting.git'
     src/Twitch: 'git@github.com:SocialiteProviders/Twitch.git'
+    src/Trovo: 'git@github.com:SocialiteProviders/Trovo.git'
     src/Twitter: 'git@github.com:SocialiteProviders/Twitter.git'
     src/UAEPass: 'git@github.com:SocialiteProviders/UAEPass.git'
     src/UCL: 'git@github.com:SocialiteProviders/UCL.git'

src/Trovo/Provider.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace SocialiteProviders\Trovo;
+
+use GuzzleHttp\RequestOptions;
+use SocialiteProviders\Manager\OAuth2\AbstractProvider;
+use SocialiteProviders\Manager\OAuth2\User;
+
+class Provider extends AbstractProvider
+{
+    public const IDENTIFIER = 'TROVO';
+
+    protected $scopes = ['user_details_self'];
+
+    protected $scopeSeparator = '+';
+
+    protected function getAuthUrl($state): string
+    {
+        return $this->buildAuthUrlFromBase(
+            'https://open.trovo.live/page/login.html',
+            $state
+        );
+    }
+
+    protected function getTokenUrl(): string
+    {
+        return 'https://open-api.trovo.live/openplatform/exchangetoken';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAccessTokenResponse($code)
+    {
+        $fields = $this->getTokenFields($code);
+        unset($fields['client_id']);
+
+        $response = $this->getHttpClient()->post($this->getTokenUrl(), [
+            RequestOptions::HEADERS => [
+                'Accept'    => 'application/json',
+                'Client-ID' => $this->clientId,
+            ],
+            RequestOptions::JSON => $fields,
+        ]);
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getUserByToken($token)
+    {
+        $response = $this->getHttpClient()->get(
+            'https://open-api.trovo.live/openplatform/getuserinfo',
+            [
+                RequestOptions::HEADERS => [
+                    'Accept'        => 'application/json',
+                    'Client-ID'     => $this->clientId,
+                    'Authorization' => 'OAuth '.$token,
+                ],
+            ]
+        );
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function mapUserToObject(array $user)
+    {
+        return (new User)->setRaw($user)->map([
+            'id'       => $user['userId'],
+            'nickname' => $user['nickName'] ?? null,
+            'name'     => $user['userName'] ?? null,
+            'email'    => $user['email'],
+            'avatar'   => $user['profilePic'] ?? null,
+        ]);
+    }
+}

src/Trovo/README.md

@@ -0,0 +1,66 @@
+# Trovo
+
+```bash
+composer require socialiteproviders/trovo
+```
+
+## 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
+'trovo' => [    
+  'client_id' => env('TROVO_CLIENT_ID'),  
+  'client_secret' => env('TROVO_CLIENT_SECRET'),  
+  'redirect' => env('TROVO_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('trovo', \SocialiteProviders\Trovo\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\Trovo\TrovoExtendSocialite::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('trovo')->redirect();
+```
+
+### Returned User fields
+
+- ``id``
+- ``name``
+- ``nickname``
+- ``email``
+- ``avatar``

src/Trovo/TrovoExtendSocialite.php

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

src/Trovo/composer.json

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