BristolSU\Service\Typeform\Connectors\OAuth

Complexity

Total Complexity

12

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	refreshAccessToken()	0	20	2
A	test()	0	7	2
A	request()	0	7	3
A	settingsSchema()	0	5	1
A	getAccessToken()	0	11	4

<?php

Missing file doc comment

namespace BristolSU\Service\Typeform\Connectors;

use BristolSU\Service\Typeform\Fields\TypeformAuthCode;
use BristolSU\Service\Typeform\Models\TypeformAuthCode as AuthModel;
use BristolSU\Support\Connection\Contracts\Connector;
use Carbon\Carbon;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;
use GuzzleHttp\Exception\GuzzleException;

class OAuth extends Connector

Missing doc comment for class OAuth

{

    /**

Missing short description in doc comment

Parameter $method should have a doc-comment as per coding-style.

Parameter $uri should have a doc-comment as per coding-style.

Parameter $options should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function request($method, $uri, array $options = [])
    {
        $options['base_uri'] = config('typeform_service.base_uri');
        $headers = ((isset($options['headers']) && is_array($options['headers']))?$options['headers']:[]);
        $headers['Authorization'] = 'Bearer ' . $this->getAccessToken();
        $options['headers'] = $headers;
        return $this->client->request($method, $uri, $options);
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function test(): bool
    {
        try {
            $this->request('get', '/me');
            return true;
        } catch (GuzzleException $e) {
            return false;
        }
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    static public function settingsSchema(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::make(TypeformAuthCode::class, 'auth_code_id')->label('Log Into Typeform')->required(true)
        )->getSchema();
    }

    private function getAccessToken($refreshable = true): string

Private method name "OAuth::getAccessToken" must be prefixed with an underscore

Missing doc comment for function getAccessToken()

    {
        $authCode = AuthModel::findOrFail($this->getSetting('auth_code_id'));
        if($authCode->isValid()) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $authCode->auth_code;
        }
        if($refreshable && $this->refreshAccessToken($authCode)) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->getAccessToken(false);
        } else {
            // TODO Throw special error to send email to people
            throw new \Exception('Access token could not be refreshed');
        }
    }

    private function refreshAccessToken(AuthModel $authCode)

Private method name "OAuth::refreshAccessToken" must be prefixed with an underscore

Missing doc comment for function refreshAccessToken()

    {
        try {
            $response = $this->client->request('post', config('typeform_service.urlAccessToken'), [

The opening parenthesis of a multi-line function call should be the last content on the line.

                'form_params' => [
                    'grant_type' => 'refresh_token',
                    'refresh_token' => $authCode->refresh_token,
                    'client_id' => config('typeform_service.client_id'),
                    'client_secret' => config('typeform_service.client_secret'),
                    'scope' => 'offline accounts:read responses:read webhooks:read webhooks:write forms:read'
                ],
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        } catch (GuzzleException $e) {
            return false;
        }
        $token = json_decode($response->getBody()->getContents(), true);
        $authCode->auth_code = $token['access_token'];
        $authCode->refresh_token = $token['refresh_token'];
        $authCode->expires_at = Carbon::now()->addSeconds($token['expires_in']);
        return $authCode->save();
    }
}