https://github.com/stevenmaguire/oauth2-bitbucket

Bitbucket OAuth 2.0 support for the PHP League's OAuth 2.0 Client
https://github.com/stevenmaguire/oauth2-bitbucket

Last synced: 15 days ago
JSON representation

Bitbucket OAuth 2.0 support for the PHP League's OAuth 2.0 Client

• Host: GitHub
• URL: https://github.com/stevenmaguire/oauth2-bitbucket
• Owner: stevenmaguire
• License: mit
• Created: 2015-07-21T16:27:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-03T22:50:40.000Z (over 6 years ago)
• Last Synced: 2024-09-18T01:13:14.702Z (about 2 months ago)
• Language: PHP
• Homepage:
• Size: 20.5 KB
• Stars: 20
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bitbucket Provider for OAuth 2.0 Client

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

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

[![Build Status](https://img.shields.io/travis/stevenmaguire/oauth2-bitbucket/master.svg?style=flat-square)](https://travis-ci.org/stevenmaguire/oauth2-bitbucket)

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

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

[![Total Downloads](https://img.shields.io/packagist/dt/stevenmaguire/oauth2-bitbucket.svg?style=flat-square)](https://packagist.org/packages/stevenmaguire/oauth2-bitbucket)

This package provides Bitbucket 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 stevenmaguire/oauth2-bitbucket

```

## Usage

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

### Authorization Code Flow

```php

$provider = new Stevenmaguire\OAuth2\Client\Provider\Bitbucket([

    'clientId'          => '{bitbucket-client-id}',

    'clientSecret'      => '{bitbucket-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->getId());

    } 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/stevenmaguire/oauth2-bitbucket/blob/master/CONTRIBUTING.md) for details.

## Credits

- [Steven Maguire](https://github.com/stevenmaguire)

- [All Contributors](https://github.com/stevenmaguire/oauth2-bitbucket/contributors)

## License

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