antogkou/laravel-oauth2-client

A Laravel package for OAuth2 integration

v1.0.0 2025-06-08 07:35 UTC

Requires

• php: ^8.2|^8.3|^8.4
• guzzlehttp/guzzle: ^7.8
• laravel/framework: ^11.0|^12.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^v3.64.0
• larastan/larastan: ^3.4.0
• laravel/pint: ^1.13
• orchestra/testbench: ^8.0|^9.0|^10.0
• pestphp/pest: ^v3.5.1
• pestphp/pest-plugin-laravel: ^v3.0.0
• pestphp/pest-plugin-type-coverage: ^3.1
• phpstan/phpstan: ^2.1.17
• rector/rector: ^2.0.5

MIT

• Antonis Gkoutzamanis

README

A robust Laravel package for OAuth2 Client Credentials flow integration with automatic token management.

Features

• 🚀 Automatic Token Management - Handles token acquisition and refresh
• 🔧 Multiple Service Support - Configure multiple OAuth2 providers
• 📦 Caching - Stores tokens securely using Laravel Cache
• 📝 Structured Logging - Detailed error logging for failed requests
• 🛡️ Security - Sensitive data redaction in logs
• ✅ Laravel 11+ Ready - Full support for latest Laravel versions

Installation

composer require antogkou/laravel-oauth2-client
php artisan oauth2:generate-types

Publish configuration file:

php artisan vendor:publish --tag=oauth2-client-config

Configuration

Config File (config/oauth2-client.php)

return [
    'services' => [
        'service1' => [
            'client_id' => env('SERVICE1_CLIENT_ID'),
            'client_secret' => env('SERVICE1_CLIENT_SECRET'),
            'token_url' => env('SERVICE1_TOKEN_URL'),
            'scope' => env('SERVICE1_SCOPE', ''),
            'verify' => env('SERVICE1_VERIFY', true),
        ],
    ],
    'cache_prefix' => 'oauth2_',
    'expiration_buffer' => 60, // Seconds before expiration to renew token
    'logging' => [
        'enabled' => true,
        'level' => 'error',
        'redact' => [
            'headers.authorization',
            'body.password',
            'response.access_token'
        ]
    ]
];

Environment Variables

# Service 1 Configuration
SERVICE1_CLIENT_ID = your_client_id
SERVICE1_CLIENT_SECRET = your_client_secret
SERVICE1_TOKEN_URL = https://auth.service.com/token
SERVICE1_SCOPE = api
SERVICE1_VERIFY = true # Set to false to disable SSL verification

Enabling IDE Autocompletion for Services

To enable IDE autocompletion for your OAuth2 service names in OAuth2::for('...'), this package provides a type generation command:

php artisan oauth2:generate-types

This command scans your config/oauth2-client.php and generates a PHP interface listing all configured service names. IDEs like PHPStorm and VSCode (with PHP Intelephense) will then offer autocompletion and static analysis for the available services.

Workflow:

1. Add or update your services in config/oauth2-client.php under the services key.
2. Run php artisan oauth2:generate-types to regenerate the types.
3. Enjoy autocompletion in your IDE for OAuth2::for('your_service').

Example:

// config/oauth2-client.php
'services' => [
    'service1' => [...],
    'service2' => [...],
],

After running the command, your IDE will suggest 'service1' and 'service2' in:

OAuth2::for('service1')->get(...);

Usage

Basic API Calls

use Antogkou\LaravelOAuth2Client\Facades\OAuth2;

// GET request
$response = OAuth2::for('service1')->get('https://api.service.com/data');

// POST request with JSON payload
$response = OAuth2::for('service1')->post('https://api.service.com/data', [
    'json' => [
        'name' => 'John Doe',
        'email' => '[e-mail]'
    ]
]);

// POST form data
$response = OAuth2::for('service1')->post('https://api.service.com/data', [
    'form_params' => [
        'name' => 'John Doe',
        'email' => '[e-mail]'
    ]
]);

// PUT request with JSON payload
$response = OAuth2::for('service1')->put('https://api.service.com/data/1', [
    'json' => [
        'name' => 'Updated Name'
    ]
]);

// PATCH request with JSON payload
$response = OAuth2::for('service1')->patch('https://api.service.com/data/1', [
    'json' => [
        'status' => 'active'
    ]
]);

// Request with custom headers
$response = OAuth2::for('service1')->post('https://api.service.com/data', [
    'json' => [
        'name' => 'John Doe'
    ],
    'headers' => [
        'X-Custom-Header' => 'value',
        'Accept' => 'application/json'
    ]
]);

// Get JSON response
$data = $response->json();

Request Options

The package supports various request options that can be passed as an array:

JSON Payload

$options = [
    'json' => [
        'key' => 'value',
        'nested' => ['data' => 'value']
    ]
];

Form Data

$options = [
    'form_params' => [
        'field1' => 'value1',
        'field2' => 'value2'
    ]
];

Multipart/Form-Data (File Uploads)

$options = [
    'multipart' => [
        [
            'name' => 'file',
            'contents' => fopen('path/to/file.pdf', 'r')
        ],
        [
            'name' => 'field',
            'contents' => 'value'
        ]
    ]
];

Custom Headers

$options = [
    'headers' => [
        'Accept' => 'application/json',
        'X-Custom-Header' => 'value'
    ],
    'json' => [
        'data' => 'value'
    ]
];

Available Methods

OAuth2::for('service1')->get($url, $options = []);
OAuth2::for('service1')->post($url, $options = []);
OAuth2::for('service1')->put($url, $options = []);
OAuth2::for('service1')->patch($url, $options = []);
OAuth2::for('service1')->delete($url, $options = []);
OAuth2::for('service1')->request($method, $url, $options = []);

Response Handling

$response = OAuth2::for('service1')->post('https://api.service.com/data', [
    'json' => ['name' => 'John']
]);

if ($response->successful()) {
    $data = $response->json();
    $status = $response->status(); // 200, 201, etc.
    $headers = $response->headers();
} else {
    $errorData = $response->json();
    $statusCode = $response->status();
}

Error Handling

The package throws Antogkou\LaravelOAuth2Client\Exceptions\OAuth2Exception for errors:

try {
    OAuth2::for('service1')->get('https://api.service.com/data');
} catch (OAuth2Exception $e) {
    // Handle exception
    $errorContext = $e->getContext();
}

Automatic JSON Error Responses

To make error handling seamless, you can configure your Laravel application's global exception handler to automatically return JSON responses for OAuth2 errors. This way, users of your API will always receive a structured JSON error response, and you don't need to manually catch exceptions in your controllers.

How to set up:

1. Open (or create) app/Exceptions/Handler.php in your Laravel application.
2. Add the following to your render method:

use Antogkou\LaravelOAuth2Client\Exceptions\OAuth2Exception;

public function render($request, Throwable $exception)
{
    if ($exception instanceof OAuth2Exception) {
        return $exception->toResponse($request);
    }
    return parent::render($request, $exception);
}

Debug Mode:

• If you include an X-Debug: 1 header or a ?debug=1 query parameter in your request, the error response will include additional debug information (stack trace, exception class).
• This is useful for development and debugging, but should be used with care in production.

Example error response (with debug):

{
  "message": "Invalid token response format for service: myservice",
  "code": 500,
  "context": { ... },
  "exception": "Antogkou\\LaravelOAuth2Client\\Exceptions\\OAuth2Exception",
  "trace": [
    { "file": "/path/to/file.php", "line": 123, "function": "...", "class": "..." },
    ...
  ]
}

This setup is optional but highly recommended for API projects using this package.

Testing

The package uses Pest PHP for testing. To run all tests:

composer test

To run only unit tests:

composer test:unit

To run static analysis:

composer test:types

To check code style:

composer lint

To test the artisan type generation command:

php artisan oauth2:generate-types
# Or run the dedicated test
pest tests/Feature/GenerateOAuth2TypesCommandTest.php

Adding New Services for Testing:

• Add your service to the services array in config/oauth2-client.php.
• Run the type generation command to update IDE support.

Troubleshooting & FAQ

Q: I added a new service but it doesn't autocomplete in my IDE.

• Run php artisan oauth2:generate-types after updating your config.
• Restart your IDE if needed.

Q: I get an exception about missing or invalid service configuration.

• Ensure your service is correctly defined in config/oauth2-client.php.
• Check for typos in the service name.

Q: How do I test error handling or simulate network/cache failures?

• See the feature tests for examples of simulating HTTP and cache errors using Laravel's testing tools.

Q: How do I contribute tests or features?

• See the 'Contributing' section below. All new features should include tests.

Contributing

Contributions welcome! Please follow:

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

License

MIT License - See LICENSE for details.

Support

For issues and feature requests, please create a GitHub issue.