freshworkx/oauth2-thingiverse

Thingiverse OAuth 2.0 Client Provider for The PHP League OAuth2-Client

0.0.7 2021-03-12 16:36 UTC

This package is auto-updated.

Last update: 2021-04-12 16:49:32 UTC


README

GitHub tag GitHub license build codecov

This package provides Thingiverse OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Requirements

The following versions of PHP are supported.

  • PHP 7.3
  • PHP 7.4
  • PHP 8.0

Installation

To install, use composer:

composer require freshworkx/oauth2-thingiverse

Or add the following to your composer.json file.

{
    "require": {
        "freshworkx/oauth2-thingiverse": "^0.0.7"
    }
}

Usage

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

Authorization Code Flow

<?php

session_start();

require_once __DIR__ . '/vendor/autoload.php';

$provider = new Freshworkx\OAuth2\Client\Provider\Thingiverse([
    'clientId'     => '{thingiverse-client-id}',
    'clientSecret' => '{thingiverse-client-secret}',
    'redirectUri'  => 'https://example.com/callback-url',
    'responseType' => 'token',
]);

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);
        printf('Hello %s!', $user->getName());

    } catch (Exception $e) {

        // Failed to get user details
        exit('Error...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.