README

Introduction

The onesyspkg package provides a convenient way to handle token-based login and additional customizable functionality for Onesys Collaboration.

Installation

You can install the package via Composer:

composer require pacificcross/onesyspkg

Instruction

If the project doesnt yet have passport, you need to run the following command:

php artisan passport:install

Get the passport password grant client id and secret

php artisan passport:client --password

Example:

Client ID ....................................................................................................................... 1  
Client secret ............................................................................ QY4osDh5eIQEuToDTQS5TbQnWILeHpwvsInOHkkN

Usage

Publish Configuration

Publish the configuration file using the following command:

php artisan vendor:publish --provider="PacificCross\Onesyspkg\OnesysServiceProvider" --tag="config"

Configure Handler

If you want to add function that needs to run after the login happen add it to this CustomTokenLoginHandler class. Example if the project needs to set the timezone to the session data:

namespace App\Http\Controllers\Auth;

use Illuminate\Support\Facades\Auth;

class CustomLoginHandler
{
    public function handle()
    {
        //Put Custom Code Here
    }
}

Routes

The package provides a route for logging in using a token. You can access this route by sending a GET request to /loginUsingToken with the following query parameters:

token: The JWT token route: The route to redirect to after successful login Example:

/loginUsingToken?token=your_token_here&route=dashboard

Testing

You can run the package's tests using PHPUnit. Ensure you have PHPUnit installed and configured:

composer require --dev phpunit/phpunit

Run the tests with the following command:

vendor/bin/phpunit

License

The MIT License (MIT). Please see License File for more information.

pcid / onesyspkg

Maintainers

Details