thinkerytim/oauth2-flexmls

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

v0.1-alpha 2020-06-20 15:57 UTC

Requires

• php: >=7.2
• league/oauth2-client: ^2.0

Requires (Dev)

• mockery/mockery: ^1.4
• phpunit/phpunit: ^9.2

MIT

• Tim Kramer

• php
• authorization
• api
• Authentication
• client
• oauth
• oauth2
• RESO
• flexmls

README

This package provides FlexMLS OAuth 2.0 support for the PHP League's OAuth 2.0 Client. Users can authenticate against the FlexMLS Spark Platform (https://www.sparkplatform.com) and obtain a token for use with the Spark API or the FlexMLS RESO Web API.

Using these tokens developers can create real estate applications for web, mobile or data replication.

Installation

composer require thinkerytim/oauth2-flexmls

Usage

$flexmlsProvider = new \ThinkeryTim\OAuth2\Client\Provider\FlexMLS([
    'clientId'                => 'yourId',          // The client ID assigned to you by the Spark Platform  
    'clientSecret'            => 'yourSecret',      // The client password assigned to you by the Spark Platform 
    'redirectUri'             => 'yourRedirectUri'  // The return URL you specified for your app on Spark Platform 
]);

// Get authorization code
if (!isset($_GET['code'])) {
    // Options are optional, defaults to 'openid' only
    $options = ['scope' => 'openid'];
    // Get authorization URL
    $authorizationUrl = $flexmlsProvider->getAuthorizationUrl($options);

    // Get state and store it to the session
    $_SESSION['oauth2state'] = $flexmlsProvider->getState();

    // Redirect user to authorization URL
    header('Location: ' . $authorizationUrl);
    exit;
// Check for errors
} elseif (empty($_GET['state']) || (isset($_SESSION['oauth2state']) && $_GET['state'] !== $_SESSION['oauth2state'])) {
    if (isset($_SESSION['oauth2state'])) {
        unset($_SESSION['oauth2state']);
    }
    exit('Invalid state');
} else {
    // Get access token
    try {
        $accessToken = $flexmlsProvider->getAccessToken(
            'authorization_code',
            [
                'code' => $_GET['code']
            ]
        );
    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
        exit($e->getMessage());
    }

    // Get resource owner
    try {
        $resourceOwner = $flexmlsProvider->getResourceOwner($accessToken);
    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
        exit($e->getMessage());
    }
        
    // Now you can store the results to session etc.
    $_SESSION['accessToken'] = $accessToken;
    $_SESSION['resourceOwner'] = $resourceOwner;
    
    var_dump(
        $resourceOwner->getId(),
        $resourceOwner->getName(),
        $resourceOwner->getPrimaryEmail(),
        $resourceOwner->OfficeMlsId, // this is using the _get magic method
        $resourceOwner->toArray()
    );
}

For more information see the PHP League's general usage examples.

Testing

$ ./vendor/bin/phpunit

License

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