gregurco / guzzle-bundle-oauth2-plugin
OAuth2 Plugin for Guzzle Bundle, a PHP HTTP client library and framework for building RESTful web service clients
Installs: 256 071
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 14
Open Issues: 4
Requires
- php: >=7.2
- eightpoints/guzzle-bundle: ^8.0
- guzzlehttp/guzzle: ^6.5.8|^7.4.5
- sainsburys/guzzle-oauth2-plugin: ^3.0
- symfony/config: ~5.0|~6.0|~7.0
- symfony/dependency-injection: ~5.0|~6.0|~7.0
- symfony/expression-language: ~5.0|~6.0|~7.0
- symfony/http-kernel: ~5.0|~6.0|~7.0
Requires (Dev)
- php-coveralls/php-coveralls: ^2.2
- symfony/phpunit-bridge: ~5.0|~6.0|~7.0
README
This plugin integrates OAuth2 functionality into Guzzle Bundle, a bundle for building RESTful web service clients.
Prerequisites
- PHP 7.2 or above
- Guzzle Bundle
- guzzle-oauth2-plugin
Installation
To install this bundle, run the command below on the command line and you will get the latest stable version from Packagist.
composer require gregurco/guzzle-bundle-oauth2-plugin
Usage
Enable bundle
Find next lines in src/Kernel.php
:
foreach ($contents as $class => $envs) { if (isset($envs['all']) || isset($envs[$this->environment])) { yield new $class(); } }
and replace them by:
foreach ($contents as $class => $envs) { if (isset($envs['all']) || isset($envs[$this->environment])) { if ($class === \EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle::class) { yield new $class([ new \Gregurco\Bundle\GuzzleBundleOAuth2Plugin\GuzzleBundleOAuth2Plugin(), ]); } else { yield new $class(); } } }
Basic configuration
With default grant type (client)
# app/config/config.yml eight_points_guzzle: clients: api_payment: base_url: "http://api.domain.tld" options: auth: oauth2 # plugin settings plugin: oauth2: base_uri: "https://example.com" token_url: "/oauth/token" client_id: "test-client-id" client_secret: "test-client-secret" # optional scope: "administration"
With password grant type
# app/config/config.yml eight_points_guzzle: clients: api_payment: base_url: "http://api.domain.tld" options: auth: oauth2 # plugin settings plugin: oauth2: base_uri: "https://example.com" token_url: "/oauth/token" client_id: "test-client-id" username: "johndoe" password: "A3ddj3w" scope: "administration" grant_type: "Sainsburys\\Guzzle\\Oauth2\\GrantType\\PasswordCredentials"
With client credentials in body
# app/config/config.yml eight_points_guzzle: clients: api_payment: base_url: "http://api.domain.tld" options: auth: oauth2 # plugin settings plugin: oauth2: base_uri: "https://example.com" token_url: "/oauth/token" client_id: "test-client-id" scope: "administration" auth_location: "body"
Options
See more information about middleware here.
License
This middleware is licensed under the MIT License - see the LICENSE file for details