-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 990bdfb
Showing
13 changed files
with
942 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
*.swp | ||
*~ | ||
.coveralls.yml | ||
build/ | ||
composer.lock | ||
composer.phar | ||
coveralls.phar | ||
test/log | ||
vendor/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
filter: | ||
excluded_paths: [test/*] | ||
checks: | ||
php: | ||
code_rating: true | ||
remove_extra_empty_lines: true | ||
remove_php_closing_tag: true | ||
remove_trailing_whitespace: true | ||
fix_use_statements: | ||
remove_unused: true | ||
preserve_multiple: false | ||
preserve_blanklines: true | ||
order_alphabetically: true | ||
fix_php_opening_tag: true | ||
fix_linefeed: true | ||
fix_line_ending: true | ||
fix_identation_4spaces: true | ||
fix_doc_comments: true | ||
tools: | ||
external_code_coverage: | ||
timeout: 600 | ||
runs: 3 | ||
php_analyzer: true | ||
php_code_coverage: false | ||
php_code_sniffer: | ||
config: | ||
standard: PSR2 | ||
filter: | ||
paths: ['src'] | ||
php_loc: | ||
enabled: true | ||
excluded_dirs: [vendor, test] | ||
php_cpd: | ||
enabled: true | ||
excluded_dirs: [vendor, test] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
language: php | ||
|
||
sudo: false | ||
|
||
matrix: | ||
include: | ||
- php: 5.6 | ||
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"' | ||
- php: 7.0 | ||
- php: 7.1 | ||
- php: nightly | ||
- php: hhvm | ||
sudo: required | ||
dist: trusty | ||
group: edge | ||
- php: hhvm-nightly | ||
sudo: required | ||
dist: trusty | ||
group: edge | ||
fast_finish: true | ||
allow_failures: | ||
- php: nightly | ||
- php: hhvm-nightly | ||
|
||
|
||
before_script: | ||
- travis_retry composer self-update | ||
- travis_retry composer install --no-interaction --prefer-source --dev | ||
- travis_retry phpenv rehash | ||
|
||
script: | ||
- ./vendor/bin/parallel-lint src test | ||
- ./vendor/bin/phpcs src --standard=psr2 -sp | ||
- ./vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover | ||
|
||
after_success: | ||
- wget https://scrutinizer-ci.com/ocular.phar | ||
- php ocular.phar code-coverage:upload --format=php-clover coverage.clover | ||
- mkdir -p build/logs | ||
- wget https://github.com/satooshi/php-coveralls/releases/download/v1.0.2/coveralls.phar | ||
- travis_retry php coveralls.phar -x coverage.clover |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing | ||
|
||
Contributions are **welcome** and will be fully **credited**. | ||
|
||
We accept contributions via Pull Requests on [Github](https://github.com/wohali/oauth2-discord-new). | ||
|
||
|
||
## Pull Requests | ||
|
||
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). | ||
|
||
- **Add tests!** - Your patch won't be accepted if it doesn't have tests. | ||
|
||
- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date. | ||
|
||
- **Consider our release cycle** - We try to follow SemVer. Randomly breaking public APIs is not an option. | ||
|
||
- **Create topic branches** - Don't ask us to pull from your master branch. | ||
|
||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. | ||
|
||
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. | ||
|
||
- **Ensure tests pass!** - Please run the tests (see below) before submitting your pull request, and make sure they pass. We won't accept a patch until all tests pass. | ||
|
||
- **Ensure no coding standards violations** - Please run PHP Code Sniffer using the PSR-2 standard (see below) before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails. | ||
|
||
|
||
## Testing | ||
|
||
The following tests must pass for a build to be considered successful. If contributing, please ensure these pass before submitting a pull request. Travis CI will be used to enforce a pass before a merge can occur! | ||
|
||
``` bash | ||
$ ./vendor/bin/parallel-lint src test | ||
$ ./vendor/bin/phpunit --coverage-text | ||
$ ./vendor/bin/phpcs src --standard=psr2 -sp | ||
``` | ||
|
||
**Happy coding**! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2017 Joan Touzet <wohali@apache.org> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,205 @@ | ||
# Discord Provider for OAuth 2.0 Client | ||
[![Source Code](http://img.shields.io/badge/source-wohali/oauth2--discord--new-blue.svg?style=flat-square)](https://github.com/wohali/oauth2-discord-new) | ||
[![Latest Version](https://img.shields.io/github/release/wohali/oauth2-discord-new.svg?style=flat-square)](https://github.com/wohali/oauth2-discord-new/releases) | ||
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) | ||
[![Build Status](https://img.shields.io/travis/wohali/oauth2-discord-new/master.svg?style=flat-square)](https://travis-ci.org/wohali/oauth2-discord-new) | ||
[![Scrutinizer](https://img.shields.io/scrutinizer/g/wohali/oauth2-discord-new/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/wohali/oauth2-discord-new) | ||
[![Coverage Status](https://img.shields.io/coveralls/wohali/oauth2-discord-new/master.svg?style=flat-square)](https://coveralls.io/r/wohali/oauth2-discord-new?branch=master) | ||
[![Total Downloads](https://img.shields.io/packagist/dt/wohali/oauth2-discord-new.svg?style=flat-square)](https://packagist.org/packages/wohali/oauth2-discord-new) | ||
|
||
This package provides Discord OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client), v2.0 and up. | ||
|
||
## Requirements | ||
|
||
The following versions of PHP are supported. | ||
|
||
* PHP 5.6 | ||
* PHP 7.0 | ||
* PHP 7.1 | ||
* HHVM | ||
|
||
## Installation | ||
|
||
To install, use composer: | ||
|
||
```bash | ||
$ composer require wohali/oauth2-discord-new | ||
``` | ||
|
||
## Usage | ||
|
||
Usage is the same as The League's OAuth client, using `\Wohali\OAuth2\Client\Provider\Discord` as the provider. | ||
|
||
### Sample Authorization Code Flow | ||
|
||
This self-contained example: | ||
|
||
1. Gets an authorization code | ||
1. Gets an access token using the provided authorization code | ||
1. Looks up the user's provile with the provided access token | ||
|
||
You can try this script by [registering a Discord App](https://discordapp.com/developers/applications/me/create) with a redirect URI to your server's copy of this sample script. Then, place the Discord app's client id and secret, along with that same URI, into the settings at the top of the script. | ||
|
||
```php | ||
<?php | ||
|
||
require __DIR__ . '/vendor/autoload.php'; | ||
|
||
session_start(); | ||
|
||
echo ('Main screen turn on!<br/><br/>'); | ||
|
||
$provider = new \Wohali\OAuth2\Client\Provider\Discord([ | ||
'clientId' => '{discord-client-id}', | ||
'clientSecret' => '{discord-client-secret}', | ||
'redirecturi' => '{your-server-uri-to-this-script-here}' | ||
]); | ||
|
||
if (!isset($_GET['code'])) { | ||
|
||
// Step 1. Get authorization code | ||
$authUrl = $provider->getAuthorizationUrl(); | ||
$_SESSION['oauth2state'] = $provider->getState(); | ||
header('Location: ' . $authUrl); | ||
|
||
// 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 { | ||
|
||
// Step 2. Get an access token using the provided authorization code | ||
$token = $provider->getAccessToken('authorization_code', [ | ||
'code' => $_GET['code'] | ||
]); | ||
|
||
// Show some token details | ||
echo '<h2>Token details:</h2>'; | ||
echo 'Token: ' . $token->getToken() . "<br/>"; | ||
echo 'Refresh token: ' . $token->getRefreshToken() . "<br/>"; | ||
echo 'Expires: ' . $token->getExpires() . " - "; | ||
echo ($token->hasExpired() ? 'expired' : 'not expired') . "<br/>"; | ||
|
||
// Step 3. (Optional) Look up the user's profile with the provided token | ||
try { | ||
|
||
$user = $provider->getResourceOwner($token); | ||
|
||
echo '<h2>Resource owner details:</h2>'; | ||
printf('Hello %s#%s!<br/><br/>', $user->getUsername(), $user->getDiscriminator()); | ||
var_export($user->toArray()); | ||
|
||
} catch (Exception $e) { | ||
|
||
// Failed to get user details | ||
exit('Oh dear...'); | ||
|
||
} | ||
} | ||
``` | ||
|
||
### Managing Scopes | ||
|
||
When creating your Discord authorization URL in Step 1, you can specify the state and scopes your application may authorize. | ||
|
||
```php | ||
$options = [ | ||
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE', | ||
'scope' => ['identify', 'email', '...'] // 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://discordapp.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes): | ||
|
||
- bot | ||
- connections | ||
- identify | ||
- guilds | ||
- guilds.join | ||
- gdm.join | ||
- messages.read | ||
- rpc | ||
- rpc.api | ||
- rpc.notifications.read | ||
- webhook.incoming | ||
|
||
### Refreshing a Token | ||
|
||
You can refresh an expired token using a refresh token rather than going through the entire process of obtaining a brand new token. To do so, simply reuse the fresh token from your data store to request a refresh: | ||
|
||
```php | ||
// create $provider as in the initial example | ||
$existingAccessToken = getAccessTokenFromYourDataStore(); | ||
|
||
if ($existingAccessToken->hasExpired()) { | ||
$newAccessToken = $provider->getAccessToken('refresh_token', [ | ||
'refresh_token' => $existingAccessToken->getRefreshToken() | ||
]); | ||
|
||
// Purge old access token and store new access token to your data store. | ||
} | ||
``` | ||
|
||
### Client Credentials Grant | ||
|
||
Discord provides a client credentials flow for bot developers to get their own bearer tokens for testing purposes. This returns an access token for the *bot owner*: | ||
|
||
```php | ||
// create $provider as in the initial example | ||
try { | ||
|
||
// Try to get an access token using the client credentials grant. | ||
$accessToken = $provider->getAccessToken('client_credentials'); | ||
|
||
} catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { | ||
|
||
// Failed to get the access token | ||
exit($e->getMessage()); | ||
|
||
} | ||
``` | ||
|
||
### Bot Authorization | ||
|
||
To authorize a bot, specify a scope of `bot` and set [permissions](https://discordapp.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags) appropriately: | ||
|
||
```php | ||
// create $provider as in the initial example | ||
|
||
$options = [ | ||
'scope' => ['bot'], | ||
'permissions' => 1 | ||
]; | ||
|
||
$authorizationUrl = $provider->getAuthorizationUrl($options); | ||
|
||
// Redirect user to authorization page | ||
header('Location: ' . $authUrl); | ||
``` | ||
|
||
## Testing | ||
|
||
``` bash | ||
$ ./vendor/bin/parallel-lint src test | ||
$ ./vendor/bin/phpcs src --standard=psr2 -sp | ||
$ ./vendor/bin/phpunit --coverage-text | ||
``` | ||
|
||
## Contributing | ||
|
||
Please see [CONTRIBUTING](https://github.com/wohali/oauth2-discord-new/blob/master/CONTRIBUTING.md) for details. | ||
|
||
## Credits | ||
|
||
- [Joan Touzet](https://github.com/wohali) | ||
- [All Contributors](https://github.com/wohali/oauth2-discord-new/contributors) | ||
|
||
## License | ||
|
||
The MIT License (MIT). Please see [License File](https://github.com/wohali/oauth2-discord-new/blob/master/LICENSE) for more information. |
Oops, something went wrong.