feat: Add Kick OAuth2 provider (#1414)

* feat: Add Kick OAuth2 provider

* security: add PKCE support to OAuth flow

* feat: add new line

* refactor: change key type to integer

Author: itsalifadaei

monorepo-builder.yml

@@ -108,6 +108,7 @@ parameters:
     src/Kakao: '[email protected]:SocialiteProviders/Kakao.git'
     src/Kanidm: '[email protected]:SocialiteProviders/Kanidm.git'
     src/Keycloak: '[email protected]:SocialiteProviders/Keycloak.git'
+    src/Kick: '[email protected]:SocialiteProviders/Kick.git'
     src/Klarna: '[email protected]:SocialiteProviders/Klarna.git'
     src/Kinde: '[email protected]:SocialiteProviders/Kinde.git'
     src/Kommo: '[email protected]:SocialiteProviders/Kommo.git'

src/Kick/KickExtendSocialite.php

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

src/Kick/Provider.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace SocialiteProviders\Kick;
+
+use GuzzleHttp\RequestOptions;
+use Illuminate\Support\Arr;
+use Laravel\Socialite\Two\Token;
+use SocialiteProviders\Manager\OAuth2\AbstractProvider;
+use SocialiteProviders\Manager\OAuth2\User;
+
+class Provider extends AbstractProvider
+{
+    public const IDENTIFIER = 'KICK';
+
+    protected $scopes = ['user:read'];
+
+    protected $usesPKCE = true;
+
+    protected function getAuthUrl($state): string
+    {
+        return $this->buildAuthUrlFromBase('https://id.kick.com/oauth/authorize', $state);
+    }
+
+    protected function getTokenUrl(): string
+    {
+        return 'https://id.kick.com/oauth/token';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getUserByToken($token)
+    {
+        $response = $this->getHttpClient()->get(
+            'https://api.kick.com/public/v1/users',
+            [
+                RequestOptions::HEADERS => [
+                    'Accept'        => 'application/json',
+                    'Authorization' => 'Bearer ' . $token
+                ],
+            ]
+        );
+
+        return json_decode((string) $response->getBody(), true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function mapUserToObject(array $user)
+    {
+        $user = $user['data'][0];
+
+        return (new User)->setRaw($user)->map([
+            'id'       => $user['user_id'],
+            'nickname' => $user['name'],
+            'name'     => $user['name'],
+            'email'    => $user['email'],
+            'avatar'   => $user['profile_picture'] ?? null,
+        ]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function refreshToken($refreshToken)
+    {
+        $response = $this->getRefreshTokenResponse($refreshToken);
+
+        return new Token(
+            Arr::get($response, 'access_token'),
+            Arr::get($response, 'refresh_token'),
+            Arr::get($response, 'expires_in'),
+            Arr::get($response, 'scope', [])
+        );
+    }
+}

src/Kick/README.md

@@ -0,0 +1,66 @@
+# Kick
+
+```bash
+composer require socialiteproviders/kick
+```
+
+## 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
+'kick' => [    
+  'client_id' => env('KICK_CLIENT_ID'),  
+  'client_secret' => env('KICK_CLIENT_SECRET'),  
+  'redirect' => env('KICK_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('kick', \SocialiteProviders\Kick\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\Kick\KickExtendSocialite::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('kick')->redirect();
+```
+
+### Returned User fields
+
+- ``id``
+- ``username``
+- ``account_type``
+- ``media_count``
+- ``avatar``

src/Kick/composer.json

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