README

Introduction

Socialiser is a rebuild of Laravel Socialite which provides an expressive, fluent interface to OAuth authentication with Facebook, Instagram, Twitter, Google, YouTube, LinkedIn, GitHub and Bitbucket. It handles almost all of the boilerplate social authentication code you are dreading writing.

This adaption of Socialite goes further by adding in the controllers, seperate configuration, migration, and storage of social data to allow super speed integration of social services into your application, If using Laravel version 5.5+ you can require this package and link your buttons, Socialiser will take care of registering and connecting to your chosen social services storing your social data .

In-fact the only manual step you will need to take if planning on storing the social data is to run the artisan command:

    php artisan socialiser:migrate

**NOTE: If you want to link your user to their social data though, open up config/socialiser and set your fully namespaced user model i.e: App\User, socialiser will then add the foreign key back to the users id when running its migration. The name of the user model is irrelevant, as is the name of the user table, just set fully namespaced user model and socialiser will find your user table, you can also set the primary key column in the configuration too, if left blank socialiser will assume 'id' as per Laravel standards. You can in-fact set the model, table and id column name within the config file

Socialiser will also add its own routes:

    socialiser/login/{provider}
    socialiser/login/{provider}/callback
    
    socialiser/connect/{provider}
    socialiser/connect/{provider}/callback

These are what allows us to get running out of the box (bar aquiring your api keys).

We have seperations for login and connect to allow us to limit which services we can register by or connect to, these can be set in the socialiser.php file in config folder.

Additionally within the config file you can set the fully namespace user model you are using, allowing the socialiser migration to add the foreign key so the socialiser_provider_user

We are not accepting new adapters.

If you are using Laravel 5.3 or below, please use Socialite 2.0.

Adapters for other platforms are listed at the community driven Socialite Providers website.

License

Laravel Socialite is open-sourced software licensed under the MIT license

Official Documentation

In addition to typical, form based authentication, Laravel also provides a simple, convenient way to authenticate with OAuth providers using Laravel Socialite. Socialite currently supports authentication with Facebook, Twitter, LinkedIn, Google, GitHub and Bitbucket.

To get started with Socialite, use Composer to add the package to your project's dependencies:

composer require laravel/socialite

Configuration

After installing the Socialite library, register the Laravel\Socialite\SocialiteServiceProvider in your config/app.php configuration file:

'providers' => [
    // Other service providers...

    Laravel\Socialite\SocialiteServiceProvider::class,
],

Also, add the Socialite facade to the aliases array in your app configuration file:

'Socialite' => Laravel\Socialite\Facades\Socialite::class,

You will also need to add credentials for the OAuth services your application utilizes. These credentials should be placed in your config/services.php configuration file, and should use the key facebook, twitter, linkedin, google, github or bitbucket, depending on the providers your application requires. For example:

'github' => [
    'client_id' => 'your-github-app-id',
    'client_secret' => 'your-github-app-secret',
    'redirect' => 'http://your-callback-url',
],

If the redirect option contains a relative path, it will automatically be resolved to a fully qualified URL.

Basic Usage

Next, you are ready to authenticate users! You will need two routes: one for redirecting the user to the OAuth provider, and another for receiving the callback from the provider after authentication. We will access Socialite using the Socialite facade:

<?php

namespace App\Http\Controllers\Auth;

use Socialite;

class LoginController extends Controller
{
    /**
     * Redirect the user to the GitHub authentication page.
     *
     * @return Response
     */
    public function redirectToProvider()
    {
        return Socialite::driver('github')->redirect();
    }

    /**
     * Obtain the user information from GitHub.
     *
     * @return Response
     */
    public function handleProviderCallback()
    {
        $user = Socialite::driver('github')->user();

        // $user->token;
    }
}

The redirect method takes care of sending the user to the OAuth provider, while the user method will read the incoming request and retrieve the user's information from the provider. Before redirecting the user, you may also add additional "scopes" on the request using the scopes method. This method will merge all existing scopes with the ones you supply:

return Socialite::driver('github')
            ->scopes(['scope1', 'scope2'])->redirect();

You can overwrite all exisiting scopes using the setScopes method:

return Socialite::driver('github')
            ->setScopes(['scope1', 'scope2'])->redirect();

Of course, you will need to define routes to your controller methods:

Route::get('login/github', 'Auth\LoginController@redirectToProvider');
Route::get('login/github/callback', 'Auth\LoginController@handleProviderCallback');

A number of OAuth providers support optional parameters in the redirect request. To include any optional parameters in the request, call the with method with an associative array:

return Socialite::driver('google')
            ->with(['hd' => 'example.com'])->redirect();

When using the with method, be careful not to pass any reserved keywords such as state or response_type.

Stateless Authentication

The stateless method may be used to disable session state verification. This is useful when adding social authentication to an API:

return Socialite::driver('google')->stateless()->user();

Retrieving User Details

Once you have a user instance, you can grab a few more details about the user:

$user = Socialite::driver('github')->user();

// OAuth Two Providers
$token = $user->token;
$refreshToken = $user->refreshToken; // not always provided
$expiresIn = $user->expiresIn;

// OAuth One Providers
$token = $user->token;
$tokenSecret = $user->tokenSecret;

// All Providers
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();

Retrieving User Details From Token

If you already have a valid access token for a user, you can retrieve their details using the userFromToken method:

$user = Socialite::driver('github')->userFromToken($token);

ronappleton / socialiser

Maintainers

Details