auburus/netatmo-api

There is no license information available for the latest version (v1.0.0) of this package.

Netatmo Provider for the league/oauth2-client library

v1.0.0 2015-12-25 23:49 UTC

Requires

• league/oauth2-client: ~1.0

Requires (Dev)

• mockery/mockery: ^0.9.4
• phpunit/phpunit: ^5.1
• squizlabs/php_codesniffer: ^2.5

Unknown License

• Jordi Nonell

• api
• oauth2
• provider
• netatmo

README

This is a Provider implementation for the league/OAuth2-client library.

Install

Via Composer

$ composer require auburus/netatmo-api:~0.2.0

Usage

Here's a code based on the usage example example.

<?php

require_once 'vendor/autoload.php';

use Auburus\OAuth2\Client\Provider\Netatmo;
use GuzzleHttp\Exception\RequestException;

session_start();

$provider = new Netatmo([
    'clientId'      => 'XXXXXXXX',
    'clientSecret'  => 'XXXXXXXX',
    'redirectUri'   => 'https://your-registered-redirect-uri/',
]);

// Handles the case when the user choose to NOT authorize
if (isset($_GET['error'])) {
    echo $_GET['error'];
    exit;
}

if (!isset($_GET['code'])) {


    $authorizationUrl = $provider->getAuthorizationUrl([
        'scope' => ['read_station']
    ]);

    $_SESSION['oauth2state'] = $provider->getState();

    // Redirect the user to the authorization URL.
    header('Location: ' . $authorizationUrl);
    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 {

        // Try to get an access token using the authorization code grant.
        $accessToken = $provider->getAccessToken('authorization_code', [
            'code' => $_GET['code']
        ]);

        // We have an access token, which we may use in authenticated
        // requests against the service provider's API.
        echo $accessToken->getToken() . "<br>";
        echo $accessToken->getRefreshToken() . "<br>";
        echo $accessToken->getExpires() . "<br>";
        echo ($accessToken->hasExpired() ? 'expired' : 'not expired') . "<br>";

        // The provider provides a way to get an authenticated API request for
        // the service, using the access token; it returns an object conforming
        // to Psr\Http\Message\RequestInterface.
        $request = $provider->getAuthenticatedRequest(
            'GET',
            'https://api.netatmo.com/api/getstationsdata?access_token=' . $accessToken,
            $accessToken
        );

        try {
            $response = $provider->getHttpClient()->send($request);
            echo $response->getBody();
        } catch (RequestException $e) {
            echo "<h1>ERROR!</h1>";
            echo $e->getResponse()->getBody();
        }

    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {

        // Failed to get the access token or user details.
        exit($e->getMessage());

    }

}

Using Resource Owner

The original league/OAuth2-client provides the $provider->getResourceOwner() method to access the user data. Although it's very convinient, the Netatmo Api has recently deprecated the api endpoint to access to those information, and has embedded it in some other methods.

So, depending on the api scope you will use, you should use a "slighly more" specific provider than the Netatmo.

Scope	Provider
read_station	NetatmoStation
read_thermostat	NetatmoThermostat
read_camera	NetatmoHome

So, the example will result in:

<?php
use Auburus\OAuth2\Client\Provider\NetatmoThermostat;

$provider = new NetatmoThermostat([
    'clientId'      => 'XXXXXXXX',
    'clientSecret'  => 'XXXXXXXX',
    'redirectUri'   => 'https://your-registered-redirect-uri/',
]);

// (All the OAuth2 proces...)
// ...


$resourceOwner = $provider->getResourceOwner($accessToken);

var_export($resourceOwner->toArray());

Note that you can still use all provider methods, as getAuthenticatedRequest.

I personally suggest declaring the provider as:

use Auburus\OAuth2\Client\Provider\NetatmoThermostat as Netatmo;

So as long as you use the right scope when requesting authorization, you can assume it's the normal Netatmo provider.