jhaoda/socialite-mailru

Mail.ru OAuth2 Provider for Laravel Socialite

v4.0.0 2021-03-21 05:49 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• socialiteproviders/manager: ~4.0

MIT

• JhaoDa

README

1. Installation

composer require jhaoda/socialite-mailru

2. Service Provider

• Remove Laravel\Socialite\SocialiteServiceProvider from your providers[] array in config\app.php if you have added it already.
• Add SocialiteProviders\Manager\ServiceProvider to your providers[] array in config\app.php.

For example:

'providers' => [
    // a whole bunch of providers
    // remove 'Laravel\Socialite\SocialiteServiceProvider',
    SocialiteProviders\Manager\ServiceProvider::class, // add
];

• Note: If you would like to use the Socialite Facade, you need to install it.

3. Add the Event and Listeners

• Add SocialiteProviders\Manager\SocialiteWasCalled::class event to your listen[] array in <app_name>/Providers/EventServiceProvider.

• Add your listeners (i.e. the ones from the providers) to the SocialiteProviders\Manager\SocialiteWasCalled[] that you just created.

• The listener that you add for this provider is JhaoDa\SocialiteProviders\MailRu\MailRuExtendSocialite::class.

• Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.

For example:

/**
 * The event handler mappings for the application.
 *
 * @var array
 */
protected $listen = [
    SocialiteProviders\Manager\SocialiteWasCalled::class => [
        JhaoDa\SocialiteProviders\MailRu\MailRuExtendSocialite::class
    ],
];

4. Services Array and .env

Add to config/services.php:

'mailru' => [
    'client_id' => env('MAILRU_ID'),
    'client_secret' => env('MAILRU_SECRET'),
    'redirect' => env('MAILRU_REDIRECT'),  
],

Append provider values to your .env file:

// other values above
MAILRU_ID=your_app_id_for_the_service
MAILRU_SECRET=your_app_secret_for_the_service
MAILRU_REDIRECT=https://example.com/login