Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edwin-luijten/oauth2-runkeeper
Runkeeper OAuth 2.0 Client Provider for The PHP League OAuth2-Client
https://github.com/edwin-luijten/oauth2-runkeeper
Last synced: 2 months ago
JSON representation
Runkeeper OAuth 2.0 Client Provider for The PHP League OAuth2-Client
- Host: GitHub
- URL: https://github.com/edwin-luijten/oauth2-runkeeper
- Owner: Edwin-Luijten
- License: mit
- Created: 2016-02-05T14:54:12.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-26T10:32:04.000Z (almost 8 years ago)
- Last Synced: 2024-10-28T06:07:51.780Z (3 months ago)
- Language: PHP
- Size: 15.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Runkeeper Provider for OAuth 2.0 Client
[](https://github.com/Edwin-Luijten/oauth2-runkeeper/releases)
[](LICENSE.md)
[](https://travis-ci.org/Edwin-Luijten/oauth2-runkeeper)
[](https://scrutinizer-ci.com/g/Edwin-Luijten/oauth2-runkeeper/?branch=master)
[](https://scrutinizer-ci.com/g/Edwin-Luijten/oauth2-runkeeper/?branch=master)
[](https://packagist.org/packages/edwin-luijten/oauth2-runkeeper)
This package provides Runkeeper OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).
## Install
Via Composer
``` bash
$ composer require edwin-luijten/oauth2-runkeeper
```
## Usage
Usage is the same as The League's OAuth client, using `\League\OAuth2\Client\Provider\Runkeeper` as the provider.
``` php
$provider = new League\OAuth2\Client\Provider\Runkeeper([
'clientId' => '{runkeeper-client-id}',
'clientSecret' => '{runkeeper-client-secret}',
'redirectUri' => 'https://example.com/callback-url',
]);
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
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
unset($_SESSION['oauth2state']);
exit('Invalid state');
} else {
// 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->getFirstName() . ' ' . $user->getLastName());
} 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();
}
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
## Credits
- [Edwin Luijten](https://github.com/Edwin-Luijten)
- [All Contributors](https://github.com/Edwin-Luijten/oauth2-runkeeper/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.