kevbaldwyn/sentry-auth

Provides an authentication driver for Sentry as well as additional role based access control

Introduction

Sentry Auth is designed to be a drop in replacement for the native Laravel Auth system. It provides the same native API as the Auth class but also adds Sentry's own API to it natively. It also binds the Sentry User and Group model APIs to your Eloquent Model, along with mapping the Sentry Hash API to Laravel's., _(*1)

Installation

Add the following to your composer.json file, _(*2)

"repositories": [
    {
        "type":"composer",
        "url" : "http://packages.purepixel.co.uk"
    }
]

And the requirement, _(*3)

"kevbaldwyn/sentry-auth":"dev-master"

Then composer update, _(*4)

Add the providers to app/config/app.php, _(*5)

'providers' => array(

    ...

    'Cartalyst\Sentry\SentryServiceProvider', // Sentry must be defined first
    'KevBaldwyn\SentryAuth\SentryAuthServiceProvider'

    ...

Add Sentry Facade to app/config/app.php, _(*6)

'aliases' => array( 
    ...

    'Sentry' => 'Cartalyst\Sentry\Facades\Laravel\Sentry'
    ...

Configuration

The package uses a couple of config options to bind the User and Group Models., _(*7)

sentry-auth/src/config/sentry.php, _(*8)

'users' => array(

    'model' => 'KevBaldwyn\SentryAuth\Models\User'

)

You can then extend this class to create your own models:, _(*9)

// app/models/User.php:
class User extends \KevBaldwyn\SentryAuth\Models\User {

    // your own model definition

}

Then update the model config, _(*10)

// app/config/packages/kevbaldwyn/sentry-auth/sentry.php
'users' => array(

    'model' => 'User'

)

sentry-auth/src/config/sentry.php can be used to overwrite any sentry default config options by defining any sentry config options with the same keys as you'd find in cartalyst/sentry/src/config/config.php, _(*11)

Examples

You can use all native Auth class methods the same way plus additionally you can call Sentry methods natively from the same Auth API, _(*12)

$user = Auth::register(array(
    'email'    => 'john.doe@example.com',
    'password' => 'test',
));
// user will be an Eloquent Model with access to all of Sentry's user API
$activationCode = $user->getActivationCode();
var_dump($activationCode);

Auth::loginUsingId(1);
var_dump(Auth::user()->email);


$credentials = array(
    'email'    => 'john.doe@example.com',
    'password' => 'test',
);
Auth::once($credentials);


// Sentry User methods mapped directly to Eloquent model
User::findByCredentials(array(
        'email'      => 'john.doe@example.com',
        'password'   => 'test')
);

//$group = Group::create(array(
    'name'        => 'Users',
    'permissions' => array(
        'admin' => 1,
        'users' => 1,
    ),
));


$user = User::create(array(
    'email'    => 'john.doe@example.com',
    'password' => 'test',
));

// Assign the group to the user
$user->addGroup($group);