Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osavchenko/oauth2-cloudconvert
CloudConvert Provider for the OAuth 2.0 Client
https://github.com/osavchenko/oauth2-cloudconvert
cloudconvert oauth oauth-provider oauth2
Last synced: 26 days ago
JSON representation
CloudConvert Provider for the OAuth 2.0 Client
- Host: GitHub
- URL: https://github.com/osavchenko/oauth2-cloudconvert
- Owner: osavchenko
- License: mit
- Created: 2021-08-28T18:37:11.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-09-17T17:54:59.000Z (about 3 years ago)
- Last Synced: 2024-04-18T16:09:02.003Z (7 months ago)
- Topics: cloudconvert, oauth, oauth-provider, oauth2
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CloudConvert Provider for OAuth 2.0 Client
[](https://github.com/osavchenko/oauth2-cloudconvert)
[](https://github.com/osavchenko/oauth2-cloudconvert/releases)
[](https://github.com/osavchenko/oauth2-cloudconvert/blob/master/LICENSE)
[](https://github.com/osavchenko/oauth2-cloudconvert/actions?query=workflow%3ACI)
[](https://scrutinizer-ci.com/g/osavchenko/oauth2-cloudconvert)
[](https://codecov.io/gh/osavchenko/oauth2-cloudconvert)
This package provides [CloudConvert](https://cloudconvert.com/) OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/osavchenko/oauth2-cloudconvert).
## Installation
To install, use composer:
```
composer require osavchenko/oauth2-cloudconvert
```
## Usage
Usage is the same as The League's OAuth client, using `\Osavchenko\OAuth2\Client\Provider\CloudConvert` as the provider.
### Authorization Code Flow
```php
$provider = new Osavchenko\OAuth2\Client\Provider\CloudConvert([
'clientId' => '{cloud-convert-client-id}',
'clientSecret' => '{cloud-convert-client-secret}',
'redirectUri' => 'https://example.com/callback-url',
'sandbox' => false, // optional
]);
if (!isset($_GET['code'])) {
// If we don't have an authorization code then get one
$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2state'] = $provider->getState();
header('Location: '.$authUrl);
exit;
}
// Check given state against previously stored one to mitigate CSRF attack
if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
}
// Try to get an access token (using the authorization code grant)
$token = $provider->getAccessToken('authorization_code', [
'code' => $_GET['code']
]);
// Optional: Now you have a token you can look up a users profile data
try {
// We got an access token, let's now get the user's details
$user = $provider->getResourceOwner($token);
// Use these details to create a new profile
printf('Hello %s!', $user->getNickname());
} catch (Exception $e) {
// Failed to get user details
exit('Oh dear...');
}
// Use this to interact with an API on the users behalf
echo $token->getToken();
}
```
### Managing Scopes
When creating your CloudConvert authorization URL, you can specify the state and scopes your application may authorize.
```php
$options = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['user.read','task.read'], // array or string
];
$authorizationUrl = $provider->getAuthorizationUrl($options);
```
If neither are defined, the provider will utilize internal defaults.
At the time of authoring this documentation, the [following scopes are available](https://cloudconvert.com/api/v2#authentication).
- user.read
- user.write
- task.read
- task.write
- webhook.read
- webhook.write
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## License
The MIT License (MIT). Please see [License File](https://github.com/osavchenko/oauth2-cloudconvert/blob/master/LICENSE) for more information.