https://github.com/xrelease/oauth2-xrel

xREL OAuth 2.0 Client Provider for The PHP League OAuth2-Client http://oauth2-client.thephpleague.com/
https://github.com/xrelease/oauth2-xrel

Last synced: 5 days ago
JSON representation

xREL OAuth 2.0 Client Provider for The PHP League OAuth2-Client http://oauth2-client.thephpleague.com/

• Host: GitHub
• URL: https://github.com/xrelease/oauth2-xrel
• Owner: xrelease
• License: mit
• Created: 2016-04-09T21:36:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-04-11T13:04:52.000Z (over 8 years ago)
• Last Synced: 2024-08-02T12:42:52.086Z (3 months ago)
• Language: PHP
• Homepage:
• Size: 7.81 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - xrelease/oauth2-xrel - xREL OAuth 2.0 Client Provider for The PHP League OAuth2-Client http://oauth2-client.thephpleague.com/ (others)

README

        
# xREL Provider for OAuth 2.0 Client

[![Latest Version](https://img.shields.io/github/release/xrelease/oauth2-xrel.svg?style=flat-square)](https://github.com/xrelease/oauth2-xrel/releases)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

[![Build Status](https://scrutinizer-ci.com/g/xrelease/oauth2-xrel/badges/build.png?b=master)](https://scrutinizer-ci.com/g/xrelease/oauth2-xrel/build-status/master)

[![HHVM Status](https://img.shields.io/hhvm/xrelease/oauth2-xrel.svg?style=flat-square)](http://hhvm.h4cc.de/package/xrelease/oauth2-xrel)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/xrelease/oauth2-xrel.svg?style=flat-square)](https://scrutinizer-ci.com/g/xrelease/oauth2-xrel/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/g/xrelease/oauth2-xrel.svg?style=flat-square)](https://scrutinizer-ci.com/g/xrelease/oauth2-xrel)

[![Dependency Status](https://www.versioneye.com/user/projects/570a2acafcd19a0039f16a1a/badge.svg?style=flat)](https://www.versioneye.com/php/xrelease:oauth2-xrel/1.0.0)

This package provides xREL OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).

## Installation

To install, use composer:

```

composer require xrelease/oauth2-xrel

```

## Usage

Usage is the same as The League's OAuth client, using `\xREL\OAuth2\Client\Provider\xREL` as the provider.

### Authorization Code Flow

```php

 '{xrel-client-id}',

    'clientSecret'      => '{xrel-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->getName());

    } 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();

}

```

## Testing

``` bash

$ ./vendor/bin/phpunit

```

## Contributing

Please see [CONTRIBUTING](https://github.com/xrelease/oauth2-xrel/blob/master/CONTRIBUTING.md) for details.

## Credits

- [xREL](https://github.com/xrelease)

- [All Contributors](https://github.com/xrelease/oauth2-xrel/contributors)

## License

The MIT License (MIT). Please see [License File](https://github.com/xrelease/oauth2-xrel/blob/master/LICENSE) for more information.